Create an e-invoicing business region

Creates an e-invoicing business region.

You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India.

The business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template.

Note: This operation is available only if you have the E-Invoicing feature in Early Adopter phase enabled.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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 do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
country
required
string

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 View countries or regions.

businessName
required
string <= 255 characters

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

addressLine1
string

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

addressLine2
string

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

businessNumber
string

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.

businessNumberSchemaId
string

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

city
string

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

contactName
string <= 255 characters

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

digitalSignatureEnable
boolean
Default: false

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

digitalSignatureBoxEnable
boolean
Default: false

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

digitalSignatureBoxPosX
number >= 0

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

digitalSignatureBoxPosY
number >= 0

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

email
string

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

endpointId
string

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

endpointSchemeId
string

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

phoneNumber
string

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

postalCode
string

The short code that can identify the business address.

object (responseMapping)

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

Note that this field is applicable only to the Sovos service provider.

For more information, see Configure e-invoicing response field mappings.

serviceProviderId
string

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

state
string

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

taxRegisterNumber
string

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.

tradeName
string <= 100 characters

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

Responses
200
post/v1/einvoice/business-regions
Request samples
application/json
{
  • "addressLine1": null,
  • "addressLine2": null,
  • "businessName": "legal business name",
  • "businessNumber": "20002039",
  • "businessNumberSchemaId": "88",
  • "city": "Tokyo",
  • "contactName": null,
  • "country": "JP",
  • "email": null,
  • "endpointId": "8992",
  • "endpointSchemeId": "88",
  • "phoneNumber": null,
  • "postalCode": "368779",
  • "serviceProviderId": "4028948972a2bf990172bc9b27724ddc",
  • "state": null,
  • "taxRegisterNumber": "TAX393999",
  • "tradeName": "Zuora"
}
Response samples
application/json
{
  • "addressLine1": "",
  • "addressLine2": "",
  • "businessName": "legal business name",
  • "businessNumber": "20002039",
  • "businessNumberSchemaId": "88",
  • "businessRegionNumber": "EIBR-00000002",
  • "city": "Tokyo",
  • "contactName": "",
  • "country": "JP",
  • "digitalSignatureEnable": false,
  • "digitalSignatureBoxEnable": false,
  • "digitalSignatureBoxPosX": 0,
  • "digitalSignatureBoxPosY": 0,
  • "email": "",
  • "id": "4028b2aa8890c524018890c7e9ef3826",
  • "phoneNumber": "",
  • "postalCode": "368779",
  • "responseMapping": { },
  • "serviceProviderId": "4028948972a2bf990172bc9b27724ddc",
  • "state": "",
  • "taxRegisterNumber": "TAX393999",
  • "tradeName": "Zuora"
}