home

Indirect Tax

Sovos Docs

Set up inbound connections

Learn how to configure inbound connections to retrieve invoices using Indirect Tax API

You have already configured a company and assigned it a product supporting inbound communication.
Note:

The defined inbound products differ for each country

  1. Send a POST request to the endpoint URL:
    POST https://api-test.sovos.com/v2/configurations/organizations/{orgId}/settings
  2. Include the following headers in your request:
    • Authorization: Bearer {accessToken}

    • Content-Type: application/json

    • x-correlationId: {uniqueValue}

  3. Include the following parameters inside the JSON payload in the request body:
    NameTypeRequiredDescription
    contextstringYesEnter "polling".
    configurationsarray of objectsYes
    Object 1:
    namestringYesEnter "query_filter_params".
    valueobjectYes
    itemsarray of objectsYes
    namestringYesEnter "PollingDateFrom".
    valuestringYesEnter the polling start “datetime”.
    scopeobjectYes
    categorystringYesThe proper value for the country being configured.
    productIdstringYesThe proper value for the country being configured.
    orgIdstringYesThe organization ID obtained from the Sovos Professional Services team.
    taxIdstringYesThe tax ID of the company for which the credentials are being configured.
    Object 2:
    namestringYesEnter "query_filter_params".
    valueobjectYes
    pollingWorkflowStatearray of objectsYesA flag to enable or disable the inbound flow for a given company. Possible values: “enable” or “disable”.
    scopeobjectYes
    operationstringYesEnter “Validate”.
    categorystringYesThe proper value for the country being configured.
    productIdstringYesThe proper value for the country being configured.
    orgIdstringYesThe organization ID obtained from the Sovos Professional Services team
    taxIdstringYesThe tax ID of the company for which the credentials are being configured.
    systemIdstringYesThe systemId configured for document retrieval.
Upon successful creation, the API will return a JSON object containing the configuration details and their assigned Setting ID. Use the Setting ID value from the response to update configured values in the future.