Structure of getting partners list

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.notes Note String Note added to partner
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"
      }
    }
  ]
}

 

Structure of getting single partner by ID

Field Example Type Description
id d1da6d90-b787-4086-a515-09a82203eabf String Partner id used to identify on partners list
NOTE: it is not a company id
groups Array of objects List of groups a partner is a member of
groups.id 8460ce1a-a74b-488f-8fb7-df969e7a5aef String Group id
groups.name Group name String Group name
groups.description Example description String Group description
company Object Partner’s company details
company.address Object Address
company.address.country PL String Country using ISO values
company.address.locality Wrocław String Name of the city
company.address.number 12 String Number
company.address.postal_code 19-598 String Postal code
company.address.street Street 72 String Street name
company.email mail@example.com String Email
company.fax 0048 111111111 String Fax number
company.financial_verification_status POSITIVE String Financial verification status
company.id 1038201 Int Company id (OfficeId)
company.name Example name String Company name
company.permissions Object List of assigned permissions
company.permissions.is_authorized True Boolean Authorization status
company.permissions.is_blocked False Boolean Determines if company has been blocked
company.permissions.was_authorized_at_least_once True Boolean Authorization status
company.roles CARRIER String Company roles: carrier, shipper, forwarder
company.status ACTIVE String Cooperation status – can be ACTIVE or SUSPENDED
company.telephone 0048 111111111 String Telephone number
company.vat_id PL11111111111 String Company VAT number or other tax identification
contractors_satisfaction
Object Contrators satisfaction (in percents)
contractors_satisfaction.communication
53
Int Assessment for companies in carrier or shipper role
contractors_satisfaction.documents_delivery
100
Int Assesment for company in carrier role
contractors_satisfaction.load_as_described
92
Int Assessment for company in shipper role
contractors_satisfaction.waiting_for_loading
76
Int Assessment for company in shipper role
contractors_satisfaction.caring_for_goods 85 Int Assesment for company in carrier role
contractors_satisfaction.service_as_agreed 42 Int Assesment for company in carrier role
contractors_satisfaction.transport_on_time_performance 25 Int Assesment for company in carrier role
contractors_satisfaction.waiting_for_unloading 100 Int Assessment for company in shipper role
contractors_satisfaction.waiting_for_loading 48 Int Assessment for company in shipper role
documents
Array of objects Information about company documents
documents.expire_date
2022-07-21
Timestamp Document expiration date
documents.insurance_value Object Insurance value (for insurance documents only)
documents.insurance_value.currency EUR String Insurance currency
documents.insurance_value.value 1000 Int Insurance value
documents.issue_date
2021-07-22
Timestamp Document issue date
documents.media Object Document information
documents.media.pages Array Url to document download (string type)
overall_rating
4.8 Float Company rate (maximum value 5.0)
payment_status
Object Payment assessment
payment_status.paid_on_time 5 Int Amount of payments on time
payment_status.paid_with_delay 4 Int Amount of payments with delay
payment_status.unpaid 3 Int Amount of unpaid transactions
trans_risk
Object TransRisk value
trans_risk.calculation_time
2021-11-22T01:56:46.079+01:00
Timestamp TransRisk calculation date
trans_risk.description GOOD String TransRisk description (may be one of following: SUPER, VERY_GOOD, GOOD, MEDIOCRE, POOR, null)

Json example

{
    "company": {
        "address": {
            "country": "pl",
            "locality": "Wrocław",
            "number": 2,
            "postal_code": "53-146",
            "street": "Racławicka"
        },
        "email": "api@trans.eu",
        "fax": "22222222",
        "financial_verification_status": "NEGATIVE",
        "flags": [],
        "id": 11111111,
        "name": "Test company",
        "permissions": {
            "is_authorized": true,
            "is_blocked": false,
            "was_authorized_at_least_once": true
        },
        "roles": [
            "FORWARDER"
        ],
        "status": "ACTIVE",
        "telephone": "12345678",
        "type": "STANDARD",
        "vat_id": "7777777777"
    },
    "contractors_satisfaction": {
        "communication": 53,
        "documents_delivery": 100,
        "load_as_described": 92,
        "waiting_for_loading": 76
    },
    "documents": [
        {
            "expire_date": "2022-07-21",
            "insurance_value": {
                "currency": "EUR",
                "value": 1234
            },
            "issue_date": "2021-07-22",
            "media": {
               "pages": [
                 "https://platform.trans.eu/app/media-storage/v1/assets/5cfa11a6-4ff1-4bfd-a87f-3ffe3d6eb87d"
                        ]
      }
        }
    ],
    "groups": [
        {
            "description": null,
            "id": "2e249789-795a-40de-bcd8-3805dadce93c",
            "name": "test"
        }
    ],
    "id": "1f4c0772-5d23-4ff4-a10c-42a45f7dbd86",
    "overall_rating": 4.8,
    "payments_status": {
        "paid_on_time": 5,
        "paid_with_delay": 4,
        "unpaid": 3
    },
    "trans_risk": {
        "calculation_time": "2021-11-22T02:02:12.147+01:00",
        "description": "GOOD"
    }
}