Resources - Customer register
This resource provides methods for retrieving and creating the data in the Customer register (Asiakasrekisteri) of a Fivaldi company.
GET /customers
This method is used to retrieve a list of customers in the Customer register matching the search criteria. The list contains some basic information about the customer and the free text search criteria (searchWord) applies to these fields. More detailed information for one customer can be retrieved with GET /companies/{cuid}/customers/{id}.
If you need to synchronize the Customer register from Fivaldi to an external system, it is recommended to design the integration logic so that only relevant customers are retrieved using change time date filter (fromDate) to filter out results that have already been retrieved earlier.
Required access level for Partner account: WebService yritysrekisteri - käyttö
GET /customers/{id}
This method is used to retrieve all information for one customer in the Customer register.
Required access level for Partner account: WebService yritysrekisteri - käyttö
GET /customers/getCustomerRegisterBasicDetails
This method is used to retrieve company specific basic details. As Fivaldi allows company specific customization, this method must usually be used to retrieve the configuration used by that company for which Customers are created through the API.
These details are for example Customer groups and segments, accounting dimensions, Posting groups, Delivery terms and methods etc.
Required access level for Partner account: WebService yritysrekisteri - käyttö
POST /customers/createCustomer
This method is used to create a new customer including addresses and bank accounts to Fivaldi Company’s Customer register. Customer id is automatically set by Fivaldi as the next available customer number for that Fivaldi Company.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/updateCustomerAllFields
This method is used to update all existing customer details on Fivaldi Company’s Customer register. Addresses and bank accounts will not be updated with this method, as there is a separate method for that purpose.
Missing properties or null values will delete the existing data in Fivaldi.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/updateCustomer
This method is used to update parts of existing customer details in Fivaldi Company’s Customer register. Addresses and bank accounts will not be updated with this method, as there is a separate method for that purpose. For example with this method only customer name can be updated if it is the only property given
Missing properties or null values will be ignored so the existing data in Fivaldi will not be altered.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/createAddress
This method is used to create a new address for existing customer in Fivaldi Company’s Customer register. Address-id is set automatically by Fivaldi.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/address/{address-id}/updateAddressAllFields
This method is used to update existing customer address details in Fivaldi Company’s Customer register.
Missing properties or null values will delete previous data. Address-id provided in the parameters take precedence over the corresponding object properties in case of conflict.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/createBankAccount
This method is used to create a new bank account for existing customer in Fivaldi Company’s Customer register. Bank account id is set automatically by Fivaldi.
Required access level for Partner account: WebService yritysrekisteri - lisäys
POST /customers/{id}/bank-account/{account-id}/updateBankAccountAllFields
This method is used to update existing customer bank account details in Fivaldi Company’s Customer register.
If IBAN is given, bban and swift will be set based on IBAN. If IBAN is not given, IBAN and swift will be set based on bban.
Missing properties or null values will delete previous data. Accounti-id provided in the parameters take precedence over the corresponding object properties in case of conflict.
Required access level for Partner account: WebService yritysrekisteri - lisäys
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedback