CommonFinancing

Get invoices

Returns a list of invoices requested for financing

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

orderenumOptional

Order by

Allowed values:
limitintegerOptional>=1<=100Defaults to 100

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sortenumOptional

Allowed sort fields

Allowed values:
invoice_idstringOptionalformat: "uuid"

ID of a payable or receivable invoice.

invoice_id__instringOptionalformat: "uuid"

List of invoice IDs.

statusenumOptional

Status of the invoice.

status__inenumOptional

List of invoice statuses.

typeenumOptional

Type of the invoice. payable or receivable.

Allowed values:
type__inenumOptional

List of invoice types.

Allowed values:
document_idstringOptional

Document ID of the invoice.

document_id__instringOptional

List of document IDs.

issue_date__gtdatetimeOptional

Issue date greater than.

issue_date__ltdatetimeOptional

Issue date less than.

issue_date__gtedatetimeOptional

Issue date greater than or equal.

issue_date__ltedatetimeOptional

Issue date less than or equal.

due_date__gtdatetimeOptional

Due date greater than.

due_date__ltdatetimeOptional

Due date less than.

due_date__gtedatetimeOptional

Due date greater than or equal.

due_date__ltedatetimeOptional

Due date less than or equal.

created_at__gtdatetimeOptional

Created date greater than.

created_at__ltdatetimeOptional

Created date less than.

created_at__gtedatetimeOptional

Created date greater than or equal.

created_at__ltedatetimeOptional

Created date less than or equal.

total_amountintegerOptional

Total amount of the invoice in minor units.

total_amount__gtintegerOptional

Total amount greater than.

total_amount__ltintegerOptional

Total amount less than.

total_amount__gteintegerOptional

Total amount greater than or equal.

total_amount__lteintegerOptional

Total amount less than or equal.

Response

Successful Response

datalist of objects

A list of invoices requested for financing.

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

Errors