Custom Tax Provider Webhooks (1.0.0)

Download OpenAPI specification:Download

A service, for providing tax quotations for transactions, which implements this API.

Tax quotation

Actions for tax quotation.

Create tax quotation

Create tax quotation for the given transaction.

Authorizations:

basic

Request Body schema: application/json

transaction_type	string Enum: "SALE" "RETURN" Type of the transaction.
order_id	string Order identifier.
tax_exempt required	boolean Tax exemption status of the transaction.
exemption_number	string Tax exemption certificate number of the customer.
exemption_class	string Tax exemption class.
required	Array of objects A list of items sold/returned in the transaction.

Responses

Request samples

Payload

Content type

application/json

{"transaction_type": "SALE",
"order_id": "56bb9975-f43a-4eee-8fb2-200957eb0624",
"tax_exempt": false,
"exemption_number": "string",
"exemption_class": "string",
"items": [{"index": 0,
"tax_class": "AAA000",
"tax_method": "vat_excluded",
"item_price": 200,
"quantity": 1,
"shipping_address": {"address_line_1": "1500 Wilson Blvd",
"address_line_2": "string",
"province": "Arlington",
"state": "VA",
"zip_code": "22209",
"city": "Arlington",
"country_code": "DE"
},
"shipping_origin": {"address_line_1": "1500 Wilson Blvd",
"address_line_2": "string",
"province": "Arlington",
"state": "VA",
"zip_code": "22209",
"city": "Arlington",
"country_code": "DE"
},
"type": "product",
"currency_consumer": "USD",
"consumer_uuid": "79a78090-ba7b-4cd7-b6b6-64638788f0fd",
"product_name": "Metallica T-shirt",
"product_sku": "AIK-0790",
"product_id": "123",
"extended_attributes": [{"name": "size",
"value": "36"
}
],
"id": "123",
"exemption_number": "string",
"tax_exempt": false
}
]
}

Response samples

200
400
default

Content type

application/json

{"document_id": "3195649a-cd43-47ec-8774-c7b404df1e00",
"items": [{"index": 0,
"net_amount": 200,
"gross_amount": 250,
"tax_amount": 50,
"tax_rates": [{"rate": 0.25,
"amount": 50,
"tax_name": "State tax",
"country_code": "DE",
"taxable_amount": 100,
"exempt_amount": 100
}
]
}
]
}