Take a line of a recurring series away
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.
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
Path Parameters
The record's id, or ext:<external_id> for the record that carries your own key.
The id of a recurring line, or the line_id of a one-time line as its occurrence states it.
Query Parameters
this-and-following: from the occurrence period names, onward. this-only: on that occurrence alone.
Value in
- "this-and-following"
- "this-only"
The occurrence the change holds from: the first day of its billing period, YYYY-MM-DD.
^\d{4}-\d{2}-\d{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 DELETE "https://example.com/recurring-series/string/lines/string?scope=this-and-following&period=string"{ "object": "series_line", "id": "string", "deleted": true}Read the revenue recognition of one customer GET
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.
List the recurring series of the company GET
Oldest change first. A series that has ended is still `active`: a series ends by date, and has no cancelled state. `updated_since` narrows the list to what changed at or after an instant; the stamp is taken when the series is written, so a list is followed from the instant the last walk started, with no overlap. A change to a line alone does not move the stamp.