Description of available fields and its values in single contractor entity.
Field | Example | Type | Description |
partners | [] | Array | List of partners from contractors module |
partners.id | d1da6d90-b787-4086-a515-09a82203eabf | string | Partner id used to identify on partners list NOTE: it is not a company id |
partners.groups | Object | List of groups a partner is a member of | |
partners.groups.id | 8460ce1a-a74b-488f-8fb7-df969e7a5aef | string | Group id |
partners.groups.name | Group name | string | Group name |
partners.groups.description | Example description | string | Group description |
partners.company | Object | Partner’s company details | |
partners.company.address | Object | Address | |
partners.company.address.country | pl | string | Country using ISO values |
partners.company.country.locality | Pmtlhoqprk | string | Name of the city |
partners.company.country.number | 12 | string | Number |
partners.company.country.postal_code | 19-598 | string | Postal code |
partners.company.country.street | Zrwdgrrh 72 | string | Street name |
partners.company.email | mail@example.com | string | |
partners.company.fax | 0048 872156041 | string | Fax number |
partners.company.financial_verification_status | POSITIVE | string | Financial verification status |
partners.company.id | 1038201 | int | Company id (OfficeId) |
partners.company.name | Example name | string | Company name |
partners.company.permissions | Object | List of assigned permissions | |
partners.company.permissions.is_authorized | false | boolean | Authorization status |
partners.company.permissions.is_blocked | false | boolean | Determines if cooperation with this partner is blocked |
partners.company.permissions. was_authorized_at_least_once |
true | boolean | Authorization status |
partners.company.roles | CARRIER | string | Company roles: carrier, shipper, forwarder |
partners..company.status | ACTIVE | string | Company status |
partners..company.telephone | 0048 872156041 | string | Telephone number |
partners..company.type | STANDARD | string | Company type |
partners..company.vat_id | PL9211968281 | string | Company VAT number or other tax identification |
Json example
{ "page": 1, "page_count": 5, "page_size": 15, "partners": [ { "id": "d1da6d90-b787-4086-a515-09a82203eabf", "groups": [ { "id": "8460ce1a-a74b-488f-8fb7-df969e7a5aef", "name": "Group name", "description": "Example escription" } ], "company": { "address": { "country": "pl", "locality": "Pmtlhoqprk", "number": null, "postal_code": "19-598", "street": "Zrwdgrrh 72" }, "email": "mail@example.com", "fax": "0048 287433053", "financial_verification_status": "POSITIVE", "id": 1038201, "name": "Example name", "permissions": { "is_authorized": true, "is_blocked": false, "was_authorized_at_least_once": true }, "roles": [ "CARRIER" ], "status": "ACTIVE", "telephone": "0048 872156041", "type": "STANDARD", "vat_id": "PL9211968281" } } ] }