Issue a credit note

POSThttps://app.speybooks.com/api/v1/credit-notes/{id}/issue

Issues a draft credit note: it moves draft -> issued and the issue journal posts, moving the VAT return. Only a draft can be issued: a note already issued or voided is refused 409, and a missing note is 404. Every line must carry an account, else 400. There is no request body. User-actor only: an API key is refused 403.

The path for a note created as a draft; it reaches the same posted state a create-as-issued does. Idempotent under an Idempotency-Key (AX-CON-002); a second issue of the same note returns 409 (only a draft is issuable).

Path parameters

idstringrequired

Response

200Default Response

Show response fields

creditNoteIdstring

statusstring

Error codes

400Default Response

403The caller is an API key; issuing requires a user.

404Credit note not found.

409The note is not a draft (already issued or voided).

RequestPOST/v1/credit-notes/{id}/issuecurl

curl -X POST https://api.speybooks.com/v1/credit-notes/cn_5/issue \
  -H "Authorization: Bearer <token>"

Response200

{
  "success": true,
  "data": {
    "creditNoteId": "cn_5",
    "status": "issued"
  }
}