Get Credit Note (V2)
GET/api/xero/v2/credit-notes/:creditNote
Get a single synced Xero credit note (ACCRECCREDIT) — header fields including remaining_credit, line items, the reverse link to the SKU.io record it was generated from, and sync metadata (sync_status, last_error, and url, a deep link to the credit note in Xero). Monetary amounts are in the credit note's currency; datetimes are UTC ISO-8601.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Path parameters:
creditNote(integer, required): internal credit note record ID — theidreturned by List Credit Notes (V2).
Reverse link fields: at_id/at_reference identify the SKU.io accounting transaction the record was generated from (null when the record was synced via the ledger pipeline instead — then ledger_entry_id/ledger_entry_reference are set). sku_link_type/sku_link_id identify the underlying SKU.io source record (e.g. a sales order or purchase order); sku_link_label and sku_link_route are only populated when the link was resolved through the ledger.
Returns 404 when no credit note with that ID exists.
Authentication: Bearer token.
Returns raw_payload (the full raw Xero payload); present only on the detail/show endpoint.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.