Get Invoices

get

https://api.apicbase.com/api/v2/invoices/

Returns a list of invoice records in a library.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 1

A page number within the paginated result set.

page_size

int32

Defaults to 10

The number of items to return per page. The maximum is 200.

ordering

string

Allow to order the items in the result. The possible values are: invoice_date, due_date, supplier_name, total_amount, created_at, invoice_number, processing_status, approval_status. You can also reverse order by prepending "-" to the value.

string

Allow to search for items. The inputted value will be searched in the following fields: Supplier name, invoice number, purchase order number.

outlet_ids

string

A list of outlet IDs to filter the items by.

supplier_ids

string

A list of supplier IDs to filter the items by.

processing_statuses

string

A list of processing statuses to filter the items by.

approval_statuses

string

A list of approval statuses to filter the items by.

approved_by

string

A list of user IDs that approved the invoice to filter the items by.

created_by

string

A list of user IDs that created the invoice to filter the items by.

invoice_type

string

A list of invoice types to filter the items by.

bulk_importation_id

string

For orders generated by a bulk import, this is the ID of the import request that generated them.

invoice_date

date

Filter by exact invoice date (YYYY-MM-DD).

invoice_date__gt

date

Filter invoices with invoice_date greater than specified date.

invoice_date__lt

date

Filter invoices with invoice_date less than specified date.

due_date

date

Filter by exact due date (YYYY-MM-DD).

due_date__gt

date

Filter invoices with due_date greater than specified date.

due_date__lt

date

Filter invoices with due_date less than specified date.

created_at

date

Filter by exact creation date (YYYY-MM-DD).

created_at__gt

date

Filter invoices created after specified date.

created_at__lt

date

Filter invoices created before specified date.

updated_at

date

Filter by exact update date (YYYY-MM-DD).

updated_at__gt

date

Filter invoices updated after specified date.

updated_at__lt

date

Filter invoices updated before specified date.

Responses

200200

400400