Read the revenue recognition of one customer
Earned, billed, deferred revenue and work in progress over every line of every invoice of the customer, drafts and occurrences of recurring series among them, in the company’s base currency. The figures are the month-end accrual’s own, stated as of the last day of month: the running month where it is left out. Deferred revenue and work in progress are stated per line and summed, so a customer can carry both.
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 figures are stated as of, at its last day. Left out: the running month, as it stands today.
^\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/recognition?customer=string"{ "object": "customer_recognition", "customer_id": "string", "currency": "string", "month": "string", "earned": 0, "billed": 0, "deferred": 0, "wip": 0, "missing_rates": [ { "invoice_line_id": "string", "currency": "string", "at": "string" } ]}Create a product POST
The product is written to the accounting platform first. With an `external_id` that a product already carries, that product is updated and the answer is 200; otherwise a product is created and the answer is 201. A product number names one product: where the platform already holds a product under the number, that product is answered with 200 and nothing is written to it. One create runs at a time under an `external_id`: a second while the first is still running is answered 409 `CREATE_IN_PROGRESS` with `Retry-After`, and the same request after that interval answers the product the first created.
Take a line of a recurring series away DELETE
With `this-and-following` the line stops from the occurrence `period` names; earlier occurrences keep it. With `this-only` it is absent from that one occurrence. A one-time line is removed under either scope. Refused with `DELETE_EMPTIES_OCCURRENCE` (409) when it would leave an occurrence that is already an invoice with no lines, and with `OCCURRENCE_ISSUED` (409) when the occurrence is issued.