{"id":2354,"date":"2020-10-21T14:22:18","date_gmt":"2020-10-21T12:22:18","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=2354"},"modified":"2023-02-23T15:39:25","modified_gmt":"2023-02-23T14:39:25","slug":"contractor-description","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/partners\/contractor-description\/","title":{"rendered":"Contractor description"},"content":{"rendered":"\n

Struc\u00adture of get\u00adting part\u00adners list<\/p>\n\n\n\n\n\n\n\n

Field<\/strong><\/td>Exam\u00adple<\/strong><\/td>Type<\/strong><\/td>Descrip\u00adtion<\/strong><\/td><\/tr>
part\u00adners<\/td><\/td>Array of objects<\/td>List of part\u00adners from con\u00adtrac\u00adtors mod\u00adule<\/td><\/tr>
partners.id<\/td>d1da6d90-b787-4086-a515-09a82203e\u00adabf<\/td>String<\/td>Part\u00adner id used to iden\u00adti\u00adfy on part\u00adners list
NOTE: it is not a com\u00adpa\u00adny id<\/td><\/tr>
partners.notes<\/td>Note<\/td>String<\/td>Note added to part\u00adner<\/td><\/tr>
partners.groups<\/td><\/td>Array of objects<\/td>List of groups a part\u00adner is a mem\u00adber of<\/td><\/tr>
partners.groups.id<\/td>8460ce1a-a74b-488f-8fb7-df969e7a5aef<\/td>String<\/td>Group id<\/td><\/tr>
partners.groups.name<\/td>Group name<\/td>String<\/td>Group name<\/td><\/tr>
partners.groups.description<\/td>Exam\u00adple descrip\u00adtion<\/td>String<\/td>Group descrip\u00adtion<\/td><\/tr>
partners.company<\/td><\/td>Object<\/td>Part\u00adner\u2019s com\u00adpa\u00adny details<\/td><\/tr>
partners.company.address<\/td><\/td>Object<\/td>Address<\/td><\/tr>
partners.company.address.country<\/td>PL<\/td>String<\/td>Coun\u00adtry using ISO val\u00adues<\/a><\/td><\/tr>
partners.company.address.locality<\/td>Wroc\u0142aw<\/td>String<\/td>Name of the city<\/td><\/tr>
partners.company.address.number<\/td>12<\/td>String<\/td>Num\u00adber<\/td><\/tr>
partners.company.address.postal_code<\/td>19\u2013598<\/td>String<\/td>Postal code<\/td><\/tr>
partners.company.address.street<\/td>Street 72<\/td>String<\/td>Street name<\/td><\/tr>
partners.company.email<\/td>mail@example.com<\/td>String<\/td>Email<\/td><\/tr>
partners.company.fax<\/td>0048 111111111<\/td>String<\/td>Fax num\u00adber<\/td><\/tr>
partners.company.financial_verification_status<\/td>POSITIVE<\/td>String<\/td>Finan\u00adcial ver\u00adi\u00adfi\u00adca\u00adtion sta\u00adtus<\/td><\/tr>
partners.company.id<\/td>1038201<\/td>Int<\/td>Com\u00adpa\u00adny id (Offi\u00adceId)<\/td><\/tr>
partners.company.name<\/td>Exam\u00adple name<\/td>String<\/td>Com\u00adpa\u00adny name<\/td><\/tr>
partners.company.permissions<\/td><\/td>Object<\/td>List of assigned per\u00admis\u00adsions<\/td><\/tr>
partners.company.permissions.is_authorized<\/td>True<\/td>Boolean<\/td>Autho\u00adriza\u00adtion sta\u00adtus<\/td><\/tr>
partners.company.permissions.is_blocked<\/td>False<\/td>Boolean<\/td>Deter\u00admines if com\u00adpa\u00adny has been blocked<\/td><\/tr>
partners.company.permissions.
was_authorized_at_least_once<\/td>		True<\/td>Boolean<\/td>Autho\u00adriza\u00adtion sta\u00adtus<\/td><\/tr>
partners.company.roles<\/td>CARRIER<\/td>String<\/td>Com\u00adpa\u00adny roles: car\u00adri\u00ader, ship\u00adper, for\u00adwarder<\/td><\/tr>
partners.company.status<\/td>ACTIVE<\/td>String<\/td>Coop\u00ader\u00ada\u00adtion sta\u00adtus \u2014 can be ACTIVE or SUSPENDED<\/td><\/tr>
partners.company.telephone<\/td>0048 111111111<\/td>String<\/td>Tele\u00adphone num\u00adber<\/td><\/tr>
partners.company.vat_id<\/td>PL11111111111<\/td>String<\/td>Com\u00adpa\u00adny VAT num\u00adber or oth\u00ader tax iden\u00adti\u00adfi\u00adca\u00adtion<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Json example<\/h2>\n\n\n\n
{\n  \"page\": 1,\n  \"page_count\": 5,\n  \"page_size\": 15,\n  \"partners\": [\n    {\n      \"id\": \"d1da6d90-b787-4086-a515-09a82203eabf\",\n      \"groups\": [\n        {\n          \"id\": \"8460ce1a-a74b-488f-8fb7-df969e7a5aef\",\n          \"name\": \"Group name\",\n          \"description\": \"Example description\"\n        }\n      ],\n      \"company\": {\n        \"address\": {\n          \"country\": \"PL\",\n          \"locality\": \"Wroc\u0142aw\",\n          \"number\": null,\n          \"postal_code\": \"19-598\",\n          \"street\": \"Street 72\"\n        },\n        \"email\": \"mail@example.com\",\n        \"fax\": \"0048 111111111\",\n        \"financial_verification_status\": \"POSITIVE\",\n        \"id\": 1038201,\n        \"name\": \"Example name\",\n        \"permissions\": {\n          \"is_authorized\": true,\n          \"is_blocked\": false,\n          \"was_authorized_at_least_once\": true\n        },\n        \"roles\": [\n          \"CARRIER\"\n        ],\n        \"status\": \"ACTIVE\",\n        \"telephone\": \"0048 111111111\",\n        \"vat_id\": \"PL11111111111\"\n      }\n    }\n  ]\n}<\/code><\/pre><\/div>\n\n\n\n
Structure of getting single partner by ID<\/h2>\n\n\n\n
Field<\/strong><\/td>Exam\u00adple<\/strong><\/td>Type<\/strong><\/td>Descrip\u00adtion<\/strong><\/td><\/tr>
id<\/td>d1da6d90-b787-4086-a515-09a82203e\u00adabf<\/td>String<\/td>Part\u00adner id used to iden\u00adti\u00adfy on part\u00adners list
NOTE: it is not a com\u00adpa\u00adny id<\/td><\/tr>
groups<\/td><\/td>Array of objects<\/td>List of groups a part\u00adner is a mem\u00adber of<\/td><\/tr>
groups.id<\/td>8460ce1a-a74b-488f-8fb7-df969e7a5aef<\/td>String<\/td>Group id<\/td><\/tr>
groups.name<\/td>Group name<\/td>String<\/td>Group name<\/td><\/tr>
groups.description<\/td>Exam\u00adple descrip\u00adtion<\/td>String<\/td>Group descrip\u00adtion<\/td><\/tr>
com\u00adpa\u00adny<\/td><\/td>Object<\/td>Part\u00adner\u2019s com\u00adpa\u00adny details<\/td><\/tr>
company.address<\/td><\/td>Object<\/td>Address<\/td><\/tr>
company.address.country<\/td>PL<\/td>String<\/td>Coun\u00adtry using ISO val\u00adues<\/a><\/td><\/tr>
company.address.locality<\/td>Wroc\u0142aw<\/td>String<\/td>Local\u00adi\u00adty<\/td><\/tr>
company.address.number<\/td>12<\/td>String<\/td>Num\u00adber<\/td><\/tr>
company.address.postal_code<\/td>19\u2013598<\/td>String<\/td>Postal code<\/td><\/tr>
company.address.street<\/td>Street 72<\/td>String<\/td>Street name<\/td><\/tr>
company.email<\/td>mail@example.com<\/td>String<\/td>Email<\/td><\/tr>
company.fax<\/td>0048 111111111<\/td>String<\/td>Fax num\u00adber<\/td><\/tr>
company.financial_verification_status<\/td>POSITIVE<\/td>String<\/td>Finan\u00adcial ver\u00adi\u00adfi\u00adca\u00adtion sta\u00adtus<\/td><\/tr>
company.id<\/td>1038201<\/td>Int<\/td>Com\u00adpa\u00adny id (Offi\u00adceId)<\/td><\/tr>
company.name<\/td>Exam\u00adple name<\/td>String<\/td>Com\u00adpa\u00adny name<\/td><\/tr>
company.permissions<\/td><\/td>Object<\/td>List of assigned per\u00admis\u00adsions<\/td><\/tr>
company.permissions.is_authorized<\/td>True<\/td>Boolean<\/td>Autho\u00adriza\u00adtion sta\u00adtus<\/td><\/tr>
company.permissions.is_blocked<\/td>False<\/td>Boolean<\/td>Deter\u00admines if com\u00adpa\u00adny has been blocked<\/td><\/tr>
company.permissions.was_authorized_at_least_once<\/td>True<\/td>Boolean<\/td>Autho\u00adriza\u00adtion sta\u00adtus<\/td><\/tr>
company.roles<\/td>CARRIER<\/td>String<\/td>Com\u00adpa\u00adny roles: car\u00adri\u00ader, ship\u00adper, for\u00adwarder<\/td><\/tr>
company.status<\/td>ACTIVE<\/td>String<\/td>Coop\u00ader\u00ada\u00adtion sta\u00adtus \u2014 can be ACTIVE or SUSPENDED<\/td><\/tr>
company.telephone<\/td>0048 111111111<\/td>String<\/td>Tele\u00adphone num\u00adber<\/td><\/tr>
company.vat_id<\/td>PL11111111111<\/td>String<\/td>Com\u00adpa\u00adny VAT num\u00adber or oth\u00ader tax iden\u00adti\u00adfi\u00adca\u00adtion<\/td><\/tr>
contractors_satisfaction<\/td><\/td>Object<\/td>Con\u00adtra\u00adtors sat\u00adis\u00adfac\u00adtion (in per\u00adcents)<\/td><\/tr>
contractors_satisfaction.communication<\/td>53<\/td>Int<\/td>Assess\u00adment for com\u00adpa\u00adnies in car\u00adri\u00ader or ship\u00adper role<\/td><\/tr>
contractors_satisfaction.documents_delivery<\/td>100<\/td>Int<\/td>Ass\u00ades\u00adment for com\u00adpa\u00adny in car\u00adri\u00ader role<\/td><\/tr>
contractors_satisfaction.load_as_described<\/td>92<\/td>Int<\/td>Assess\u00adment for com\u00adpa\u00adny in ship\u00adper role<\/td><\/tr>
contractors_satisfaction.waiting_for_loading<\/td>76<\/td>Int<\/td>Assess\u00adment for com\u00adpa\u00adny in ship\u00adper role<\/td><\/tr>
contractors_satisfaction.caring_for_goods<\/td>85<\/td>Int<\/td>Ass\u00ades\u00adment for com\u00adpa\u00adny in car\u00adri\u00ader role<\/td><\/tr>
contractors_satisfaction.service_as_agreed<\/td>42<\/td>Int<\/td>Ass\u00ades\u00adment for com\u00adpa\u00adny in car\u00adri\u00ader role<\/td><\/tr>
contractors_satisfaction.transport_on_time_performance<\/td>25<\/td>Int<\/td>Ass\u00ades\u00adment for com\u00adpa\u00adny in car\u00adri\u00ader role<\/td><\/tr>
contractors_satisfaction.waiting_for_unloading<\/td>100<\/td>Int<\/td>Assess\u00adment for com\u00adpa\u00adny in ship\u00adper role<\/td><\/tr>
contractors_satisfaction.waiting_for_loading<\/td>48<\/td>Int<\/td>Assess\u00adment for com\u00adpa\u00adny in ship\u00adper role<\/td><\/tr>
doc\u00adu\u00adments<\/td><\/td>Array of objects<\/td>Infor\u00adma\u00adtion about com\u00adpa\u00adny doc\u00adu\u00adments<\/td><\/tr>
documents.expire_date<\/td>2022-07-21<\/td>Time\u00adstamp<\/td>Doc\u00adu\u00adment expi\u00adra\u00adtion date<\/td><\/tr>
documents.insurance_value<\/td><\/td>Object<\/td>Insur\u00adance val\u00adue (for insur\u00adance doc\u00adu\u00adments only)<\/td><\/tr>
documents.insurance_value.currency<\/td>EUR<\/td>String<\/td>Insur\u00adance cur\u00adren\u00adcy<\/a><\/td><\/tr>
documents.insurance_value.value<\/td>1000<\/td>Int<\/td>Insur\u00adance val\u00adue<\/td><\/tr>
documents.issue_date<\/td>2021-07-22<\/td>Time\u00adstamp<\/td>Doc\u00adu\u00adment issue date<\/td><\/tr>
documents.media<\/td><\/td>Object<\/td>Doc\u00adu\u00adment infor\u00adma\u00adtion<\/td><\/tr>
documents.media.pages<\/td><\/td>Array<\/td>Url to doc\u00adu\u00adment down\u00adload (string type)<\/td><\/tr>
overall_rating<\/td>4.8<\/td>Float<\/td>Com\u00adpa\u00adny rate (max\u00adi\u00admum val\u00adue 5.0)<\/td><\/tr>
payment_status<\/td><\/td>Object<\/td>Pay\u00adment assess\u00adment<\/td><\/tr>
payment_status.paid_on_time<\/td>5<\/td>Int<\/td>Amount of pay\u00adments on time<\/td><\/tr>
payment_status.paid_with_delay<\/td>4<\/td>Int<\/td>Amount of pay\u00adments with delay<\/td><\/tr>
payment_status.unpaid<\/td>3<\/td>Int<\/td>Amount of unpaid trans\u00adac\u00adtions<\/td><\/tr>
trans_risk<\/td><\/td>Object<\/td>Tran\u00adsRisk val\u00adue<\/td><\/tr>
trans_risk.calculation_time<\/td>2021\u201311-22T01:56:46.079+01:00<\/td>Time\u00adstamp<\/td>Tran\u00adsRisk cal\u00adcu\u00adla\u00adtion date<\/td><\/tr>
trans_risk.description<\/td>GOOD<\/td>String<\/td>Tran\u00adsRisk descrip\u00adtion (may be one of fol\u00adlow\u00ading: SUPER, VERY_GOOD, GOOD, MEDIOCRE, POOR, null)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Json example<\/h2>\n\n\n\n
{\n    \"company\": {\n        \"address\": {\n            \"country\": \"pl\",\n            \"locality\": \"Wroc\u0142aw\",\n            \"number\": 2,\n            \"postal_code\": \"53-146\",\n            \"street\": \"Rac\u0142awicka\"\n        },\n        \"email\": \"api@trans.eu\",\n        \"fax\": \"22222222\",\n        \"financial_verification_status\": \"NEGATIVE\",\n        \"flags\": [],\n        \"id\": 11111111,\n        \"name\": \"Test company\",\n        \"permissions\": {\n            \"is_authorized\": true,\n            \"is_blocked\": false,\n            \"was_authorized_at_least_once\": true\n        },\n        \"roles\": [\n            \"FORWARDER\"\n        ],\n        \"status\": \"ACTIVE\",\n        \"telephone\": \"12345678\",\n        \"type\": \"STANDARD\",\n        \"vat_id\": \"7777777777\"\n    },\n    \"contractors_satisfaction\": {\n        \"communication\": 53,\n        \"documents_delivery\": 100,\n        \"load_as_described\": 92,\n        \"waiting_for_loading\": 76\n    },\n    \"documents\": [\n        {\n            \"expire_date\": \"2022-07-21\",\n            \"insurance_value\": {\n                \"currency\": \"EUR\",\n                \"value\": 1234\n            },\n            \"issue_date\": \"2021-07-22\",\n            \"media\": {\n               \"pages\": [\n                 \"https:\/\/platform.trans.eu\/app\/media-storage\/v1\/assets\/5cfa11a6-4ff1-4bfd-a87f-3ffe3d6eb87d\"\n                        ]\n      }\n        }\n    ],\n    \"groups\": [\n        {\n            \"description\": null,\n            \"id\": \"2e249789-795a-40de-bcd8-3805dadce93c\",\n            \"name\": \"test\"\n        }\n    ],\n    \"id\": \"1f4c0772-5d23-4ff4-a10c-42a45f7dbd86\",\n    \"overall_rating\": 4.8,\n    \"payments_status\": {\n        \"paid_on_time\": 5,\n        \"paid_with_delay\": 4,\n        \"unpaid\": 3\n    },\n    \"trans_risk\": {\n        \"calculation_time\": \"2021-11-22T02:02:12.147+01:00\",\n        \"description\": \"GOOD\"\n    }\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"
Struc\u00adture of get\u00adting part\u00adners list<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"wp_typography_post_enhancements_disabled":false,"footnotes":""},"categories":[66],"tags":[],"class_list":["post-2354","post","type-post","status-publish","format-standard","hentry","category-partners"],"acf":[],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t