This call is deprecated. We recommend to use PIM API instead.
The corresponding new call is: POST /v1/supplier.
Create or update a supplier.
Parameter name | Description | Possible value | Required |
---|---|---|---|
supplierID | Supplier ID. Set this parameter to edit an existing supplier. Omit this parameter to create a new one. | integer | |
groupID | Supplier group ID. Use getSupplierGroups. If not specified, supplier will be assigned to the first supplier group in the list. When updating existing supplier, groupID must not be set to 0. |
integer | |
supplierManagerID | Supplier manager (must be an employee, use getEmployees). | integer | |
***** | If creating a new supplier, use parameter companyName. If creating a new person, use parameters firstName and lastName. Alternatively - if it is necessary to add data where person's name is not split into surname and given names, use parameter fullName. One of three parameters - companyName, lastName, fullName - is required. |
||
companyName | string | ||
companyTypeID | If is not set - company type ID will be calculated by analysing company name for type-related parts. | integer | |
firstName | string | ||
lastName | string | ||
fullName | string | ||
code | National ID number (for persons) / Registry code (for companies). | string | |
companyID | Use to indicate that this person is a contact person / an employee in a particular company.. | integer | |
birthday | Person birthday (not applicable to companies). | Date (yyyy-mm-dd) | |
vatNumber | Supplier's VAT number. | string | |
bankName | Name of supplier's bank. | string | |
bankAccountNumber | Number of supplier's bank account. | string | |
bankIBAN | IBAN number of supplier's bank account. | string | |
bankSWIFT | BIC/SWIFT identifier of supplier's bank account. | string | |
phone | string | ||
mobile | string | ||
fax | string | ||
string | |||
skype | string | ||
website | string | ||
notes | string | ||
integrationCode | Corresponding supplier identifier in a system integrated with Erply (eg. accounting software) | string | |
vatrateID | ID of a VAT rate | integer | |
currencyCode | Currency code, e.g. "EUR" | string | |
deliveryTermsID | ID of delivery terms | integer | |
countryID | ID of supplier's country | integer | |
GLN | string | GLN. | |
paymentDays | Default payment period. | integer | |
***** | Additional attributes associated with this item. Attributes must be supplied as a flat list, each attribute defined by the following set of three parameters. Replace # with set number (1, 2, 3, ...). When updating an existing entry, API will only update the attributes specified in input data and leave all other existing attributes unchanged. To delete an attribute, set its value to 'null' or 'undefined'. |
||
attributeName# | Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore. | string | |
attributeType# | Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'. | string | |
attributeValue# | Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute. 'text' attribute can be any string, maximum 255 characters. 'int' must be a signed 32-bit integer. 'double' must be a decimal number. |
string |
Field name | Type | Description |
---|---|---|
supplierID | integer | ID of the newly-created or updated item |
alreadyExists | integer | (0 or 1) |