Skip to content
ZUTAX ZUTAX Documentation

Get a credit note by ZUTAX UUID

GET
/api/public/v1/credit-notes/{credit_note_id}
Code sample: cURL 
curl --request GET \
  --url 'https://api.getzutax.com/api/public/v1/credit-notes/5f508f31-c2bb-4f87-9b91-97af8a64dd41' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
credit_note_id
required
Credit Note Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
CreditNoteResponse
object
id
required
Id
string format: uuid
external_id
required
Any of:
string
status
required
Status
string
Allowed values: draft submitted validated dispatched delivered accepted rejected cancelled
credit_note_number
Any of:
string
irn
Any of:
string
currency
required
Currency
string
issue_date
required
Issue Date
string format: date
referenced_invoice_id
Any of:
string format: uuid
subtotal_naira
required
Subtotal Naira
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
vat_total_naira
required
Vat Total Naira
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_naira
required
Total Naira
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
pasca_dispatch_id
Any of:
string
Examples
Example Sample response

200 response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "string",
  "status": "draft",
  "credit_note_number": "string",
  "irn": "string",
  "currency": "string",
  "issue_date": "2026-02-11",
  "referenced_invoice_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "subtotal_naira": "100.00",
  "vat_total_naira": "100.00",
  "total_naira": "100.00",
  "pasca_dispatch_id": "string"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples
Example Sample response

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}