2.2.2. Querry string parametrs
Parametrs
Main Parameters
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| country | Country code | Yes | string | |
| name | Organization name | Yes | string | |
| fiscal_id | Tax identification number | Yes | string | |
| is_legal | Indicator of legal entity (true/false) | boolean | True by default | |
| contract_num | Contract number | Yes | string | |
| contact_name | Contact person | |||
| region | Region name | string | If not found in the directory, it will be added | |
| district | District name | string | If not found in the directory, it will be added | |
| address | Organization address | Yes | string | |
| Email address | Yes | string | ||
| phone | Organization phone number | Yes | string | |
| activities | Array of activity types | array of objects | See activities Array Structure below | |
| shop_name | Store name | Yes (mandatory and key if shop code is not used) | string | |
| shop_address | Store address | Yes | string | |
| shop_phone | Store phone number | string | ||
| shop_code | Store code | string | Mandatory if used | |
| shop_type | Type of retail outlet | string | ||
| license_num | Cash register license number; mandatory and key | Yes (if “dev_model” and “serial” values are not passed) | string | |
| dev_model | Device model | Yes (f “license_num” is not passed) | string | |
| serial | Serial number | Yes (f “license_num” is not passed) | string | |
| token | Cash register fiscal token | string |
activities Array Structure
| Parameter | Description | Mandatory | Type | Notes |
|---|---|---|---|---|
| code | Activity code | |||
| name | Activity name |
Code structure
{
"country": "",
"name": "",
"fiscal_id": "",
"is_legal": true,
"contract_num": "",
"region": "",
"district": "",
"address": "",
"email": "",
"phone": "",
"activities": [
{
"code": "",
"name": ""
}
],
"shop_name": "",
"shop_address": "",
"shop_phone": "",
"shop_code": "",
"shop_type": "",
"license_num": "",
"dev_model": "",
"serial": "",
"token": ""
}
Field Descriptions
- country – country code, required, string
- name – organization name, required, string
- fiscal_id – tax identification number, required, string
- is_legal – legal entity indicator, boolean, default True
- contract_num – contract number, required, string
- region – region name, added automatically if not found in directory, string
- district – district name, added automatically if not found in directory, string
- address – organization address, required, string
- email – email address, required, string
- phone – organization phone number, required, string
- activities – array of activity types (objects with "code" and "name"), optional
- shop_name – store name, required and key if shop_code is not used, string
- shop_address – store address, required, string
- shop_phone – store phone number, string
- shop_code – store code, key if used, string
- shop_type – type of retail point, string
- license_num – cash register license number, required and key if dev_model and serial are not provided, string
- dev_model – device model, required if license_num is not provided, string
- serial – device serial number, required if license_num is not provided, string
- token – fiscal token number, string