Upsert VAT / GT Transactio
PUT/v1/transactions/source/{source}/externalId/{externalId}Update or Insert Transaction by External ID and source
Request
Path Params
externalId
string
required
External ID
Example:
{{transactionExternalId}}
source
string
required
Transaction Source (should be [1-9])
Example:
{{source}}
Match pattern:
[1-9]
Body Params application/json
No schema defined
Example
{
"externalId": "{{transactionExternalId}}",
"source": "9",
"items": [
{
"unitPrice": 100,
"quantity": 1,
"totalPrice": 100,
"description": "string",
"name": "string",
"taxCode": "C1S1",
"manualSalesTax": false,
"manualSalesTaxRate": 0
}
],
"billingAddress": {
"city": "",
"country": "US",
"county": null,
"state": "CA",
"street": "3098 N Remington Ave",
"zip": "93711-5508",
"region": "string",
"isPartial": false
},
"shippingAddress": {
"country": "Canada",
"region": "Quebec"
},
"customerId": "{{customerComplytId}}",
"externalTimestamps": {
"createdDate": "2023-02-05T12:24:43.193Z",
"updatedDate": "2023-02-05T12:24:43.193Z"
},
"transactionStatus": "ACTIVE",
"transactionType": "INVOICE",
"createdFrom": "string",
"transactionFilingStatus": "NOT_FILED"
}Request samples
Responses
Successful operation(200)
Successful operation(201)
Something is wrong with your request(400)
Unauthorized(401)
Forbidden(403)
Transaction Not Found(404)
Internal Error(500)
Successful operation
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
{
"complytId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "999444",
"source": "1",
"items": [
{
"unitPrice": 0,
"quantity": 0,
"totalPrice": 0,
"calculatedTotal":0,
"discount":0,
"description": "string",
"name": "string",
"taxCode": "string",
"jurisdictionalSalesTaxRules": {
"name": "string",
"abbreviation": "string",
"taxable": true,
"specialTreatment": true,
"calculationType": "FIXED",
"description": "string",
"calculationValue": 0,
"cities": null,
"regions":null
},
"salesTaxRates": {
"cityDistrictRate": 0,
"cityRate": 0,
"countyDistrictRate": 0,
"countyRate": 0,
"stateRate": 0,
"taxRate": 0
},
"gtRates": {
"countryRate": 0,
"regionRate": 0,
"taxRate": 0
},
"manualSalesTax": true,
"manualSalesTaxRate": 0,
"tangibleCategory": "TANGIBLE",
"taxableCategory": "TAXABLE"
}
],
"billingAddress": {
"city": "string",
"country": "string",
"county": "string",
"state": "string",
"street": "string",
"zip": "string",
"isPartial": false
},
"shippingAddress": {
"city": "string",
"country": "string",
"county": "string",
"state": "string",
"street": "string",
"zip": "string",
"region":"string",
"isPartial": false
},
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer": {
"complytId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "string",
"source": "7",
"name": "string",
"address": {
"city": "string",
"country": "string",
"county": "string",
"state": "string",
"street": "string",
"zip": "string",
"isPartial": false
},
"email": "example@some.mail.com",
"customerType": "RETAIL",
"internalTimestamps": {
"createdDate": "2023-02-05T12:24:43.193Z",
"updatedDate": "2023-02-05T12:24:43.193Z"
},
"externalTimestamps": {
"createdDate": "2023-02-05T12:24:43.193Z",
"updatedDate": "2023-02-05T12:24:43.193Z"
}
},
"salesTax": {
"amount": 0,
"taxRate": 0,
"salesTaxRates": {
"cityDistrictRate": 0,
"cityRate": 0,
"countyDistrictRate": 0,
"countyRate": 0,
"stateRate": 0,
"taxRate": 0
},
"gtRates": {
"countryRate": 0,
"regionRate": 0,
"taxRate": 0
},
},
"transactionStatus": "ACTIVE",
"internalTimestamps": {
"createdDate": "2023-02-05T12:24:43.193Z",
"updatedDate": "2023-02-05T12:24:43.193Z"
},
"externalTimestamps": {
"createdDate":"2023-02-05T12:24:43.193Z",
"updatedDate": "2023-02-05T12:24:43.193Z"
},
"transactionType": "SALES_ORDER",
"shippingFee": {
"manualSalesTax": true,
"manualSalesTaxRate": 0,
"totalPrice": 0,
"calculatedTotal":0,
"taxCode": "string",
"taxableCategory": "TAXABLE",
"tangibleCategory": "TANGIBLE",
"jurisdictionalSalesTaxRules": {
"name": "string",
"abbreviation": "string",
"taxable": true,
"specialTreatment": true,
"calculationType": "FIXED",
"description": "string",
"calculationValue": 0,
"cities": null
},
"salesTaxRates": {
"cityDistrictRate": 0,
"cityRate": 0,
"countyDistrictRate": 0,
"countyRate": 0,
"stateRate": 0,
"taxRate": 0
},
"gtRates": {
"countryRate": 0,
"regionRate": 0,
"taxRate": 0
},
},
"createdFrom": "string",
"taxableItemsAmount": 0,
"tangibleItemsAmount": 0,
"totalItemsAmount": 0,
"totalDiscount" :0,
"transactionFilingStatus": "NOT_FILED"
}
Last modified: a day ago