Consulta das Notas fiscais de entrada de cana - Mensal

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


Estrutura:

AtributosDescriçãoTamanhoTipoObservação
instanciaIdentificador da instância-TextoObrigatório
notaFiscalNúmero da nota fiscal-NuméricoObrigatório
cdSerieNfCódigo da série da nota fiscal-NuméricoObrigatório
cdTpPropCódigo do tipo de propriedade-Numérico-
cdSafraAno da safra4Numérico-
amFornecData de fornecimento-DataFormato ISO 8601
acPesoPeso acumulado-Numérico-
vlTotNfValor total da nota fiscal-Decimal-
dtEmisNfData de emissão da nota fiscal-DataFormato ISO 8601
deMunicNome do município-Texto-
deNatOperNatureza da operação-Texto-
cdFiscOpCódigo fiscal da operação-Numérico-
deEndEndereço-Texto-
noCepCEP8Texto-
cdUfCódigo da unidade federativa2Texto-
noFoneTelefone-TextoOpcional
noCgcCpfCNPJ/CPF-Texto-
fgSituacaoSituação1TextoEx: 'N'
acTxContribValor da taxa de contribuição-Decimal-
vlLiqNfValor líquido da nota fiscal-Decimal-
vlLiquidaValor líquido alternativo-DecimalOpcional
cdTpCalcCódigo do tipo de cálculo-Numérico-
fgComplPrecoComplemento de preço-TextoOpcional
fgManAutoFlag de manutenção automática1Texto-
fgTipoNotaFiscalTipo de nota fiscal-Texto-
deObsObservações-TextoOpcional
deFiscOpDescrição fiscal da operação-TextoOpcional
cdClasFiscCódigo de classificação fiscal-TextoOpcional
fgSubstituicaoFlag de substituição-TextoOpcional
vlCredIcmsValor crédito ICMS-DecimalOpcional
fgAcertoAnualFlag de acerto anual-TextoOpcional
fgCprFlag CPR-TextoOpcional
fgComplProdutoComplemento de produto-TextoOpcional
fgIndividualFlag individual-TextoOpcional
noContrCanaNúmero do contrato de cana-Numérico-
cdEmpresaCódigo da empresa-Texto-
instContrInstância do contrato-Texto-
cdMunicCódigo do município-Numérico-
cdUsuarioIncUsuário que incluiu-TextoOpcional
dtHrIncData/hora inclusão-DataHoraOpcional
cdUsuarioAltUsuário que alterou-TextoOpcional
dtHrAltData/hora alteração-DataHoraOpcional
fluxoCaixaDescrição do fluxo de caixa-Texto-


detalheQuinzena

AtributosDescriçãoTamanhoTipoObservação
detalheQuinzena.cdUsuarioIncUsuário que incluiu-TextoOpcional
detalheQuinzena.dtHrAltData/hora alteração-DataHoraOpcional
detalheQuinzena.vlTonCanaVolume em toneladas de cana-Decimal-
detalheQuinzena.dtHrIncData/hora inclusão-DataHoraOpcional
detalheQuinzena.ddFinalDia final do período-Numérico-
detalheQuinzena.vlFatorKFator K-Decimal-
detalheQuinzena.vlRefValor de referência-Decimal-
detalheQuinzena.cdUsuarioAltUsuário que alterou-TextoOpcional
detalheQuinzena.vlTotalValor total-Decimal-
detalheQuinzena.vlAcertoAtrValor de acerto-DecimalOpcional
detalheQuinzena.vlAcAtrRecebValor a receber-Decimal-
detalheQuinzena.ddInicialDia inicial do período-Numérico-
detalheQuinzena.cdTpCalcTipo de cálculo-Numérico-
detalheQuinzena.vlKgAtrValor por kg-Decimal-
detalheQuinzena.vlAtrValor de atr-Decimal-
detalheQuinzena.pcPgVlTonPercentual pago por tonelada-Decimal-
detalheQuinzena.qtdeCanaQuantidade de cana-Numérico-
detalheQuinzena.vlRetencaoValor de retenção-DecimalOpcional
detalheQuinzena.vlSubsidioValor de subsídio-DecimalOpcional
detalheQuinzena.vlBonusTonBônus por tonelada-Decimal-


detalheHistTx

AtributosDescriçãoTamanhoTipoObservação
detalheHistTx.instanciaInstância-Texto-
detalheHistTx.noNfNúmero da nota fiscal-Numérico-
detalheHistTx.cdSerieNfSérie da nota fiscal-Numérico-
detalheHistTx.cdFornecCódigo do fornecedor-Numérico-
detalheHistTx.cdUpnivel1Código do nível 1-Texto-
detalheHistTx.dtIniPerData início período-DataISO 8601
detalheHistTx.dtFimPerData fim período-DataISO 8601
detalheHistTx.cdTxcontrCódigo da taxa-Numérico-
detalheHistTx.vlTxContribValor da taxa-Decimal-
detalheHistTx.cdGrpTxcontrGrupo da taxa-Numérico-
detalheHistTx.vlBaseTxBase da taxa-Decimal-
detalheHistTx.fgAcertoAnualFlag acerto anual-TextoOpcional
detalheHistTx.fgIndividualFlag individual-TextoOpcional
detalheHistTx.vlSubsidioValor de subsídio-Decimal-
detalheHistTx.fgLiminarInssFlag liminar INSS-TextoOpcional
detalheHistTx.cdUsuarioAltUsuário alteração-TextoOpcional
detalheHistTx.dtHrIncData/hora inclusão-DataHoraOpcional
detalheHistTx.dtHrAltData/hora alteração-DataHoraOpcional
detalheHistTx.cdUsuarioIncUsuário inclusão-Texto

Opcional


detalheHistTx.infComplTaxa

AtributosDescriçãoTamanhoTipoObservação
detalheHistTx.infComplTaxa.cdTxcontrCódigo da taxa-Numérico-
detalheHistTx.infComplTaxa.dtValIniData início validade-Data-
detalheHistTx.infComplTaxa.deTxcontrDescrição taxa-Texto-
detalheHistTx.infComplTaxa.pcTxcontrPercentual da taxa-Decimal-
detalheHistTx.infComplTaxa.cdIndBaseCódigo indicador base-Numérico-
detalheHistTx.infComplTaxa.pcRedBasePercentual redução base-DecimalOpcional
detalheHistTx.infComplTaxa.fgAcertoAnoFlag acerto anual1Texto-
detalheHistTx.infComplTaxa.cdTxErpCódigo ERP-TextoOpcional
detalheHistTx.infComplTaxa.codigoClassificacaoCódigo classificação-Texto-
detalheHistTx.infComplTaxa.codigoEspecieCódigo espécie-Texto-


deducoes

AtributosDescriçãoTamanhoTipoObservação
deducoes.instanciaInstância-Texto-
deducoes.fgTpProcTipo de processo-Texto-
deducoes.cdFornecCódigo fornecedor-Numérico-
deducoes.dtiniPerData início período-DataISO 8601
deducoes.dtFinPerData fim período-DataISO 8601
deducoes.cdEvtoCódigo do evento-Numérico-
deducoes.dtEvtoData do evento-DataISO 8601
deducoes.vlDeducaoValor dedução-Decimal-
deducoes.cdGrpEvtoGrupo do evento-Numérico-
deducoes.fgIndividualFlag individual-Texto-
deducoes.cdUsuarioIncUsuário inclusão-Texto-
deducoes.dtHrIncData/hora inclusão-DataHora-
deducoes.cdUsuarioAltUsuário alteração-Texto-
deducoes.dtHrAltData/hora alteração-DataHora-


deducoesGtm 

AtributosDescriçãoTamanhoTipoObservação
deducoesGtm.instanciaInstância-Texto-
deducoesGtm.fgTpProcTipo de processo-Texto-
deducoesGtm.cdFornecCódigo fornecedor-Numérico-
deducoesGtm.dtiniPerData início período-DataISO 8601
deducoesGtm.dtFinPerData fim período-DataISO 8601
deducoesGtm.cdEvtoCódigo evento-Numérico-
deducoesGtm.dtEvtoData do evento-DataISO 8601
deducoesGtm.vlDeducaoValor dedução-Decimal-
deducoesGtm.cdGrpEvtoGrupo do evento-Numérico-
deducoesGtm.fgIndividualFlag individual-TextoOpcional
deducoesGtm.cdUsuarioIncUsuário inclusão-TextoOpcional
deducoesGtm.dtHrIncData/hora inclusão-DataHoraOpcional
deducoesGtm.cdUsuarioAltUsuário alteração-TextoOpcional
deducoesGtm.dtHrAltData/hora alteração-DataHoraOpcional


infoUpnivel1

AtributosDescriçãoTamanhoTipoObservação
infoUpnivel1.cdUpnivel1Código nível 1-Texto-
infoUpnivel1.deUpnivel1Descrição nível 1-Texto-
infoUpnivel1.cdFornecCódigo fornecedor-Numérico-
infoUpnivel1.fgTpPessTipo pessoa1TextoJ = Jurídica, F = Física
infoUpnivel1.cdIntErpCódigo interno ERP-Texto

-


infoFornecs

AtributosDescriçãoTamanhoTipoObservação
infoFornecs.cdFornecCódigo fornecedor-Numérico-
infoFornecs.deFornecDescrição fornecedor-Texto-
infoFornecs.fgTpFornecTipo fornecedor-Texto1=Interno, 2=Fornecedor
infoFornecs.deTpFornecDescrição tipo fornecedor-Texto-
infoFornecs.fgTpPessTipo pessoa1TextoJ = Jurídica, F = Física
infoFornecs.cdIntErpCódigo interno ERP-Texto-





Método GET:

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

Estrutura de dados:

{
   "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:TOTVS,S/N",
         "noCep":"14350000",
         "cdUf":"SP",
         "noFone":null,
         "noCgcCpf":"99.999.999/0000-00",
         "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",
               "cdFornec":50774,
               "cdUpnivel1":" 20526",
               "dtIniPer":"2016-04-01T00:00:00",
               "dtFimPer":"2016-04-30T00:00:00",
               "cdTxcontr":1,
               "vlTxContrib":310.46,
               "cdGrpTxcontr":1,
               "vlBaseTx":23881.35,
               "fgAcertoAnual":null,
               "fgIndividual":null,
               "vlSubsidio":0,
               "fgLiminarInss":null,
               "cdUsuarioAlt":null,
               "dtHrInc":null,
               "dtHrAlt":null,
               "cdUsuarioInc":null,
               "infComplTaxa":{
                  "cdTxcontr":1,
                  "dtValIni":"2015-10-01T00:00:00",
                  "deTxcontr":"INSS",
                  "pcTxcontr":1.3,
                  "cdIndBase":950,
                  "pcRedBase":null,
                  "fgAcertoAno":"S",
                  "cdTxErp":null,
                  "codigoClassificacao":"CLAS 1",
                  "codigoEspecie":"ESPECIE 1"
               }
            },
            {
               "instancia":"1",
               "noNf":24,
               "cdSerieNf":"8",
               "cdFornec":50774,
               "cdUpnivel1":" 20526",
               "dtIniPer":"2016-04-01T00:00:00",
               "dtFimPer":"2016-04-30T00:00:00",
               "cdTxcontr":2,
               "vlTxContrib":47.76,
               "cdGrpTxcontr":1,
               "vlBaseTx":23881.35,
               "fgAcertoAnual":null,
               "fgIndividual":null,
               "vlSubsidio":0,
               "fgLiminarInss":null,
               "cdUsuarioAlt":null,
               "dtHrInc":null,
               "dtHrAlt":null,
               "cdUsuarioInc":null,
               "infComplTaxa":{
                  "cdTxcontr":2,
                  "dtValIni":"2015-10-01T00:00:00",
                  "deTxcontr":"SENAR",
                  "pcTxcontr":0.2,
                  "cdIndBase":950,
                  "pcRedBase":null,
                  "fgAcertoAno":"S",
                  "cdTxErp":null,
                  "codigoClassificacao":"CLAS 2",
                  "codigoEspecie":"ESPECIE 2"
               }
            }
         ],
         "deducoes":[
            {
               "instancia":"1",
               "fgTpProc":"Nota Mensal",
               "cdFornec":50774,
               "dtiniPer":"2016-04-01T00:00:00",
               "dtFinPer":"2016-04-30T00:00:00",
               "cdEvto":162,
               "dtEvto":"2016-04-01T00:00:00",
               "vlDeducao":150,
               "cdGrpEvto":2,
               "fgIndividual":"S",
               "cdUsuarioInc":"TOTVS",
               "dtHrInc":"2024-08-06T03:00:00",
               "cdUsuarioAlt":"XXX",
               "dtHrAlt":"2024-08-07T21:00:00"
            }
         ],
         "deducoesGtm":[
            {
               "instancia":"1",
               "fgTpProc":"Nota Mensal",
               "cdFornec":50774,
               "dtiniPer":"2016-04-01T00:00:00",
               "dtFinPer":"2016-04-30T00:00:00",
               "cdEvto":110,
               "dtEvto":"2016-11-30T00:00:00",
               "vlDeducao":78349.97,
               "cdGrpEvto":1,
               "fgIndividual":null,
               "cdUsuarioInc":null,
               "dtHrInc":null,
               "cdUsuarioAlt":null,
               "dtHrAlt":null
            }
         ],
         "infoUpnivel1":[
            {
               "cdUpnivel1":" 20526",
               "deUpnivel1":"TOTVS",
               "cdFornec":50774,
               "fgTpPess":"J",
               "cdIntErp":"1_1133_4"
            }
         ],
         "infoFornecs":[
            {
               "cdFornec":50774,
               "deFornec":"TOTVS FAZ",
               "fgTpFornec":"2",
			   "deTpFornec": "FORNECEDOR",
               "fgTpPess":"F",
               "cdIntErp":"50774"
            }
         ]
      }
   ]
}


Parâmetros Obrigatórios


Parâmetros Opcionais

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

Disponibilizado endpoint para atualizar status de integração dos registros relacionados as Notas fiscais de entrada de cana - Mensal.

Método PUT:

http:127.0.0.1:8080/query/v1/notasFiscais


{ 
  "fgStatusERP": "S",
  "instancia": 31,
  "notaFiscal": 49,
  "cdSerieNf": "8",
  "fgTipoNotaFiscal": "M" 
} 

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.

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.

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.