Invoices

Retrieve invoice

get

Retrieve a specific invoice by ID.

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Query parameters
hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
get
/api/v1/invoice/{id}

Retrieve detailed invoice

get

Retrieve a specific invoice by ID with detailed information.

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Query parameters
hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
get
/api/v1/invoice/{id}/detailed/

List invoices

get

Retrieve a list of invoices with optional filtering.

Authorizations
AuthorizationstringRequired
Query parameters
hyperbooleanOptional

Activate id to hyperlink the response data.

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
invoice_typestring · enumOptional

Filter by invoice type.

Possible values:
ordernumberOptional

Filter by order ID.

Example: 123
channelintegerOptional

ID of the channel the customer belongs to

Example: 5
related_invoiceintegerOptional

Filter by related invoice.

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z
modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

Responses
get
/api/v1/invoice/

List invoices

get

Retrieve a list of invoices with optional filtering.

Authorizations
AuthorizationstringRequired
Query parameters
hyperbooleanOptional

Activate id to hyperlink the response data.

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000
invoice_typestring · enumOptional

Filter by invoice type.

Possible values:
ordernumberOptional

Filter by order ID.

Example: 123
channelintegerOptional

ID of the channel the customer belongs to

Example: 5
related_invoiceintegerOptional

Filter by related invoice.

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z
modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

Responses
get
/api/v1/invoice/detailed/

Last updated

Was this helpful?