Sign in
latestOpenAPI 3.0.02026-07-24161168406.5 KB

3f26defa2a42

Operation Unit
Operation Unit

Create a new operation unit

Creates an operation unit for the current company. Only name and externalCode are required.

post/os/v1/operation-units

Request body

namestring required

operation unit name

externalCodestring required

operation unit external code

addressstring

operation unit address

businessRegistrationNumberstring

operation unit business registration number (CNPJ)

externalCodeParentstring

parent operation unit external code

Example request

{
  "name": "Matriz Sao Paulo",
  "externalCode": "SP001",
  "address": "Av. Paulista, 1000 - Sao Paulo, SP",
  "businessRegistrationNumber": "12.345.678/0001-90",
  "externalCodeParent": "SP000"
}

Response

Operation unit successfully created

pathstring required

Request path

durationstring required

Request duration

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' required

HTTP method used

Example response

{
  "result": {
    "name": "Matriz São Paulo",
    "externalCode": "SP001",
    "address": "Av. Paulista, 1000 - São Paulo, SP",
    "businessRegistrationNumber": "12.345.678/0001-90",
    "company": {
      "id": "1",
      "name": "Gupy"
    },
    "parent": {
      "name": "Matriz São Paulo",
      "externalCode": "SP001",
      "address": "Av. Paulista, 1000 - São Paulo, SP",
      "businessRegistrationNumber": "12.345.678/0001-90",
      "company": {
        "id": "1",
        "name": "Gupy"
      }
    }
  }
}