Pular para o conteúdo principal

Centros de custo da empresa

Centros de custo organizam as cobranças de uma empresa. Correspondem à lista Centros de custo da aba Cadastros, na tela Empresas. O centro de custo aparece como filtro na aba Treinamentos.

Endpoints​

MétodoCaminhoDescrição
GET/administrative/business/{customer_vendor_uuid}/cost-centersLista os centros de custo da empresa
POST/administrative/business/{customer_vendor_uuid}/cost-centersCadastra um centro de custo
GET/administrative/business/{customer_vendor_uuid}/cost-centers/{id}Consulta um centro de custo
PUT/administrative/business/{customer_vendor_uuid}/cost-centers/{id}Altera um centro de custo
DELETE/administrative/business/{customer_vendor_uuid}/cost-centers/{id}Apaga um centro de custo

O {customer_vendor_uuid} é o uuid da empresa. O {id} é o id numérico do centro de custo.

Endpoints de centros de custo​

GET /administrative/business/{customer_vendor_uuid}/cost-centers​

Lista os centros de custo da empresa, por ordem alfabética do nome, salvo se columnName e orderData forem informados.

Parâmetros de URL

ParâmetroDescrição
searchBusca pelo nome do centro de custo
columnName e orderDataOrdenação: coluna e direção
per_page e pagePaginação

Resposta: 200, lista com id, customer_vendor_id, name (nome da empresa), cost_center e o nome de quem criou o registro.

POST /administrative/business/{customer_vendor_uuid}/cost-centers​

Cadastra um centro de custo.

Corpo

CampoObrigatórioTipoDescrição
cost_centerSimTextoNome do centro de custo

Resposta: 201, com o centro de custo criado.

GET /administrative/business/{customer_vendor_uuid}/cost-centers/{id} e DELETE /administrative/business/{customer_vendor_uuid}/cost-centers/{id}​

Consultar e apagar um centro de custo. A exclusão é lógica e não verifica se o centro de custo está em uso.

Resposta: 200.

PUT /administrative/business/{customer_vendor_uuid}/cost-centers/{id}​

Altera um centro de custo.

Corpo

CampoObrigatórioTipoDescrição
cost_centerSimTextoNome do centro de custo

Resposta: 200, com o centro de custo alterado.