Read the configuration of the company the key is bound to
The base currency every figure is stated in, and the two accounts the month-end accrual moves. Both accounts are null until an admin has confirmed them.
Authorization
bearerAuth An API key minted by an admin under Settings → Developers. It is bound to one company and has a scope: read, or read_write. A request without one, or with one that is not ours, is answered 401 and metered by its client address (x-rate-limits).
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/config"{ "object": "config", "integration_id": "string", "company_name": "string", "base_currency": "string", "wip_account_number": -9007199254740991, "deferred_revenue_account_number": -9007199254740991}Read the accrual entry of one customer for one month GET
Where the month-end accrual stands for the customer in that month: a draft kept current while the month runs, or the entry the close booked. Answered `NOT_FOUND` (404) where the customer has no entry for the month: nothing moved for them in it, or the company’s two accrual accounts are not confirmed.
Credit an issued invoice POST
The accounting platform books and sends the credit note inside the request, and the answer is the booked credit note, 201. A full credit takes the whole invoice back and is refused once anything was credited (`INVOICE_ALREADY_CREDITED`); a partial credit names lines of the invoice, each by no more than is left on it (`VALIDATION_FAILED` with `AMOUNT_EXCEEDS_BILLED` under the line). Amounts are before VAT. **Sending it again is safe**: the same `external_id` is the same credit note, whatever its body says the second time. Booked, it is answered as it stands, 200, and nothing is booked twice; not booked, that attempt is taken up again under its own date and lines. **A credit note that booked and could not be delivered is a success** whose `send_error` says why. An attempt the platform gave no definite answer to holds every other credit on the invoice back (`CREDIT_ATTEMPT_UNRESOLVED`, 409) until the request that made it is sent again. Metered against the `platform_write` bucket as well as `default`.