Skip to content

Suppliers

Endpoints for listing, creating, and updating supplier records.

GET /suppliers

List suppliers with optional filtering and pagination.

Request

GET /api/{account}/v4.0.0/suppliers
Authorization: Bearer <xa-token>

Parameters

Name In Type Required Description
nonce query integer (int64) No Client-generated unique sequential number
searchString query string No Search by supplier code or number
searchColumn query string No Column to search instead of the default field
searchOperator query string No Comparison operator: lt, lte, gt, gte, ne
limit query integer No Max records to return. Max: 1000, default: 50

Responses

200 — Success

Returns an array of thirdParty objects (empty array if none found).

400 — Invalid input parameters

POST /suppliers

Add a new supplier to the system.

Request

POST /api/{account}/v4.0.0/suppliers?nonce={nonce}
Authorization: Bearer <xa-token>
Content-Type: application/json

Parameters

Name In Type Required Description
nonce query integer (int64) Yes Client-generated unique sequential number

Request Body

A thirdParty object.

{
  "name": "New Supplier Lda",
  "vat_id": "PT111222333",
  "email": "orders@supplier.com"
}

Responses

201 — Created

Returns an entityCreated object.

400 — Invalid input

Returns an apiError.

409 — Duplicate entry

PUT /suppliers

Update an existing supplier record.

Request

PUT /api/{account}/v4.0.0/suppliers?nonce={nonce}
Authorization: Bearer <xa-token>
Content-Type: application/json

Parameters

Name In Type Required Description
nonce query integer (int64) Yes Client-generated unique sequential number

Request Body

A thirdParty object with the id or identifying code of the record to update.

Responses

201 — Updated

400 — Invalid input

409 — Conflict

See Also