List invoice line sections for a credit note

List invoice line sections for a a credit note

🚧

This endpoint is deprecated. Please, use the Customer Invoices endpoint instead. More details in this article

⚠️ ALPHA STATUS NOTICE

This endpoint is currently in alpha. It is part of an early testing phase, and its functionality may change or be removed in future updates.
We welcome your feedback to help us improve. Please use this endpoint with caution, especially in production environments, as backward compatibility is not guaranteed and functionality may change frequently.
This feature is best suited for developers interested in testing and providing input on upcoming capabilities.

ℹ️

This endpoint requires one of the following scopes: credit_notes:all, credit_notes:readonly

Log in to see full request history
Path Params
integer
required
Query Params
string

Cursor for pagination. Use this to fetch the next set of results.
The cursor is an opaque string returned in the previous response's metadata.
Leave empty for the first request.

integer
1 to 100

Number of items to return per request.
Defaults to 20 if not specified.
Must be between 1 and 100.

string
Defaults to -id

You can choose to sort items on specific attributes
Sort field may be prefixed with - for descending order.
Example : id will sort by ascending order, -id will sort by descending order.
Available fields : id

Responses

Response body
object
boolean
required

Indicates whether additional results are available beyond this set.
Use this flag to determine if another request is needed.

string | null
required

Cursor to retrieve the next set of results.
Include this value in the cursor parameter of your next request to fetch subsequent items.
A null next_cursor in the response indicates no further results.

items
array of objects
required
items*
object
number
required

Invoice line section id

string | null
required

Invoice line section label

string | null
required

Invoice line section description

integer
required

The rank of the section in the credit note. The rank is used to order the sections in the credit note.

date-time
required
date-time
required

Language
Credentials
OAuth2