3.09 List of Customers
Connection URL
| TEST URL | http://nap.dev.icash.bg/clientapi/v1/get-contragents |
| ( AL ) PRODUCTION URL | https://v1.icash.al/clientapi/v1/get-contragents |
| ( BG ) PRODUCTION URL | https://v5.icash.bg/clientapi/v1/get-contragents |
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 |
| ContragentID | Indentificator | Integer | No/YES |
| ContragentName | Customer company name | String(100) | No/YES |
| ContragentType | Customer type | ENUM(CLIENT, SUPPLIER) | No/YES |
| ContragentBarcode | Barcode | String(20) | No/YES |
| ContragentTaxNum | Tax number | String(15) | No/YES |
| ContragentActive | Active status | ENUM(0,1) | No/YES |
| sort | Srot field | String | No |
| order | Order type | ENUM(ASC,DESC)
Default ASC |
No |
| offset | offset | Integer
Default 0 |
No |
| count | count | Integer(MAX 100)
Default 10 |
No |
JSON response on success
| Param | Description | Field type | Required |
| nonce | Nonce from request | Integer | YES |
| status | Request status | Integer
1 – successful |
YES |
| data | Result | result | YES |
Structure of type “result”
| Param | Description | Field type | Required |
| TotalRecords | Count of total records | Integer | YES |
| Data | Array customers | Array of contragent | YES |
Structure of type “contragent”
| Param | Description | Field type | Required |
| ContragentID | Indentificator | Integer | YES |
ContragentName |
Company name | String(100) | YES |
ContragentType |
Type client,supplier | SET(CLIENT, SUPPLIER) | YES |
ContragentBarcode |
Barcode | String(20) | YES |
| ContragentTaxNum | Company Tax number | String(15) | YES |
ContragentVatRegistered |
Is tax registered | ENUM(0,1) | YES |
ContragentVatNum |
VAT number | String(15) | YES |
ContragentMOL |
Person name | String(60) | YES |
| ContragentAllowPartPays | Allow partly pay | ENUM(0,1) | YES |
| ContragentForbidSupplies | Forbid delivery | ENUM(0,1) | YES |
| ContragentForbidSales | Forbid sale | ENUM(0,1) | YES |
| ContragentActive | Status | ENUM(0,1) | YES |
| ContragentPhone | Phone | String(20) | YES |
| ContragentMobile | Mobile phone | String(20) | YES |
| ContragentEmail | String(75) | YES | |
| ContragentCreateDate | Creation date and time | YYYY-MM-DD HH:MM:SS | YES |
| ContragentAlbaniaTaxNumType | Contragent type | string |
Example:
| { „nonce“: „1553001733“, „status“: 1, „data“: { „TotalRecords“: 57, „Data“: [ { „ContragentID“: 25, „ContragentType“: „CLIENT,SUPPLIER“, „ContragentBarcode“: „115825956“, „ContragentName“: „Invest Holding Ltd.“, „ContragentVatRegistered“: 1, „ContragentAllowPartPays“: 1, „ContragentTaxNum“: „115825956“, „ContragentMOL“: „Jhon Smith“, „ContragentMobile“: „“, „ContragentEmail“: „“, „ContragentContactName“: „“, „ContragentForbidSupplies“: 0, „ContragentForbidSales“: 0, „ContragentActive“: 1, „ContragentCreateDate“: „2013-03-20 11:24:03“ „ContragentAddress“: „New York, P.O. 2454“, „ContragentVatNum“: „“, „ContragentCountryID“: 34, „ContragentCountry“: „USA”, “ContragentAlbaniaTaxNumType” =>’’NUIS” }, { „ContragentID“: 26, „ContragentType“: „CLIENT,SUPPLIER“, „ContragentBarcode“: „123578950“, „ContragentName“: „Agent Express Ltd.“, „ContragentVatRegistered“: 1, „ContragentAllowPartPays“: 1, „ContragentTaxNum“: „123578950“, „ContragentMOL“: „Jonatan `Deo“, „ContragentMobile“: „087654321“, „ContragentEmail“: „“, „ContragentContactName“: „“, „ContragentForbidSupplies“: 0, „ContragentForbidSales“: 0, „ContragentActive“: 1, „ContragentCreateDate“: „2013-03-20 11:25:33“, „ContragentAddress“: „Tirana, Slavianska Str.“, „ContragentVatNum“: „L123123432N“, „ContragentCountryID“: 34, „ContragentCountry“: „Albania”, “ContragentAlbaniaTaxNumType” =>’’NUIS” } ] } } |
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:
| { „nonce“: „1552990901“, „status“: 0, „error_message“: „Session expired“ } |