3.08 ADD/EDIT Customers
Connection URL
TEST URL | http://nap.dev.icash.bg/clientapi/v1/add-contragent |
( AL ) PRODUCTION URL | https://v1.icash.al/clientapi/v1/add-contragent |
( BG ) PRODUCTION URL | https://v5.icash.bg/clientapi/v1/add-contragent |
POST REQUEST
Param | Description | Field type | Required. |
api_key | API Key | String | YES |
nonce | Nonce | Integer | YES |
signature | Signature | String | YES |
ses | Session indentificator | String | YES |
EditContragentID | Indentificator of edited customer | Integer | No |
ContragentName | Company name | String(100) | YES |
ContragentType | Type client or supplier | SET(CLIENT, SUPPLIER) | YES |
ContragentBarcode | Barcode | String(20) | No/YES |
ContragentCountryCode | Country code
ISO 3166-1 alpha-2 |
String(2) | YES |
ContragentCityName | City | String(70) | YES |
ContragentAddress | Address | String(100) | No |
ContragentTaxNum | Company IDN | String(15) | YES/YES |
ContragentVatRegistered | Tax registered 1- for registered | ENUM(0,1) | YES |
ContragentVatNum | Tax number | String(15) | No |
ContragentMOL | Person name | String(60) | No |
ContragentAllowPartPays | Access to partly payment | ENUM(0,1)
Default 0 |
No |
ContragentForbidSupplies | prohibited for delivery | ENUM(0,1)
Default 0 |
No |
ContragentForbidSales | prohibited sale | ENUM(0,1)
Default 0 |
No |
ContragentMobile | Mobile phone | String(20) | No |
ContragentPhone | Phone | String(20) | No |
ContragentFax | fax | String(20) | No |
ContragentEmail | String(75) | No | |
ContragentWebSite | Web site | String(100) | No |
ContragentAlbaniaTaxNumType | NUIS, ID, PASS, TAX,SOC | String | YES |
JSON response on success
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
1 – successful |
YES |
data | Result data | result |
Structure of type “result”
Param | Description | Field type | Required |
ContragentID | Indentificator | Integer | YES |
Example:
{ „nonce“: „1552999153“, „status“: 1, „data“: { „ContragentID“: 129 } } |
JSON response on unsuccess
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
0 – unsuccess request |
YES |
error_message | Error Description | String | YES |
Example on unsuccess:
{ „nonce“: „1552999151“, „status“: 0, „error_message“: „ContragentName is mandatory“ } |