Sales APIs
Deletes specified customer
| HTTP method | DELETE |
| URI | https://api.rambase.net/sales/customers/{customerId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| Successful HTTP status code | 202 |
| API resource identifier | 1855, version 3 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |
| Error 101376 HTTP 400 | ShippingService is not active (status 4) |
| Error 101375 HTTP 400 | Direction of the Shipping Service mismatch with type of transaction document |
| Error 101399 HTTP 400 | Customer account in shipping service mismatch with this customer account |
| Error 101385 HTTP 400 | The carrier that offers this shipping service is not activ (status 4) |
| Error 106505 HTTP 400 | This supplier is used for creating production work orders and can not be deactivated. |
| Error 106931 HTTP 400 | Illegal currency {0}, this currency is not supporterted by companies rate sources |
| Error 110027 HTTP 400 | Confidential type is not active |
| Error 100948 HTTP 400 | Can not deactivate customers with open transaction documents |
| Error 100949 HTTP 400 | Can not delete customers with open transaction documents |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |