Israel

Enabling support for Israel involves confirming prerequisites and product IDs, registering with the Israel Tax Authority (ITA), and setting up credentials.

Prerequisites

An API key obtained from the ITA portal.
An API secret obtained from the ITA portal.
A refresh token obtained from the ITA portal.
Note: Expired tokens are detected during document submission via the API. Since the refresh token expires 90 days after the first document issuance for Sandbox, be sure to get a new refresh token at that time.

Available products

il_TaxInvoice__1.0

Register with the Israel tax authority

Obtain the required API key, Secret, and Refresh Token by registering with the Israel Tax Authority (ITA). Follow their registration tutorial, along with the following guidance.

The ITA tutorial advises users to subscribe to the "Invoice Approval 1.0.0" API product after creating the app.
Sovos recommends subscribing to the "Longtimeacces' 1.0.0" API product.

Create an Organization on the ITA portal.
Note: The ITA tax authority's registration tutorial and portal use several terms, such as "Organization", "Apps" and "Products". These words are specific to the tax authority and are not related to Sovos concepts.
Create an App.
You'll get an API key and a Secret.
Ensure both the API Key and the Secret are stored on the client side.
Subscribe the app to the relevant products in the ITA portal.
Perform OAuth 2.0 authentication to get the access and refresh tokens.
Ensure the refresh token is stored on the client side.
Note: The refresh token expires after 90 days, so be sure to request a new token before the old one expires.

Configure credentials for Israel

You must set up transmission credentials to connect your Sovos account to a valid business that is registered with the Israel Tax Authority (ITA).

Obtain a username, password, and signature from the ITA.

Use the dedicated Create settings endpoint to add transmission credentials through the API.
Complete and return an Appointment Letter to Sovos or your reseller.
Complete and return a Support and Change Management Document to Sovos or your reseller.

Samples for uploading credentials for Israel

The request and response samples for uploading new credentials using the dedicated Create settings endpoint.

Request sample

Request sample for uploading new credentials:

curl --location --request POST 'https://api-test.sovos.com/v2/configurations/organizations/YOUR-ORG-ID/settings' \
--header 'x-correlationId: developer-guide' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "context": "transmission",
        "configurations": [
            {
                "name": "partner_credentials_shaam",
                "value": {
                    "clientId": "INSERT-CLIENTID-HERE",
					"clientSecret": "INSERT-CLIENTSECRET-HERE",
					"refreshToken": "INSERT-REFRESH-TOKEN-HERE"
                },
                "scope": {
                    "category": "IL_INV",
                    "productId": "il_TaxInvoice__1.0",
                    "orgId": "YOUR-ORG-ID",
                    "taxId": "YOUR-COMPANY-TAXID"
                }
            }
        ]
    }
]'

Response sample

Response sample for uploading new credentials:

{
    "status": 201,
    "message": "Created",
    "success": true,
    "timestamp": 1666259266257,
    "data": [
        {
            "message": "Configurations are created",
            "statusCode": 201,
            "configurationContextResponse": {
                "context": "Transmission",
                "configurations": [
                    {
                        "id": "SETTING-ID",
                        "name": "partner_credentials_shaam",
                        "value": {
                            "clientId": "INSERT-CLIENTID-HERE",
					        "clientSecret": "INSERT-CLIENTSECRET-HERE",
					        "refreshToken": "INSERT-REFRESH-TOKEN-HERE"
                        },
                        "scope": {
                            "category": "IL_INV",
                            "productId": "il_TaxInvoice__1.0",
                            "orgId": "YOUR-ORG-ID",
                            "taxId": "YOUR-COMPANY-TAXID"
                        },
                        "auditData": {
                            "createdAt": 1666259265,
                            "createdBy": "user@company.com",
                            "isDeleted": false,
                            "version": 1
                        }
                    }
                ]
            }
        }
    ]
}

Sovos Docs