/api/customers/

Parameters for GET Queries

PARAMETER NAMETYPEDESCRIPTIONREQUIRED
keywordStringPart of Customer Name/Code
sortByString
noSuppliersbooleanDon’t Show Suppliers
includeEmployeesbooleanInclude Employees
noCustomersbooleanDon’t Show Customers
startint
limitint

Response

FIELD NAMETYPEDESCRIPTIONREQUIRED
CustomerInfoidlongCustomer ID (internal)
CustomerInfonameStringCustomer Name
CustomerInfocodeStringCustomer Code
CustomerInforegistrationCodeStringCustomer Registration Code
CustomerInfolegalAddressStringCustomer Legal Address
CustomerInfolegalCountryCodeStringCustomer Country Code
CustomerInfolegalPostcodeStringCustomer Legal Postcode
CustomerInfodeadlineDaysintDays to Deadline
CustomerInfodiscountBigDecimalCustomer Discont Percent
CustomerInfopenaltyBigDecimalCustomer Penalty Percent
CustomerInforeferenceNumberStringCustomer Reference Number
CustomerInfosupplierReferenceNumberStringSupplier Reference Number
CustomerInfovatNumberStringCustomer VAT Nr
CustomerInfoactualAddressStringCustomer Actual Address
CustomerInfoactualPostcodeStringCustomer Actual Postcode
CustomerInfoactualCountryCodeStringCustomer Actual Country Code
CustomerInfoemailStringCustomer E-mail
CustomerInfophone1StringCustomer phone1
CustomerInfophone2StringCustomer phone2
CustomerInfofaxStringCustomer fax
CustomerInfowebsiteStringCustomer Website
CustomerInfocontactPersonIdlongContact Person ID
CustomerInfocontactPersonNameStringContact Person Name
CustomerInfocontactPersonEmailStringContact Person E-mail
CustomerInfocontactPersonPhoneStringContact Person Phone
CustomerInfoinfoStringCustomer Info
CustomerInfopartnerCustomerIdStringCustomer ID (from ERPLY)
CustomerInfopartnerSupplierIdStringSupplier ID (from ERPLY)
CustomerInfobankNameStringBank Name
CustomerInfobankAccountNumberStringBank Account Number
CustomerInfobankIbanStringBank IBAN
CustomerInfobankSwiftStringBank Swift
CustomerInfobankIdentificatorStringBank Identificatior
CustomerInfocustomerbooleanIs Customer?
CustomerInfosupplierbooleanIs Supplier?
CustomerInfoentityTypeCodeStringENTITY_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"}