Supplier

Manage suppliers, including registration, update, deletion, and advanced search.
Suppliers can be linked to projects and support metadata and filtering.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/supplier/index

Returns a paginated and filterable list of suppliers.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching suppliers

object

filter

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

created_at

The timestamp when the supplier was created.

integer

updated_at

The timestamp of the last update operation on the supplier.

integer

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "name": "Supplier 1",
    "country": "Italy"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of suppliers

Array<object>

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

created_at

The timestamp when the supplier was created.

integer

updated_at

The timestamp of the last update operation on the supplier.

integer

Example

{
  "supplier_id": "sup-1",
  "name": "Supplier 1",
  "code": "SUP001",
  "country": "Italy",
  "project_id": "proj-1",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/supplier/create

Create a new supplier by providing the required details.

Request Body ^required

Supplier object to be created

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

Example

{
  "name": "Supplier 2",
  "code": "SUP002",
  "country": "France",
  "project_id": "proj-2"
}

Responses

201

Supplier created successfully

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

Example

{
  "supplier_id": "sup-2",
  "name": "Supplier 2",
  "code": "SUP002",
  "country": "France",
  "project_id": "proj-2"
}

view

GET

/v2/supplier/view/{id}

Retrieve a supplier by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the supplier to retrieve

Responses

200

Supplier found

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

created_at

The timestamp when the supplier was created.

integer

updated_at

The timestamp of the last update operation on the supplier.

integer

Example

{
  "supplier_id": "sup-1",
  "name": "Supplier 1",
  "code": "SUP001",
  "country": "Italy",
  "project_id": "proj-1",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

404

Supplier not found

delete

DELETE

/v2/supplier/delete/{id}

Delete a supplier by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the supplier to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Supplier deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/supplier/update/{id}

Update an existing supplier by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the supplier to update

Request Body ^required

Supplier object with updated data

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

Example

{
  "name": "Updated Supplier",
  "country": "Germany"
}

Responses

200

Supplier updated successfully

object

supplier_id

The unique identifier for the supplier.

string format: uuid

code

The code associated with the supplier, if available.

string

nullable <= 50 characters

name

The name of the supplier.

string

<= 255 characters

description

A description of the supplier, if available.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier’s address.

string

nullable <= 50 characters

region

The region of the supplier’s address.

string

nullable <= 10 characters

locality

The locality of the supplier’s address.

string

nullable <= 50 characters

country

The country of the supplier’s address.

string

nullable <= 20 characters

tax_code

The tax code associated with the supplier, if available.

string

nullable <= 20 characters

vat

The VAT number of the supplier, if available.

string

nullable <= 20 characters

project_id

The unique identifier for the associated project.

string format: uuid

<= 50 characters

Example

{
  "supplier_id": "sup-1",
  "name": "Updated Supplier",
  "country": "Germany"
}

404

Supplier not found