O que são APIs?
API (Application Programming Interface) é uma padronização para comunicação e troca de dados entre dois sistemas. Na prática, é um conjunto de endpoints que formam um recurso (por exemplo: Clientes, Credores, Movimentos de Estoque) e permitem obter, criar, editar ou excluir informações desse recurso.
A documentação de APIs do Sienge é dinâmica e pode ser atualizada com frequência. A referência técnica sempre válida está em: https://api.sienge.com.br/docs/
API REST – Movimento de Estoque
A API de Movimento de Estoque retorna informações sobre os insumos no estoque de um centro de custo, excluindo os que estão com quantidade zerada. Cada item representa o estoque de um insumo por combinação de insumo, detalhe e marca, incluindo apropriações de obra e reservas, de forma paginada. A API também permite criar movimentos de entrada e saída e transferências entre centros de custo, além de consultar os movimentos já realizados.
A API REST de Movimento de Estoque possui 9 endpoints, organizados em quatro grupos. A documentação técnica completa está em: https://api.sienge.com.br/docs/#/stock-inventories-v1
Endpoints disponíveis
Método | Endpoint | Descrição |
GET | /stock-inventories/{costCenterId}/items | Lista os insumos atuais no estoque do centro de custo (exceto quantidade zerada). |
GET | /stock-inventories/{costCenterId}/items/{resourceId}/building-appropriation | Consulta as apropriações de obra do insumo em estoque no centro de custo. |
GET | /stock-reservations | Lista todas as reservas consistentes, de forma paginada. |
GET | /stock-reservations/{reservationId}/items | Lista os itens da reserva de estoque informada, de forma paginada. |
POST | /stock-reservations/{reservationId}/movements | Cria um movimento que atende a reserva. |
POST | /stock-movements | Cria um movimento de estoque de entrada ou saída, para um ou mais insumos. |
POST | /stock-movements/transfer | Realiza uma transferência de estoque entre centros de custo. |
GET | /inventory-movements | Retorna a coleção de movimentações de estoque, de forma paginada. |
GET | /inventory-movements/{id} | Retorna uma movimentação de estoque específica. |
Itens em Estoque
- GET /stock-inventories/{costCenterId}/items — retorna todos os insumos atuais no estoque do centro de custo informado. Insumos com quantidade zerada não são retornados. Cada item representa o estoque de uma combinação de insumo, detalhe e marca.
- GET /stock-inventories/{costCenterId}/items/{resourceId}/building-appropriation — consulta as apropriações de obra do insumo em estoque no centro de custo.
Reservas de Estoque
- GET /stock-reservations — lista todas as reservas consistentes, de forma paginada.
- GET /stock-reservations/{reservationId}/items — lista os itens da reserva informada, de forma paginada.
- POST /stock-reservations/{reservationId}/movements — cria um movimento que atende a reserva.
Movimentos de Estoque
- POST /stock-movements — cria um movimento de entrada ou saída, para um ou mais insumos.
- POST /stock-movements/transfer — realiza uma transferência de estoque entre centros de custo.
- GET /inventory-movements — retorna a coleção de movimentações de estoque (entradas e saídas), de forma paginada.
- GET /inventory-movements/{id} — retorna uma movimentação de estoque específica pelo identificador.
Atenção! A consulta (GET) de movimentos de estoque é feita pelo endpoint GET /inventory-movements, e não por GET /stock-movements. No path /stock-movements está disponível apenas o método POST (criação de movimento).
Filtros do GET /inventory-movements
A consulta de movimentos aceita os parâmetros abaixo (todos opcionais), combináveis para refinar o resultado:
Parâmetro | Descrição |
documentId | Filtra pelo número do documento associado ao movimento. |
movementNumber | Filtra pelo número do movimento. |
movementTypeId | Filtra pelo tipo de movimento (entrada, saída, etc.). |
startDate | Data inicial do período de consulta. |
endDate | Data final do período de consulta. |
costCenterId | Filtra pelo centro de custo. |
buildingId | Filtra pela obra. |
offset | Deslocamento inicial da paginação (registro de início). |
limit | Quantidade máxima de registros retornados por página. |
Dica! Use startDate e endDate junto com costCenterId para consultar os movimentos de um centro de custo em um período específico, e offset/limit para percorrer os resultados paginados.
Quais clientes podem utilizar APIs?
Os recursos de API estão disponíveis para clientes DC (Data Center). Para clientes com servidor local, o acesso a APIs não está disponível.
Para saber mais sobre disponibilidade e planos, acesse Quais clientes podem utilizar APIs e quais recursos estão disponíveis?.
Artigos relacionados
- Como entender a documentação das APIs?
- Quais clientes podem utilizar APIs e quais recursos estão disponíveis?
Esperamos que este artigo tenha ajudado!