Description of available fields and its values in single contractor entity.

Field Example Type Description
partners [] Array List of partners from contractors module 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 8460ce1a-a74b-488f-8fb7-df969e7a5aef string Group id Group name string Group name
partners.groups.description Example description string Group description Object Partner’s company details Object Address pl string Country using ISO values Pmtlhoqprk string Name of the city 12 string Number 19-598 string Postal code Zrwdgrrh 72 string Street name string Email 0048 872156041 string Fax number POSITIVE string Financial verification status 1038201 int Company id (OfficeId) Example name string Company name Object List of assigned permissions false boolean Authorization status false boolean Determines if cooperation with this partner is blocked
true boolean Authorization status CARRIER string Company roles: carrier, shipper, forwarder ACTIVE string Company status 0048 872156041 string Telephone number STANDARD string Company type 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": "",
        "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": [
        "status": "ACTIVE",
        "telephone": "0048 872156041",
        "type": "STANDARD",
        "vat_id": "PL9211968281"