Configure e-invoicing response field mappings

Prerequisites

Before configuring the response field mappings, you must complete the following prerequisites:

• Get an XML-formatted response payload sample of a particular country from Sovos.
• Get familiar with the XPath syntax that field paths must be compliant with. For more information, see Field path format.

Configure response field mappings

You can configure response field mappings when creating or updating business regions for the Sovos service provider.

To configure response field mappings, perform the following steps:

1. Click your avatar in the upper right and click Settings > Billing.
2. On the Billing Settings page, click E-Invoice.
3. On the E-Invoice Settings page, perform one of the following operations:
   • If you want to configure response field mappings for a new business region, click + Add in the Business Regions section.
   • If you want to configure response field mappings for an existing business region, locate the business region in the Business Regions section and then click the Edit  icon.

4. In the displayed Add Business Region dialog, click + Add Field Mapping in the Response Mapping section.

   You can configure response field mappings only if you configure the following settings:

   • Specify Sovos as the service provider.
   • Specify a country that is not pre-integrated. The default response mappings have been configured and cannot be changed for the pre-integrated countries. For more information, see Manage country-specific configurations. 
5. Complete the following information:
   • Field Name: Select a field name from the list. This is the name of the mapped field on the EInvoiceData object. For more information, see Supported response fields.
     If you select a default field for countries with which Zuora is pre-integrated, the setting will overwrite the default mapping. For more information about default fields of different countries, see Manage country-specific configurations.
   • Field Path: Refer to the response payload sample provided by Sovos and specify the field path of an XML node.
     The format of this field must comply with the XML Path Language (XPath) syntax. For more information about how to identify XML nodes with XPath, see Field path format.

Retrieve e-invoicing response data

When the e-invoice file status of a billing document is Success, you can retrieve the e-invoicing response data stored in the EInvoiceData object.

For more information, see Retrieve e-invoice results.

Supported response fields

The following table lists supported e-invoicing response fields. Most of these fields are from the EInvoiceData object, except for the EInvoiceFile field.

Field path format

A field path in a field mapping configuration is a string that indicates a node in Sovos’ XML response payload, and the string must comply with the XPath syntax.

The later sections of this article use the following snippet as an example to help you understand the XPath syntax. This snippet is extracted from the Sovos’ response payload sample. You can get a complete response payload sample for each country from Sovos.

<ApplicationResponse>
    <ext:UBLExtensions>
        <ext:UBLExtension>
            <ext:ExtensionContent>
                <ad:AdditionalData>
                    <ad:Field name="SdiId" type="FormalIdentifier">a2c73…10b31
                    </ad:Field>
                    …
                </ad:AdditionalData>
            </ext:ExtensionContent>
        </ext:UBLExtension>
    </ext:UBLExtensions>
    …
    <cac:DocumentResponse>
        …
        <cac:DocumentReference>
            <cbc:ID>JqYyq…cKje</cbc:ID>
            <cbc:DocumentTypeCode>LegalCleared</cbc:DocumentTypeCode>
            <cac:Attachment>
                <cbc:EmbeddedDocumentBinaryObject>ZXlKaGJH…nN3c=
                </cbc:EmbeddedDocumentBinaryObject>
            </cac:Attachment>
        </cac:DocumentReference>
        <cac:DocumentReference>
            <cbc:ID>JqYyq…CUcs</cbc:ID>
            <cbc:DocumentTypeCode>Legal</cbc:DocumentTypeCode>
            <cac:Attachment>
                <cbc:EmbeddedDocumentBinaryObject>ZXlKaGJH…kQQ==
                </cbc:EmbeddedDocumentBinaryObject>
            </cac:Attachment>
        </cac:DocumentReference>
    </cac:DocumentResponse>
</ApplicationResponse>