01. DADOS GERAIS
Produto: | TOTVS Backoffice |
---|---|
Linha de Produto: | Linha Datasul |
Segmento: | Manufatura |
Módulo: | TOTVS Backoffice (Linha Datasul) - Estoque (MCE) |
Função: | Saldo em Estoque |
País: | Brasil |
Ticket: | |
Requisito/Story/Issue (informe o requisito relacionado) : | DMANESTOQ-12806 |
02. SITUAÇÃO/REQUISITO
Criação de API REST com método de GET (consulta) saldos em estoque a fim de substituir a integração EAI. A integração a ser substituída é: adapters/xml/ar2/axrar003.p.
03. SOLUÇÃO
GET - Consulta de saldos em estoque. Deve ser enviada requisição GET na ROTA http://[servidor]/dts/datasul-rest/resources/prg/cep/v3/stockBalancePublic passando os filtros padrões no parâmetro $filter, de acordo com a necessidade das informações. Os filtros informados no parâmetro $filter serão aplicados exclusivamente aos campos da tabela saldo-estoq.
04. DEMAIS INFORMAÇÕES
Demais parâmetros de filtros - método GET:
Os seguintes parâmetros deverão ser passados via URL para realizar o filtro das informações.
stockGroupIni → Grupo de estoque inicial (padrão 0)
stockGroupEnd → Grupo de estoque final (padrão 99)
materialFamilyIni → Família Material Inicial (padrão branco)
materialFamilyEnd → Família Material Final (padrão ZZZZZZZZ)
Parâmetros para indicar o tipo de depósito (CD0601) que não será considerado para consulta dos saldos. O padrão de todos é true/yes (verdadeiro). Para desconsiderar algum tipo de depósito, passar o parâmetro na URL como false/no (falso).
includeAvailBalance → Considera Saldo Disponível
considerMrpOrders → Considera Saldo Ordens MRP
finishedProdWarehouse → Depósito Produto Acabado
recycledWarehouse → Depósito Reciclado
qcWarehouse → Depósito CQ
scrapWarehouse → Depósito Rejeito
processWarehouse → Depósito Processo
internalWarehouse → Depósito Interno
externalWarehouse → Depósito Externo
Formato de resposta JSON - método GET:
CAMPOS
"siteCode": "1", → Código do Estabelecimento
"unitOfMeasure": null, → Unidade de Medida
"itemCode": "RDP.TT", → Código do item
"qtyAllocOrder": 0, → Quantidade alocada (qt-aloc-ped)
"warehouseCode": "alm", → Depósito
"lot": "", → Lote ou Série
"qtyAvailBalance": 21, → Quantidade Atual Disponivel
"lastCountDate": null, → Data última Contagem (dt-ul-contag)
"qtyAllocProd": 0, → Quantidade alocada (qt-aloc-prod)
"manufacturingDate": "2024-08-06", → Data de produção
"locationCode": "", → Localização
"referenceCode": "", → Referência
"qtyAllocated": 0, → Quantidade alocada (qt-alocada)
"expirationDate": NULL → Data de Validade do Lote
"balanceDate": → Data do Saldo
"qtyDate": → Quantidade na Data
"qtyCurrent": → Quantidade Atual Total
JSON
{
"total": 1,
"totalHits": 1,
"hasNext": false,
"items": [
{
"siteCode": "1",
"unitOfMeasure": "pc",
"itemCode": ".compras1",
"qtyAllocOrder": 0.0,
"warehouseCode": "001",
"lot": "",
"lastCountDate": null,
"qtyAvailBalance": 7191.0,
"qtyAllocProd": 0.0,
"balanceDate": "2024-09-16",
"manufacturingDate": "2024-08-06",
"qtyCurrent": 11803.0,
"locationCode": "",
"referenceCode": "",
"qtyAllocated": 4612.0,
"expirationDate": null,
"qtyDate": 11803.0
}
]
}
05. ASSUNTOS RELACIONADOS