Histórico da Página

...

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:

Atributos	Descrição

Cabeçalho (Header)CampoDescrição

	Tipo

ObrigatórioExemplo

Observação
instancia

stringSim1

Identificador da instância do processo

fgTpNotastringSimCana de Muda Mensal

Numérico	Usado como chave de controle interno
cdTpNota	Código do tipo de

Tipo da

nota fiscal

noNfintegerSim1Número da NFcdSerieNfstringSim1Série da NFcdUnidIndintegerSim1Unidade industrialcdTpPropintegerSim2Tipo de propriedadecdUpnivel1stringSim10005BCódigo da UPNIVEL 1 (Ex. Fazenda)deUpNivel1stringSimSÃO PEDRODescrição da UPNIVEL 1 (Ex. Fazenda)deNatOperstringSimNOTA CANA MUDANatureza da operaçãocdFiscOpintegerSim1101Código fiscal operaçãocdFornecintegerSim28785Código do fornecedordeFornecstringSimTOTVS SANome do fornecedorcdSafraintegerSim2016Safra associadaamFornecstring(date-time)Sim2016-04-01T00:00:00Mês/Ano referência fornecedoracPesointegerSim156136Peso acumuladovlTotNfnumberSim10079.55Valor total da NFdtEmisNfstring(date-time)Sim2016-04-30T00:00:00Data emissão NFacTxContribnumberSim231.83Taxa contribuição acumuladavlLiqNfnumberSim9847.72Valor líquido NFcdTpCalcstring/nullNãonullTipo de cálculofgComplPrecostring/nullNãonullFlag complemento preçodeObsstring/nullNãonullObservaçãodeFiscOpstring/nullNãonullDescrição operação fiscalcdClassFiscstring/nullNãonullClassificação fiscalfgSubstituicaostring/nullNãonullFlag Substituição tributáriavlCredIcmsfnumber/nullNãonullCrédito ICMSfgAcertoAnualstring/nullNãonullFlag acerto anualfgManAutostringSimMFlag manual/automáticofgCprstring/nullNãonullFlag CPRfgIndividualstring/nullNãonullFlag individualnoContrCanaintegerSim1262Contrato de canacdEmpresastringSim1Código empresainstContrstringSim1Instância contratocdMunicstring/nullNãonullMunicípionoNfComplinteger/nullNãonullNF complementarcdSerieNfComplstring/nullNãonullSérie NF complementarnoNfErpComplstring/nullNãonullNF 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

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	Texto	Ex: “Nota Cana Sobrepreço”
noNf	Número da nota fiscal	Numérico	Identificação da NF
cdSerieNf	Série da nota fiscal	Texto	Série utilizada na emissão
cdUnidInd	Código da unidade industrial	Numérico	Refere-se à usina ou filial
cdTpProp	Código do tipo de propriedade	Numérico	Relacionado ao tipo de fornecedor (ex: próprio, parceria)
deNatOper	Descrição da natureza da operação	Texto	Ex: “COMPRA”
cdFiscOp	Código fiscal da operação	Numérico	Código CFOP ou equivalente
cdSafra	Código do ano-safra	Numérico	Ex: 2018
amFornec	Mês e ano de fornecimento	Data	Data base da operação
acPeso	Peso acumulado de cana entregue	Numérico	Em quilos
vlTotNf	Valor total da nota fiscal	Numérico	Valor bruto total
dtEmisNf	Data de emissão da NF	Data	Data em que a NF foi emitida
acTxContrib	Total de contribuições acumuladas	Numérico	Soma das taxas aplicadas
vlLiqNf	Valor líquido da nota fiscal	Numérico	Valor final após descontos
cdTpCalc	Código do tipo de cálculo	Numérico	Pode ser nulo
fgComplPreco	Indicador de complemento de preço	Texto	‘N’ = não é complemento
deObs	Observação da nota	Texto	Ex: “Nota Fiscal de Sobrepreço.”
deFiscOp	Descrição fiscal da operação	Texto	Pode ser nulo
cdClassFisc	Código de classificação fiscal	Numérico	Pode ser nulo
dfSubstituicao	Indicador de substituição fiscal	Texto	Pode ser nulo
vlCredIcmsf	Valor de crédito de ICMS	Numérico	Pode ser nulo
fgAcertoAnual	Indicador de acerto anual	Texto	‘N’ = não houve acerto anual
fgManAuto	Indicador de manutenção automática	Texto	‘A’ = automática
dfCpr	Indicador de CPR	Texto	Pode ser nulo
fgIndividual	Indicador de operação individual	Texto	Pode ser nulo
noContrCana	Número do contrato de cana	Numérico	Identifica o contrato associado
cdEmpresa	Código da empresa	Texto	Ex: “1”
instContr	Instância do contrato	Texto	Identifica a origem da NF
cdMunic	Código do município	Numérico	Pode ser nulo
noNfCompl	Número da NF complementar	Numérico	Pode ser nulo
cdSerieNfCompl	Série da NF complementar	Texto	Pode ser nulo
noNfErpCompl	Número ERP da NF complementar	Texto	Pode ser nulo

infoUpnivel1.cdUpnivel1	Código da unidade superior	Texto	Ex: “20003”
infoUpnivel1.deUpnivel1	Descrição da unidade superior	Texto	Ex: “TOTVS”
infoUpnivel1.cdFornec	Código do fornecedor	Numérico	Identificador ERP
infoUpnivel1.fgTpPess	Tipo de pessoa	Texto	‘J’ = Jurídica
infoUpnivel1.cdIntErp	Código integrado ERP	Texto	Identificação composta no ERP

infoFornecs.cdFornec	Código do fornecedor	Numérico	Identificação do fornecedor principal
infoFornecs.deFornec	Nome do fornecedor	Texto	Ex: “TOTVS FORN”
infoFornecs.fgTpFornec	Tipo de fornecedor	Texto	Ex: “2” = fornecedor
infoFornecs.deTpFornec	Descrição do tipo de fornecedor	Texto	1 - ACIONISTA 2 - FORNECEDOR 3 - EVENTUAL 4 - PROPRIO 5 - PARCEIRO
infoFornecs.fgTpPess	Tipo de pessoa	Texto	‘F’ = Física
infoFornecs.cdIntErp	Código integrado ERP	Texto	Código único no ERP

detalheNfDeOut.cdUnidInd	Código da unidade industrial (detalhe)	Numérico	Relaciona-se à usina
detalheNfDeOut.vlTonCana	Valor por tonelada de cana	Numérico	Valor unitário
detalheNfDeOut.ddFim	Dia final do período	Numérico	Ex: 31
detalheNfDeOut.vlFatorK	Fator K	Numérico	Pode ser nulo
detalheNfDeOut.qCanaEnt	Quantidade de cana entregue	Numérico	Em quilos
detalheNfDeOut.vlTotal	Valor total	Numérico	Soma geral do período
detalheNfDeOut.cdSerieNf	Série da nota (detalhe)	Texto	Ex: “5”
detalheNfDeOut.vlKgAtr	Valor do ATR (kg)	Numérico	Pode ser nulo
detalheNfDeOut.cdTpCalc	Código do tipo de cálculo	Numérico	Pode ser nulo
detalheNfDeOut.dataInicial	Dia inicial do período	Numérico	Ex: 1

detalheshistTxOut.dtIniPer	Data inicial do período da taxa	Data	Ex: “2018-05-01”
detalheshistTxOut.dtFimPer	Data final do período da taxa	Data	Ex: “2018-05-31”
detalheshistTxOut.vlTxContrib	Valor da contribuição	Numérico	Ex: 449.73
detalheshistTxOut.cdTxContr	Código da taxa de contrato	Numérico	Identificador da taxa

txContrib.deTxcontr	Descrição da taxa	Texto	Ex: “INSS” ou “SENAR”
txContrib.pcTxcontr	Percentual da taxa	Numérico	Ex: 1.3 ou 0.2
txContrib.cdIndBase	Código de índice base	Numérico	Ex: 950
txContrib.fgAcertoAno	Indicador de acerto anual da taxa	Texto	‘S’ = Sim
txContrib.codigoClassificacao	Código da classificação	Texto	Ex: “CLAS 1”
txContrib.codigoEspecie	Código da espécie	Texto	Ex: “ESPECIE 1”

Método GET:

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

Bloco de código

language	java
title	Body da Requisição - Notas Fiscais Cana Muda.

{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "cdTpNota":"S",
         "deTpNota":"Nota Cana Sobrepreço",
         "noNf":1,
         "cdSerieNf":"5",
         "cdUnidInd":1,
         "cdTpProp":5,
         "deNatOper":"COMPRA",
         "cdFiscOp":1101,
         "cdSafra":2018,
         "amFornec":"2018-05-01T00:00:00",
         "acPeso":4867980,
         "vlTotNf":34594.79,
         "dtEmisNf":"2018-05-22T00:00:00",
         "acTxContrib":518.92,
         "vlLiqNf":34075.87,
         "cdTpCalc":null,
         "fgComplPreco":"N",
         "deObs":"Nota Fiscal de Sobrepreço.",
         "deFiscOp":null,
         "cdClassFisc":null,
         "dfSubstituicao":null,
         "vlCredIcmsf":null,
         "fgAcertoAnual":"N",
         "fgManAuto":"A",
         "dfCpr":null,
         "fgIndividual":null,
         "noContrCana":2277,
         "cdEmpresa":"1",
         "instContr":"1",
         "cdMunic":null,
         "noNfCompl":null,
         "cdSerieNfCompl":null,
         "noNfErpCompl":null,
         "infoUpnivel1":[
            {
               "cdUpnivel1":" 20003",
               "deUpnivel1":"TOTVS",
               "cdFornec":7052,
               "fgTpPess":"J",
               "cdIntErp":"1_19_1"
            }
         ],
         "infoFornecs":[
            {
               "cdFornec":7052,
               "deFornec":"TOTVS FORN",
               "fgTpFornec":"2",
               "deTpFornec":"FORNECEDOR",
               "fgTpPess":"F",
               "cdIntErp":"7052"
            }
         ],
         "detalheNfDeOut":[
            {
               "cdUnidInd":1,
               "vlTonCana":7.1066,
               "ddFim":31,
               "vlFatorK":null,
               "noNf":1,
               "vlTotalServ":null,
               "vlRef":null,
               "qCanaEnt":4867980,
               "vlTotal":34594.79,
               "cdSerieNf":"5",
               "vlAcertoAtr":null,
               "vlAcAtrReceb":null,
               "instancia":"1",
               "detalheshistTxOut":[
                  {

Bloco de código

language	java
title	Body da Requisição - Notas Fiscais Cana Muda.

{
    "hasNext": false,
    "items": [ {
            "instanciadtIniPer": "1"2018-05-01T00:00:00",
             "fgTpNota": "Cana de Muda Mensal",
    "cdGrpTxContr":1,
        "noNf": 1,
            "cdSerieNfinstancia": "1",
            "cdUnidInd": 1,
                "cdTpPropcdUnidInd": 21,
            "cdUpnivel1": "10005B",
            "deUpNivel1dtFimPer": "SÃO PEDRO"2018-05-31T00:00:00",
            "deNatOper": "NOTA CANA MUDA",
            "cdFiscOpvlTxContrib": 1101449.73,
            "cdFornec": 28785,
            "deForneccdTxContr": "TOTVS SA"1,
            "cdSafra": 2016,
            "amFornectxContrib": "2016-04-01T00:00:00",[
            "acPeso": 156136,
            "vlTotNf": 10079.55,
{
              "dtEmisNf": "2016-04-30T00:00:00",
            "acTxContribcdTxcontr": 231.831,
              "vlLiqNf": 9847.72,
            "dtValIni"cdTpCalc:": null2015-10-01T03:00:00.000+00:00",
            "fgComplPreco": null,
               "deObsdeTxcontr": null"INSS",
              "deFiscOp": null,
            "cdClassFiscpcTxcontr": null1.3,
              "dfSubstituicao": null,
            "vlCredIcmsfcdIndBase": null950,
              "fgAcertoAnual": null,
            "fgManAutopcRedBase": "M"null,
            "dfCpr": null,
               "fgIndividualfgAcertoAno": null"S",
              "noContrCana": 1262,
            "cdEmpresacdTxErp": "1"null,
              "instContr": "1",
            "cdMuniccodigoClassificacao":"CLAS null1",
             "noNfCompl": null,
              "cdSerieNfCompl": null,codigoEspecie":"ESPECIE 1"
            "noNfErpCompl": null,
           }
 "detalheNfDeOut": [
                {
   ]
                 "cdUnidInd": 1},
                  {
  "vlTonCana": 57.38,
                    "ddFimdtIniPer": 30"2018-05-01T00:00:00",
                     "vlFatorKcdGrpTxContr": null1,
                     "noNfinstancia": "1",
                     "vlTotalServcdUnidInd": null1,
                     "dtFimPer"vlRef": null:"2018-05-31T00:00:00",
                     "qCanaEntvlTxContrib": 507306069.19,
                     "vlTotalcdTxContr": 291092.182,
                     "cdSerieNftxContrib": "1",
          [
          "vlAcertoAtr": null,
              {
      "vlAcAtrReceb": null,
                    "instanciacdTxcontr": "1"2,
                           "detalheshistTxOut": [
dtValIni":"2015-10-01T03:00:00.000+00:00",
                              {
 "deTxcontr":"SENAR",
                           "dtIniPerpcTxcontr": "2016-04-01T00:00:00"0.2,
                            "cdGrpTxContrcdIndBase": 1950,
                            "instanciapcRedBase": "1"null,
                            "cdUnidIndfgAcertoAno": 1"S",
                            "dtFimPercdTxErp": "2016-04-30T00:00:00"null,
                            "vlTxContribcodigoClassificacao": 6112.94"CLAS 2",
                            "cdTxContrcodigoEspecie":"ESPECIE 12"
                        }
                     ],
                  }
         "vlKgAtr": null,
     ],
               "cdTpCalcvlKgAtr": null,
                    "dataInicialcdTpCalc": 1null,
                    "pcPgVlTondataInicial": null1,
                    "vlBonusTonpcPgVlTon": null,
                },"vlBonusTon":null
               
   }
         ]
        }
     ]
}

Parâmetros Obrigatórios

...

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

...

Método PUT:

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

Body da Requisição - Notas Fiscais de Cana Muda

...

Páginas filhas

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Estruturas:

Parâmetros Obrigatórios

Atualizar status de integração - Notas Fiscais de Cana Muda