Issue Credit Note

Issue a credit note against an invoice or account. The only correct way to reduce a finalised invoice.

POST/api/v1/billing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/billing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: ISSUE_CREDIT_NOTE" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "amount": "string",
    "credit_note_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "current_status": "DRAFT",
    "reason": "CANCELLATION"
  }'

Authorization

Minimum role: FinanceThe caller must hold this role or a higher one.
Multi-factor sign-in: Required. The access token must come from a session that completed multi-factor sign-in.
Action: ISSUE_CREDIT_NOTE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be ISSUE_CREDIT_NOTE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

account_iduuidRequired
No description yet.
amountstringRequired
No description yet.
credit_note_iduuidRequired
No description yet.
current_statusenumRequired
Lifecycle of a credit note. A credit note is the ONLY correct way to reduce a finalised invoice: issued invoices are immutable accounting records, so the correction is a new document, never an edit.
Allowed values
- DRAFT
- ISSUED
- VOID
- APPLIED
APPLIED
Fully consumed against one or more invoices.
reasonenumRequired
Why a credit was granted. Recorded because credits are the first thing an auditor and a revenue-leakage review both look at.
Allowed values
- CANCELLATION
- GOODWILL
- DUPLICATE
- DOWNGRADE
- SERVICE_CREDIT
- BILLING_ERROR
DOWNGRADE
Unused value from a mid-term downgrade.
SERVICE_CREDIT
SLA breach or outage compensation.
BILLING_ERROR
We billed it wrong.
currencystring or nullOptional
Required for standalone credits; linked credits use the stored invoice currency.
invoice_iduuid or nullOptional
No description yet.
memostring or nullOptional
No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send ISSUE_CREDIT_NOTE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below finance, the session has not completed multi-factor sign-in, or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.