(Quick Reference) Service: Save

Description: This web service is used to add a new customerTaxList object into the database



Method: POST

Request content type: application/json


NameDescriptionTypeRequiredExample values
taxListIdthe id of the tax list to be assignedLong/StringYes777
customerIdid of the customer to assignLong/StringYes123
useExternalIdBy default, it is set to false. set it to true if you want to use external ids.Booleannotrue , 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_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..."