Páginas filhas
  • API Notas Fiscais de Cana Muda

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • 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:

AtributosDescrição
Cabeçalho (Header)Campo
Tipo
Exemplo
Observação
Descrição
instancia
string1
Identificador da instância
fgTpNotastringCana de Muda Mensal
do processoNuméricoUsado como chave de controle interno
cdTpNotaCódigo do tipo de
Tipo da
nota fiscal
noNfinteger1Número da NFcdSerieNfstring1Série da NFcdUnidIndinteger1Unidade industrialcdTpPropinteger2Tipo de propriedadecdUpnivel1string10005BCódigo da UPNIVEL 1 (Ex. Fazenda)deUpNivel1stringSÃO PEDRODescrição da UPNIVEL 1 (Ex. Fazenda)deNatOperstringNOTA CANA MUDANatureza da operaçãocdFiscOpinteger1101Código fiscal operaçãocdFornecinteger28785Código do fornecedordeFornecstringTOTVS SANome do fornecedorcdSafrainteger2016Safra associadaamFornecstring(date-time)2016-04-01T00:00:00Mês/Ano referência fornecedoracPesointeger156136Peso acumuladovlTotNfnumber10079.55Valor total da NFdtEmisNfstring(date-time)2016-04-30T00:00:00Data emissão NFacTxContribnumber231.83Taxa contribuição acumuladavlLiqNfnumber9847.72Valor líquido NFcdTpCalcstring/nullnullTipo de cálculofgComplPrecostring/nullnullFlag complemento preçodeObsstring/nullnullObservaçãodeFiscOpstring/nullnullDescrição operação fiscalcdClassFiscstring/nullnullClassificação fiscalfgSubstituicaostring/nullnullFlag Substituição tributáriavlCredIcmsfnumber/nullnullCrédito ICMSfgAcertoAnualstring/nullnullFlag acerto anualfgManAutostringMFlag manual/automáticofgCprstring/nullnullFlag CPRfgIndividualstring/nullnullFlag individualnoContrCanainteger1262Contrato de canacdEmpresastring1Código empresainstContrstring1Instância contratocdMunicstring/nullnullMunicípionoNfComplinteger/nullnullNF complementarcdSerieNfComplstring/nullnullSérie NF complementarnoNfErpComplstring/nullnullNF ERP complementar
Detalhe ( Detail)
CampoTipoExemploDescrição
cdUnidIndinteger1Unidade industrial
vlTonCananumber57.38Valor por tonelada
ddFiminteger30Dia fim do período
vlFatorKnumber/nullnullFator K
noNfinteger1Número NF
vlTotalServnumber/nullnullValor total serviço
vlRefnumber/nullnullValor referência
qCanaEntinteger5073060Quantidade cana entregue
vlTotalnumber291092.18Valor total
cdSerieNfstring1Série NF
vlAcertoAtrnumber/nullnullValor acerto ATR
vlAcAtrRecebnumber/nullnullValor ATR recebido
instanciastring1Instância
vlKgAtrnumber/nullnullValor ATR/kg
cdTpCalcstring/nullnullTipo cálculo
dataInicialinteger1Data inicial
pcPgVlTonnumber/nullnullPercentual pagamento tonelada
vlBonusTonnumber/nullnullValor bônus tonelada
TextoD - 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
deTpNotaDescrição do tipo de nota fiscalTextoEx: “Nota Cana Sobrepreço”
noNfNúmero da nota fiscalNuméricoIdentificação da NF
cdSerieNfSérie da nota fiscalTextoSérie utilizada na emissão
cdUnidIndCódigo da unidade industrialNuméricoRefere-se à usina ou filial
cdTpPropCódigo do tipo de propriedadeNuméricoRelacionado ao tipo de fornecedor (ex: próprio, parceria)
deNatOperDescrição da natureza da operaçãoTextoEx: “COMPRA”
cdFiscOpCódigo fiscal da operaçãoNuméricoCódigo CFOP ou equivalente
cdSafraCódigo do ano-safraNuméricoEx: 2018
amFornecMês e ano de fornecimentoDataData base da operação
acPesoPeso acumulado de cana entregueNuméricoEm quilos
vlTotNfValor total da nota fiscalNuméricoValor bruto total
dtEmisNfData de emissão da NFDataData em que a NF foi emitida
acTxContribTotal de contribuições acumuladasNuméricoSoma das taxas aplicadas
vlLiqNfValor líquido da nota fiscalNuméricoValor final após descontos
cdTpCalcCódigo do tipo de cálculoNuméricoPode ser nulo
fgComplPrecoIndicador de complemento de preçoTexto‘N’ = não é complemento
deObsObservação da notaTextoEx: “Nota Fiscal de Sobrepreço.”
deFiscOpDescrição fiscal da operaçãoTextoPode ser nulo
cdClassFiscCódigo de classificação fiscalNuméricoPode ser nulo
dfSubstituicaoIndicador de substituição fiscalTextoPode ser nulo
vlCredIcmsfValor de crédito de ICMSNuméricoPode ser nulo
fgAcertoAnualIndicador de acerto anualTexto‘N’ = não houve acerto anual
fgManAutoIndicador de manutenção automáticaTexto‘A’ = automática
dfCprIndicador de CPRTextoPode ser nulo
fgIndividualIndicador de operação individualTextoPode ser nulo
noContrCanaNúmero do contrato de canaNuméricoIdentifica o contrato associado
cdEmpresaCódigo da empresaTextoEx: “1”
instContrInstância do contratoTextoIdentifica a origem da NF
cdMunicCódigo do municípioNuméricoPode ser nulo
noNfComplNúmero da NF complementarNuméricoPode ser nulo
cdSerieNfComplSérie da NF complementarTextoPode ser nulo
noNfErpComplNúmero ERP da NF complementarTextoPode ser nulo




infoUpnivel1.cdUpnivel1Código da unidade superiorTextoEx: “20003”
infoUpnivel1.deUpnivel1Descrição da unidade superiorTextoEx: “TOTVS”
infoUpnivel1.cdFornecCódigo do fornecedorNuméricoIdentificador ERP
infoUpnivel1.fgTpPessTipo de pessoaTexto‘J’ = Jurídica
infoUpnivel1.cdIntErpCódigo integrado ERPTextoIdentificação composta no ERP




infoFornecs.cdFornecCódigo do fornecedorNuméricoIdentificação do fornecedor principal
infoFornecs.deFornecNome do fornecedorTextoEx: “TOTVS FORN”
infoFornecs.fgTpFornecTipo de fornecedorTextoEx: “2” = fornecedor
infoFornecs.deTpFornecDescrição do tipo de fornecedorTexto

1 - ACIONISTA

2 - FORNECEDOR

3 - EVENTUAL

4 - PROPRIO

5 - PARCEIRO

infoFornecs.fgTpPessTipo de pessoaTexto‘F’ = Física
infoFornecs.cdIntErpCódigo integrado ERPTextoCódigo único no ERP




detalheNfDeOut.cdUnidIndCódigo da unidade industrial (detalhe)NuméricoRelaciona-se à usina
detalheNfDeOut.vlTonCanaValor por tonelada de canaNuméricoValor unitário
detalheNfDeOut.ddFimDia final do períodoNuméricoEx: 31
detalheNfDeOut.vlFatorKFator KNuméricoPode ser nulo
detalheNfDeOut.qCanaEntQuantidade de cana entregueNuméricoEm quilos
detalheNfDeOut.vlTotalValor totalNuméricoSoma geral do período
detalheNfDeOut.cdSerieNfSérie da nota (detalhe)TextoEx: “5”
detalheNfDeOut.vlKgAtrValor do ATR (kg)NuméricoPode ser nulo
detalheNfDeOut.cdTpCalcCódigo do tipo de cálculoNuméricoPode ser nulo
detalheNfDeOut.dataInicialDia inicial do períodoNuméricoEx: 1




detalheshistTxOut.dtIniPerData inicial do período da taxaDataEx: “2018-05-01”
detalheshistTxOut.dtFimPerData final do período da taxaDataEx: “2018-05-31”
detalheshistTxOut.vlTxContribValor da contribuiçãoNuméricoEx: 449.73
detalheshistTxOut.cdTxContrCódigo da taxa de contratoNuméricoIdentificador da taxa




txContrib.deTxcontrDescrição da taxaTextoEx: “INSS” ou “SENAR”
txContrib.pcTxcontrPercentual da taxaNuméricoEx: 1.3 ou 0.2
txContrib.cdIndBaseCódigo de índice baseNuméricoEx: 950
txContrib.fgAcertoAnoIndicador de acerto anual da taxaTexto‘S’ = Sim
txContrib.codigoClassificacaoCódigo da classificaçãoTextoEx: “CLAS 1”
txContrib.codigoEspecieCódigo da espécieTextoEx: “ESPECIE 1”
Histórico de TaxasCampoTipoExemploDescriçãodtIniPerstring(date-time)2016-04-01T00:00:00Data início períodocdGrpTxContrinteger1Grupo taxa contribuiçãoinstanciastring1InstânciacdUnidIndinteger1Unidade industrialdtFimPerstring(date-time)2016-04-30T00:00:00Data fim períodovlTxContribnumber6112.94Valor taxa contribuiçãocdTxContrinteger1Código taxa contribuição


Método GET:

http:127.0.0.1:8080/api/query/v1/canaMuda

Bloco de código
languagejava
titleBody da Requisição - Notas Fiscais Cana Muda.
{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "cdTpNota":"AS",
         "deTpNota":"DesconhecidoNota Cana Sobrepreço",
         "noNf":1,
         "cdSerieNf":"15",
         "cdUnidInd":1,
         "cdTpProp":25,
         "deNatOper":"Nota Amortização ManCOMPRA",
         "cdFiscOp":1101,
         "cdSafra":20162018,
         "amFornec":"20162018-0405-01T00:00:00",
         "acPeso":50730604867980,
         "vlTotNf":29109234594.1879,
         "dtEmisNf":"20162018-0405-30T0022T00:00:00",
         "acTxContrib":6695518.1292,
         "vlLiqNf":28439734075.0687,
         "cdTpCalc":null,
         "fgComplPreco":null"N",
         "deObs":null"Nota Fiscal de Sobrepreço.",
         "deFiscOp":null,
         "cdClassFisc":null,
         "dfSubstituicao":null,
         "vlCredIcmsf":null,
         "fgAcertoAnual":null"N",
         "fgManAuto":"MA",
         "dfCpr":null,
         "fgIndividual":null,
         "noContrCana":18522277,
         "cdEmpresa":"1",
         "instContr":"1",
         "cdMunic":null,
         "noNfCompl":null,
         "cdSerieNfCompl":null,
         "noNfErpCompl":null,
         "infoUpnivel1":[
            {
               "cdUpnivel1":"10950A 20003",
               "deUpnivel1":"SANTA CARLOTATOTVS",
               "cdFornec":9447052,
               "fgTpPess":"J",
               "cdIntErp":"1_105119_1"
            }
         ],
         "infoFornecs":[
            {
               "cdFornec":9447052,
               "deFornec":"ESP.SYLVIO DE SAMPAIO M. JUNIOR E OUTROTOTVS FORN",
               "fgTpFornec":"2",
               "deTpFornec":"FORNECEDOR",
               "fgTpPess":"F",
               "cdIntErp":"9447052"
            }
         ],
         "detalheNfDeOut":[
            {
               "cdUnidInd":1,
               "vlTonCana":577.381066,
               "ddFim":3031,
               "vlFatorK":null,
               "noNf":1,
               "vlTotalServ":null,
               "vlRef":null,
               "qCanaEnt":50730604867980,
               "vlTotal":29109234594.1879,
               "cdSerieNf":"15",
               "vlAcertoAtr":null,
               "vlAcAtrReceb":null,
               "instancia":"1",
               "detalheshistTxOut":[
                  {
                     "dtIniPer":"20162018-0405-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"20162018-0405-30T0031T00:00:00",
                     "vlTxContrib":6112449.9473,
                     "cdTxContr":1,
                     "txContrib":[
                        {
                           "cdTxcontr":1,
                           "dtValIni":"2015-10-01T03:00:00.000+00:00",
                           "deTxcontr":"INSS",
                           "pcTxcontr":1.3,
                           "cdIndBase":950,
                           "pcRedBase":null,
                           "fgAcertoAno":"S",
                           "cdTxErp":null,
                           "codigoClassificacao":"CLAS 1",
                           "codigoEspecie":"ESPECIE 1"
                        }
                     ]
                  },
                  {
                     "dtIniPer":"20162018-0405-01T00:00:00",
                     "cdGrpTxContr":1,
                     "instancia":"1",
                     "cdUnidInd":1,
                     "dtFimPer":"20162018-0405-30T0031T00:00:00",
                     "vlTxContrib":58269.1819,
                     "cdTxContr":2,
                     "txContrib":[
                        {
                           "cdTxcontr":2,
                           "dtValIni":"2015-10-01T03:00:00.000+00:00",
                           "deTxcontr":"SENAR",
                           "pcTxcontr":0.2,
                           "cdIndBase":950,
                           "pcRedBase":null,
                           "fgAcertoAno":"S",
                           "cdTxErp":null,
                           "codigoClassificacao":"CLAS 2",
                           "codigoEspecie":"ESPECIE 2"
                        }
                     ]
                  }
               ],
               "vlKgAtr":null,
               "cdTpCalc":null,
               "dataInicial":1,
               "pcPgVlTon":null,
               "vlBonusTon":null
            }
         ]
      }
   ]
}

...

  • 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

...