Read the accrual entry of one customer for one month
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.
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
Query Parameters
The customer: its id, or ext:<external_id>.
1 <= length <= 255YYYY-MM: the month the entry closes.
^\d{4}-(0[1-9]|1[0-2])$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/accruals?customer=string&month=string"{ "object": "accrual", "id": "string", "customer_id": "string", "accrual_month": "string", "original_accrual_month": "string", "status": "draft", "platform_ref": "string", "platform_number": -9007199254740991, "booked_at": "string", "line_targets": [ { "invoice_line_id": "string", "target": 0 } ]}Overview
Every /api/v1 endpoint and every webhook event, generated from the OpenAPI document.
Read the configuration of the company the key is bound to GET
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.