Obter a relação dos valores de saldos contábeis de Crédito e Débito de Material, Mão de Obra e GGF de uma ordem de produção específica, podendo ser resumido ou detalhado por operação. É possível consultar os valores em períodos passados ou o acumulado mais recente.
Informações da API utilizada para busca dos dados e nome do cadastro de menu relacionado à API, caso o usuário queira restringir o acesso. Mais informações: Manutenção de Programa (MEN012AA)
| MÉTODO | GET |
|---|---|
| API | api/csp/v1/orderBalances |
| ROTA | / |
| MENU | orderBalances_csp_v1 |
Exemplos de perguntas que deverão ser respondidas por esse assunto.
| Pergunta | |
|---|---|
| 1 | Quais os saldos contábeis da minha ordem de produção <código>? |
| 2 | Qual o total de crédito da OP <código>? |
| 3 | Qual o total de débitos da OP <código>? |
São os possíveis campos utilizados na busca dos dados pela API.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| productionOrderNumber | string | Número da ordem de produção | Sim |
| period | string | Período/data para busca dos saldos | não |
| currencyCode | string | código da moeda, se não for informado, enviar 0 | sim |
O glossário é um conjunto de termos utilizados para definir a tradução das propriedades retornadas no JSON da API. Além disso, os campos apresentados são incluídos na cláusula FIELDS da query, ou seja, somente esses campos são retornados na resposta da API.
| Propriedade | Descrição | Tipo | Formato |
|---|---|---|---|
| balancePeriod | Período | character | |
| currencyCode | Moeda | integer | ->>>,>>>,>>9 |
| itemCode | Item da Ordem | character | |
| laborBalance | Saldo Valor Mão de Obra | decimal | ->>>>,>>>,>>9.9999 |
| laborCreditValue | Valor Crédito Mão de Obra | decimal | ->>>>,>>>,>>9.9999 |
| laborDebitValue | Valor Débito Mão de Obra | decimal | ->>>>,>>>,>>9.9999 |
| materialBalance | Saldo Valor Materiais | decimal | ->>>>,>>>,>>9.9999 |
| materialCreditValue | Valor Crédito Materiais | decimal | ->>>>,>>>,>>9.9999 |
| materialDebitValue | Valor Débito Materiais | decimal | ->>>>,>>>,>>9.9999 |
| operationSequence | Seq. Operação | integer | ->>>,>>>,>>9 |
| overheadBalance | Saldo Valor GGF | decimal | ->>>>,>>>,>>9.9999 |
| overheadCreditValue | Valor Crédito GGF | decimal | ->>>>,>>>,>>9.9999 |
| overheadDebitValue | Valor Débito GGF | decimal | ->>>>,>>>,>>9.9999 |
| period | Período do saldo | character | |
| productionOrderNumber | Ordem de Produção | integer | ->>>,>>>,>>9 |
| status | Estado | character |
São sugestões de novas perguntas ou ações que serão sugeridas ao usuário após a execução desse assunto.