🔒 Update supplier V3

patch

https://{xentralId}.xentral.biz/api/v3/suppliers/{id}

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: supplier:update.

Update an existing supplier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

number

string

Supplier number

deviatingSupplierNumber

string | null

Deviating supplier account number for accounting

mainProject

Main project the supplier belongs to

primaryAddress

object

Primary address information for the supplier

deviatingBillingAddress

Deviating billing address information. Set to null to delete the deviating billing address. When updating, the required fields (name, street, zipCode, city, country) cannot be set to null or empty.

communication

object

Communication preferences and settings

financials

object

Financial information and settings

fulfillment

object

Fulfillment and delivery settings

documentDelivery

object

Document delivery preferences

accountManager

Account manager reference

groups

array of objects

Groups the supplier belongs to

groups

supplierRoles

array of objects

Supplier roles associated with projects. All provided roles will be upserted.

supplierRoles

customFields

array of objects

Custom fields for additional custom data

customFields

notes

string | null

Notes for the supplier

supplierPurchaseNote

string | null

Supplier purchase note text

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Update an existing supplier.

400Failed validation

429Too Many Requests