POST /v1/einvoice/business-regions

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.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Id`	String	No	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 (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	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.
`Zuora-Entity-Ids`	String	No	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	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`businessName`	String	Yes	The full official name that the Seller is registered with the relevant legal authority.
`phoneNumber`	String	No	The business phone number of the Seller contact to receive e-invoicing data.
`state`	String	No	The name of the state or province where the business is located.
`businessNumberSchemaId`	String	No	The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.
`contactName`	String	No	The name of the Seller contact to receive e-invoicing data.
`addressLine1`	String	No	The first line of the Seller’s address, which is often a street address or business name.
`city`	String	No	The the name of the city where the business is located.
`addressLine2`	String	No	The second line of the Seller’s address, which is often the name of a building.
`postalCode`	String	No	The short code that can identify the business address.
`email`	String	No	The email address of the Seller contact to receive e-invoicing data.
`endpointId`	String	No	The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.
`serviceProviderId`	String	No	The unique ID of the e-invoicing service provider that is associated to the business region.
`digitalSignatureEnable`	Boolean	No	Whether the e-invoicing service provider signs PDF files for billing documents. Default value: false
`digitalSignatureBoxPosY`	Number	No	The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.
`digitalSignatureBoxPosX`	Number	No	The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.
`endpointSchemeId`	String	No	The identification scheme identifier of the Seller’s electronic address.
`responseMapping`	Object	No	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.
`taxRegisterNumber`	String	No	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	No	The name that the Seller is known as, other than the legal business name.
`digitalSignatureBoxEnable`	Boolean	No	Whether the digital signature box is displayed on PDF files for billing documents. Default value: false
`country`	String	Yes	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.
`businessNumber`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.