Billing

Void billing documents on a contract.

Operations

Void a billing document

Request

Purpose

Voids a billing document (invoice or credit memo) on the revenue contract, reversing its billed amounts from the contract's billing, contract asset, and contract liability balances.

When to use

A billing document was voided or issued in error in the billing system and Zuora Revenue must reflect it.

Behavior notes

Errors from the revenue engine for this operation are returned as HTTP 200 with success: false and the generic message shown in the examples, not as 4xx/5xx responses. The contract in the path is validated by the revenue engine.

Security

bearerAuth

Path

rcIdinteger, (int64)required

Revenue contract ID.

Example:111442

X-REV-BOOK-IDinteger, (int64)

Revenue book to work in. Defaults to 1 (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books.

Default:1

Example:1

Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11

Bodyapplication/jsonrequired

billDocNumberstring, non-emptyrequired

Billing document (invoice or credit memo) number to void.

reasonstring, non-emptyrequired

Reason for voiding.

commentstring

Additional comment.

Default:""

{
  "billDocNumber": "INV00012345",
  "reason": "Duplicate invoice",
  "comment": "Customer requested void"
}

Responses

Processed. success: true means the action completed; success: false means a business rule rejected it and message explains why.

Headers

traceIdstring

Correlation ID of the request. Quote it when you contact Zuora Global Support.

Bodyapplication/json

successbooleanrequired

true when the action completed. false when the revenue engine rejected it under a business rule; see message.

processIdstringrequired

Unique ID generated for this request. Quote it when you contact Zuora Global Support.

messagestring

Result message from the revenue engine. May be empty on success.

changeIdsstring

Comma-separated IDs of records changed by the action, when the action reports them. Omitted otherwise.

Response

{
  "success": true,
  "processId": "3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11",
  "message": "Billing voided successfully"
}