Pular para o conteúdo principal

Centros de custo

Centros de custo agrupam os lançamentos por setor, curso ou outro critério da empresa. O centro de custo é opcional nos lançamentos e pode ser usado como filtro nas listas e nos relatórios. Corresponde à aba Centros de custo da tela Configurações do menu Financeiro.

Os endereços a seguir são relativos a https://api.pedagogo.app. Este recurso é identificado pelo id numérico.

Endpoints​

MétodoCaminhoDescrição
GET/financial/settings/cost-centersLista os centros de custo
POST/financial/settings/cost-centersCadastra um centro de custo
PUT/financial/settings/cost-centers/{id}Altera um centro de custo
DELETE/financial/settings/cost-centers/{id}Apaga um centro de custo

Cadastrar​

POST /financial/settings/cost-centers​

Corpo

CampoObrigatórioTipoDescrição
cost_centerSimTextoNome do centro de custo
codeNãoTextoCódigo do centro de custo

Resposta (200): o centro de custo criado, com o id.

curl -X POST https://api.pedagogo.app/financial/settings/cost-centers \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"cost_center": "Centro exemplo", "code": "CC-01"}'

Listar​

GET /financial/settings/cost-centers​

Parâmetros de URL

ParâmetroDescrição
searchTexto livre. Busca no nome do centro de custo
column e orderOrdena pela coluna informada e pelo sentido (asc ou desc). Sem eles, a lista vem pelo código, ou pelo nome quando não há código
per_page e pagePaginação, conforme Convenções

Resposta (200): lista com id, cost_center, code e os nomes de quem criou e alterou o registro.

Alterar e apagar​

PUT /financial/settings/cost-centers/{id}​

Altera um centro de custo.

Corpo

CampoObrigatórioTipoDescrição
cost_centerSimTextoNome do centro de custo
codeNãoTextoCódigo do centro de custo

Resposta (200): o centro de custo alterado.

DELETE /financial/settings/cost-centers/{id}​

Apaga o centro de custo. Resposta 200, sem corpo.