Invoiced item detail

get

https://api.bizyness.fr/reports/articles/{key}

Returns one item's sales over the period, invoiced and cashed as an external income alike, bucketed by the requested granularity. An invoice falls on its issue date and an income on the date it was paid. The key alone says whether it designates a product or one of its variants, and no extra parameter selects between the two. The series is continuous: a period during which nothing was sold is present with its counters at zero, and a well formed key that sold nothing over the period returns a zeroed series rather than a 404.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Item key, copied verbatim from the key field of a row. Opaque: it is never parsed nor rebuilt by the caller

Query Params

date_min

string

required

First calendar day of the period, resolved to the start of that day in the effective timezone. It bounds an invoice on its issue date and an external income on the date it was paid

date_max

string

required

Last calendar day of the period, resolved to the end of that day in the effective timezone. It bounds an invoice on its issue date and an external income on the date it was paid

activity_id

string

Filter on one or more activities, as comma separated identifiers

status

string

Filter on one or more document statuses, as comma separated values among issued, not_paid, paid, cancelled and overdue. Absent means all five, cancelled included. It applies to invoices and credit notes only: a status describes a billing document, so no value of it, known or not, ever removes an external income

breakdown

string

enum

required

Granularity of the series, applied exactly as asked. The server substitutes no granularity of its own and has no default

Allowed:

Headers

X-Timezone

string

Set the time zone. An absent or unknown zone falls back silently to the company zone

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Return the item series of the selected period

401Unauthorized. A valid API key is required to access this endpoint.

500Internal Server Error. Bizyness could not complete the request because of an unexpected server-side failure.