Pular para o conteúdo principal

Insumos

Materiais de consumo cadastrados no almoxarifado. Cada insumo pertence a um grupo e pode ter uma unidade de medida. Os lançamentos de entrada e de saída são feitos nas movimentações, em Inventário. O saldo aparece em Estoque. Corresponde à tela Insumos, do módulo Almoxarifado. Os arquivos ficam em Arquivos do insumo.

Endpoints​

MétodoCaminhoDescrição
GET/warehouse/suppliesLista os insumos
POST/warehouse/suppliesCadastra um insumo
GET/warehouse/supplies/{uuid}Consulta um insumo
PUT/warehouse/supplies/{uuid}Altera um insumo
DELETE/warehouse/supplies/{uuid}Apaga um insumo
GET/warehouse/supplies/groupsLista os grupos, para o campo Grupo
GET/warehouse/supplies/measurement-unitsLista as unidades de medida, para o campo Unidade de medida

GET /warehouse/supplies​

Lista os insumos da empresa cliente, ordenados pelo grupo.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pelo nome, pelo código, pelo fabricante ou pelo nome do grupo
group_idLista somente os insumos do grupo de id informado
per_pageQuantidade de registros por página. Com ele, a resposta é paginada
pageNúmero da página, quando per_page é informado

Resposta (200): lista de insumos com os campos do cadastro, group_name, e quantity, que é a soma das quantidades das movimentações concluídas do insumo. Para o saldo, use Estoque. Inclui também os nomes de quem criou e de quem alterou por último.

POST /warehouse/supplies​

Cadastra um insumo.

Corpo

CampoObrigatórioTipoDescrição
group_idSimNúmero inteiroid do grupo, obtido em GET /warehouse/supplies/groups
detailsSimTextoNome do insumo (Suprimento)
serial_numberSimTextoCódigo de identificação do insumo
measurement_unit_idNãoNúmero inteiroid da unidade de medida, obtido em GET /warehouse/supplies/measurement-units
manufacturerNãoTextoNome do fabricante
manufacturer_codeNãoTextoCódigo do insumo no fabricante
dimensionsNãoTextoDimensões do insumo
weightNãoNúmeroPeso do insumo
cost_priceNãoNúmeroPreço de custo. Ao concluir uma movimentação, este valor é atualizado com o preço da movimentação
quantityNãoNúmeroQuantidade informada no cadastro
observationNãoTextoObservações livres

Resposta (201): o insumo criado, com uuid.

curl -X POST https://api.pedagogo.app/warehouse/supplies \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"group_id": 2, "details": "Luva de borracha", "serial_number": "LUV-001", "measurement_unit_id": 1}'

Consultar, alterar e apagar​

  • GET /warehouse/supplies/{uuid}: devolve o insumo, com os dados do grupo e da unidade de medida. Resposta (200).
  • PUT /warehouse/supplies/{uuid}: altera o insumo. Os campos são os mesmos do cadastro, todos com Não, e só os informados são alterados. Resposta (200): o insumo alterado.
  • DELETE /warehouse/supplies/{uuid}: apaga o insumo (exclusão lógica). Resposta (200), com corpo null.

GET /warehouse/supplies/groups​

Lista os grupos de insumos, para o campo Grupo. A resposta é a de Grupos.

GET /warehouse/supplies/measurement-units​

Lista as unidades de medida, para o campo Unidade de medida. A resposta é a de Unidades de medida.