(Quick Reference)
43 Assign categories of customers to tax lists - Reference Documentation
Version: 2.1
43 Assign categories of customers to tax lists
43.1 List
Service: List
Description: This web service return the list of customer category assigned to tax lists in JSON format
URL:
https://BASE_URL/api/VERSION/customerCategoryTaxLists
: 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 | |
| customerCategoryReference | Wildcard search by the resource's reference | String | no | customerCategoryReference=Ref-6* , customerCategoryReference=*ef-6 , customerCategoryReference=*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": 11,
"taxListReference": "RT-007",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"taxList": {
"id": 11,
"reference": "RT-007",
"name": "new Tx1",
"href": "/api/v1/taxLists/11"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:21:09Z",
"lastUpdated": "2016-08-25T10:21:09Z"
},
{
"id": 12,
"taxListReference": "RT-007",
"customerCategoryReference": "1111",
"customerCategory": {
"id": 61,
"reference": "1111",
"name": "joe",
"href": "/api/v1/customerCategories/61"
},
"taxList": {
"id": 11,
"reference": "RT-007",
"name": "new Tx1",
"href": "/api/v1/taxLists/11"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:21:11Z",
"lastUpdated": "2016-08-25T10:21:11Z"
},
{
"id": 13,
"taxListReference": "RT-2",
"customerCategoryReference": "102",
"customerCategory": {
"id": 60,
"reference": "102",
"name": "Preferred Customers",
"href": "/api/v1/customerCategories/60"
},
"taxList": {
"id": 12,
"reference": "RT-2",
"name": "Tx2",
"href": "/api/v1/taxLists/12"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:21:16Z",
"lastUpdated": "2016-08-25T10:21:16Z"
}
]
} 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..."
}43.2 Show
Service: Show
Description: This web service return an assigned customer category to a tax list 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 category tax list | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryTaxLists/reference/{customerCategoryId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"id": 11,
"taxListReference": "RT-007",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"taxList": {
"id": 11,
"reference": "RT-007",
"name": "new Tx1",
"href": "/api/v1/taxLists/11"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:21:09Z",
"lastUpdated": "2016-08-25T10:21:09Z"
} 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 category tax list with the id 999 doesn't exist."
}43.3 Create
Service: Save
Description: This web service is used to assign a customer category to a tax list object into the database
URL:
https://BASE_URL/api/VERSION/customerCategoryTaxLists
: 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 |
| customerCategoryId | id of the customer category to assign | Long/String | Yes | 123 |
Success Output
Success case: response.status=201
{
"id": 14,
"taxListReference": "RT-23",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"taxList": {
"id": 14,
"reference": "RT-23",
"name": "Tx22",
"href": "/api/v1/taxLists/14"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:35:24Z",
"lastUpdated": "2016-08-25T10:35:24Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "taxListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer category 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..."
}43.4 Update
Service: Update
Description: This web service is used to update an assigned customer category to a tax list object into the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerCategoryTaxLists
:
| 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 |
| customerCategoryId | id of the customer category to assign | Long | Yes | 123 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryTaxLists/reference/{customerCategoryId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"id": 11,
"taxListReference": "RT-2",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"taxList": {
"id": 12,
"reference": "RT-2",
"name": "Tx2",
"href": "/api/v1/taxLists/12"
},
"organization": "Lyon",
"dateCreated": "2016-08-25T10:21:09Z",
"lastUpdated": "2016-08-25T10:43:51Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "taxListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer category 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..."
}43.5 Delete
Service: Delete
Description: This web service is used in order to dissociate an assigned customer category to tax list object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerCategoryTaxLists/{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/customerCategoryTaxLists/reference/{customerCategoryId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-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..."
}
