Opero Docs
Opero APIcompanies

Update contractor

PATCH
/v1/companies/{companyId}/contractors/{id}

Updates the contractor aggregate in the token organization. Missing child collections are unchanged.

Authorization

api-token
AuthorizationBearer <token>

Opero API token. Send it as Authorization: Bearer ek_...

In: header

Path Parameters

id*string
companyId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/companies/string/contractors/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "uniqueId": "string",    "acronym": "string",    "fullName": "string",    "contractorType": "string",    "status": "ACTIVE",    "isCompany": true,    "vatId": "string",    "pesel": "string",    "regon": "string",    "krs": "string",    "country": "string",    "phone": "string",    "email": "string",    "website": "string",    "creditLimit": "string",    "creditLimitCurrency": "string",    "creditLimitGrantedAt": "2019-08-24T14:15:22Z",    "creditLimitExpiresAt": "2019-08-24T14:15:22Z",    "riskStatus": "string",    "salesBlocked": true,    "salesBlockReason": "string",    "addresses": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "type": "string",        "street": "string",        "buildingNumber": "string",        "apartmentNumber": "string",        "city": "string",        "postalCode": "string",        "region": "string",        "country": "string",        "isDefault": true      }    ],    "contacts": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "firstName": "string",        "lastName": "string",        "position": "string",        "department": "string",        "phone": "string",        "email": "string",        "notes": "string"      }    ],    "bankAccounts": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "bankName": "string",        "iban": "string",        "swift": "string",        "currency": "string",        "isDefault": true,        "accountType": "string"      }    ],    "subscriptions": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "email": "string",        "subscriptionType": "string",        "frequency": "string"      }    ],    "externalIds": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "system": "string",        "externalId": "string"      }    ],    "customFields": [      {        "reference": {          "ownership": "SUBORDINATE",          "cardinality": "ONE_TO_ONE"        },        "fieldDefinitionId": "string",        "key": "string",        "name": "string",        "type": "LINES",        "validationConfig": {},        "presentation": {          "fileImage": {            "imageMode": "full",            "objectFit": "cover",            "objectPosition": "center"          }        },        "dictionaryId": "string",        "customObjectModuleId": "string",        "customObjectId": "string",        "customObjectModuleKey": "string",        "customObjectKey": "string",        "value": {          "id": "string",          "version": 0,          "entries": [            {              "id": "string",              "clientId": "string",              "serviceCatalogItemId": "string",              "unitDictionaryEntryId": "string",              "name": "string",              "description": "string",              "quantity": "1.000000",              "unit": "service",              "unitNetPrice": "100.0000",              "discountPercent": "10.0000",              "discountAmount": "25.0000",              "taxRateCode": "23",              "taxRatePercent": "23.0000",              "taxAmountOverride": "23.0000",              "gtuCode": "GTU_01",              "ksefProcedureCode": "WSTO_EE",              "cnCode": "string",              "pkwiuCode": "string",              "exciseAmount": "12.34",              "sourceType": "MANUAL",              "revision": 0,              "hasBillingHistory": true,              "position": 0,              "currencyCode": "string",              "netAmount": "string",              "taxAmount": "string",              "grossAmount": "string",              "reservedQuantity": "string",              "billedQuantity": "string",              "availableQuantity": "string",              "serviceCatalogSnapshot": {},              "warnings": [                {}              ]            }          ]        },        "mentions": [          {            "kind": "user",            "id": "string",            "label": "string",            "active": true          }        ],        "renderedValue": {          "html": "string",          "css": "string"        },        "resolvedValue": {          "id": "string",          "type": "USER",          "displayLabel": "string",          "email": "string",          "fullName": "string",          "acronym": "string"        },        "file": {          "id": "string",          "originalName": "string",          "mimeType": "string",          "sizeBytes": 0,          "createdAt": "2019-08-24T14:15:22Z",          "urlPath": "string",          "downloadPath": "string"        },        "files": [          {            "id": "string",            "originalName": "string",            "mimeType": "string",            "sizeBytes": 0,            "createdAt": "2019-08-24T14:15:22Z",            "urlPath": "string",            "downloadPath": "string"          }        ]      }    ]  }}
{  "error": {    "code": "NOT_FOUND",    "message": "Resource not found",    "meta": {      "partiallyApplied": true,      "failedPhase": "defaultForms",      "committedObjects": [        {          "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3",          "key": "session",          "created": true        }      ],      "fieldsWritten": 1,      "fieldsDeleted": 0    },    "fieldErrors": {      "name": [        "Field \"name\" is required"      ]    },    "unavailableMutationScopes": [      "contractor.bankAccounts"    ],    "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50",    "relationTableErrors": {},    "idempotencyConflict": {},    "errors": [      {        "message": "relation \"foo\" does not exist"      }    ],    "impacts": [      {}    ],    "validation": {}  }}
{  "error": {    "code": "NOT_FOUND",    "message": "Resource not found",    "meta": {      "partiallyApplied": true,      "failedPhase": "defaultForms",      "committedObjects": [        {          "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3",          "key": "session",          "created": true        }      ],      "fieldsWritten": 1,      "fieldsDeleted": 0    },    "fieldErrors": {      "name": [        "Field \"name\" is required"      ]    },    "unavailableMutationScopes": [      "contractor.bankAccounts"    ],    "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50",    "relationTableErrors": {},    "idempotencyConflict": {},    "errors": [      {        "message": "relation \"foo\" does not exist"      }    ],    "impacts": [      {}    ],    "validation": {}  }}
{  "error": {    "code": "NOT_FOUND",    "message": "Resource not found",    "meta": {      "partiallyApplied": true,      "failedPhase": "defaultForms",      "committedObjects": [        {          "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3",          "key": "session",          "created": true        }      ],      "fieldsWritten": 1,      "fieldsDeleted": 0    },    "fieldErrors": {      "name": [        "Field \"name\" is required"      ]    },    "unavailableMutationScopes": [      "contractor.bankAccounts"    ],    "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50",    "relationTableErrors": {},    "idempotencyConflict": {},    "errors": [      {        "message": "relation \"foo\" does not exist"      }    ],    "impacts": [      {}    ],    "validation": {}  }}
{  "error": {    "code": "NOT_FOUND",    "message": "Resource not found",    "meta": {      "partiallyApplied": true,      "failedPhase": "defaultForms",      "committedObjects": [        {          "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3",          "key": "session",          "created": true        }      ],      "fieldsWritten": 1,      "fieldsDeleted": 0    },    "fieldErrors": {      "name": [        "Field \"name\" is required"      ]    },    "unavailableMutationScopes": [      "contractor.bankAccounts"    ],    "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50",    "relationTableErrors": {},    "idempotencyConflict": {},    "errors": [      {        "message": "relation \"foo\" does not exist"      }    ],    "impacts": [      {}    ],    "validation": {}  }}
{  "error": {    "code": "NOT_FOUND",    "message": "Resource not found",    "meta": {      "partiallyApplied": true,      "failedPhase": "defaultForms",      "committedObjects": [        {          "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3",          "key": "session",          "created": true        }      ],      "fieldsWritten": 1,      "fieldsDeleted": 0    },    "fieldErrors": {      "name": [        "Field \"name\" is required"      ]    },    "unavailableMutationScopes": [      "contractor.bankAccounts"    ],    "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50",    "relationTableErrors": {},    "idempotencyConflict": {},    "errors": [      {        "message": "relation \"foo\" does not exist"      }    ],    "impacts": [      {}    ],    "validation": {}  }}

Get contractor

Previous Page

Delete contractor

Next Page