Using the API
Terminology
Public names for businesses, documents, invoices, accounts, and periods.
Use these meanings when you map NoCFO data. The names are the public contract. They are not the database tables.
Business and access
| Term | Meaning |
|---|---|
| Business | One company the user can access. Address it with slug from list businesses. |
slug | The tenant key in /v1/business/{business_slug}/ and /v1/invoicing/{business_slug}/. Store it exactly. A slug from another user does not grant access. |
id | A numeric id of a resource inside a business. It is not a substitute for slug. |
Bookkeeping and invoices
| Term | Meaning |
|---|---|
| Document | A bookkeeping document under /v1/business/{business_slug}/document/. Entries hang off a document. This is not a sales invoice. |
| Entry | A line returned by the entries list for one document. |
| Header | A journal header under /v1/business/{business_slug}/header/. A header is not a document and not an invoice. |
| Account | A chart-of-accounts row under /v1/business/{business_slug}/account/. Filter by type only with values the account list documents. |
| Sales invoice | An invoice you issue, under /v1/invoicing/{business_slug}/invoice/. |
| Purchase invoice | A supplier invoice, under /v1/invoicing/{business_slug}/purchase_invoice/. Listing it is not the same call as listing sales invoices. |
| Contact | A customer or supplier under /v1/business/{business_slug}/contacts/. |
| Product | A product under /v1/invoicing/{business_slug}/product/. |
| File | An uploaded file under /v1/business/{business_slug}/files/. Upload goes to POST .../file_upload/. |
| Tag | A label under /v1/business/{business_slug}/tags/. |
VAT and periods
| Term | Meaning |
|---|---|
| VAT code | A code from GET /v1/business/{business_slug}/constants/vat_codes/. Do not hardcode a code in the client. |
| VAT rate | A rate from GET /v1/business/{business_slug}/constants/vat_rates/. The operation is dated. Read the reference before you cache it. |
| Accounting period | A period under /v1/business/{business_slug}/period/. |
| VAT period | A period under /v1/business/{business_slug}/vat_period/. It is not an accounting period. |
Store every id exactly as returned. Do not increment it, and do not reuse an id from another business.