WorkPlaceSupplier

Manage work place suppliers, which represent the association between work places and suppliers.
You can create, update, delete, and search for work place suppliers with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-place-supplier/index

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

Request Body

Parameters for searching work place suppliers

object

filter

object

office_work_place_supplier_id

The unique identifier for the office work place supplier.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

The code for the office work place supplier.

string

nullable <= 50 characters

name

The name of the office work place supplier.

string

<= 255 characters

description

The description of the office work place supplier.

string

nullable

street

The street address of the office work place supplier.

string

nullable <= 255 characters

postal_code

The postal code of the office work place supplier.

string

nullable <= 50 characters

region

The region of the office work place supplier.

string

nullable <= 10 characters

locality

The locality of the office work place supplier.

string

nullable <= 50 characters

country

The country of the office work place supplier.

string

nullable <= 20 characters

tax_code

The tax code of the office work place supplier.

string

nullable <= 20 characters

vat

The VAT code of the office work place supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

The timestamp of the create operation.

integer

updated_at

The timestamp of the last update operation.

integer

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

work_place_code

The code for the work place.

string

work_place_name

The name of the work place.

string

work_place_description

The description of the work place.

string

nullable

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": "Work place supplier 1"
  },
  "per-page": 100,
  "page": 1,
  "sort": "name"
}

Responses

200

List of work place suppliers

Array<object>

object

office_work_place_supplier_id

The unique identifier for the office work place supplier.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

The code for the office work place supplier.

string

nullable <= 50 characters

name

The name of the office work place supplier.

string

<= 255 characters

description

The description of the office work place supplier.

string

nullable

street

The street address of the office work place supplier.

string

nullable <= 255 characters

postal_code

The postal code of the office work place supplier.

string

nullable <= 50 characters

region

The region of the office work place supplier.

string

nullable <= 10 characters

locality

The locality of the office work place supplier.

string

nullable <= 50 characters

country

The country of the office work place supplier.

string

nullable <= 20 characters

tax_code

The tax code of the office work place supplier.

string

nullable <= 20 characters

vat

The VAT code of the office work place supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

The timestamp of the create operation.

integer

updated_at

The timestamp of the last update operation.

integer

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

work_place_code

The code for the work place.

string

work_place_name

The name of the work place.

string

work_place_description

The description of the work place.

string

nullable

Example

{
  "office_work_place_supplier_id": "wps-1",
  "office_work_place_id": "wp-1",
  "supplier_office_id": "so-1",
  "name": "Work place supplier 1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "work_place_name": "Work Place 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

view

GET

/v2/work-place-supplier/view/{id}

Retrieve a work place supplier by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work place supplier to retrieve

Responses

200

Work place supplier found

object

office_work_place_supplier_id

The unique identifier for the office work place supplier.

string format: uuid

office_work_place_id

The unique identifier for the office work place.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

The code for the office work place supplier.

string

nullable <= 50 characters

name

The name of the office work place supplier.

string

<= 255 characters

description

The description of the office work place supplier.

string

nullable

street

The street address of the office work place supplier.

string

nullable <= 255 characters

postal_code

The postal code of the office work place supplier.

string

nullable <= 50 characters

region

The region of the office work place supplier.

string

nullable <= 10 characters

locality

The locality of the office work place supplier.

string

nullable <= 50 characters

country

The country of the office work place supplier.

string

nullable <= 20 characters

tax_code

The tax code of the office work place supplier.

string

nullable <= 20 characters

vat

The VAT code of the office work place supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

The timestamp of the create operation.

integer

updated_at

The timestamp of the last update operation.

integer

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

work_place_code

The code for the work place.

string

work_place_name

The name of the work place.

string

work_place_description

The description of the work place.

string

nullable

Example

{
  "office_work_place_supplier_id": "wps-1",
  "office_work_place_id": "wp-1",
  "supplier_office_id": "so-1",
  "name": "Work place supplier 1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "work_place_name": "Work Place 1",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

404

Work place supplier not found