Skip to main content
GET
/
payable_credit_notes
/
{credit_note_id}
/
line_items
Get all line items of a credit note
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payable_credit_notes/{credit_note_id}/line_items \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-15T14:30:00Z",
      "credit_note_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Premium version of Product XYZ with extended warranty",
      "name": "Product XYZ",
      "quantity": 2,
      "subtotal": 10000,
      "tax": 20,
      "tax_amount": 2000,
      "total": 12000,
      "unit": "pieces",
      "unit_price": 5000
    }
  ],
  "next_pagination_token": "eyJwYWdlIjoyfQ==",
  "prev_pagination_token": "eyJwYWdlIjoxfQ=="
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
credit_note_id
string<uuid>
required

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
id,
created_at,
name,
total,
quantity,
unit_price
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
name
string
​
name__iexact
string
​
name__contains
string
​
name__icontains
string
​
description
string
​
description__contains
string
​
description__icontains
string
​
total__gt
integer
Required range: x >= 0
​
total__lt
integer
Required range: x >= 0
​
total__gte
integer
Required range: x >= 0
​
total__lte
integer
Required range: x >= 0
​
subtotal__gt
integer
Required range: x >= 0
​
subtotal__lt
integer
Required range: x >= 0
​
subtotal__gte
integer
Required range: x >= 0
​
subtotal__lte
integer
Required range: x >= 0
​
unit_price__gt
integer
Required range: x >= 0
​
unit_price__lt
integer
Required range: x >= 0
​
unit_price__gte
integer
Required range: x >= 0
​
unit_price__lte
integer
Required range: x >= 0
​
quantity__gt
number
Required range: x >= 0
​
quantity__lt
number
Required range: x >= 0
​
quantity__gte
number
Required range: x >= 0
​
quantity__lte
number
Required range: x >= 0
​
tax__gt
integer
Required range: x >= 0
​
tax__lt
integer
Required range: x >= 0
​
tax__gte
integer
Required range: x >= 0
​
tax__lte
integer
Required range: x >= 0
​
tax_amount__gt
integer
Required range: x >= 0
​
tax_amount__lt
integer
Required range: x >= 0
​
tax_amount__gte
integer
Required range: x >= 0
​
tax_amount__lte
integer
Required range: x >= 0
​
created_by_user_id
string<uuid>
​
unit
string
​
unit__iexact
string
​
source
string
​
source_id
string

Response

Successful Response

A paginated list of credit note line items.

​
data
object[]
required

List of credit note line items for the current page

​
next_pagination_token
string

Token to retrieve the next page of results

Example:

"eyJwYWdlIjoyfQ=="

​
prev_pagination_token
string

Token to retrieve the previous page of results

Example:

"eyJwYWdlIjoxfQ=="