Skip to main content
PUT
/
companies
/
{id}
Update a company
curl --request PUT \
  --url https://api.example.com/companies/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACTIVE"
}
'
{
  "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
  "tenantId": "e305e9a4-585e-49b8-bc88-9fba992c6326",
  "name": "Acme Corp (Atualizada)",
  "document": "12345678000199",
  "status": "ACTIVE",
  "email": "contato_novo@acme.com",
  "address": null,
  "settings": {},
  "taxRegime": "SIMPLES_NACIONAL",
  "costMethod": "WEIGHTED_AVERAGE",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "updatedAt": "2024-02-01T12:00:00.000Z"
}

​
Path

​
id
string
required
UUID da empresa que será atualizada.

​
Body

​
name
string
Razão Social ou Nome Fantasia da empresa.
​
document
string
CNPJ ou CPF (somente números).
​
email
string
Email de contato da empresa.
​
address
object
Endereço completo estruturado.
​
settings
object
Configurações extras da empresa alocadas em JSON.

​
Response

{
  "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
  "tenantId": "e305e9a4-585e-49b8-bc88-9fba992c6326",
  "name": "Acme Corp (Atualizada)",
  "document": "12345678000199",
  "status": "ACTIVE",
  "email": "contato_novo@acme.com",
  "address": null,
  "settings": {},
  "taxRegime": "SIMPLES_NACIONAL",
  "costMethod": "WEIGHTED_AVERAGE",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "updatedAt": "2024-02-01T12:00:00.000Z"
}

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>

Update status

Available options:
ACTIVE,
DISABLED,
BLOCKED,
SUSPENDED

Response

Company updated successfully.

​
name
string
required

Company Name

Example:

"Acme Corp"

​
document
string
required

CNPJ or CPF

Example:

"12345678000199"

​
status
enum<string>
required

Company Status

Available options:
ACTIVE,
DISABLED,
BLOCKED,
SUSPENDED
Example:

"ACTIVE"

​
settings
object
required

Configuration Settings

Example:
{}
​
taxRegime
enum<string>
required

Tax Regime

Available options:
SIMPLES_NACIONAL,
LUCRO_PRESUMIDO,
LUCRO_REAL
Example:

"SIMPLES_NACIONAL"

​
costMethod
enum<string>
required

Cost Method

Available options:
REPLACEMENT,
WEIGHTED_AVERAGE
Example:

"WEIGHTED_AVERAGE"

​
email
string

Contact Email

Example:

"contact@acme.com"

​
address
object

Address Object