API Docs

Retrieve a purchase credit note

Retrieves the details of a specific purchase credit note.

Rate limit

60 requests/minute per authenticated account. See Rate limiting for response headers (X-RateLimit-*) and retry guidance.

Path parameters

GET /api/purchase-credit-notes/{id}

Parameter	Type	Required	Description
`id`	string	Required	The ID of the purchase credit note to retrieve.

Response

Status code: 200 OK

Returns the full purchase credit note.

Response body fields

Field	Type	Source	Description
`id`	string	System Provided	Primary identifier for the document (UUID). Automatically generated when the document is created.
`org_id`	string	System Provided	Unique identifier of the organization that owns this credit note.
`document_sequence`	number	System Provided	Sequential number for the credit note within your organization. Used for compliance and tracking.
`tax_breakdown`	array	Calculated	Tax amounts grouped by tax category and rate.
`allowance_total_amount`	number	Calculated	Total of all document-level allowances.
`charge_total_amount`	number	Calculated	Total of all document-level charges.
`line_extension_amount`	number	Calculated	Sum of all line amounts before charges, allowances, and taxes. UBL 2.1 LineExtensionAmount.
`tax_exclusive_amount`	number	Calculated	Line extension plus charges minus allowances, before tax. UBL 2.1 TaxExclusiveAmount.
`tax_amount`	number	Calculated	Aggregated VAT amount in document currency. UBL 2.1 TaxTotal.
`tax_amount_in_aed`	number	Calculated	Total tax amount converted to AED.
`tax_inclusive_amount`	number	Calculated	Tax exclusive amount plus total tax. UBL 2.1 TaxInclusiveAmount.
`payable_amount`	number	Calculated	Final amount to be refunded/credited. UBL 2.1 PayableAmount.
`payable_amount_in_aed`	number	Calculated	Final amount payable in AED.
`total_item_allowances`	number	Calculated	Total of all line-level allowances.
`total_item_charges`	number	Calculated	Total of all line-level charges.
`total_taxable_amount`	number	Calculated	Total taxable amount for the credit note.
`total_non_taxable_amount`	number	Calculated	Total non-taxable amount.
`meta_info`	object	System Provided	Additional metadata (timestamps, Peppol status, etc.). See Meta info object below.
`is_phase2_document`	boolean	System Provided	Whether the document is Peppol-enabled (Phase 2).

Nested object field tables are on Create.

Error responses

401 Unauthorized

Authentication required or invalid token.

{
  "errors": {
    "message": "Authentication required or invalid token"
  }
}

404 Not Found

Purchase credit note not found.

{
  "errors": {
    "message": "Purchase credit note not found"
  }
}

500 Internal Server Error

An error occurred while processing the request.

{
  "errors": {
    "message": "An error occurred"
  }
}