Skip to content

The accounts you can post to on a business's chart of accounts.

One endpoint, with the fields it takes and the fields it gives back.

GET/accounts

Lists the accounts you can post to, each with its place in the chart of accounts.

  • These are the leaves of the chart of accounts, each with its full path. Parent and heading accounts are not returned, and neither are archived ones.
  • The list is not paged.
  • Leave entityId out only when this key can reach exactly one business. When it can reach several, a call that omits it is refused; call GET /businesses for the ids.

Needs the accounts:read permission. A Read only key has it.

Query parameters

entityId
Typestring
RequiredOptional
Details
  • a uuid
type
Typestring
RequiredOptional
Details
  • one of: asset, liability, equity, revenue, expense
Request
curl "https://www.numm.io/api/v1/accounts?entityId=0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f1002&type=expense" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY"
Response 200
{
  "accounts": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f1003",
      "code": "5010",
      "name": "Office Expense",
      "type": "expense",
      "path": "Expenses > Office Expense"
    }
  ]
}

Response fields

accounts
Typearray of object
PresentAlways
accounts[].id
Typestring
PresentAlways
Details
  • a uuid
accounts[].code
Typestring
PresentAlways
accounts[].name
Typestring
PresentAlways
accounts[].type
Typestring
PresentAlways
Details
  • one of: asset, liability, equity, revenue, expense
accounts[].path
Typestring
PresentAlways

Errors

entity_not_allowed
Status403
MeaningYour key is limited to certain businesses, and this is not one of them.
not_found
Status404
MeaningThere is no such record, or none your key can reach.

Every endpoint can also return:

invalid_key
Status401
MeaningYour key is missing, malformed, revoked, or expired.
insufficient_scope
Status403
MeaningYour key does not carry the scope this endpoint needs.
rate_limited
Status429
MeaningYou've made too many requests for this key. The retry-after header says how long to wait.
validation_failed
Status422
MeaningSomething in the path, the query, or the body did not pass validation.
internal_error
Status500
MeaningSomething went wrong on our side. Try again.
Accounts — Nummio API