Sign in
E-Invoicing
E-Reporting

Reconcile an e-compliance request

Reconciles an e-compliance request for the supplied source object.

Note: In the broader e-compliance workflow, this operation can work alongside the "Create an e-invoice lifecycle status update" operation that is shared across e-reporting and e-invoice business lifecycle processing.

post/v1/e-compliance/reconcile

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

complianceType'EReporting' | 'EInvoiceBusinessLifecycle' required

The type of e-compliance request.

Note: Use EInvoiceBusinessLifecycle when reconciling e-invoice business lifecycle status updates.

sourceObjectKeystring required

The business identifier of the source object to reconcile. Use the document number for invoices, credit memos, and debit memos.

Note: Use PaymentApplicationId for payments, RefundApplicationId for refunds, and CreditMemoApplicationId for credit memo applications.

sourceObjectType'INVOICE' | 'CREDIT_MEMO' | 'DEBIT_MEMO' | 'PAYMENT' | 'REFUND' | 'CREDIT_MEMO_APPLICATION' required

The type of source object for the e-compliance operation.

transactionIdstring

Optional external transaction ID to use for this reconcile request.

Note: If you do not specify this field, Zuora uses the transactionId from the current request context.

Example request

{
  "complianceType": "EInvoiceBusinessLifecycle",
  "sourceObjectKey": "e4c081829f3b3c68019f3bd8d6161368",
  "sourceObjectType": "INVOICE"
}

Response

OK

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Changes