Credit notes

The CreditNote object

Attributes

idstring · uuidOptional

datestring · date-timeOptional

total_price_excl_taxnumber · floatOptionalExample: 100

total_price_incl_taxnumber · floatOptionalExample: 121

final_price_excl_taxnumber · floatOptionalExample: 100

final_price_incl_taxnumber · floatOptionalExample: 121

tax_componentnumber · floatOptionalExample: 21

discounted_taxnumber · floatOptionalExample: 0

discounted_pricenumber · floatOptionalExample: 0

final_tax_componentnumber · floatOptionalExample: 21

left_to_refundnumber · floatOptionalExample: 0

currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

booking_idstring · uuidOptional

invoice_idstring · uuidOptional

metadataobject · jsonOptional

deleted_atstring · date-time · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

The CreditNote object

{
  "date": "2000-01-23T04:56:07.000+00:00",
  "metadata": "{}",
  "total_price_incl_tax": 121,
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "final_tax_component": 21,
  "left_to_refund": 0,
  "deleted_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_price": 0,
  "reference": {
    "number": 1,
    "prefix": "CN-",
    "suffix": "-UK",
    "full": "CN-0001-UK"
  },
  "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_tax": 0,
  "final_price_excl_tax": 100,
  "invoice_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency": "EUR",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "total_price_excl_tax": 100,
  "tax_component": 21,
  "final_price_incl_tax": 121
}

List credit notes

get

List all credit notes

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

booking_idstring · uuid[]Optional

ID(s) of the booking to filter credit notes by

invoice_idstring · uuid[]Optional

ID(s) of the invoice to filter credit notes by

final_price_incl_taxstringOptional

Filter credit notes by final price including tax

Example: 100,200Pattern: ^\d+,\d+$

currencystring · iso-4217[]Optional

Filter credit notes by currency

Example: ["EUR","USD"]

datestringOptional

Filter credit notes by date

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

reference_numberstringOptional

Filter credit notes by reference number

Example: 100,200Pattern: ^\d+,\d+$

booking_reference_yearintegerOptional

Filter credit notes by booking reference year

booking_reference_numberintegerOptional

Filter credit notes by booking reference number

booking_created_atstringOptional

Filter credit notes by booking created at

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

booking_statusstring · enumOptional

Filter credit notes by booking status

Possible values:

booking_location_idinteger[]Optional

Filter credit notes by booking location ID(s)

limitinteger · int32 · min: 1 · max: 100Optional

Number of credit notes to return

Default: 10

pageinteger · int32 · min: 1Optional

Page number

Default: 1

Responses

200

A list of credit notes

application/json

idstring · uuidOptional

datestring · date-timeOptional

total_price_excl_taxnumber · floatOptionalExample: 100

total_price_incl_taxnumber · floatOptionalExample: 121

final_price_excl_taxnumber · floatOptionalExample: 100

final_price_incl_taxnumber · floatOptionalExample: 121

tax_componentnumber · floatOptionalExample: 21

discounted_taxnumber · floatOptionalExample: 0

discounted_pricenumber · floatOptionalExample: 0

final_tax_componentnumber · floatOptionalExample: 21

left_to_refundnumber · floatOptionalExample: 0

currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

booking_idstring · uuidOptional

invoice_idstring · uuidOptional

metadataobject · jsonOptional

deleted_atstring · date-time · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

get

/credit_notes

HTTPcURLJavaScriptPython

GET /private/credit_notes HTTP/1.1
Host: api.bookinglayer.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A list of credit notes

[
  {
    "date": "2000-01-23T04:56:07.000+00:00",
    "metadata": "{}",
    "total_price_incl_tax": 121,
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "final_tax_component": 21,
    "left_to_refund": 0,
    "deleted_at": "2000-01-23T04:56:07.000+00:00",
    "discounted_price": 0,
    "reference": {
      "number": 1,
      "prefix": "CN-",
      "suffix": "-UK",
      "full": "CN-0001-UK"
    },
    "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "discounted_tax": 0,
    "final_price_excl_tax": 100,
    "invoice_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "currency": "EUR",
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "total_price_excl_tax": 100,
    "tax_component": 21,
    "final_price_incl_tax": 121
  }
]

Get a credit note

get

Get a credit note by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

credit_note_idstring · uuidRequired

ID of the credit note to get

Query parameters

Responses

200

A credit note

application/json

idstring · uuidOptional

datestring · date-timeOptional

total_price_excl_taxnumber · floatOptionalExample: 100

total_price_incl_taxnumber · floatOptionalExample: 121

final_price_excl_taxnumber · floatOptionalExample: 100

final_price_incl_taxnumber · floatOptionalExample: 121

tax_componentnumber · floatOptionalExample: 21

discounted_taxnumber · floatOptionalExample: 0

discounted_pricenumber · floatOptionalExample: 0

final_tax_componentnumber · floatOptionalExample: 21

left_to_refundnumber · floatOptionalExample: 0

currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

booking_idstring · uuidOptional

invoice_idstring · uuidOptional

metadataobject · jsonOptional

deleted_atstring · date-time · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

get

/credit_notes/{credit_note_id}

HTTPcURLJavaScriptPython

GET /private/credit_notes/{credit_note_id} HTTP/1.1
Host: api.bookinglayer.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A credit note

{
  "date": "2000-01-23T04:56:07.000+00:00",
  "metadata": "{}",
  "total_price_incl_tax": 121,
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "final_tax_component": 21,
  "left_to_refund": 0,
  "deleted_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_price": 0,
  "reference": {
    "number": 1,
    "prefix": "CN-",
    "suffix": "-UK",
    "full": "CN-0001-UK"
  },
  "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_tax": 0,
  "final_price_excl_tax": 100,
  "invoice_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency": "EUR",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "total_price_excl_tax": 100,
  "tax_component": 21,
  "final_price_incl_tax": 121
}

Update credit note

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

booking_idstring · uuidRequired

The ID of the booking associated with the credit note.

credit_note_idintegerRequired

The ID of the credit note to be updated.

Body

application/json

numberinteger · nullableOptional

Credit note id.

closed_atstring · date-time · nullableOptional

The date and time the credit note was closed.

prefixstring · nullableOptional

The prefix placed before the credit note number within the credit note reference.

suffixstring · nullableOptional

The suffix placed after the credit note number within the credit note reference.

Responses

200

Credit note was successfully updated

application/json

idstring · uuidOptional

datestring · date-timeOptional

total_price_excl_taxnumber · floatOptionalExample: 100

total_price_incl_taxnumber · floatOptionalExample: 121

final_price_excl_taxnumber · floatOptionalExample: 100

final_price_incl_taxnumber · floatOptionalExample: 121

tax_componentnumber · floatOptionalExample: 21

discounted_taxnumber · floatOptionalExample: 0

discounted_pricenumber · floatOptionalExample: 0

final_tax_componentnumber · floatOptionalExample: 21

left_to_refundnumber · floatOptionalExample: 0

currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

booking_idstring · uuidOptional

invoice_idstring · uuidOptional

metadataobject · jsonOptional

deleted_atstring · date-time · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

400

Credit note cannot be updated with the provided data at the present time.

application/json

422

The sent request is invalid.

put

/bookings/{booking_id}/credit_notes/{credit_note_id}

HTTPcURLJavaScriptPython

PUT /private/bookings/{booking_id}/credit_notes/{credit_note_id} HTTP/1.1
Host: api.bookinglayer.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "number": 1,
  "closed_at": "2026-02-20T06:16:53.904Z",
  "prefix": "text",
  "suffix": "text"
}

{
  "date": "2000-01-23T04:56:07.000+00:00",
  "metadata": "{}",
  "total_price_incl_tax": 121,
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "final_tax_component": 21,
  "left_to_refund": 0,
  "deleted_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_price": 0,
  "reference": {
    "number": 1,
    "prefix": "CN-",
    "suffix": "-UK",
    "full": "CN-0001-UK"
  },
  "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "discounted_tax": 0,
  "final_price_excl_tax": 100,
  "invoice_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency": "EUR",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "total_price_excl_tax": 100,
  "tax_component": 21,
  "final_price_incl_tax": 121
}

Batch update lines

put

Batch update the fields of multiple credit note lines that belong to the same credit note

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

credit_note_idstring · uuidRequired

ID of the credit note

Example: 6e7a4594-b05a-4705-a783-4ea849b944c2

Body

application/json

Responses

204

Lines have been successfully updated

400

One of the provided lines doesn't exist or belongs to another credit note

422

There is some validation error

put

/credit_notes/{credit_note_id}/lines

HTTPcURLJavaScriptPython

PUT /private/credit_notes/{credit_note_id}/lines HTTP/1.1
Host: api.bookinglayer.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "grouped_lines": [
    {
      "id": "86e4a868-349c-4c4f-9362-358df8032d43",
      "backoffice_title": "text",
      "title": {},
      "backoffice_package_title": "text",
      "package_title": {}
    }
  ]
}

No content