PaymentInvoiceItem

Retrieve payment invoice item

get

Retrieve a specific payment invoice item 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
chevron-right
200

Payment invoice item retrieved successfully

application/json
Responseone of
or
get
/api/v1/payment_invoice_items/{id}

Retrieve detailed payment invoice item

get

Retrieve a specific payment invoice item 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
chevron-right
200

Detailed payment invoice item retrieved successfully

application/json
Responseone of
or
get
/api/v1/payment_invoice_items/{id}/detailed/

List payment invoice items

get

Retrieve a list of payment invoice items 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
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

invoiceintegerOptional

Filter by invoice

order_transactionintegerOptional

Filter by order_transaction

instant_amountintegerOptional

Filter by instant_amount

Responses
chevron-right
200

A list of payment invoice items.

application/json
get
/api/v1/payment_invoice_items/

List detailed payment invoice items

get

Retrieve a list of detailed payment invoice items 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
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

invoiceintegerOptional

Filter by invoice

order_transactionintegerOptional

Filter by order_transaction

instant_amountintegerOptional

Filter by instant_amount

Responses
chevron-right
200

A list of detailed payment invoice items.

application/json
get
/api/v1/payment_invoice_items/detailed/

Last updated

Was this helpful?