Credit notes

Get all line items of a credit note

get/payable_credit_notes/{credit_note_id}/line_items

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payable_credit_notes/{credit_note_id}/line_items
  • Auth: HTTP bearer

Path parameters

credit_note_idstring required

Query parameters

order'asc' | 'desc'

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

limitinteger

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.

pagination_tokenstring

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'id' | 'created_at' | 'name' | 'total' | 'quantity' | 'unit_price'

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

created_at__gtstring date-time
created_at__ltstring date-time
created_at__gtestring date-time
created_at__ltestring date-time
namestring
name__iexactstring
name__containsstring
name__icontainsstring
descriptionstring
description__containsstring
description__icontainsstring
total__gtinteger
total__ltinteger
total__gteinteger
total__lteinteger
subtotal__gtinteger
subtotal__ltinteger
subtotal__gteinteger
subtotal__lteinteger
unit_price__gtinteger
unit_price__ltinteger
unit_price__gteinteger
unit_price__lteinteger
quantity__gtnumber double
quantity__ltnumber double
quantity__gtenumber double
quantity__ltenumber double
tax__gtinteger
tax__ltinteger
tax__gteinteger
tax__lteinteger
tax_amount__gtinteger
tax_amount__ltinteger
tax_amount__gteinteger
tax_amount__lteinteger
created_by_user_idstring uuid
unitstring
unit__iexactstring
sourcestring
source_idstring

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

Token to retrieve the next page of results

prev_pagination_tokenstring

Token to retrieve the previous page of results

Changes

No recorded changes to this operation across all 1 revision of this API.