Sign in
E-Invoicing
E-Reporting

Trigger an e-compliance request

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

post/v1/e-compliance/trigger

Headers

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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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-Versionstring

The minor API version.

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

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.

Request body

complianceType'EReporting' | 'EInvoiceBusinessLifecycle' required

Type of e-compliance request.

sourceObjectKeystring required

Source object key. Use the document number for invoice, credit memo, and debit memo; use PaymentApplicationId for payment; use RefundApplicationId for refund; use CreditMemoApplicationId for credit memo application.

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

Type of source object for e-compliance operations (trigger or reconcile).

supplierIdstring required

ID of the e-reporting supplier to use for the request.

templateIdstring

Optional ID of the e-reporting template to use. If not specified, the system will auto-resolve a template based on the source object and supplier.

Response

OK

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Changes