Histórico da Página

...

Disponibilizado endpoint para consulta das Notas Fiscais de Entrada de Cana.

Estrutura:

Atributos	Descrição	Tipo	Observação
instancia	Identificador da instância	Texto	-
notaFiscal	Número da nota fiscal	Numérico	-
cdSerieNf	Código da série da nota fiscal	Numérico	-
cdTpProp	Código do tipo de propriedade	Numérico	-
cdSafra	Ano da safra	Numérico	-
amFornec	Data de fornecimento	Data	Formato ISO 8601
acPeso	Peso acumulado	Numérico	-
vlTotNf	Valor total da nota fiscal	Decimal	-
dtEmisNf	Data de emissão da nota fiscal	Data	Formato ISO 8601
deMunic	Nome do município	Texto	-
deNatOper	Natureza da operação	Texto	-
cdFiscOp	Código fiscal da operação	Numérico	-
deEnd	Endereço	Texto	-
noCep	CEP	Texto	-
cdUf	Código da unidade federativa	Texto	-
noFone	Telefone	Texto	-
noCgcCpf	CNPJ/CPF	Texto	-
fgSituacao	Situação	Texto	Ex: 'N'
acTxContrib	Valor da taxa de contribuição	Decimal	-
vlLiqNf	Valor líquido da nota fiscal	Decimal	-
vlLiquida	Valor líquido alternativo	Decimal	-
cdTpCalc	Código do tipo de cálculo	Numérico	-
fgComplPreco	Complemento de preço	Texto	-
fgManAuto	Flag de manutenção automática	Texto	-
fgTipoNotaFiscal	Tipo de nota fiscal	Texto	-
deObs	Observações	Texto	M - Complemento Manual A - Complemento Automática N - Mensal Automático
deFiscOp	Descrição fiscal da operação	Texto	-
cdClasFisc	Código de classificação fiscal	Texto	-
fgSubstituicao	Flag de substituição	Texto	-
vlCredIcms	Valor crédito ICMS	Decimal	-
fgAcertoAnual	Flag de acerto anual	Texto	-
fgCpr	Flag CPR	Texto	-
fgComplProduto	Complemento de produto	Texto	-
fgIndividual	Flag individual	Texto	-
noContrCana	Número do contrato de cana	Numérico	-
cdEmpresa	Código da empresa	Texto	-
instContr	Instância do contrato	Texto	-
cdMunic	Código do município	Numérico	-
cdUsuarioInc	Usuário que incluiu	Texto	-
dtHrInc	Data/hora inclusão	DataHora	-
cdUsuarioAlt	Usuário que alterou	Texto	-
dtHrAlt	Data/hora alteração	DataHora	-
fluxoCaixa	Descrição do fluxo de caixa	Texto	Parâmetro Seção: RCMP_PGTCP Entrada: CD_TP_FLXCX_NF_DS
noNfReferencia	Notas Fiscais de referencia para Notas de Complemento de Preço	Texto	-

Atributos	Descrição	Tipo	Observação
detalheQuinzena.cdUsuarioInc	Usuário que incluiu	Texto	-
detalheQuinzena.dtHrAlt	Data/hora alteração	DataHora	-
detalheQuinzena.vlTonCana	Volume em toneladas de cana	Decimal	-
detalheQuinzena.dtHrInc	Data/hora inclusão	DataHora	-
detalheQuinzena.ddFinal	Dia final do período	Numérico	-
detalheQuinzena.vlFatorK	Fator K	Decimal	-
detalheQuinzena.vlRef	Valor de referência	Decimal	-
detalheQuinzena.cdUsuarioAlt	Usuário que alterou	Texto	-
detalheQuinzena.vlTotal	Valor total	Decimal	-
detalheQuinzena.vlAcertoAtr	Valor de acerto	Decimal	-
detalheQuinzena.vlAcAtrReceb	Valor a receber	Decimal	-
detalheQuinzena.ddInicial	Dia inicial do período	Numérico	-
detalheQuinzena.cdTpCalc	Tipo de cálculo	Numérico	-
detalheQuinzena.vlKgAtr	Valor por kg	Decimal	-
detalheQuinzena.vlAtr	Valor de atr	Decimal	-
detalheQuinzena.pcPgVlTon	Percentual pago por tonelada	Decimal	-
detalheQuinzena.qtdeCana	Quantidade de cana	Numérico	-
detalheQuinzena.vlRetencao	Valor de retenção	Decimal	-
detalheQuinzena.vlSubsidio	Valor de subsídio	Decimal	-
detalheQuinzena.vlBonusTon	Bônus por tonelada	Decimal	-

Atributos	Descrição	Tipo	Observação
detalheHistTx.instancia	Instância	Texto	-
detalheHistTx.noNf	Número da nota fiscal	Numérico	-
detalheHistTx.cdSerieNf	Série da nota fiscal	Numérico	-
detalheHistTx.cdFornec	Código do fornecedor	Numérico	-
detalheHistTx.cdUpnivel1	Código do nível 1	Texto	-
detalheHistTx.dtIniPer	Data início período	Data	ISO 8601
detalheHistTx.dtFimPer	Data fim período	Data	ISO 8601
detalheHistTx.cdTxcontr	Código da taxa	Numérico	-
detalheHistTx.vlTxContrib	Valor da taxa	Decimal	-
detalheHistTx.cdGrpTxcontr	Grupo da taxa	Numérico	-
detalheHistTx.vlBaseTx	Base da taxa	Decimal	-
detalheHistTx.fgAcertoAnual	Flag acerto anual	Texto	-
detalheHistTx.fgIndividual	Flag individual	Texto	-
detalheHistTx.vlSubsidio	Valor de subsídio	Decimal	-
detalheHistTx.fgLiminarInss	Flag liminar INSS	Texto	-
detalheHistTx.cdUsuarioAlt	Usuário alteração	Texto	-
detalheHistTx.dtHrInc	Data/hora inclusão	DataHora	-
detalheHistTx.dtHrAlt	Data/hora alteração	DataHora	-
detalheHistTx.cdUsuarioInc	Usuário inclusão	Texto	-

Atributos	Descrição	Tipo	Observação
detalheHistTx.infComplTaxa.cdTxcontr	Código da taxa	Numérico	-
detalheHistTx.infComplTaxa.dtValIni	Data início validade	Data	-
detalheHistTx.infComplTaxa.deTxcontr	Descrição taxa	Texto	-
detalheHistTx.infComplTaxa.pcTxcontr	Percentual da taxa	Decimal	-
detalheHistTx.infComplTaxa.cdIndBase	Código indicador base	Numérico	-
detalheHistTx.infComplTaxa.pcRedBase	Percentual redução base	Decimal	-
detalheHistTx.infComplTaxa.fgAcertoAno	Flag acerto anual	Texto	-
detalheHistTx.infComplTaxa.cdTxErp	Código ERP	Texto	-
detalheHistTx.infComplTaxa.codigoClassificacao	Código classificação	Texto	-
detalheHistTx.infComplTaxa.codigoEspecie	Código espécie	Texto	-

Atributos	Descrição	Tipo	Observação
deducoes.instancia	Instância	Texto	-
deducoes.fgTpProc	Tipo de processo	Texto	N - Nota Mensal
deducoes.cdFornec	Código fornecedor	Numérico	-
deducoes.dtiniPer	Data início período	Data	ISO 8601
deducoes.dtFinPer	Data fim período	Data	ISO 8601
deducoes.cdEvto	Código do evento	Numérico	-
deducoes.noCtaContb	Numero da Conta Contábil	Numérico	-
deducoes.dtEvto	Data do evento	Data	ISO 8601
deducoes.vlDeducao	Valor dedução	Decimal	-
deducoes.cdGrpEvto	Grupo do evento	Numérico	-
deducoes.fgIndividual	Flag individual	Texto	-
deducoes.cdUsuarioInc	Usuário inclusão	Texto	-
deducoes.dtHrInc	Data/hora inclusão	DataHora	-
deducoes.cdUsuarioAlt	Usuário alteração	Texto	-
deducoes.dtHrAlt	Data/hora alteração	DataHora	-
deducoes.fgDedAdiant	Flag indicativa para dedução de Adiantamento	Texto	'S' ou 'N'

Atributos	Descrição	Tipo	Observação
deducoesGtm.instancia	Instância	Texto	-
deducoesGtm.fgTpProc	Tipo de processo	Texto	N - Nota Mensal L - Nota de Complemento Automática
deducoesGtm.cdFornec	Código fornecedor	Numérico	-
deducoesGtm.dtiniPer	Data início período	Data	ISO 8601
deducoesGtm.dtFinPer	Data fim período	Data	ISO 8601
deducoesGtm.cdEvto	Código evento	Numérico	-
deducoesGtm.noCtaContb	Numero da Conta Contábil	Numérico
deducoesGtm.dtEvto	Data do evento	Data	ISO 8601
deducoesGtm.vlDeducao	Valor dedução	Decimal	-
deducoesGtm.cdGrpEvto	Grupo do evento	Numérico	-
deducoesGtm.fgIndividual	Flag individual	Texto	-
deducoesGtm.cdUsuarioInc	Usuário inclusão	Texto	-
deducoesGtm.dtHrInc	Data/hora inclusão	DataHora	-
deducoesGtm.cdUsuarioAlt	Usuário alteração	Texto	-
deducoesGtm.dtHrAlt	Data/hora alteração	DataHora	-
deducoesGtm.fgDedAdiant	Flag indicativa para dedução de Adiantamento	Texto	'S' ou 'N'

Atributos	Descrição	Tipo	Observação
infoUpnivel1.cdUpnivel1	Código nível 1	Texto	-
infoUpnivel1.deUpnivel1	Descrição nível 1	Texto	-
infoUpnivel1.cdFornec	Código fornecedor	Numérico	-
infoUpnivel1.fgTpPess	Tipo pessoa	Texto	J = Jurídica, F = Física
infoUpnivel1.cdIntErp	Código interno ERP	Texto	-

Atributos	Descrição	Tipo	Observação
infoFornecs.cdFornec	Código fornecedor	Numérico	-
infoFornecs.deFornec	Descrição fornecedor	Texto	-
infoFornecs.fgTpFornec	Tipo fornecedor	Texto	1 - ACIONISTA 2 - FORNECEDOR 3 - EVENTUAL 4 - PROPRIO 5 - PARCEIRO
infoFornecs.deTpFornec	Descrição tipo fornecedor	Texto	-
infoFornecs.fgTpPess	Tipo pessoa	Texto	J = Jurídica, F = Física
infoFornecs.cdIntErp	Código interno ERP	Texto	-

Atributos	Descrição	Tipo	Observação
infoCanaDia.primeiraQuinzena	Quantidades de Cana entregue na primeira quinzena	Numérico	Valores separados por dia e valor. Ex: "29 = 4000; 30 = 380280" - Para o dia 30 do mês de referência teve uma entrega de 380280 kg
infoCanaDia.segundaQuinzena	Quantidades de Cana entregue na segunda quinzena	Numérico	Valores separados por dia e valor. Ex: "29 = 4000; 30 = 380280" - Para o dia 30 do mês de referência teve uma entrega de 380280 kg

Método GET:

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

...

Bloco de código

language	java
title	Notas fiscais de entrada de cana - Mensal

{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "notaFiscal":24,
         "cdSerieNf":"8",
         "cdTpProp":7,
         "cdSafra":2016,
         "amFornec":"2016-04-01T00:00:00",
         "acPeso":384280,
         "vlTotNf":23881.35,
         "dtEmisNf":"2016-04-30T00:00:00",
         "deMunic":"ALTINÓPOLIS",
         "deNatOper":"TEST",
         "cdFiscOp":1101,
         "deEnd":"SITIO:CONQUISTATOTVS,S/N",
         "noCep":"14350000",
         "cdUf":"SP",
         "noFone":null,
         "noCgcCpf":"1599.796999.317999/00060000-6800",
         "fgSituacao":"N",
         "acTxContrib":358.22,
         "vlLiqNf":23523.13,
         "vlLiquida":null,
         "cdTpCalc":99,
         "fgComplPreco":null,
         "fgManAuto":"A",
         "fgTipoNotaFiscal":"Mensal Automático",
         "deObs":null,
         "deFiscOp":null,
         "cdClasFisc":null,
         "fgSubstituicao":null,
         "vlCredIcms":null,
         "fgAcertoAnual":null,
         "fgCpr":null,
         "fgComplProduto":null,
         "fgIndividual":null,
         "noContrCana":1729,
         "cdEmpresa":"1",
         "instContr":"1",
         "cdMunic":5,
         "cdUsuarioInc":null,
         "dtHrInc":null,
         "cdUsuarioAlt":null,
         "dtHrAlt":null,
         "fluxoCaixa":"RCMP - FLXCX - NF",
         "detalheQuinzena":[
            {
               "cdUsuarioInc":null,
               "dtHrAlt":null,
               "vlTonCana":62.1457,
               "dtHrInc":null,
               "ddFinal":30,
               "vlFatorK":1,
               "vlRef":0,
               "cdUsuarioAlt":null,
               "vlTotal":23881.35,
               "vlAcertoAtr":null,
               "vlAcAtrReceb":0,
               "ddInicial":16,
               "cdTpCalc":99,
               "vlKgAtr":0.5881,
               "vlAtr":132.09,
               "pcPgVlTon":80,
               "qtdeCana":384280,
               "vlRetencao":null,
               "vlSubsidio":null,
               "vlBonusTon":0
            }
         ],
         "detalheHistTx":[
            {
               "instancia":"1",
               "noNf":24,
             {  "cdSerieNf":"8",
               "instanciacdFornec":"1"50774,
               "noNfcdUpnivel1":24" 20526",
               "cdSerieNfdtIniPer":"82016-04-01T00:00:00",
               "cdFornec":50774dtFimPer":"2016-04-30T00:00:00",
               "cdUpnivel1cdTxcontr":" 20526"1,
               "dtIniPervlTxContrib":"2016-04-01T00:00:00"310.46,
               "dtFimPer":cdGrpTxcontr"2016-04-30T00:00:00":1,
               "cdTxcontrvlBaseTx":123881.35,
               "vlTxContribfgAcertoAnual":310.46null,
               "cdGrpTxcontrfgIndividual":1null,
               "vlBaseTxvlSubsidio":23881.350,
               "fgAcertoAnualfgLiminarInss":null,
               "fgIndividualcdUsuarioAlt":null,
               "vlSubsidiodtHrInc":0null,
               "fgLiminarInssdtHrAlt":null,
               "cdUsuarioAltcdUsuarioInc":null,
               "dtHrIncinfComplTaxa":null,{
                  "dtHrAltcdTxcontr":null1,
               "cdUsuarioInc":null,
   "dtValIni":"2015-10-01T00:00:00",
                  "infComplTaxadeTxcontr":{"INSS",
                  "cdTxcontrpcTxcontr":1.3,
                  "dtValInicdIndBase":"2015-10-01T00:00:00"950,
                  "deTxcontrpcRedBase":"INSS"null,
                  "pcTxcontrfgAcertoAno":1.3"S",
                  "cdIndBasecdTxErp":950null,
                  "pcRedBasecodigoClassificacao":null"CLAS 1",
                  "fgAcertoAnocodigoEspecie":"SESPECIE 1",

               }
            "cdTxErp":null},
            {
               "codigoClassificacaoinstancia":"CLAS 1",
                  "codigoEspecienoNf":"ESPECIE 1"24,
               }"cdSerieNf":"8",
            }   "cdFornec":50774,
            {   "cdUpnivel1":" 20526",
               "instancia":"1""dtIniPer":"2016-04-01T00:00:00",
               "noNf":24dtFimPer":"2016-04-30T00:00:00",
               "cdSerieNfcdTxcontr":"8"2,
               "cdFornecvlTxContrib":5077447.76,
               "cdUpnivel1cdGrpTxcontr":" 20526"1,
               "dtIniPervlBaseTx":"2016-04-01T00:00:00"23881.35,
               "dtFimPerfgAcertoAnual":"2016-04-30T00:00:00"null,
               "cdTxcontrfgIndividual":2null,
               "vlTxContribvlSubsidio":47.760,
               "cdGrpTxcontrfgLiminarInss":1null,
               "vlBaseTxcdUsuarioAlt":23881.35null,
               "fgAcertoAnualdtHrInc":null,
               "fgIndividualdtHrAlt":null,
               "vlSubsidiocdUsuarioInc":0null,
               "fgLiminarInssinfComplTaxa":null,{
                  "cdUsuarioAltcdTxcontr":null2,
                  "dtHrIncdtValIni":null"2015-10-01T00:00:00",
                  "dtHrAltdeTxcontr":null"SENAR",
                  "cdUsuarioIncpcTxcontr":null,
0.2,
                  "infComplTaxacdIndBase":{950,
                  "cdTxcontrpcRedBase":2null,
                  "dtValInifgAcertoAno":"2015-10-01T00:00:00S",
                  "deTxcontrcdTxErp":"SENAR"null,
                  "pcTxcontrcodigoClassificacao":0."CLAS 2",
                  "cdIndBasecodigoEspecie":950,"ESPECIE 2"
               }
   "pcRedBase":null,
         }
         "fgAcertoAno":"S"],
         "deducoes":[
             "cdTxErp":null,{
                  "codigoClassificacaoinstancia":"CLAS 21",
                  "codigoEspeciefgTpProc":"ESPECIENota 2Mensal",
               }"cdFornec":50774,
            }
   "dtiniPer":"2016-04-01T00:00:00",
           ],
    "dtFinPer":"2016-04-30T00:00:00",
      "deducoes":[
            {"cdEvto":162,
               "instancianoCtaContb":"1110",
               "fgTpProcdtEvto":"Nota Mensal2016-04-01T00:00:00",
               "cdFornecvlDeducao":50774150,
               "dtiniPercdGrpEvto":"2016-04-01T00:00:00"2,
               "dtFinPerfgIndividual":"2016-04-30T00:00:00S",
               "cdEvtocdUsuarioInc":162"TOTVS",
               "dtEvtodtHrInc":"20162024-0408-01T0006T03:00:00",
               "vlDeducaocdUsuarioAlt":150"XXX",
               "cdGrpEvto":2dtHrAlt":"2024-08-07T21:00:00",
               "fgIndividualfgDedAdiant":"SN",
            }
   "cdUsuarioInc":"TOTVS",
          ],        
            "dtHrInc":"2024-08-06T03:00:00",deducoesGtm":[
            {
               "cdUsuarioAltinstancia":"DCS_PEDRA1",
               "dtHrAltfgTpProc":"2024-08-07T21:00:00"Nota Mensal",
            }
   "cdFornec":50774,
      ],
         "deducoesGtmdtiniPer":["2016-04-01T00:00:00",
            {   "dtFinPer":"2016-04-30T00:00:00",
               "instanciacdEvto":"1"110,
               "fgTpProcnoCtaContb":"Nota Mensal110",
               "cdFornec":50774dtEvto":"2016-11-30T00:00:00",
               "dtiniPervlDeducao":"2016-04-01T00:00:00"78349.97,
               "dtFinPercdGrpEvto":"2016-04-30T00:00:00"1,
               "cdEvtofgIndividual":110null,
               "dtEvtocdUsuarioInc":"2016-11-30T00:00:00"null,
               "vlDeducaodtHrInc":78349.97null,
               "cdGrpEvtocdUsuarioAlt":1null,
               "fgIndividualdtHrAlt":null,
               "cdUsuarioIncfgDedAdiant":null,
"N"
            }
        "dtHrInc":null ],
          "infoUpnivel1":[
          "cdUsuarioAlt":null,  {
               "dtHrAltcdUpnivel1":null" 20526",
            }
    "deUpnivel1":"TOTVS",
     ],
          "infoUpnivel1cdFornec":[50774,
            {   "fgTpPess":"J",
               "cdUpnivel1cdIntErp":" 20526",1_1133_4"
            }
   "deUpnivel1":"CONQUISTA",
      ],
         "cdFornecinfoFornecs":50774,[
            {
               "fgTpPesscdFornec":"J"50774,
               "cdIntErpdeFornec":"1_1133_4"TOTVS FAZ",
            }
   "fgTpFornec":"2",
      ],
         "infoFornecsdeTpFornec":["FORNECEDOR",
            {   "fgTpPess":"F",
               "cdForneccdIntErp":"50774,"
            }
   "deFornec":"ALLAN BORGES ANNIBAL",
    ],
           "fgTpFornecinfoCanaDia":"2", {
               "fgTpPess	"primeiraQuinzena": "F",
               "cdIntErpsegundaQuinzena":"50774"
    "29 = 4000; 30 = 380280"
         },
		 "noNfReferencia": "5852, 8569, 4758"     ]
        }
   ]
}

Parâmetros Obrigatórios

...

cdSerieNf: Codigo da Serie da N.F.
cdFornecedor: Código do Fornecedor.notaFiscal: Numero da N.F.Fornecedor.
notaFiscal: Numero da N.F.
fgStatusIntegracao; Status da Integração ( ex: S;N;P ou nulo)
fgUltimaNotaFiscalComplemento: Preencher com 'S' para trazer a última nota Fiscal de complemento de preço.

Atualizar status de integração - Notas fiscais de entrada de cana

...

Método PUT:

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

Bloco de código

language	java
title	Notas fiscais de entrada de cana - Mensal

{ 
  "fgStatusERPfgStatusIntegracao": "S",
  "instancia": 31,
  "notaFiscal": 49,
  "cdSerieNf": "8",
  "fgTipoNotaFiscal": "M",
  "noNfErp": "123" 
}

Dica

title	Bloqueio da Reversão de Processamentos que apresentem registros já integrados com outros sistemas

Com o objetivo de assegurar a consistência das informações integradas com outros sistemas, foi desenvolvido uma nova funcionalidade dentro da aplicação Configuração Central (CFGCEN/ TOTVS Agro Bioenergia), onde será possível realizar o cadastro de rotinas executadas pelo TOTVS Agro Bioenergia e indicar os possíveis "status de integração" vindos de sistemas externos (que estejam integrados ao TOTVS Agro Bioenergia).

Para cada status indicado, será possível apontar se será permitido ou não a reversão do processo em questão.

Observação importante: Para que seja realizada a atualização das informações na API, os parâmetros fgStatusIntegracao e noNfErp são informações obrigatórias, podendo ser nulos ou não.

Visando possibilitar a indicação de diferentes cadastros para diferentes processamentos disponíveis em nosso sistema, foram criados parâmetros específicos para cada rotina,
onde o usuário deverá determinar qual cadastro deverá ser consultado no momento de realizar a reversão do processamento.

Também é Importante frisar que, caso um ou mais registros apresentem um status onde esteja apontado o impedimento para reversão, o processamento será interrompido, impedindo a execução da reversão para todos os registros envolvidos.

Parâmetro "Código do cadastro de controle de status para NFs de entrada de cana":

Seção: RCMP_PGTCP;
Entrada: CD_CAD_STATUS_INT_NFENT;

Para mais detalhes sobre a funcionalidade citada acima, acesse a página Cadastro de Bloqueio de Movimentações via API.

Páginas filhas

Versões comparadas

Versão antiga 13

Nova versão Atual

Chave

Parâmetros Obrigatórios

Atualizar status de integração - Notas fiscais de entrada de cana