(Quick Reference)

41 Taxes - Reference Documentation

Version: 2.1

41.1List

41.2Show

41.3Create

41.4Update

41.5Upsert

41.6Delete

41 Taxes

41.1 List

Service: List taxes

Description: This web service return the list of taxes in JSON format.

URL:

https://BASE_URL/api/VERSION/taxes

Method: 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 or descending	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
itemReference	Wildcard search by the item's reference	String	no	itemReference=Ref-6*
taxListReference	Wildcard search by the tax-list's reference	String	no

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
  "paging": {
    "total": 780,
    "max": 5,
    "offset": 0,
    "previous": null,
    "next": "/api/v1.0/taxes?max=5&offset=5&sort=dateCreated&order=asc"
  },
  "data": [
    {
      "id": 1367,
      "itemReference": "bracelet-GRP09062",
      "item": {
        "id": 519,
        "reference": "bracelet-GRP09062",
        "name": "Knot Band Bracelet",
        "href": "/api/v1.0/items/519"
      },
      "taxListReference": "20_tax_list",
      "taxList": {
        "id": 7,
        "reference": "20_tax_list",
        "name": "VAT 20%",
        "href": "/api/v1.0/taxLists/7"
      },
      "taxValue": 24,
      "organization": "entity1",
      "dateCreated": "2016-02-10T13:36:18Z",
      "lastUpdated": "2016-02-10T13:36:18Z"
    }
  ]
}

Failure Output

Failure case:response.status = 400

{
   "error": "invalid_param",
   "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}

Failure case:response.status = 500

{
   "error": "server_error",
   "error_description": "Oops! Something went wrong..."
}

41.2 Show

Service: Show a tax

Description: This web service return an existing tax of the specified id in JSON format

Method: GET

URL:

https://BASE_URL/api/VERSION/taxes/{id}

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired tax	Long	Yes	777

URL with external_id:

https://BASE_URL/api/VERSION/taxes/reference/{itemListId}/{itemId}

Parameters:

Name	Description	Type	Required	Examples values
itemId	reference of the item	String	No	eliteBook_820
taxListId	reference of the tax list	String	Yes	TL-001

Success Output

Success case: response.status=200

{
  "id": 1367,
  "itemReference": "bracelet-GRP09062",
  "item": {
    "id": 519,
    "reference": "bracelet-GRP09062",
    "name": "Knot Band Bracelet",
    "href": "/api/v1.0/items/519"
  },
  "taxListReference": "20_tax_list",
  "taxList": {
    "id": 7,
    "reference": "20_tax_list",
    "name": "VAT 20%",
    "href": "/api/v1.0/taxLists/7"
  },
  "taxValue": 24,
  "organization": "entity1",
  "dateCreated": "2016-02-10T13:36:18Z",
  "lastUpdated": "2016-02-10T13:36:18Z"
}

Failure Output

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The tax with the id 10 doesn't exist."
}

Failure case:response.status = 400

{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}

41.3 Create

Service: Create a tax

Description: Returns the created tax in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/taxes

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
itemId	The ID of item. Required if tax type of list is not `Fixed amount`	Long/String	-
taxListId	The ID of tax-list	Long/String	yes
taxValue	The tax value	Double	yes
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

Status: HTTP/1.1 201 Created

{
  "id": 1367,
  "itemReference": "bracelet-GRP09062",
  "item": {
    "id": 519,
    "reference": "bracelet-GRP09062",
    "name": "Knot Band Bracelet",
    "href": "/api/v1.0/items/519"
  },
  "taxListReference": "20_tax_list",
  "taxList": {
    "id": 7,
    "reference": "20_tax_list",
    "name": "VAT 20%",
    "href": "/api/v1.0/taxLists/7"
  },
  "taxValue": 24,
  "organization": "entity1",
  "dateCreated": "2016-02-10T13:36:18Z",
  "lastUpdated": "2016-02-10T13:36:18Z"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

{
  "error": "not_unique",
  "error_description": "tax already used"
}

{
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: taxValue (must be positive)"
}

Status: HTTP/1.1 404 Not Found

{
  "error": "not_found",
  "error_description": "The item with the id 4945 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The taxList with the id 457 doesn't exist."
}

41.4 Update

Service: Update a tax

Description: Returns the updated tax in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

Method: PUT

Request content type: application/json

URL:

https://BASE_URL/api/VERSION/taxes/{id}

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired tax	Long	yes	123
itemId	The numerical ID of item. Required if tax type of list is not `Fixed amount`	Long	-
taxListId	The numerical ID of tax-list	Long	yes
taxValue	The tax value	Double	yes
useExternalId	By default, it is set to false. set it to true if you want to use external ids.	Boolean	no	true , false

URL with external_id:

https://BASE_URL/api/VERSION/taxes/reference/{itemListId}/{itemId}

Parameters:

Name	Description	Type	Required	Examples values
itemId	reference of the item	String	No	eliteBook_820
taxListId	reference of the tax list	String	Yes	TL-001
taxValue	The tax value	Double	yes

Success Output

Status: HTTP/1.1 200 OK

{
  "id": 1367,
  "itemReference": "bracelet-GRP09062",
  "item": {
    "id": 519,
    "reference": "bracelet-GRP09062",
    "name": "Knot Band Bracelet",
    "href": "/api/v1.0/items/519"
  },
  "taxListReference": "20_tax_list",
  "taxList": {
    "id": 7,
    "reference": "20_tax_list",
    "name": "VAT 20%",
    "href": "/api/v1.0/taxLists/7"
  },
  "taxValue": 24,
  "organization": "entity1",
  "dateCreated": "2016-02-10T13:36:18Z",
  "lastUpdated": "2016-02-10T14:40:00Z"
}

Failure Output

Status: HTTP/1.1 404 Not Found

{
  "error": "not_found",
  "error_description": "The tax with the id 70 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The item with the id 4945 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The taxList with the id 457 doesn't exist."
}

Status: HTTP/1.1 400 Bad Request

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

{
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: taxValue (must be a Double)"
}

41.5 Upsert

Service: Upsert a tax

Description: This web service is used to insert a tax object to the database if it does not already exist, or update it.

URL with external_id:

https://BASE_URL/api/VERSION/taxes/reference/{taxListId}/{itemId}

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
itemId	The ID of item. Required if tax type of list is not `Fixed amount`	Long/String	-
taxListId	The ID of tax-list	Long/String	yes
taxValue	The tax value	Double	yes
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

Status: HTTP/1.1 201 Created

{
  "id": 1367,
  "itemReference": "bracelet-GRP09062",
  "item": {
    "id": 519,
    "reference": "bracelet-GRP09062",
    "name": "Knot Band Bracelet",
    "href": "/api/v1.0/items/519"
  },
  "taxListReference": "20_tax_list",
  "taxList": {
    "id": 7,
    "reference": "20_tax_list",
    "name": "VAT 20%",
    "href": "/api/v1.0/taxLists/7"
  },
  "taxValue": 24,
  "organization": "entity1",
  "dateCreated": "2016-02-10T13:36:18Z",
  "lastUpdated": "2016-02-10T13:36:18Z"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

{
  "error": "not_unique",
  "error_description": "tax already used"
}

{
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: taxValue (must be positive)"
}

Status: HTTP/1.1 404 Not Found

{
  "error": "not_found",
  "error_description": "The item with the id 4945 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The taxList with the id 457 doesn't exist."
}

41.6 Delete

Service: Delete a tax

Description: Returns a json response.

Method: DELETE

URL:

https://BASE_URL/api/VERSION/taxes/{id}

Parameters:

Name	Description	Type	Required	Example values
id	The numerical ID of the desired tax	Long	yes	123

URL with external_id:

https://BASE_URL/api/VERSION/taxes/reference/{itemListId}/{itemId}

Parameters:

Name	Description	Type	Required	Examples values
itemId	reference of the item	String	No	eliteBook_820
taxListId	reference of the tax list	String	Yes	TL-001

Success Output

Status: HTTP/1.1 200 OK

{
  "success": "true",
  "success_description": "Instance deleted successfully"
}

Failure Output

Status: HTTP/1.1 400 Bad Request

{
  "error": "delete_failed",
  "error_description": "Failed to delete instance."
}

Status: HTTP/1.1 404 Not Found

{
  "error": "not_found",
  "error_description": "The tax with the id 70 doesn't exist."
}

<< 40Tax Types

42Assign customers to tax Lists >>

41 Taxes - Reference Documentation

Table of Contents

41 Taxes

41.1 List

Success Output

Failure Output

41.2 Show

Success Output

Failure Output

41.3 Create

Success Output

Failure Output

41.4 Update

Success Output

Failure Output

41.5 Upsert

Success Output

Failure Output

41.6 Delete

Success Output

Failure Output

Answers

Appointment

Appointment Categories

Attribute values

Attributes

Authentication

Authority

Check In List

Contacts

Customer Categories

Customer Categories Discount Lists

Customer Categories Price Lists

Customer Categories Tax Lists

Customer Discounts

Customer Employee

Customer Group Promotion Lists

Customer Groups

Customer Groups Assign

Customer Price List

Customer Promo List

Customer Segmentations

Customer Tax List

Customers

Deliveries

Discount lists

Employee Groups

Employee Item Category Assign

Employee WareHouses

Employees

Exchange rates

Item Categories

Item Groups

Item Groups Assign

Item attributes

Item category translation

Item customer groups assign

Item group translation

Item translation

Item units

Items

Loading details

Loadings

Objectives

Operation Prepayments

Operation lines

Operation payments

Operations

Payment types

Prepayment Allocations

Price List

Prices

Promotion inputs

Promotion outputs

Promotions

Question Columns

Question Lines

Question options

Questions

Reasons