(Quick Reference)
42 Assign customers to tax Lists - Reference Documentation
Version: 2.1
42 Assign customers to tax Lists
42.1 List
Service: List
Description: This web service return the list of customer tax list in JSON format
URL:
https://BASE_URL/api/VERSION/customerTaxLists
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results | Integer | No | |
| max | limits the number of resources requested to return | Integer | No | |
| sort | Orders the results by the specified field | String | No | |
| order | Orders ascending (ASC) or descending DESC | Integer | No | asc, desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| customer.reference | Wildcard search by the resource's reference | String | no | customer.reference=Ref-6* , customer.reference=*ef-6 , customer.reference=*ef-6* |
| taxListReference | Wildcard search by the resource's reference | String | no | taxListReference=Ref-6* , taxListReference=*ef-6 , taxListReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 161,
"customerReference": "C-001",
"taxListReference": "RT-007",
"customer": {
"id": 1334,
"reference": "C-001",
"name": "cus1",
"href": "/api/v1/customers/1334"
},
"taxList": {
"id": 11,
"reference": "RT-007",
"name": "new Tx1",
"href": "/api/v1/taxLists/11"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T08:33:51Z",
"lastUpdated": "2016-08-24T08:33:51Z"
},
{
"id": 162,
"customerReference": "C-003",
"taxListReference": "RT-2",
"customer": {
"id": 1336,
"reference": "C-003",
"name": "cus3",
"href": "/api/v1/customers/1336"
},
"taxList": {
"id": 12,
"reference": "RT-2",
"name": "Tx2",
"href": "/api/v1/taxLists/12"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T08:33:56Z",
"lastUpdated": "2016-08-24T08:33:56Z"
},
{
"id": 163,
"customerReference": "C-001",
"taxListReference": "RT-22",
"customer": {
"id": 1334,
"reference": "C-001",
"name": "cus1",
"href": "/api/v1/customers/1334"
},
"taxList": {
"id": 13,
"reference": "RT-22",
"name": "Tx22",
"href": "/api/v1/taxLists/13"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T08:33:59Z",
"lastUpdated": "2016-08-24T08:33:59Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}42.2 Show
Service: Show
Description: This web service return an existing customer taxList of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerTaxLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted customer tax list | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerTaxLists/reference/{customerId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"id": 163,
"customerReference": "C-001",
"taxListReference": "RT-22",
"customer": {
"id": 1334,
"reference": "C-001",
"name": "cus1",
"href": "/api/v1/customers/1334"
},
"taxList": {
"id": 13,
"reference": "RT-22",
"name": "Tx22",
"href": "/api/v1/taxLists/13"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T08:33:59Z",
"lastUpdated": "2016-08-24T08:33:59Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer tax list with the id 999 doesn't exist."
}42.3 Delete
Service: Delete
Description: This web service is used in order to delete an existing customer tax list object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerTaxLists/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the desired record to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerTaxLists/reference/{customerId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer tax list with the id 444 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}42.4 Update
Service: Update
Description: This web service is used to update an existing customerTaxList object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerTaxLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long | Yes | 111 |
| taxListId | the id of the tax list to be assigned | Long | Yes | 777 |
| customerId | id of the customer to assign | Long | Yes | 123 |
URL with external_id:
https://BASE_URL/api/VERSION/customerTaxLists/reference/{customerId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=201
{
"id": 164,
"customerReference": "C-002",
"taxListReference": "RT-23",
"customer": {
"id": 1335,
"reference": "C-002",
"name": "cus2",
"href": "/api/v1/customers/1335"
},
"taxList": {
"id": 14,
"reference": "RT-23",
"name": "Tx22",
"href": "/api/v1/taxLists/14"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:33:41Z",
"lastUpdated": "2016-08-24T09:35:31Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "taxListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer is already assigned to taxList."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error":"invalid_param_type",
"error_description": "The type of parameter taxListId you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The taxList with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}42.5 Create
Service: Save
Description: This web service is used to add a new customerTaxList object into the database
URL:
https://BASE_URL/api/VERSION/customerTaxLists
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| taxListId | the id of the tax list to be assigned | Long/String | Yes | 777 |
| customerId | id of the customer to assign | Long/String | Yes | 123 |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output
Success case: response.status=201
{
"id": 164,
"customerReference": "C-001",
"taxListReference": "RT-23",
"customer": {
"id": 1334,
"reference": "C-001",
"name": "cus1",
"href": "/api/v1/customers/1334"
},
"taxList": {
"id": 14,
"reference": "RT-23",
"name": "Tx22",
"href": "/api/v1/taxLists/14"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:33:41Z",
"lastUpdated": "2016-08-24T09:33:41Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "taxListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer is already assigned to taxList."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"error":"invalid_param_type",
"error_description": "The type of parameter taxListId you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The taxList with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
