Business partners

Update a business partner.

Supported customer and supplier business partners. The fields that are supported are: id, name, type (CUSTOMER and SUPPLIER only), address (but NOT billing address nor delivery address), invoicing info and payment info. To update a partner, it's required to provide version, which is the last modification time. It can be provided as query param or in request body.

patch/businesspartners/{id}

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/businesspartners/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Business partner identifier

Query parameters

versionstring

Business partner last modification time. It is required if not filled in the request body.

Request body

idinteger

Unique identifier of the partner.

namestring required

Name of the partner.

type'CUSTOMER' | 'SUPPLIER' | 'PERSON' required

Type of the partner.

versionstring date-time

Business partner version timestamp. Automatically generated by Procountor and updated every time the partner is modified. When using PATCH /businesspartners, it is required to include the latest version timestamp of the partner to the request. This prevents conflicts if the partner is being modified from several sources.It is not required for POST and will be omitted

Example request

{
  "address": {
    "country": "SWEDEN"
  },
  "billingAddress": {
    "country": "SWEDEN"
  },
  "deliveryAddress": {
    "country": "SWEDEN"
  },
  "attachments": [
    {
      "name": "Picture.jpg"
    }
  ]
}

Response

Business partner was successfully updated.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.