InvoiceItem

Retrieve invoice item

get

Retrieve a specific invoice item by ID.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses

200

Invoice item retrieved successfully

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/invoice_items/{id}

HTTPcURLJavaScriptPython

GET /api/v1/invoice_items/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "invoice": 1,
  "order_item": 1,
  "tax_rate": 1,
  "tax_amount": 1,
  "discount_rate": 1,
  "discount_amount": 1,
  "total_amount": 1,
  "net_amount": 1,
  "related_invoice_item": 1
}

Retrieve detailed invoice item

get

Retrieve a specific invoice item by ID with detailed information.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses

200

Detailed invoice item retrieved successfully

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/invoice_items/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/invoice_items/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "invoice": 1,
  "order_item": 1,
  "tax_rate": 1,
  "tax_amount": 1,
  "discount_rate": 1,
  "discount_amount": 1,
  "total_amount": 1,
  "net_amount": 1,
  "related_invoice_item": 1
}

List invoice items

get

Retrieve a list of invoice items with optional filtering.

Authorizations

Token

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_itemintegerOptional

Filter by order item ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

tax_amountnumberOptional

Filter by tax amount

discount_ratenumberOptional

Filter by discount rate

discount_amountnumber · decimalOptional

Filter by discount amount

total_amountnumberOptional

Filter by total amount

net_amountnumberOptional

Filter by net amount

related_invoice_itemintegerOptional

Filter by related invoice item

Responses

200

A list of invoice items.

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/invoice_items/

HTTPcURLJavaScriptPython

GET /api/v1/invoice_items/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "pk": 1,
      "invoice": 1,
      "order_item": 1,
      "tax_rate": 1,
      "tax_amount": 1,
      "discount_rate": 1,
      "discount_amount": 1,
      "total_amount": 1,
      "net_amount": 1,
      "related_invoice_item": 1
    }
  ]
}

List detailed invoice items

get

Retrieve a list of detailed invoice items with optional filtering.

Authorizations

Token

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_itemintegerOptional

Filter by order item ID.

tax_ratenumber · decimalOptional

Filter by Tax Rate.

Example: 18

tax_amountnumberOptional

Filter by tax amount

discount_ratenumberOptional

Filter by discount rate

discount_amountnumber · decimalOptional

Filter by discount amount

total_amountnumberOptional

Filter by total amount

net_amountnumberOptional

Filter by net amount

related_invoice_itemintegerOptional

Filter by related invoice item

Responses

200

A list of detailed invoice items.

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/invoice_items/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/invoice_items/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "pk": 1,
      "invoice": 1,
      "order_item": 1,
      "tax_rate": 1,
      "tax_amount": 1,
      "discount_rate": 1,
      "discount_amount": 1,
      "total_amount": 1,
      "net_amount": 1,
      "related_invoice_item": 1
    }
  ]
}