Sign in
E-Reporting

Update an e-reporting business region

Updates an e-reporting business region.

put/v1/e-reporting/business-regions/{key}

Path parameters

keystring required

The unique ID or natural key of an e-reporting business region.

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

countrystring

The short name of a country or region where you must comply with e-invoicing requirements. For example, IN for India. For the full list of country names and codes, see <a href="https://docs.zuora.com?resourceId=countries-regions-subregions-overview" target="_blank">ISO Standard Country Codes</a>.

engineIdstring

The unique ID of the e-reporting service provider (engine) to associate with this business region.

statestring

The name of the state or province within the country where the business is located.

citystring

The name of the city where the business is located.

postalCodestring

The postal code of the Seller's business address.

addressLine1string

The first line of the Seller's business address.

addressLine2string

The second line of the Seller's business address.

businessNamestring

The full official name that the Seller is registered with the relevant legal authority.

businessNumberstring

The unique identifier number of the legal entity or person that you do business with.

businessNumberSchemeIdstring

The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.

tradeNamestring

The name that the Seller is known as, other than the legal business name.

endpointIdstring

The Seller's electronic address to which application-level responses might be delivered.

endpointSchemeIdstring

The identification scheme identifier of the Seller's electronic address.

taxRegisterNumberstring

The Seller's tax identification number or local identification for tax purposes.

contactNamestring

The name of the Seller contact to receive e-reporting data.

phoneNumberstring

The business phone number of the Seller contact to receive e-reporting data.

emailstring email

The email address of the Seller contact to receive e-reporting data.

mode'INDIVIDUAL' | 'BATCH'

The processing mode for e-reporting submissions.

natureKeystring

An optional customer-provided identifier for the business region.

invoiceEnabledboolean

Whether invoice documents are enabled for e-reporting in this business region.

creditMemoEnabledboolean

Whether credit memo documents are enabled for e-reporting in this business region.

debitMemoEnabledboolean

Whether debit memo documents are enabled for e-reporting in this business region.

paymentEnabledboolean

Whether payment documents are enabled for e-reporting in this business region.

refundEnabledboolean

Whether refund documents are enabled for e-reporting in this business region.

creditMemoApplicationEnabledboolean

Whether credit memo application events are enabled for e-reporting in this business region.

invoicePostedTriggerEnabledboolean

Whether the invoice posted event triggers an e-reporting submission.

cmPostedTriggerEnabledboolean

Whether the credit memo posted event triggers an e-reporting submission.

dmPostedTriggerEnabledboolean

Whether the debit memo posted event triggers an e-reporting submission.

paymentAppliedTriggerEnabledboolean

Whether the payment applied event triggers an e-reporting submission.

refundAppliedTriggerEnabledboolean

Whether the refund applied event triggers an e-reporting submission.

creditMemoApplicationTriggerEnabledboolean

Whether the credit memo application event triggers an e-reporting submission.

einvoiceSuccessTriggerEnabledboolean

Whether a successful e-invoice submission triggers an e-reporting submission.

invoiceFiltersobject[]

The filter conditions applied to invoice documents before e-reporting submission. Valid root object types: Invoice, InvoiceItem.

creditMemoFiltersobject[]

The filter conditions applied to credit memo documents before e-reporting submission. Valid root object types: CreditMemo, CreditMemoItem.

debitMemoFiltersobject[]

The filter conditions applied to debit memo documents before e-reporting submission. Valid root object types: DebitMemo, DebitMemoItem.

paymentFiltersobject[]

The filter conditions applied when a payment is applied before e-reporting submission. Valid root object type: Payment. Item sub-queries may use PaymentApplication.

refundFiltersobject[]

The filter conditions applied when a refund is applied before e-reporting submission. Valid root object type: Refund. Item sub-queries may use RefundApplication.

creditMemoApplicationFiltersobject[]

The filter conditions applied when a credit memo is applied before e-reporting submission. Valid root object type: CreditMemoApplication. Item sub-queries may use CreditMemoApplicationItem.

b2bFileFormatstring

The file format used for business-to-business e-reporting submissions.

b2cFileFormatstring

The file format used for business-to-consumer e-reporting submissions.

b2gFileFormatstring

The file format used for business-to-government e-reporting submissions.

responseMappingobject

A mapping of response field keys to their handling configuration for e-reporting responses.

Example request

{
  "country": "ES",
  "businessName": "Acme Corp Spain",
  "businessNumber": "12345678A",
  "businessNumberSchemeId": "ES:VAT",
  "tradeName": "Acme Spain",
  "taxRegisterNumber": "ES12345678A",
  "endpointId": "9908:es-acme",
  "endpointSchemeId": "9908",
  "addressLine1": "Gran Via 1",
  "addressLine2": "Floor 2",
  "city": "Madrid",
  "state": "",
  "postalCode": "28013",
  "contactName": "Maria Garcia",
  "phoneNumber": "+34 555 0101",
  "email": "maria.garcia@example.com",
  "invoiceEnabled": true,
  "mode": "INDIVIDUAL",
  "natureKey": "es-sii-main",
  "engineId": "4028948972a2bf990172bc9b27724ddc"
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Changes