---
title: "Create an e-invoicing business region"
method: POST
path: "/v1/einvoice/business-regions"
tags: ["E-Invoicing"]
---

# Create an e-invoicing business region

`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 <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.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- CreateEInvoicingBusinessRegionRequest
  - `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.
  - `businessName` string, required — The full official name that the Seller is registered with the relevant legal authority.
  - `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 — The name of the Seller contact to receive e-invoicing data.
  - `country` string, required — 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>.
  - `digitalSignatureEnable` boolean — Whether the e-invoicing service provider signs PDF files for billing documents.
  - `digitalSignatureBoxEnable` boolean — Whether the digital signature box is displayed on PDF files for billing documents.
  - `digitalSignatureBoxPosX` number — The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.
  - `digitalSignatureBoxPosY` number — 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.
  - `responseMapping` object — 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' — The process type of the e-invoicing business region. - If the service provider is Sovos, specify the process type as `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, specify the process type as `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, leave this field empty.
  - `invoiceEnabled` boolean — This field controls whether the invoice should be supported by the process type or not. For some countries, this field is required to be set to `true`. 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/Manage_country-specific_configurations" target="_blank">Manage country-specific configurations</a>.
  - `creditMemoEnabled` boolean — This field controls whether the credit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. 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/Manage_country-specific_configurations" target="_blank">Manage country-specific configurations</a>.
  - `debitMemoEnabled` boolean — This field controls whether the debit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. 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/Manage_country-specific_configurations" target="_blank">Manage country-specific configurations</a>.
  - `invoiceFilters` InvoiceFiltersRequestType[] — The documents belonging to the e-invoicing business region.
    - `condition` InvoiceFiltersCondition — Container for condition information about the invoice filters.
      - `conditions` InvoiceFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'Invoice' | 'InvoiceItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `creditMemoFilters` CreditMemoFiltersRequestType[] — The documents belonging to the e-invoicing business region.
    - `condition` CreditMemoFiltersCondition — Container for condition information about the credit memo filters.
      - `conditions` CreditMemoFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'CreditMemo' | 'CreditMemoItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `debitMemoFilters` DebitMemoFiltersRequestType[] — The documents belonging to the e-invoicing business region.
    - `condition` DebitMemoFiltersCondition — Container for condition information about the debit memo filters.
      - `conditions` DebitMemoFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'DebitMemo' | 'DebitMemoItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `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 — The name that the Seller is known as, other than the legal business name.
  - `fileFormat` string[] — You can define the file format for each business category as shown in the following example: fileFormat" : { "B2B" : [ "XML" ], "B2C" : [ ], "B2G" : [ "XML" ] } **Note:** This field is optional; however, if you use Avalara integration, it becomes a mandatory field.

## Response `200`

OK

- GetEInvoicingBusinessRegionResponse
  - `id` string — The unique ID of the e-invoicing business region.
  - `country` 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 <a href="https://docs.zuora.com?resourceId=view-countries-or-regions" target="_blank">View countries or regions</a>.
  - `businessName` string — The full official name that the Seller is registered with the relevant legal authority.
  - `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.
  - `tradeName` string, nullable — The name that the Seller is known as, other than the legal business name.
  - `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.
  - `taxRegisterNumber` string, 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.
  - `state` string, nullable — The name of the state or province where the business is located.
  - `city` string — The the name of the city where the business is located.
  - `postalCode` string — The short code that can identify the business address.
  - `addressLine1` string, nullable — The first line of the Seller’s address, which is often a street address or business name.
  - `addressLine2` string, nullable — The second line of the Seller’s address, which is often the name of a building.
  - `contactName` string, nullable — The name of the Seller contact to receive e-invoicing data.
  - `phoneNumber` string, nullable — The business phone number of the Seller contact to receive e-invoicing data.
  - `email` string, nullable — The email address of the Seller contact to receive e-invoicing data.
  - `serviceProviderId` string — The unique ID of the e-invoicing service provider that is associated to the business region.
  - `businessRegionNumber` string — The unique number of the e-invoicing business region.
  - `digitalSignatureEnable` boolean — Whether the e-invoicing service provider signs PDF files for billing documents.
  - `digitalSignatureBoxEnable` boolean — Whether the digital signature box is displayed on PDF files for billing documents.
  - `digitalSignatureBoxPosX` number — The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.
  - `digitalSignatureBoxPosY` number — The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.
  - `responseMapping` object — 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`.
  - `invoiceEnabled` boolean — 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.
  - `creditMemoEnabled` boolean — 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.
  - `debitMemoEnabled` boolean — 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.
  - `invoiceFilters` InvoiceFiltersResponseType[], nullable — The documents belonging to the e-invoicing business region.
    - `condition` InvoiceFiltersCondition — Container for condition information about the invoice filters.
      - `conditions` InvoiceFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'Invoice' | 'InvoiceItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `creditMemoFilters` CreditMemoFiltersResponseType[], nullable — The documents belonging to the e-invoicing business region.
    - `condition` CreditMemoFiltersCondition — Container for condition information about the credit memo filters.
      - `conditions` CreditMemoFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'CreditMemo' | 'CreditMemoItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `debitMemoFilters` DebitMemoFiltersResponseType[], nullable — The documents belonging to the e-invoicing business region.
    - `condition` DebitMemoFiltersCondition — Container for condition information about the debit memo filters.
      - `conditions` DebitMemoFiltersCondition[] — Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields.
      - `field` string — The field name of a single condition that is indicated by the `conditions` field.
      - `operator` 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte' | 'lk' | 'in' | 'nl' | 'nnl' — The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null)
      - `relation` 'and' | 'or' — The relation among the `conditions` fields.
      - `value` string — The value of a single condition that is indicated by the `conditions` field.
      - `objectType` 'DebitMemo' | 'DebitMemoItem' — The target object type of the condition when the `filterType` field is specified as `FilterCondition`.
  - `fileFormat` string[], nullable — The file format for each business category. An example response is "[ "application/xml", "application/vnd.oasis.ubl+xml" ]"
  - `success` boolean — Indicats if the request succeeds.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)