(Quick Reference)
11 Customers - Reference Documentation
Version: 2.1
11 Customers
11.1 List
Service: List of customers Description: This web service returns a list of customers in JSON format URL: https://BASE_URL/api/VERSION/customers : GET Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | | | offset | Tells where to start returning records from the entire set of results. | Integer | no | | | order | Orders ascending or descending. | Integer | no | asc-desc | | sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default. Filter parameters:
| Name | Description | Type | Required | Possible values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | | | 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 | | | reference | Wildcard search by the resource's reference | String | no | reference=*ef-6* | | name | Wildcard search by the resource's name | String | no | | | categoryReference | Wildcard search by the resource's category reference | String | no | categoryReference=Ref-6* , categoryReference=*ef-6 , categoryReference=*ef-6* | | isActive | Filters by the resource's status | Boolean | no | true, false |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output Success case: response.status=200
{
"paging": {
"total": 1019,
"max": 2,
"offset": 0,
"previous": null,
"next": "/api/v1.0/customers?max=2&offset=2&sort=dateCreated&order=asc"
},
"data": [
{
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Home",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": true,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": null,
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": null,
"city": null,
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 3,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "EUR",
"customerRisk": null,
"customerRiskColor": null,
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2015-12-17T23:00:00Z",
"region": null
},
…
]
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
If geographical locations is activated in organization, region field will be returned.
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.png 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..."
}11.2 Show
Service: Show a customer Description: Returns the requested customer in json format when successful. Returns a json response, describing the failure condition when unsuccessful. URL: https://BASE_URL/api/VERSION/customers/{id}: https://BASE_URL/api/VERSION/customers/reference/{id}: GET Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired customer | Long/String | yes | 123 |
Success Output Success case: response.status=200
{
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Jewelry and accessories",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": true,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": "BASE_URL/entity1-1450169988465/photoCustomer/1471338230737_logo_color_272x92dp.png",
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": null,
"city": null,
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 7,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [{
"id": 7,
"reference": "cash",
"name": "cash",
"href": "/api/v1.0/paymentTypes/7"
},
{
"id": 8,
"reference": "cheque",
"name": "cheque",
"href": "/api/v1.0/paymentTypes/8"
}
],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "EUR",
"customerRisk": null,
"customerRiskColor": null,
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2016-08-16T09:02:13Z"
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.png 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 with the id 2559 doesn't exist."
}11.3 Create
Service: Create a customer Description: Returns the created customer in json format when successful. Returns a json response, describing the failure condition when unsuccessful. URL: https://BASE_URL/api/VERSION/customers : POST Request content type: application/x-www-form-urlencoded or multipart/form-data Parameters: | Name | Description | Type | Required | Example values |
|---|
| reference | | String | yes | | | name | | String | yes | | | reference2 | | String | no | | | barcode | | String | no | | | isActive | By default, it is set to true | Boolean | no | true, false | | categoryId | The ID of the customer category. By default, if this parameter is not specified, customer will be added to the root customer category. | Long/String | - | | | isSubCustomer | By default, it is equal to false | Boolean | no | true, false | | parentCustomer | Identifier of parent customer. Required if isSubCustomer is equal to true | Long/String | - | | | billWithParent | By default, it is equal to false. | Boolean | no | | | customerSegmentationId | | Long/String | - | | | userId | user who created the customer | Long/String | - | | | isSameAddress | If shipping address is the same as billing address.By default, this parameter is equal to true. | Boolean | no | | | billingCountry | ISO county code or country name of billing | String | no | FR, France | | billingCity | Billing city | String | no | | | billingPostalCode | Billing postal code | String | no | | | billingAddress | Billing address | String | no | | | billingLat | Billing latitude | Double | no | | | billingLng | Billing longitude | Double | no | | | country | ISO county code or country name of shipping | String | no | FR, France | | city | Shipping city | String | no | | | postalCode | Shipping postal code | String | no | | | address | Shipping address | String | no | | | latitude | Shipping latitude | Double | no | | | longitude | Shipping longitude | Double | no | | | email | | String | no | | | phone | | String | no | | | mobile | | String | no | | | fax | | String | no | | | comment | | String | no | | | website | | String | no | | | creditLimit | | Double | no | | | dueDateConfigNumber | Number of days | Integer | required if dueDateConfigType is specified | | | dueDateConfigType | Should be equal to 1 if "after the invoice date" or 2 if "after the end of the invoice month" | String | no | 1 or 2 | | taxNumber | Tax / VAT number | String | no | | | companyRegistrationNumber | Company registration number | String | no | | | currency | ISO code of configured currency(with exchange rate). By default, it is set as the organization currency. | String | no | EUR | | imageFile | Image can be in jpg, gif, png or bmp format | Multipart | no | | | paymentTypes | list of the id of payment type | JSON structure | no | paymentTypes=[{"id"=7},{"id"=8}] | | regionId | the numeric value of the region's ID | Long | no | | | customerRisk | | String | no | | | customerRiskColor | | String | no | #FFFFFF, #1BE9D8 | | onHold | By default, it is set to false | Boolean | no | true, false | | onHoldReason | | String | no | | | useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Reference must be unique
Region is used only if geographical locations is activated, it should be at the same level as the configured level in organization, or below (sub-levels). Success Output Success case: response.status=201 {
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Jewelry and accessories",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": true,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": "BASE_URL/entity1-1450169988465/photoCustomer/1471338230737_logo_color_272x92dp.png",
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": null,
"city": null,
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 7,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [
{
"id": 7,
"reference": "cash",
"name": "cash",
"href": "/api/v1.0/paymentTypes/7"
},
{
"id": 8,
"reference": "cheque",
"name": "cheque",
"href": "/api/v1.0/paymentTypes/8"
}
],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "USD",
"customerRisk": null,
"customerRiskColor": null,
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2015-12-17T23:00:00Z",
"region": {
"id": 3,
"name" : "New York",
"href": "/api/v1.0/regions/3"
}
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.png Failure Output Failure case:response.status = 400 {
"error": "missing_param",
"error_description": "reference parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error":"invalid_param_type",
"error_description": "The type of parameter payment type id you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "exceeded_file_size",
"error_description": "image size should not exceed 2Mo"
}{
"error": "unsupported_file_type",
"error_description": "image format not supported."
} Failure case:response.status = 404 {
"error":"not_found",
"error_description": "The payment type with the id 999 doesn't exist."
}{
"error": "not_found",
"error_description": "The currency with name GmBP doesn't exist."
}{
"error": "not_found",
"error_description": "The currency with name GBP is not configured."
}{
"error": "not_found",
"error_description": "The parent customer with the id 188911 doesn't exist."
} Failure case:response.status = 500 {
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}11.4 Update
Service: Update a customer, this API can be used to update resources partially. Description: Returns the updated customer in json format when successful. Returns a json response, describing the failure condition when unsuccessful. URL: https://BASE_URL/api/VERSION/customers/{id}: https://BASE_URL/api/VERSION/customers/reference/{id}: POST Request content type: application/x-www-form-urlencoded or multipart/form-data Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired customer | Integer/String | yes | 123 | | reference | | String | no | | | name | | String | no | | | reference2 | | String | no | | | barcode | | String | no | | | isActive | By default, it is set to true | Boolean | no | true, false | | categoryId | The ID of the customer category. By default, if this parameter is not specified, customer will be added to the root customer category. | Long/String | - | | | isSubCustomer | By default, it is equal to false | Boolean | no | true, false | | parentCustomer | Identifier of parent customer. Required if isSubCustomer is equal to true | Long/String | - | | | billWithParent | By default, it is equal to false. | Boolean | no | | | customerSegmentationId | | Long/String | - | | | userId | User who created the customer | Long/String | - | | | isSameAddress | If shipping address is the same as billing address.By default, this parameter is equal to true. | Boolean | no | | | billingCountry | ISO county code or country name of billing | String | no | FR, France | | billingCity | Billing city | String | no | | | billingPostalCode | Billing postal code | String | no | | | billingAddress | Billing address | String | no | | | billingLat | Billing latitude | Double | no | | | billingLng | Billing longitude | Double | no | | | country | ISO county code or country name of shipping | String | no | FR, France | | city | Shipping city | String | no | | | postalCode | Shipping postal code | String | no | | | address | Shipping address | String | no | | | latitude | Shipping latitude | Double | no | | | longitude | Shipping longitude | Double | no | | | email | | String | no | | | phone | | String | no | | | mobile | | String | no | | | fax | | String | no | | | comment | | String | no | | | website | | String | no | | | creditLimit | | Double | no | | | dueDateConfigNumber | Number of days | Integer | required if dueDateConfigType is specified | | | dueDateConfigType | Should be equal to 1 if "after the invoice date" or 2 if "after the end of the invoice month" | String | no | 1 or 2 | | taxNumber | Tax / VAT number | String | no | | | companyRegistrationNumber | Company registration number | String | no | | | currency | ISO code of configured currency. By default, it is set as the organization currency. | String | no | EUR | | imageFile | Image can be in jpg, gif, png or bmp format | Multipart | no | | | paymentTypes | list of the id of payment type | JSON structure | no | paymentTypes=[{"id"=7},{"id"=8}] | | regionId | the numeric value of the region's ID | Long | no | | | customerRisk | | String | no | | | customerRiskColor | | String | no | #FFFFFF, #1BE9D8 | | onHold | By default, it is set to false | Boolean | no | true, false | | onHoldReason | | String | no | |
Region is used only if geographical locations is activated, it should be at the same level as the configured level in organization, or below (sub-levels).
Success Output Success case: response.status=200 {
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Jewelry and accessories",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": true,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": "BASE_URL/entity1-1450169988465/photoCustomer/1471338230737_logo_color_272x92dp.png",
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": null,
"city": null,
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 7,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [
{
"id": 7,
"reference": "cash",
"name": "cash",
"href": "/api/v1.0/paymentTypes/7"
},
{
"id": 8,
"reference": "cheque",
"name": "cheque",
"href": "/api/v1.0/paymentTypes/8"
}
],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "USD",
"customerRisk": null,
"customerRiskColor": null,
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2016-08-16T09:02:13Z",
"region": {
"id": 2,
"name": "California",
"href": "/api/v1.0/regions/2"
}
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.png Failure Output Failure case:response.status = 400 {
"error": "missing_param",
"error_description": "reference parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error":"invalid_param_type",
"error_description": "The type of parameter payment type id you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "exceeded_file_size",
"error_description": "image size should not exceed 2Mo"
}{
"error": "unsupported_file_type",
"error_description": "image format not supported."
} Failure case:response.status = 404 {
"error":"not_found",
"error_description": "The payment type with the id 999 doesn't exist."
}{
"error": "not_found",
"error_description": "The customer cannot be a subcustomer of itself."
}{
"error": "not_found",
"error_description": "The parent customer with the id 188911 doesn't exist."
} Failure case:response.status = 500 {
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}11.5 Upsert
Service: Upsert a customer Description: This web service is used to insert a customer to the database if it does not already exist, or update it. URL: https://BASE_URL/api/VERSION/customers/reference/{id}: POST Request content type: application/x-www-form-urlencoded or multipart/form-data Parameters: | Name | Description | Type | Required | Example values |
|---|
| name | | String | yes | | | barcode | | String | no | | | isActive | By default, it is set to true | Boolean | no | true, false | | categoryId | The ID of the customer category. By default, if this parameter is not specified, customer will be added to the root customer category. | String | - | | | isSubCustomer | By default, it is equal to false | Boolean | no | true, false | | parentCustomer | Identifier of parent customer. Required if isSubCustomer is equal to true | Long/String | - | | | billWithParent | By default, it is equal to false. | Boolean | no | | | customerSegmentationId | | String | - | | | userId | user who created the customer | String | - | | | isSameAddress | If shipping address is the same as billing address.By default, this parameter is equal to true. | Boolean | no | | | billingCountry | ISO county code or country name of billing | String | no | FR, France | | billingCity | Billing city | String | no | | | billingPostalCode | Billing postal code | String | no | | | billingAddress | Billing address | String | no | | | billingLat | Billing latitude | Double | no | | | billingLng | Billing longitude | Double | no | | | country | ISO county code or country name of shipping | String | no | FR, France | | city | Shipping city | String | no | | | postalCode | Shipping postal code | String | no | | | address | Shipping address | String | no | | | latitude | Shipping latitude | Double | no | | | longitude | Shipping longitude | Double | no | | | email | | String | no | | | phone | | String | no | | | mobile | | String | no | | | fax | | String | no | | | comment | | String | no | | | website | | String | no | | | creditLimit | | Double | no | | | dueDateConfigNumber | Number of days | Integer | required if dueDateConfigType is specified | | | dueDateConfigType | Should be equal to 1 if "after the invoice date" or 2 if "after the end of the invoice month" | String | no | 1 or 2 | | taxNumber | Tax / VAT number | String | no | | | companyRegistrationNumber | Company registration number | String | no | | | currency | ISO code of configured currency. By default, it is set as the organization currency. | String | no | EUR | | imageFile | Image can be in jpg, gif, png or bmp format | Multipart | no | | | paymentTypes | list of the id of payment type | JSON structure | no | paymentTypes=[{"id"=7},{"id"=8}] | | regionId | the numeric value of the region's ID | Long | no | | | customerRisk | | String | no | | | customerRiskColor | | String | no | #FFFFFF, #1BE9D8 | | onHold | By default, it is set to false | Boolean | no | true, false | | onHoldReason | | String | no | |
Reference must be unique
Region is used only if geographical locations is activated, it should be at the same level as the configured level in organization, or below (sub-levels). Success Output Success case: response.status=201 {
"id": 256,
"reference": "NC-3",
"reference2": null,
"name": "Marie's Jewelry",
"categoryReference": "jewelry",
"customerCategory": {
"id": 2,
"reference": "jewelry",
"name": "Jewelry and accessories",
"href": "/api/v1.0/customerCategories/2"
},
"isSubCustomer": false,
"parentCustomer": null,
"billWithParent": false,
"customerSegmentationReference": "seg_a",
"customerSegmentation": {
"id": 1,
"reference": "seg_a",
"name": "Segmentation A",
"href": "/api/v1.0/customerSegmentations/1"
},
"pocTenus": null,
"email": null,
"logo": "BASE_URL/entity1-1450169988465/photoCustomer/1471338230737_logo_color_272x92dp.png",
"phone": null,
"mobile": null,
"fax": null,
"comment": null,
"barcode": null,
"isSameAddress": true,
"billingCountry": "FR",
"billingCity": "Nice",
"billingPostalCode": null,
"billingAddress": null,
"billingLat": null,
"billingLng": null,
"country": null,
"city": null,
"postalCode": null,
"address": null,
"latitude": null,
"longitude": null,
"isCredit": null,
"creditLimit": 5000,
"balance": null,
"maxChequePeriod": null,
"maxChequeValue": null,
"appliedCashBackOutput": null,
"returnDiscount": null,
"invoicesPerRoute": null,
"isActive": true,
"onHold": false,
"onHoldReason": null,
"paymentTerm": null,
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/api/v1.0/users/2"
},
"dueDateConfigNumber": 7,
"dueDateConfigType": "daysAfterInvoiceDate",
"paymentTypes": [
{
"id": 7,
"reference": "cash",
"name": "cash",
"href": "/api/v1.0/paymentTypes/7"
},
{
"id": 8,
"reference": "cheque",
"name": "cheque",
"href": "/api/v1.0/paymentTypes/8"
}
],
"website": null,
"taxNumber": null,
"companyRegistrationNumber": null,
"contacts": [],
"currency": "EUR",
"customerRisk": null,
"customerRiskColor": null,
"organization": "entity1",
"dateCreated": "2015-12-17T23:00:00Z",
"lastUpdated": "2015-12-17T23:00:00Z",
"region": {
"id": 3,
"name": "New York",
"href": "/api/v1.0/regions/3"
}
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/entity1-1450169988465/photoCustomer/small_471338230737_logo_color_272x92dp.png Failure Output Failure case:response.status = 400 {
"error": "missing_param",
"error_description": "reference parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error":"invalid_param_type",
"error_description": "The type of parameter payment type id you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "exceeded_file_size",
"error_description": "image size should not exceed 2Mo"
}{
"error": "unsupported_file_type",
"error_description": "image format not supported."
} Failure case:response.status = 404 {
"error":"not_found",
"error_description": "The payment type with the id 999 doesn't exist."
} Failure case:response.status = 500 {
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}11.6 Delete
Service: Delete a customer Description: this web service is used in order to delete an existing customer URL: https://BASE_URL/api/VERSION/customers/{id}: https://BASE_URL/api/VERSION/customers/reference/{id}: DELETE Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired customer | Long/String | yes | 123 |
Success Output Success case: response.status=200 {
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}{
"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 with the id 32987 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
|
|
