Skip to main content

🌐 Rotas

📂 Criar

Método HTTP: POST

/api/v1/costCenter

Header: Content-Type

application/json

Header: KEY

{chave_de_api}

Corpo da Requisição
{
"title": "Nome do Centro de Custo"
}
Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID do Centro de Custo",
"title": "Nome do Centro de Custo",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível criar o centro de custo.",
"error": { ... }
}

📂 Atualizar

Método HTTP: PUT

/api/v1/costCenter/{id}

Header: Content-Type

application/json

Header: KEY

{chave_de_api}

Corpo da Requisição
{
"title": "Nome do Centro de Custo"
}
Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID do Centro de Custo",
"title": "Nome do Centro de Custo",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível atualizar o centro de custo.",
"error": { ... }
}

📂 Procurar

Método HTTP: GET

/api/v1/costCenter/{id}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{
"success": true,
"data": {
"id": "ID do Centro de Custo",
"title": "Nome do Centro de Custo",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível retornar o centro de custo.",
"error": { ... }
}

📂 Listar

Método HTTP: GET

/api/v1/costCenters

/api/v1/costCenters/{limit}

/api/v1/costCenters/{skip}/{limit}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{
"success": true,
"data": [
{
"id": "ID do Centro de Custo",
"title": "Nome do Centro de Custo",
"createdAt": "Data de Criação",
"updatedAt": "Data de Atualização"
}
]
}
Resposta (Erro)
{
"success": false,
"message": "Não foi possível retornar os centros de custo.",
"error": { ... }
}

📂 Deletar

Método HTTP: DELETE

/api/v1/costCenter/{id}

Header: KEY

{chave_de_api}

Resposta (Sucesso)
{ "success": true }
Resposta (Erro)
{
"success": false,
"message": "Não foi possível deletar o centro de custo.",
"error": { ... }
}