Search the invoiced items report

get

https://api.bizyness.fr/reports/articles/search

Same report as the ranking, restricted to the rows matching the keyword. The filter applies to the report rows rather than to the underlying lines, so searching a product and searching one of its variants return the same figures for the same row, whether those figures come from invoices, from external incomes or from both. This report answers a commercial question and not an accounting one, and it never reconciles with turnover: amounts are rounded and converted line by line, disbursements carry no row, and proportional credit notes appear under a row of their own.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

offset

integer

0 to 10000

Defaults to 0

Rank to start from in the sorted list The deepest offset served is 10000; beyond it the request is refused with 400.

limit

integer

1 to 250

Defaults to 20

Page size

group_by

string

enum

Defaults to variant

One row per variant sold, or one row per product with its variants summed

Allowed:

keyword

string

required

length ≥ 3

Case insensitive keyword, three characters minimum. Metacharacters are escaped and never interpreted

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 matching rows 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.