v1

latestOpenAPI 3.0.12026-07-141671231.8 MB

Customer Invoices

List custom header fields for a customer invoice

ℹ️ This endpoint requires one of the following scopes: customer_invoices:all, customer_invoices:readonly

get/api/external/v2/customer_invoices/{customer_invoice_id}/custom_header_fields

Path parameters

customer_invoice_idinteger required

Query parameters

cursorstring

Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

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.

limitinteger

Example:20

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

sortstring

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

Response

Returns the list of custom header fields for a customer invoice

has_moreboolean required

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

next_cursorstring nullable 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.

Example response

{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 444,
      "title": "customer_reference",
      "value": "REF-12345",
      "rank": 1,
      "created_at": "2023-08-30T10:08:08.146343Z",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ]
}