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

Field Example Type Description
partners Array of objects 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 Array of objects 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.address.locality Wrocław String Name of the city
partners.company.address.number 12 String Number
partners.company.address.postal_code 19-598 String Postal code
partners.company.address.street Street 72 String Street name
partners.company.email mail@example.com String Email
partners.company.fax 0048 111111111 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 True Boolean Authorization status
partners.company.permissions.is_blocked False Boolean Determines if company has been 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 Cooperation status – can be ACTIVE or SUSPENDED
partners.company.telephone 0048 111111111 String Telephone number
partners.company.vat_id PL11111111111 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 description"
        }
      ],
      "company": {
        "address": {
          "country": "PL",
          "locality": "Wrocław",
          "number": null,
          "postal_code": "19-598",
          "street": "Street 72"
        },
        "email": "mail@example.com",
        "fax": "0048 111111111",
        "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 111111111",
        "vat_id": "PL11111111111"
      }
    }
  ]
}