Configure e-invoicing business regions
After the e-invoicing service provider is configured, create a business region for your e-invoicing service provider through the Zuora UI or REST API to store the business detail information as a seller.
If you have multiple GSTINs for different states in India, you can create multiple business region objects.
To configure and manage a business region for your e-invoicing service provider through the REST API, use the following operations:
- Create an e-invoicing business region
- List e-invoicing business regions
- Retrieve an e-invoicing business region
- Update an e-invoicing business region
- Delete an e-invoicing business region
Create e-invoicing business regions through the Zuora UI
To create a business region for your e-invoicing service provider through the Zuora UI, perform the following steps:
- Click your avatar in the upper right and click Settings > Billing.
- On the Billing Settings page, click E-Invoice.
- On the E-Invoice Settings page, click + Add in the Business Regions section.
- In the displayed Add Business Region dialog, configure the business region settings, and then click Save to save the settings.
An e-invoicing business region is created.
Business region settings
The business region objects can be looked up according to the country and state, and their related fields can be mapped accordingly within the e-invoicing template.
The following table lists the business region settings that you need to configure in the Add Business Region dialog. This table includes the general settings for countries that are not pre-integrated. For settings of the pre-integrated countries, see Manage country-specific configurations.
The Invoice, Credit Memo, and Debit Memo and Use Default Rule to Match the Business Region checkboxes are all selected by default. You can clear the Use Default Rule to Match the Business Region to use a custom filter to define your rule for restricting the billing documents that can be transferred. See Configure rules for selecting documents and mandates.
UI section | UI field | API field | Description |
---|---|---|---|
Basic Info |
Country |
country |
From the Country list, select a country or region where you must comply with e-invoicing requirements. |
Legal Business Name |
businessName |
In the Legal Business Name field, specify the full official name that the Seller is registered with the relevant legal authority. |
|
Legal Business Number |
businessNumber |
In the Legal Business Number field, specify the unique identifier number of the legal entity or person that you do business with. |
|
Business Number Schema Id |
businessNumberSchemeId |
In the Business Number Schema Id field, specify the identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person. |
|
Trade Name |
tradeName |
In the Trade Name field, specify the name that the Seller is known as, other than the legal business name. |
|
Tax Register Number |
taxRegisterNumber |
In the Tax Register Number field, specify 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. |
|
E-Invoice Destination Code |
endpointId |
In the E-Invoice Destination Code field, specify the Seller's electronic address, to which the application-level response to the e-invoice file might be delivered. |
|
E-Invoice Destination Code Schema Id |
endpointSchemeId |
In the E-Invoice Destination Code Schema Id field, specify the identification scheme identifier of the Seller’s electronic address. |
|
Business Address |
Address 1 |
addressLine1 |
In the Address 1 field, specify the first line of the Seller’s address, which is often a street address or business name. |
Address 2 |
addressLine2 |
In the Address 2 field, specify the second line of the Seller’s address, which is often the name of a building. |
|
Postal Code |
postalCode |
In the Postal Code field, specify the short code that can identify the business address. |
|
City |
city |
In the City field, specify the name of the city where the business is located. |
|
State/Province |
state |
In the State/Province field, specify the name of the state or province where the business is located. |
|
Contact Info
|
Contact Name |
contactName |
In the Contact Name field, specify the name of the Seller contact to receive e-invoicing data. |
|
|
In the Email field, specify the email address of the Seller contact to receive e-invoicing data. |
|
Business Phone Number |
phoneNumber |
In the Business Phone Number field, specify the business phone number of the Seller contact to receive e-invoicing data. |
|
Service Provider |
Provider |
serviceProviderId |
From the Provider list, select your e-invoicing service provider. |
Digital Signature Note: Available to Sovos |
Enable PDF Digital Signature | digitalSignatureEnable |
Specify whether the e-invoicing service provider signs PDF files for billing documents. Click Yes to enable the setting. The default setting is NO. For more information, see Digital Signature. |
Show Signature Box | digitalSignatureBoxEnable |
Specify whether the digital signature box is displayed on PDF files for billing documents. Click Yes to enable the setting. The default setting is NO. |
|
Coordination on PDF | digitalSignatureBoxPosX, digitalSignatureBoxPosY | In the text box, specify the position of the on-page signature box. If the coordinates are set to (0,0), the signature box will appear in the lower-left corner of the page, while the coordinates (595,842) place the signature box in the upper-right corner of the page. | |
E-Invoice Process Note: Available to Sovos and Avalara |
E-Invoice Process | processType |
If the selected service provider is Sovos or Avalara, the E-Invoice Process field is available, you can select one of the process types corresponding to the service provider:
|
Billing Document Type |
|
Select one or more of the following billing document types to be supported:
The Invoice, Credit Memo, and Debit Memo and Use Default Rule to Match the Business Region checkboxes are all selected by default. You can clear the Use Default Rule to Match the Business Region to use a custom filter to define your rule for restricting the billing documents that can be transferred. See Create rules for selecting documents and mandates, Use cases for creating rules, and Objects and fields for creating rules. |
Create rules for selecting documents and mandates
You can create rules that combine conditions or condition groups for invoices, credit memos, debit memos, invoice items, credit memos, and debit memos.
- For invoices, credit memos, and debit memos, click + Add Condition or + Add Group.
- For a group, select the AND or OR operator and define multiple conditions.
- For a condition, select an option that includes a combination of objects and fields from the dropdown list. The available operators (for example, “=” and “>”) vary for different options. See Manage custom fields with the Object Manager.
Note: Only indexed custom fields are available in the dropdown list. - For a group or condition, click the copy icon to duplicate a new one. Alternatively, you can click the delete icon to delete a group or condition, and then add a new one.
- For invoice items, credit memo items, and debit memo items, click + Add Item Filter. After adding a item filter, click + Add Condition or + Add Group to define condition or condition groups as above.
Use cases for creating rules
This section lists common use cases for creating rules. For available objects and fields for creating the rules, see Objects and fields for creating rules.
Use case 1: By default, the country of the sold-to contact on the billing document is used to determine the business region. Create a rule that matches this default behavior for invoices, shown below. You can create the same rule for the credit memo and debit memo.
Use case 2: A company located in Germany requires its suppliers to only send an electronic invoice (ELR) when the document is above 10,000. Create a rule reflecting this requirement for invoices.
Use case 3: In Romania, companies that trade in products characterized as dangerous are required to issue an electronic fiscal document. The configuration needs to be done at the item level. Create a rule reflecting this requirement for invoices.
In this case, the Category is a custom field of the Product Rate Plan Charge object, and the Product Rate Plan Charge is the related object of the Invoice Item base object.
Use case 4: This is the scenario of the e-invoice rejected in Italy and a company needs to reverse the invoice without sending the Credit Memo to the government. Create a rule that prevents sending credit memos generated from invoice reversal.
Objects and fields for creating rules
You can use Invoice, Invoice Item, Credit Memo, Credit Memo Item, Debit Memo, and Debit Memo base objects and their related objects to create rules.
The following table lists the base objects and their related objects that can be used to create rules. Besides the objects below, you can use both standard and custom fields of these objects to create rules. To create custom fields on base objects and related objects, see Manage custom fields with the Object Manager.
If you want to add custom fields and let the custom fields display as part of the Condition, you must configure the custom fields as indexed fields.
Base object | Related objects |
---|---|
Invoice |
|
InvoiceItem |
|
CreditMemo |
|
CreditMemoItem |
|
DebitMemo |
|
DebitMemoItem |
|
What's next
You are now ready to configure an e-invoicing profile for your customer account that must comply with e-invoicing business requirements.