Sign in

v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB
Credit Note Line Items

Create a new Credit Note Line Item Group

Create a new Credit Note Line Item Group

post/credit-notes/{creditnote}/line-item-groups

Path parameters

creditnotestring required

The CreditNote ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

lineItemGroupIdstring

Line Item Group ID

titlestring required

Credit Note Line Item Group Title

descriptionstring

Credit Note Line Item Group Description

Example request

{
  "lineItemGroupId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "title": "Users",
  "description": "Credit note for users"
}

Response

Created

idstring required

Credit Note Line Item Group ID

creditNoteIdstring required

Credit Note ID

lineItemGroupIdstring

Line Item Group ID

titlestring required

Credit Note Line Item Group Title

descriptionstring

Credit Note Line Item Group Description

indexinteger required

Index (for maintaining order)

netTotalstring required

Net total

totalTaxstring required

Total tax

grossTotalstring required

Gross total

Example response

{
  "id": "e5bc0f12-4bc1-f821-bc2d-04639a16f9ec",
  "creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "lineItemGroupId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "title": "Users",
  "description": "Credit note for users",
  "index": 2,
  "netTotal": "51.20",
  "totalTax": "2.50",
  "grossTotal": "101.23"
}