To integrate OMP Feed API:
- Register a Lovat OMP Account.
- Fill a company profile.
- Choose a plan.
- Set up Webhooks.
- Get a token.
- Set tax rules.
Authentication
Authentication to the OMP API is performed via HTTP header basic authentication. Subscribers need to provide a token as the basic authentication value. If you’re new to Lovat, you’ll need to sign up for an account to get your API key. The API uses built-in HTTP features such as HTTP authentication and HTTP verbs, which can be interpreted by off-the-shelf HTTP clients. It also supports cross-origin resource sharing, allowing you to access it securely from a client web application.
URL
- Production Region
https://omp.vatcompliance.co/api/omp – OMP Feed API, OMP Tax rate API
- Test Region
sandbox.vatcompliance.co/api/omp
POST
Method
The request type: POST
https://omp.vatcompliance.co/api/omp/feed/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
JSON Params
Parameter | Type | Description | Required |
merchant_id | String | Unique identifier of the merchant | Required |
transaction_id | String | Maximum 255 characters. | Required |
parent_transaction_id | String | For refunds and returns | Optional |
inv_number | String | Tax invoice number | – |
customer_ip | String | Customer’s IP address | Optional |
сurrency | String | Transaction currency. Three-letter currency code per ISO 4217. | Required |
transaction_datetime | – | Date and time of the transaction in accordance with ISO 8601 GMT | Required |
transaction_sum | Float | Total amount of the order, excluding shipping | Required |
transaction_status | String | Sale/refund/return | Required |
customer_phone_number | String | – | Optional |
arrival_country | String | A country where the order shipped to. Three-letter uppercase country code per ISO 3166-1 alpha-3 | Required |
arrival_city | String | Arrival city | Optional |
arrival_zip | String | ZIP/Postcode, required for all US orders | Optional |
arrival_address_line | String | Arrival address line 1 | Optional |
departure_country | String | Three-letter ISO country code of the country where the order shipped from. All countries are specified as strings according to ISO 3166- 1 alpha-3 | Required |
service_code | String | Required for digitally supplied services. Tax categories of digital services | – |
good_code | String | code of a good according to EU’s eight-digit coding system The Combined Nomenclature (CN) | Optional |
vat | Float | Tax Amount | Optional |
vat_percent | Float | Tax percent | Optional |
vat_number_of_buyer | String | Tax number of buyer | Optional |
buyer_name | String | – | Optional |
sales_tax | Float | Sales tax ammount | – |
sales_tax_percent | Float | – | – |
taxable_jurisdiction | String | All countries are specified as strings according to ISO 3166- 1 alpha-3 | Optional |
deemed | Bool | True / False | Optional |
Requests and Responses
The requests to Lovat API must:
HTTP status: 200 (OK)
be sent over HTTPS, use TLS 1.2 or higher, contain authentication parameters,
Request Example
Command Line
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json'
-d '{
"transaction_id": "ttt4565-85546",
"merchant_id": "678345101",
"merchant_establishment_country_id": "DEU",
"transaction_datetime": "2020-01-09T08:27:22 +00:00",
"transaction_sum": 158.04,
"currency": "GBP",
"arrival_country" : "GBR",
"arrival_city" : "London",
"arrival_address_line" : "Peckham Road",
"transaction_status" : "Success",
"good_code": "62160000",
"vat_percent": 20.00,
"vat": 28.73,
"departure_country" : "AUS"
}'
'https://omp .vatcompliance.co/api/omp/feed/6cec387781a94425b401206d1710801a?if_digital=true&if_vat_calculate=true