Skip to content
4HSE

SupplierOffice

Manage supplier-office associations, which represent the relationship between suppliers and offices.
You can create, update, delete, and search for supplier offices with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/supplier-office/index

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

Request Body

Section titled “Request Body ”

Parameters for searching supplier offices

object
filter
object
supplier_office_id

The unique identifier for the supplier-office relationship.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
supplier_id

The unique identifier for the supplier.

string format: uuid
supplier_code

The code of the supplier.

string
supplier_name

The name of the supplier.

string
supplier_street

The street address of the supplier.

string
supplier_postal_code

The postal code of the supplier.

string
supplier_region

The region where the supplier is located.

string
supplier_locality

The locality of the supplier.

string
supplier_country

The country where the supplier is located.

string
supplier_tax_code

The tax code of the supplier.

string
supplier_vat

The VAT number of the supplier.

string
project_id

The unique identifier for the project.

string
project_name

The name of the project.

string
project_type

The type of the project.

string
office_code

The code of the office.

string
office_name

The name of the office.

string
owned_active

Indicates whether the office is owned and active.

boolean
parent_active

Indicates whether the parent office is active.

boolean
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": {
    "office_id": "off-1",
    "supplier_id": "sup-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "office_id"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of supplier offices

Array<object>
object
supplier_office_id

The unique identifier for the supplier-office relationship.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
supplier_id

The unique identifier for the supplier.

string format: uuid
supplier_code

The code of the supplier.

string
supplier_name

The name of the supplier.

string
supplier_street

The street address of the supplier.

string
supplier_postal_code

The postal code of the supplier.

string
supplier_region

The region where the supplier is located.

string
supplier_locality

The locality of the supplier.

string
supplier_country

The country where the supplier is located.

string
supplier_tax_code

The tax code of the supplier.

string
supplier_vat

The VAT number of the supplier.

string
project_id

The unique identifier for the project.

string
project_name

The name of the project.

string
project_type

The type of the project.

string
office_code

The code of the office.

string
office_name

The name of the office.

string
owned_active

Indicates whether the office is owned and active.

boolean
parent_active

Indicates whether the parent office is active.

boolean
Example
{
  "supplier_office_id": "so-1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "supplier_name": "Supplier 1",
  "office_name": "Main Office"
}

Headers

Section titled “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

Section titled “create”
POST
/v2/supplier-office/create

Create a new supplier office by providing the required details.

Request Body required

Section titled “Request Body required ”

Supplier office object to be created

object
supplier_office_id

The unique identifier for the supplier-office relationship.

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
Example
{
  "office_id": "off-2",
  "supplier_id": "sup-2"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Supplier office created successfully

object
supplier_office_id

The unique identifier for the supplier-office relationship.

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
Example
{
  "supplier_office_id": "so-2",
  "office_id": "off-2",
  "supplier_id": "sup-2"
}

view

Section titled “view”
GET
/v2/supplier-office/view/{id}

Retrieve a supplier office by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the supplier office to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Supplier office found

object
supplier_office_id

The unique identifier for the supplier-office relationship.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
supplier_id

The unique identifier for the supplier.

string format: uuid
supplier_code

The code of the supplier.

string
supplier_name

The name of the supplier.

string
supplier_street

The street address of the supplier.

string
supplier_postal_code

The postal code of the supplier.

string
supplier_region

The region where the supplier is located.

string
supplier_locality

The locality of the supplier.

string
supplier_country

The country where the supplier is located.

string
supplier_tax_code

The tax code of the supplier.

string
supplier_vat

The VAT number of the supplier.

string
project_id

The unique identifier for the project.

string
project_name

The name of the project.

string
project_type

The type of the project.

string
office_code

The code of the office.

string
office_name

The name of the office.

string
owned_active

Indicates whether the office is owned and active.

boolean
parent_active

Indicates whether the parent office is active.

boolean
Example
{
  "supplier_office_id": "so-1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "supplier_name": "Supplier 1",
  "office_name": "Main Office"
}
404
Section titled “404 ”

Supplier office not found

delete

Section titled “delete”
DELETE
/v2/supplier-office/delete/{id}

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

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the supplier office to delete

Query Parameters

Section titled “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Supplier office deleted successfully

400
Section titled “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

Section titled “update”
PUT
/v2/supplier-office/update/{id}

Update an existing supplier office by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the supplier office to update

Request Body required

Section titled “Request Body required ”

Supplier office object with updated data

object
supplier_office_id

The unique identifier for the supplier-office relationship.

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
Example
{
  "office_id": "off-1"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Supplier office updated successfully

object
supplier_office_id

The unique identifier for the supplier-office relationship.

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
Example
{
  "supplier_office_id": "so-1",
  "office_id": "off-1"
}
404
Section titled “404 ”

Supplier office not found