Histórico da Página
Contexto Geral
A API tem objetivo de consultar às movimentações de NF de cana com parâmetros obrigatórios e opcionais para buscas mais assertivas, incorporando:
Modelo de integração padronizado para orquestrar consultas e bloqueios.
Novo cadastro de status vinculado a um parâmetro de configuração da API que controla o comportamento dentro do TOTVS Agro Bioenergia.
Bloqueio de reversões já integradas em sistemas de origem do Bioenergia, preservando a integridade do processo.
Método GET:
http:127.0.0.1:8080/query/v1/canaMuda
Estruturas:
| Cabeçalho (Header) | ||||
| Campo | Tipo | Obrigatório | Exemplo | Descrição |
| instancia | string | Sim | 1 | Identificador da instância |
| fgTpNota | string | Sim | Cana de Muda Mensal | Tipo da nota fiscal |
| noNf | integer | Sim | 1 | Número da NF |
| cdSerieNf | string | Sim | 1 | Série da NF |
| cdUnidInd | integer | Sim | 1 | Unidade industrial |
| cdTpProp | integer | Sim | 2 | Tipo de propriedade |
| cdUpnivel1 | string | Sim | 10005B | Código da UPNIVEL 1 (Ex. Fazenda) |
| deUpNivel1 | string | Sim | SÃO PEDRO | Descrição da UPNIVEL 1 (Ex. Fazenda) |
| deNatOper | string | Sim | NOTA CANA MUDA | Natureza da operação |
| cdFiscOp | integer | Sim | 1101 | Código fiscal operação |
| cdFornec | integer | Sim | 28785 | Código do fornecedor |
| deFornec | string | Sim | GUILHERME BARROS BIAGI | Nome do fornecedor |
| cdSafra | integer | Sim | 2016 | Safra associada |
| amFornec | string(date-time) | Sim | 2016-04-01T00:00:00 | Mês/Ano referência fornecedor |
| acPeso | integer | Sim | 156136 | Peso acumulado |
| vlTotNf | number | Sim | 10079.55 | Valor total da NF |
| dtEmisNf | string(date-time) | Sim | 2016-04-30T00:00:00 | Data emissão NF |
| acTxContrib | number | Sim | 231.83 | Taxa contribuição acumulada |
| vlLiqNf | number | Sim | 9847.72 | Valor líquido NF |
| cdTpCalc | string/null | Não | null | Tipo de cálculo |
| fgComplPreco | string/null | Não | null | Flag complemento preço |
| deObs | string/null | Não | null | Observação |
| deFiscOp | string/null | Não | null | Descrição operação fiscal |
| cdClassFisc | string/null | Não | null | Classificação fiscal |
| fgSubstituicao | string/null | Não | null | Flag Substituição tributária |
| vlCredIcmsf | number/null | Não | null | Crédito ICMS |
| fgAcertoAnual | string/null | Não | null | Flag acerto anual |
| fgManAuto | string | Sim | M | Flag manual/automático |
| fgCpr | string/null | Não | null | Flag CPR |
| fgIndividual | string/null | Não | null | Flag individual |
| noContrCana | integer | Sim | 1262 | Contrato de cana |
| cdEmpresa | string | Sim | 1 | Código empresa |
| instContr | string | Sim | 1 | Instância contrato |
| cdMunic | string/null | Não | null | Município |
| noNfCompl | integer/null | Não | null | NF complementar |
| cdSerieNfCompl | string/null | Não | null | Série NF complementar |
| noNfErpCompl | string/null | Não | null | NF ERP complementar |
| Detalhe ( Detail) | ||||
| Campo | Tipo | Obrigatório | Exemplo | Descrição |
| cdUnidInd | integer | Sim | 1 | Unidade industrial |
| vlTonCana | number | Sim | 57.38 | Valor por tonelada |
| ddFim | integer | Sim | 30 | Dia fim do período |
| vlFatorK | number/null | Não | null | Fator K |
| noNf | integer | Sim | 1 | Número NF |
| vlTotalServ | number/null | Não | null | Valor total serviço |
| vlRef | number/null | Não | null | Valor referência |
| qCanaEnt | integer | Sim | 5073060 | Quantidade cana entregue |
| vlTotal | number | Sim | 291092.18 | Valor total |
| cdSerieNf | string | Sim | 1 | Série NF |
| vlAcertoAtr | number/null | Não | null | Valor acerto ATR |
| vlAcAtrReceb | number/null | Não | null | Valor ATR recebido |
| instancia | string | Sim | 1 | Instância |
| vlKgAtr | number/null | Não | null | Valor ATR/kg |
| cdTpCalc | string/null | Não | null | Tipo cálculo |
| dataInicial | integer | Sim | 1 | Data inicial |
| pcPgVlTon | number/null | Não | null | Percentual pagamento tonelada |
| vlBonusTon | number/null | Não | null | Valor bônus tonelada |
| Histórico de Taxas | ||||
| Campo | Tipo | Obrigatório | Exemplo | Descrição |
| dtIniPer | string(date-time) | Sim | 2016-04-01T00:00:00 | Data início período |
| cdGrpTxContr | integer | Sim | 1 | Grupo taxa contribuição |
| instancia | string | Sim | 1 | Instância |
| cdUnidInd | integer | Sim | 1 | Unidade industrial |
| dtFimPer | string(date-time) | Sim | 2016-04-30T00:00:00 | Data fim período |
| vlTxContrib | number | Sim | 6112.94 | Valor taxa contribuição |
| cdTxContr | integer | Sim | 1 | Código taxa contribuição |
Método GET:
http:127.0.0.1:8080/query/v1/canaMuda
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"hasNext": false,
"items": [ {
"instancia": "1",
"fgTpNota": "Cana de Muda Mensal",
"noNf": 1,
"cdSerieNf": "1",
"cdUnidInd": 1,
"cdTpProp": 2,
"cdUpnivel1": "10005B",
"deUpNivel1": "SÃO PEDRO",
"deNatOper": "NOTA CANA MUDA",
"cdFiscOp": 1101,
"cdFornec": 28785,
"deFornec": "TOTVS SA",
"cdSafra": 2016,
"amFornec": "2016-04-01T00:00:00",
"acPeso": 156136,
"vlTotNf": 10079.55,
"dtEmisNf": "2016-04-30T00:00:00",
"acTxContrib": 231.83,
"vlLiqNf": 9847.72,
"cdTpCalc": null,
"fgComplPreco": null,
"deObs": null,
"deFiscOp": null,
"cdClassFisc": null,
"dfSubstituicao": null,
"vlCredIcmsf": null,
"fgAcertoAnual": null,
"fgManAuto": "M",
"dfCpr": null,
"fgIndividual": null,
"noContrCana": 1262,
"cdEmpresa": "1",
"instContr": "1",
"cdMunic": null,
"noNfCompl": null,
"cdSerieNfCompl": null,
"noNfErpCompl": null,
"detalheNfDeOut": [
{
"cdUnidInd": 1,
"vlTonCana": 57.38,
"ddFim": 30,
"vlFatorK": null,
"noNf": 1,
"vlTotalServ": null,
"vlRef": null,
"qCanaEnt": 5073060,
"vlTotal": 291092.18,
"cdSerieNf": "1",
"vlAcertoAtr": null,
"vlAcAtrReceb": null,
"instancia": "1",
"detalheshistTxOut": [
{
"dtIniPer": "2016-04-01T00:00:00",
"cdGrpTxContr": 1,
| ||||
| Bloco de código | ||||
| ||||
{ "hasNext": false, "items": [ { "instancia": "1", "fgTpNota": "Cana de Muda Mensal", "noNf": 1, "cdSerieNf": "1", "cdUnidInd": 1, "cdTpProp": 2, "cdUpnivel1": "10005B", "deUpNivel1": "SÃO PEDRO", "deNatOper": "NOTA CANA MUDA", "cdFiscOp": 1101, "cdFornec": 28785, "deFornec": "GUILHERME BARROS BIAGI", "cdSafra": 2016, "amFornec": "2016-04-01T00:00:00", "acPeso": 156136, "vlTotNf": 10079.55, "dtEmisNf": "2016-04-30T00:00:00", "acTxContrib": 231.83, "vlLiqNf": 9847.72, "cdTpCalc": null, "fgComplPreco": null, "deObs": null, "deFiscOp": null, "cdClassFisc": null, "dfSubstituicao": null, "vlCredIcmsf": null, "fgAcertoAnual": null, "fgManAuto": "M", "dfCpr": null, "fgIndividual": null, "noContrCana": 1262, "cdEmpresa": "1", "instContr": "1", "cdMunic": null, "noNfCompl": null, "cdSerieNfCompl": null, "noNfErpCompl": null, "detalheNfDeOut": [ { "cdUnidInd": 1, "vlTonCana": 57.38, "ddFim": 30, "vlFatorK": null, "noNf": 1, "vlTotalServ": null, "vlRef": null, "qCanaEnt": 5073060, "vlTotal": 291092.18, "cdSerieNf": "1", "vlAcertoAtr": null, "vlAcAtrReceb": null, "instancia": "1", "detalheshistTxOut": [ { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 6112.94, "cdTxContr": 1 }, { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 582.18, "cdTxContr": 2 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 462.74, "cdTxContr": 1 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 71.19, "cdTxContr": 2 } ], "vlKgAtr": null, "cdTpCalc": null, "dataInicial": 1, "pcPgVlTon": null, "vlBonusTon": null }, { "cdUnidInd": 1, "vlTonCana": 56, "ddFim": 31, "vlFatorK": null, "noNf": 1, "vlTotalServ": null, "vlRef": null, "qCanaEnt": 635635, "vlTotal": 35595.56, "cdSerieNf": "1", "vlAcertoAtr": null, "vlAcAtrReceb": null, "instancia": "1", "detalheshistTxOut": [ { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 6112.94, "cdTxContr": 1 }, { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 582.18, "cdTxContr": 2 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 462.74, "cdTxContr": 1 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 71.19, "cdTxContr": 2 } ], "vlKgAtr": null, "cdTpCalc": null, "dataInicial": 1, "pcPgVlTon": null, "vlBonusTon": null }, { "cdUnidInd": 1, "vlTonCana": 40, "ddFim": 31, "vlFatorK": null, "noNf": 1, "vlTotalServ": null, "vlRef": null, "qCanaEnt": 1000, "vlTotal": 40, "cdSerieNf": "1", "vlAcertoAtr": null, "vlAcAtrReceb": null, "instancia": "1", "detalheshistTxOut": [ { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 6112.94, "cdTxContr": 1 }, { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 582.18, "cdTxContr": 2 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 462.74, "cdTxContr": 1 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 71.19, "cdTxContr": 2 } ], "vlKgAtr": null, "cdTpCalc": null, "dataInicial": 1, "pcPgVlTon": null, "vlBonusTon": null }, { "cdUnidInd": 1, "vlTonCana": 40, "ddFim": 31, "vlFatorK": null, "noNf": 1, "vlTotalServ": null, "vlRef": null, "qCanaEnt": 1000, "vlTotal": 40, "cdSerieNf": "1", "vlAcertoAtr": null, "vlAcAtrReceb": null, "instancia": "1", "detalheshistTxOut": [ { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 6112.94, "cdTxContr": 1 }, { "dtIniPer": "2016-04-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-04-30T00:00:00", "vlTxContrib": 582.18, "cdTxContr": 2 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPercdUnidInd": "2016-05-31T00:00:00"1, "vlTxContrib": 462.74, "cdTxContrdtFimPer": 1 }, { "dtIniPer": "2016-05-01T00:00:00", "cdGrpTxContr": 1, "instancia": "1", "cdUnidInd": 1, "dtFimPer": "2016-05-31T00:00:00", "vlTxContrib": 71.19, "cdTxContr": 2 } ], "vlKgAtr": null, "cdTpCalc": null, "dataInicial": 1, "pcPgVlTon": null, "vlBonusTon": null } ] } "2016-04-30T00:00:00", "vlTxContrib": 6112.94, "cdTxContr": 1 } ], "vlKgAtr": null, "cdTpCalc": null, "dataInicial": 1, "pcPgVlTon": null, "vlBonusTon": null }, ] } ] } |
Parâmetros Obrigatórios
...
- noNf: Número da Nota Fiscal.
- cdSerieNf:Série da Nota Fiscal.
- cdUnidInd: Código Unidade Industrial.
Atualizar status de integração -
...
Notas Fiscais de
...
Cana
...
Muda
Disponibilizado endpoint para atualizar atualização do status de integração dos registros relacionados às de Notas Fiscais de Cana Muda, considerando o retorno do processamento de integração e as regras de bloqueio de reversões definidas no módulo Bioenergia.
Método PUT:
http:127.0.0.1:8080/query/v1/canaMuda
Body da Requisição - Recibo Notas Fiscais de Pagamento de Cana por FornecedorMuda
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{ "fgStatusIntegracao": "S1",
"instancia": "1",
"fgTpNota": "1",
"noNf": 1,
"cdSerieNf": "1",
"cdUnidInd": 1,
"cdUpnivel1": "",
"deFornec": ""
} |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas