Sign in
E-Invoicing

Retrieve an e-invoicing business region

Retrieves information about an e-invoicing business region.

You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region.

Note: This operation is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

get/v1/einvoice/business-regions/{key}

Path parameters

keystring required

The unqiue ID or number of the e-invoicing business region that you want to retrieve information about.

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.

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.

Response

OK

idstring

The unique ID of the e-invoicing business region.

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=view-countries-or-regions" target="_blank">View countries or regions</a>.

businessNamestring

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

businessNumberstring

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

For example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.

businessNumberSchemaIdstring

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

tradeNamestring nullable

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

endpointIdstring

The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.

endpointSchemeIdstring

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

taxRegisterNumberstring nullable

The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status.

statestring nullable

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

citystring

The the name of the city where the business is located.

postalCodestring

The short code that can identify the business address.

addressLine1string nullable

The first line of the Seller’s address, which is often a street address or business name.

addressLine2string nullable

The second line of the Seller’s address, which is often the name of a building.

contactNamestring nullable

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

phoneNumberstring nullable

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

emailstring nullable

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

serviceProviderIdstring

The unique ID of the e-invoicing service provider that is associated to the business region.

businessRegionNumberstring

The unique number of the e-invoicing business region.

digitalSignatureEnableboolean

Whether the e-invoicing service provider signs PDF files for billing documents.

digitalSignatureBoxEnableboolean

Whether the digital signature box is displayed on PDF files for billing documents.

digitalSignatureBoxPosXnumber

The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.

digitalSignatureBoxPosYnumber

The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.

responseMappingobject

Container for e-invoicing response field mappings that map values from the e-invoicing service provider’s response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path.

Note: This field is applicable only to the Sovos or Avalara service provider.

For more information, see <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings" target="_blank">Configure e-invoicing response field mappings</a>.

processType'Clearance' | 'ClearanceWithCancellation' | 'PEPPOLNetwork' | 'Unknown'

The process type of the e-invoicing business region.

  • If the service provider is Sovos, the process type is Clearance or ClearanceWithCancellation.
  • If the service provider is Avalara, the process type is Clearance or PEPPOLNetwork.
  • If the service provider is PEPPOL, the process type is Unknown.
invoiceEnabledboolean

It will control whether the invoice should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.

creditMemoEnabledboolean

It will control whether the credit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.

debitMemoEnabledboolean

It will control whether the debit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara.

fileFormatstring[] nullable

The file format for each business category. An example response is "[ "application/xml", "application/vnd.oasis.ubl+xml" ]"

successboolean

Indicats if the request succeeds.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.