...
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.
Estruturas:
| Cabeçalho (Header) |
| Campo | Tipo | Exemplo | Descrição |
| instancia | string | 1 | Identificador da instância |
| fgTpNota | string | Cana de Muda Mensal | Tipo da nota fiscal |
| noNf | integer | 1 | Número da NF |
| cdSerieNf | string | 1 | Série da NF |
| cdUnidInd | integer | 1 | Unidade industrial |
| cdTpProp | integer | 2 | Tipo de propriedade |
| cdUpnivel1 | string | 10005B | Código da UPNIVEL 1 (Ex. Fazenda) |
| deUpNivel1 | string | SÃO PEDRO | Descrição da UPNIVEL 1 (Ex. Fazenda) |
| deNatOper | string | NOTA CANA MUDA | Natureza da operação |
| cdFiscOp | integer | 1101 | Código fiscal operação |
| cdFornec | integer | 28785 | Código do fornecedor |
| deFornec | string | TOTVS SA | Nome do fornecedor |
| cdSafra | integer | 2016 | Safra associada |
| amFornec | string(date-time) | 2016-04-01T00:00:00 | Mês/Ano referência fornecedor |
| acPeso | integer | 156136 | Peso acumulado |
| vlTotNf | number | 10079.55 | Valor total da NF |
| dtEmisNf | string(date-time) | 2016-04-30T00:00:00 | Data emissão NF |
| acTxContrib | number | 231.83 | Taxa contribuição acumulada |
| vlLiqNf | number | 9847.72 | Valor líquido NF |
| cdTpCalc | string/null | null | Tipo de cálculo |
| fgComplPreco | string/null | null | Flag complemento preço |
| deObs | string/null | null | Observação |
| deFiscOp | string/null | null | Descrição operação fiscal |
| cdClassFisc | string/null | null | Classificação fiscal |
| fgSubstituicao | string/null | null | Flag Substituição tributária |
| vlCredIcmsf | number/null | null | Crédito ICMS |
| fgAcertoAnual | string/null | null | Flag acerto anual |
| fgManAuto | string | M | Flag manual/automático |
| fgCpr | string/null | null | Flag CPR |
| fgIndividual | string/null | null | Flag individual |
| noContrCana | integer | 1262 | Contrato de cana |
| cdEmpresa | string | 1 | Código empresa |
| instContr | string | 1 | Instância contrato |
| cdMunic | string/null | null | Município |
| noNfCompl | integer/null | null | NF complementar |
| cdSerieNfCompl | string/null | null | Série NF complementar |
| noNfErpCompl | string/null | null | NF ERP complementar |
| Detalhe ( Detail) |
| Campo | Tipo | Exemplo | Descrição |
| cdUnidInd | integer | 1 | Unidade industrial |
| vlTonCana | number | 57.38 | Valor por tonelada |
| ddFim | integer | 30 | Dia fim do período |
| vlFatorK | number/null | null | Fator K |
| noNf | integer | 1 | Número NF |
| vlTotalServ | number/null | null | Valor total serviço |
| vlRef | number/null | null | Valor referência |
| qCanaEnt | integer | 5073060 | Quantidade cana entregue |
| vlTotal | number | 291092.18 | Valor total |
| cdSerieNf | string | 1 | Série NF |
| vlAcertoAtr | number/null | null | Valor acerto ATR |
| vlAcAtrReceb | number/null | null | Valor ATR recebido |
| instancia | string | 1 | Instância |
| vlKgAtr | number/null | null | Valor ATR/kg |
| cdTpCalc | string/null | null | Tipo cálculo |
| dataInicial | integer | 1 | Data inicial |
| pcPgVlTon | number/null | null | Percentual pagamento tonelada |
| vlBonusTon | number/null | null | Valor bônus tonelada |
| Histórico de Taxas |
| Campo | Tipo | Exemplo | Descrição |
| dtIniPer | string(date-time) | 2016-04-01T00:00:00 | Data início período |
| cdGrpTxContr | integer | 1 | Grupo taxa contribuição |
| instancia | string | 1 | Instância |
| cdUnidInd | integer | 1 | Unidade industrial |
| dtFimPer | string(date-time) | 2016-04-30T00:00:00 | Data fim período |
| vlTxContrib | number | 6112.94 | Valor taxa contribuição |
| cdTxContr | integer | 1 | Código taxa contribuição |
| Tamanho | | Tipo | Observação |
|---|
| instancia | Identificador da instância do processo |
2 | Numérico | Usado como chave de controle interno |
| cdTpNota | Código do tipo |
de nota fiscal1 | Texto | ‘S’ indica nota de sobrepreço| de nota fiscal | Texto | D - Nota Cana de Muda Mensal
R - Nota Cana de Revenda
F - Nota Cana de Bisada
G - Nota Cana sem Movimentação
N - Nota Cana de Moagem
S - Nota Cana Sobrepreço |
| deTpNota | Descrição do tipo de nota fiscal |
50 | | Texto | Ex: “Nota Cana Sobrepreço” |
| noNf | Número da nota fiscal |
10 | Numérico | Identificação da NF |
| cdSerieNf | Série da nota fiscal |
5 | | Texto | Série utilizada na emissão |
| cdUnidInd | Código da unidade industrial |
5 | | Numérico | Refere-se à usina ou filial |
| cdTpProp | Código do tipo de propriedade |
2 | | Numérico | Relacionado ao tipo de fornecedor (ex: próprio, parceria) |
| deNatOper | Descrição da natureza da operação |
50 | Texto | Ex: “COMPRA” |
| cdFiscOp | Código fiscal da operação |
10 | Numérico | Código CFOP ou equivalente |
| cdSafra | Código do ano-safra |
4 | | Numérico | Ex: 2018 |
| amFornec | Mês e ano de fornecimento |
10 | | Data | Data base da operação |
| acPeso | Peso acumulado de cana entregue |
15 | | Numérico | Em quilos |
| vlTotNf | Valor total da nota fiscal |
15 | Numérico | Valor bruto total |
| dtEmisNf | Data de emissão da NF |
10 | | Data | Data em que a NF foi emitida |
| acTxContrib | Total de contribuições acumuladas |
15 | | Numérico | Soma das taxas aplicadas |
| vlLiqNf | Valor líquido da nota fiscal |
15 | | Numérico | Valor final após descontos |
| cdTpCalc | Código do tipo de cálculo |
2 | Numérico | Pode ser nulo |
| fgComplPreco | Indicador de complemento de preço |
1 | | Texto | ‘N’ = não é complemento |
| deObs | Observação da nota |
255 | Texto | Ex: “Nota Fiscal de Sobrepreço.” |
| deFiscOp | Descrição fiscal da operação |
100 | Texto | Pode ser nulo |
| cdClassFisc | Código de classificação fiscal |
10 | Numérico | Pode ser nulo |
| dfSubstituicao | Indicador de substituição fiscal |
1 | Texto | Pode ser nulo |
| vlCredIcmsf | Valor de crédito de ICMS |
15 | | Numérico | Pode ser nulo |
| fgAcertoAnual | Indicador de acerto anual |
1 | | Texto | ‘N’ = não houve acerto anual |
| fgManAuto | Indicador de manutenção automática |
1 | | Texto | ‘A’ = automática |
| dfCpr | Indicador de CPR |
1 | Texto | Pode ser nulo |
| fgIndividual | Indicador de operação individual |
1 | Texto | Pode ser nulo |
| noContrCana | Número do contrato de cana |
10 | | Numérico | Identifica o contrato associado |
| cdEmpresa | Código da empresa |
5 | | Texto | Ex: “1” |
| instContr | Instância do contrato |
2 | Texto | Identifica a origem da NF |
| cdMunic | Código do município |
10 | Numérico | Pode ser nulo |
| noNfCompl | Número da NF complementar |
10 | | Numérico | Pode ser nulo |
| cdSerieNfCompl | Série da NF complementar |
5 | | Texto | Pode ser nulo |
| noNfErpCompl | Número ERP da NF complementar |
10 | | Texto | Pode ser nulo |
|
|
|
|
| infoUpnivel1.cdUpnivel1 | Código da unidade superior |
10 | Texto | Ex: “20003” |
| infoUpnivel1.deUpnivel1 | Descrição da unidade superior |
50 | Texto | Ex: “TOTVS” |
| infoUpnivel1.cdFornec | Código do fornecedor |
10 | | Numérico | Identificador ERP |
| infoUpnivel1.fgTpPess | Tipo de pessoa |
1 | | Texto | ‘J’ = Jurídica |
| infoUpnivel1.cdIntErp | Código integrado ERP |
20 | Texto | Identificação composta no ERP |
|
|
|
|
| infoFornecs.cdFornec | Código do fornecedor |
10 | | Numérico | Identificação do fornecedor principal |
| infoFornecs.deFornec | Nome do fornecedor |
100 | | Texto | Ex: “TOTVS FORN” |
| infoFornecs.fgTpFornec | Tipo de fornecedor |
2 | | Texto | Ex: “2” = fornecedor |
| infoFornecs.deTpFornec | Descrição do tipo de fornecedor |
50 | Texto | Ex: “FORNECEDOR” | Texto | 1 - ACIONISTA 2 - FORNECEDOR 3 - EVENTUAL 4 - PROPRIO 5 - PARCEIRO |
| infoFornecs.fgTpPess | Tipo de pessoa |
1 | Texto | ‘F’ = Física |
| infoFornecs.cdIntErp | Código integrado ERP |
20 | Texto | Código único no ERP |
|
|
|
|
| detalheNfDeOut.cdUnidInd | Código da unidade industrial (detalhe) |
5 | Numérico | Relaciona-se à usina |
| detalheNfDeOut.vlTonCana | Valor por tonelada de cana |
15 | Numérico | Valor unitário |
| detalheNfDeOut.ddFim | Dia final do período |
2 | | Numérico | Ex: 31 |
| detalheNfDeOut.vlFatorK | Fator K |
10 | | Numérico | Pode ser nulo |
| detalheNfDeOut.qCanaEnt | Quantidade de cana entregue |
15 | Numérico | Em quilos |
| detalheNfDeOut.vlTotal | Valor total |
15 | Numérico | Soma geral do período |
| detalheNfDeOut.cdSerieNf | Série da nota (detalhe) |
5 | | Texto | Ex: “5” |
| detalheNfDeOut.vlKgAtr | Valor do ATR (kg) |
15 | | Numérico | Pode ser nulo |
| detalheNfDeOut.cdTpCalc | Código do tipo de cálculo |
2 | | Numérico | Pode ser nulo |
| detalheNfDeOut.dataInicial | Dia inicial do período |
2 | Numérico | Ex: 1 |
|
|
|
|
| detalheshistTxOut.dtIniPer | Data inicial do período da taxa |
10 | Data | Ex: “2018-05-01” |
| detalheshistTxOut.dtFimPer | Data final do período da taxa |
10 | | Data | Ex: “2018-05-31” |
| detalheshistTxOut.vlTxContrib | Valor da contribuição |
15 | | Numérico | Ex: 449.73 |
| detalheshistTxOut.cdTxContr | Código da taxa de contrato |
5 | Numérico | Identificador da taxa |
|
|
|
|
| txContrib.deTxcontr | Descrição da taxa |
50 | Texto | Ex: “INSS” ou “SENAR” |
| txContrib.pcTxcontr | Percentual da taxa |
6 | | Numérico | Ex: 1.3 ou 0.2 |
| txContrib.cdIndBase | Código de índice base |
10 | | Numérico | Ex: 950 |
| txContrib.fgAcertoAno | Indicador de acerto anual da taxa |
1 | | Texto | ‘S’ = Sim |
| txContrib.codigoClassificacao | Código da classificação |
20 | Texto | Ex: “CLAS 1” |
| txContrib.codigoEspecie | Código da espécie |
20 |
Método GET:
http:127.0.0.1:8080/api/query/v1/canaMuda
...
- noNf: Número da Nota Fiscal.
- cdSerieNf:Série da Nota Fiscal.
- cdUnidInd: Código Unidade Industrial.
- fgStatusIntegracao: Flag de busca das integrações. O valor "nulo" refere-se a registros nunca integrados. Exemplo: 1;2;3;nulo;5
Atualizar status de integração - Notas Fiscais de Cana Muda
...
