Get all credit note line items.

GET
/payable_credit_notes/:credit_note_id/line_items

Path parameters

credit_note_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

order"asc" or "desc"Optional

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

Allowed values: ascdesc
limitintegerOptional>=1<=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.

pagination_tokenstringOptional

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.

sortenumOptional

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

created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
namestringOptional
name__iexactstringOptional
name__containsstringOptional
name__icontainsstringOptional
descriptionstringOptional
description__containsstringOptional
description__icontainsstringOptional
total__gtintegerOptional
total__ltintegerOptional
total__gteintegerOptional
total__lteintegerOptional
subtotal__gtintegerOptional
subtotal__ltintegerOptional
subtotal__gteintegerOptional
subtotal__lteintegerOptional
unit_price__gtintegerOptional
unit_price__ltintegerOptional
unit_price__gteintegerOptional
unit_price__lteintegerOptional
quantity__gtdoubleOptional
quantity__ltdoubleOptional
quantity__gtedoubleOptional
quantity__ltedoubleOptional
tax__gtintegerOptional
tax__ltintegerOptional
tax__gteintegerOptional
tax__lteintegerOptional
tax_amount__gtintegerOptional
tax_amount__ltintegerOptional
tax_amount__gteintegerOptional
tax_amount__lteintegerOptional
created_by_user_idstringOptional
unitstringOptional
unit__iexactstringOptional
sourcestringOptional
source_idstringOptional

Response

Successful Response

datalist of objects

List of credit note line items for the current page

next_pagination_tokenstringOptional

Token to retrieve the next page of results

prev_pagination_tokenstringOptional

Token to retrieve the previous page of results

Errors

Add a new line item to a credit note.