/api/customers/
Parameters for GET Queries
PARAMETER NAME | TYPE | DESCRIPTION | REQUIRED |
---|---|---|---|
keyword | String | Part of Customer Name/Code | |
sortBy | String | ||
noSuppliers | boolean | Don’t Show Suppliers | |
includeEmployees | boolean | Include Employees | |
noCustomers | boolean | Don’t Show Customers | |
start | int | ||
limit | int |
Response
FIELD NAME | TYPE | DESCRIPTION | REQUIRED | |
---|---|---|---|---|
CustomerInfo | id | long | Customer ID (internal) | |
CustomerInfo | name | String | Customer Name | |
CustomerInfo | code | String | Customer Code | |
CustomerInfo | registrationCode | String | Customer Registration Code | |
CustomerInfo | legalAddress | String | Customer Legal Address | |
CustomerInfo | legalCountryCode | String | Customer Country Code | |
CustomerInfo | legalPostcode | String | Customer Legal Postcode | |
CustomerInfo | deadlineDays | int | Days to Deadline | |
CustomerInfo | discount | BigDecimal | Customer Discont Percent | |
CustomerInfo | penalty | BigDecimal | Customer Penalty Percent | |
CustomerInfo | referenceNumber | String | Customer Reference Number | |
CustomerInfo | supplierReferenceNumber | String | Supplier Reference Number | |
CustomerInfo | vatNumber | String | Customer VAT Nr | |
CustomerInfo | actualAddress | String | Customer Actual Address | |
CustomerInfo | actualPostcode | String | Customer Actual Postcode | |
CustomerInfo | actualCountryCode | String | Customer Actual Country Code | |
CustomerInfo | String | Customer E-mail | ||
CustomerInfo | phone1 | String | Customer phone1 | |
CustomerInfo | phone2 | String | Customer phone2 | |
CustomerInfo | fax | String | Customer fax | |
CustomerInfo | website | String | Customer Website | |
CustomerInfo | contactPersonId | long | Contact Person ID | |
CustomerInfo | contactPersonName | String | Contact Person Name | |
CustomerInfo | contactPersonEmail | String | Contact Person E-mail | |
CustomerInfo | contactPersonPhone | String | Contact Person Phone | |
CustomerInfo | info | String | Customer Info | |
CustomerInfo | partnerCustomerId | String | Customer ID (from ERPLY) | |
CustomerInfo | partnerSupplierId | String | Supplier ID (from ERPLY) | |
CustomerInfo | bankName | String | Bank Name | |
CustomerInfo | bankAccountNumber | String | Bank Account Number | |
CustomerInfo | bankIban | String | Bank IBAN | |
CustomerInfo | bankSwift | String | Bank Swift | |
CustomerInfo | bankIdentificator | String | Bank Identificatior | |
CustomerInfo | customer | boolean | Is Customer? | |
CustomerInfo | supplier | boolean | Is Supplier? | |
CustomerInfo | entityTypeCode | String | ENTITY_TYPE |
Examples
GET
Using this request with the optional keyword parameter:https://api.erplybooks.com/api/customers
Returns clients in an array.
PUT
Used to update data.
The id in the URL and JSON component must match. Both id and name are required fields.
https://api.erplybooks.com/api/customers/992205
JSON: {"id":992205,"name":"Aita-Leida Kuusepuu", "legalAddress":"Uus Aadress 14"}
POST
Used to create new customers.
Id must be 0! All id’s are generated automatically.
https://api.erplybooks.com/api/customers
JSON: {"id":0, "name":"Aita-Leida Jõgi", "code":null, "registrationCode":null, "legalAddress":"Uus Aadress 14", "legalCountryCode":null, "legalPostcode":null, "deadlineDays":0, "discount":0.0000, "penalty":0.0000, "referenceNumber":null, "supplierReferenceNumber":null, "vatNumber":null, "actualAddress":null, "actualPostcode":null, "actualCountryCode":null, "email":null, "phone1":null, "phone2":null, "fax":null, "website":null, "contactPersonId":0, "contactPersonName":null, "contactPersonEmail":null, "contactPersonPhone":null, "info":null, "partnerCustomerId":null, "partnerSupplierId":null, "bankName":null, "bankAccountNumber":null, "bankIban":null, "bankSwift":null, "bankIdentificator":null, "customer":false, "supplier":false, "entityTypeCode":"ENTITY_TYPE_LEGAL"}