Transactions
Create a transaction
Sales Tax API
Core Concepts
Corporations
Calculate
Transactions
- Tax Transactions
- POSTCreate a transaction
- GETGet transaction
- GETList transactions
- DELDelete transaction
- Refund Transactions
- Bulk Transaction Import
Nexus
Registrations
Products
Customers
Exemption Certificates
Transactions
Create a transaction
Submit a completed transaction for processing and filing
POST
/
transactions
curl --request POST \
--url https://base_url/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_currency": "USD",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"refund_type": "FULL",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": {
"items": [
{
"amount": 123,
"line_number": "<string>",
"quantity": 123,
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
]
},
"tax_included": true,
"exemption_type": "PURPOSE_RESALE"
}'
{
"data": {
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"invoice_currency": "USD",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"transaction_status": "LOCKED",
"calculation_id": "<string>",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"source_platform": "RAZORPAY",
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE"
}
]
},
"exemption_type": "PURPOSE_RESALE",
"parent_invoice_id": "<string>"
},
"message": "Successfully created transaction."
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Transaction creation response
The response is of type object
.
curl --request POST \
--url https://base_url/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_currency": "USD",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"refund_type": "FULL",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": {
"items": [
{
"amount": 123,
"line_number": "<string>",
"quantity": 123,
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
]
},
"tax_included": true,
"exemption_type": "PURPOSE_RESALE"
}'
{
"data": {
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"invoice_currency": "USD",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"transaction_status": "LOCKED",
"calculation_id": "<string>",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"source_platform": "RAZORPAY",
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE"
}
]
},
"exemption_type": "PURPOSE_RESALE",
"parent_invoice_id": "<string>"
},
"message": "Successfully created transaction."
}