Páginas filhas
  • API Notas fiscais de entrada de cana - Mensal

Versões comparadas

Chave

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

...

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

Método GET:

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

Estrutura de dados:


Estrutura:

AtributosDescriçãoTipoObservação
instanciaIdentificador da instânciaTexto-
notaFiscalNúmero da nota fiscalNumérico-
cdSerieNfCódigo da série da nota fiscalNumérico-
cdTpPropCódigo do tipo de propriedadeNumérico-
cdSafraAno da safraNumérico-
amFornecData de fornecimentoDataFormato ISO 8601
acPesoPeso acumuladoNumérico-
vlTotNfValor total da nota fiscalDecimal-
dtEmisNfData de emissão da nota fiscalDataFormato ISO 8601
deMunicNome do municípioTexto-
deNatOperNatureza da operaçãoTexto-
cdFiscOpCódigo fiscal da operaçãoNumérico-
deEndEndereçoTexto-
noCepCEPTexto-
cdUfCódigo da unidade federativaTexto-
noFoneTelefoneTexto-
noCgcCpfCNPJ/CPFTexto-
fgSituacaoSituaçãoTextoEx: 'N'
acTxContribValor da taxa de contribuiçãoDecimal-
vlLiqNfValor líquido da nota fiscalDecimal-
vlLiquidaValor líquido alternativoDecimal-
cdTpCalcCódigo do tipo de cálculoNumérico-
fgComplPrecoComplemento de preçoTexto-
fgManAutoFlag de manutenção automáticaTexto-
fgTipoNotaFiscalTipo de nota fiscalTexto-
deObsObservaçõesTextoM - Complemento Manual
A - Complemento Automática
N - Mensal Automático
deFiscOpDescrição fiscal da operaçãoTexto-
cdClasFiscCódigo de classificação fiscalTexto-
fgSubstituicaoFlag de substituiçãoTexto-
vlCredIcmsValor crédito ICMSDecimal-
fgAcertoAnualFlag de acerto anualTexto-
fgCprFlag CPRTexto-
fgComplProdutoComplemento de produtoTexto-
fgIndividualFlag individualTexto-
noContrCanaNúmero do contrato de canaNumérico-
cdEmpresaCódigo da empresaTexto-
instContrInstância do contratoTexto-
cdMunicCódigo do municípioNumérico-
cdUsuarioIncUsuário que incluiuTexto-
dtHrIncData/hora inclusãoDataHora-
cdUsuarioAltUsuário que alterouTexto-
dtHrAltData/hora alteraçãoDataHora-
fluxoCaixaDescrição do fluxo de caixaTextoParâmetro Seção: RCMP_PGTCP Entrada: CD_TP_FLXCX_NF_DS
noNfReferenciaNotas Fiscais de referencia para Notas de Complemento de PreçoTexto-
AtributosDescriçãoTipoObservação
detalheQuinzena.cdUsuarioIncUsuário que incluiuTexto-
detalheQuinzena.dtHrAltData/hora alteraçãoDataHora-
detalheQuinzena.vlTonCanaVolume em toneladas de canaDecimal-
detalheQuinzena.dtHrIncData/hora inclusãoDataHora-
detalheQuinzena.ddFinalDia final do períodoNumérico-
detalheQuinzena.vlFatorKFator KDecimal-
detalheQuinzena.vlRefValor de referênciaDecimal-
detalheQuinzena.cdUsuarioAltUsuário que alterouTexto-
detalheQuinzena.vlTotalValor totalDecimal-
detalheQuinzena.vlAcertoAtrValor de acertoDecimal-
detalheQuinzena.vlAcAtrRecebValor a receberDecimal-
detalheQuinzena.ddInicialDia inicial do períodoNumérico-
detalheQuinzena.cdTpCalcTipo de cálculoNumérico-
detalheQuinzena.vlKgAtrValor por kgDecimal-
detalheQuinzena.vlAtrValor de atrDecimal-
detalheQuinzena.pcPgVlTonPercentual pago por toneladaDecimal-
detalheQuinzena.qtdeCanaQuantidade de canaNumérico-
detalheQuinzena.vlRetencaoValor de retençãoDecimal-
detalheQuinzena.vlSubsidioValor de subsídioDecimal-
detalheQuinzena.vlBonusTonBônus por toneladaDecimal-
AtributosDescriçãoTipoObservação
detalheHistTx.instanciaInstânciaTexto-
detalheHistTx.noNfNúmero da nota fiscalNumérico-
detalheHistTx.cdSerieNfSérie da nota fiscalNumérico-
detalheHistTx.cdFornecCódigo do fornecedorNumérico-
detalheHistTx.cdUpnivel1Código do nível 1Texto-
detalheHistTx.dtIniPerData início períodoDataISO 8601
detalheHistTx.dtFimPerData fim períodoDataISO 8601
detalheHistTx.cdTxcontrCódigo da taxaNumérico-
detalheHistTx.vlTxContribValor da taxaDecimal-
detalheHistTx.cdGrpTxcontrGrupo da taxaNumérico-
detalheHistTx.vlBaseTxBase da taxaDecimal-
detalheHistTx.fgAcertoAnualFlag acerto anualTexto-
detalheHistTx.fgIndividualFlag individualTexto-
detalheHistTx.vlSubsidioValor de subsídioDecimal-
detalheHistTx.fgLiminarInssFlag liminar INSSTexto-
detalheHistTx.cdUsuarioAltUsuário alteraçãoTexto-
detalheHistTx.dtHrIncData/hora inclusãoDataHora-
detalheHistTx.dtHrAltData/hora alteraçãoDataHora-
detalheHistTx.cdUsuarioIncUsuário inclusãoTexto

-

AtributosDescriçãoTipoObservação
detalheHistTx.infComplTaxa.cdTxcontrCódigo da taxaNumérico-
detalheHistTx.infComplTaxa.dtValIniData início validadeData-
detalheHistTx.infComplTaxa.deTxcontrDescrição taxaTexto-
detalheHistTx.infComplTaxa.pcTxcontrPercentual da taxaDecimal-
detalheHistTx.infComplTaxa.cdIndBaseCódigo indicador baseNumérico-
detalheHistTx.infComplTaxa.pcRedBasePercentual redução baseDecimal-
detalheHistTx.infComplTaxa.fgAcertoAnoFlag acerto anualTexto-
detalheHistTx.infComplTaxa.cdTxErpCódigo ERPTexto-
detalheHistTx.infComplTaxa.codigoClassificacaoCódigo classificaçãoTexto-
detalheHistTx.infComplTaxa.codigoEspecieCódigo espécieTexto-
AtributosDescriçãoTipoObservação
deducoes.instanciaInstânciaTexto-
deducoes.fgTpProcTipo de processoTextoN - Nota Mensal
deducoes.cdFornecCódigo fornecedorNumérico-
deducoes.dtiniPerData início períodoDataISO 8601
deducoes.dtFinPerData fim períodoDataISO 8601
deducoes.cdEvtoCódigo do eventoNumérico-
deducoes.noCtaContbNumero da Conta ContábilNumérico-
deducoes.dtEvtoData do eventoDataISO 8601
deducoes.vlDeducaoValor deduçãoDecimal-
deducoes.cdGrpEvtoGrupo do eventoNumérico-
deducoes.fgIndividualFlag individualTexto-
deducoes.cdUsuarioIncUsuário inclusãoTexto-
deducoes.dtHrIncData/hora inclusãoDataHora-
deducoes.cdUsuarioAltUsuário alteraçãoTexto-
deducoes.dtHrAltData/hora alteraçãoDataHora-
deducoes.fgDedAdiantFlag indicativa para dedução de AdiantamentoTexto'S' ou 'N'
AtributosDescriçãoTipoObservação
deducoesGtm.instanciaInstânciaTexto-
deducoesGtm.fgTpProcTipo de processoTextoN - Nota Mensal
L - Nota de Complemento Automática
deducoesGtm.cdFornecCódigo fornecedorNumérico-
deducoesGtm.dtiniPerData início períodoDataISO 8601
deducoesGtm.dtFinPerData fim períodoDataISO 8601
deducoesGtm.cdEvtoCódigo eventoNumérico-
deducoesGtm.noCtaContbNumero da Conta ContábilNumérico
deducoesGtm.dtEvtoData do eventoDataISO 8601
deducoesGtm.vlDeducaoValor deduçãoDecimal-
deducoesGtm.cdGrpEvtoGrupo do eventoNumérico-
deducoesGtm.fgIndividualFlag individualTexto-
deducoesGtm.cdUsuarioIncUsuário inclusãoTexto-
deducoesGtm.dtHrIncData/hora inclusãoDataHora-
deducoesGtm.cdUsuarioAltUsuário alteraçãoTexto-
deducoesGtm.dtHrAltData/hora alteraçãoDataHora-
deducoesGtm.fgDedAdiantFlag indicativa para dedução de AdiantamentoTexto'S' ou 'N'
AtributosDescriçãoTipoObservação
infoUpnivel1.cdUpnivel1Código nível 1Texto-
infoUpnivel1.deUpnivel1Descrição nível 1Texto-
infoUpnivel1.cdFornecCódigo fornecedorNumérico-
infoUpnivel1.fgTpPessTipo pessoaTextoJ = Jurídica, F = Física
infoUpnivel1.cdIntErpCódigo interno ERPTexto

-

AtributosDescriçãoTipoObservação
infoFornecs.cdFornecCódigo fornecedorNumérico-
infoFornecs.deFornecDescrição fornecedorTexto-
infoFornecs.fgTpFornecTipo fornecedorTexto

1 - ACIONISTA

2 - FORNECEDOR

3 - EVENTUAL

4 - PROPRIO

5 - PARCEIRO

infoFornecs.deTpFornecDescrição tipo fornecedorTexto-
infoFornecs.fgTpPessTipo pessoaTextoJ = Jurídica, F = Física
infoFornecs.cdIntErpCódigo interno ERPTexto-
AtributosDescriçãoTipoObservação

infoCanaDia.primeiraQuinzena

Quantidades de Cana entregue na primeira quinzenaNuméricoValores 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.segundaQuinzenaQuantidades de Cana entregue na segunda quinzenaNuméricoValores 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

Estrutura de dados:

Bloco de código
languagejava
titleNotas 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,
Bloco de código
languagejava
titleNotas fiscais de entrada de cana - Mensal
{
   "hasNext":true,
   "items":[
      {
         "instanciadtEmisNf":"12016-04-30T00:00:00",
         "notaFiscaldeMunic":24"ALTINÓPOLIS",
         "cdSerieNfdeNatOper":"8TEST",
         "cdTpPropcdFiscOp":71101,
         "cdSafradeEnd":2016"SITIO:TOTVS,S/N",
         "amFornecnoCep":"2016-04-01T00:00:0014350000",
         "acPesocdUf":384280"SP",
         "vlTotNfnoFone":23881.35null,
         "dtEmisNfnoCgcCpf":"2016-04-30T00:00:99.999.999/0000-00",
         "deMunicfgSituacao":"ALTINÓPOLISN",
         "deNatOperacTxContrib":"TEST"358.22,
         "cdFiscOpvlLiqNf":110123523.13,
         "deEndvlLiquida":"SITIO:TOTVS,S/N",null,
         "noCepcdTpCalc":"14350000"99,
         "cdUffgComplPreco":"SP"null,
         "noFonefgManAuto":null"A",
         "noCgcCpffgTipoNotaFiscal":"99.999.999/0000-00Mensal Automático",
         "fgSituacaodeObs":"N"null,
         "acTxContribdeFiscOp":358.22null,
         "vlLiqNfcdClasFisc":23523.13null,
         "vlLiquidafgSubstituicao":null,
         "cdTpCalcvlCredIcms":99null,
         "fgComplPrecofgAcertoAnual":null,
         "fgManAutofgCpr":"A"null,
         "fgTipoNotaFiscalfgComplProduto":"Mensal Automático"null,
         "deObsfgIndividual":null,
         "deFiscOpnoContrCana":null1729,
         "cdClasFisccdEmpresa":null"1",
         "fgSubstituicaoinstContr":null"1",
         "vlCredIcmscdMunic":null5,
         "fgAcertoAnualcdUsuarioInc":null,
         "fgCprdtHrInc":null,
         "fgComplProdutocdUsuarioAlt":null,
         "fgIndividualdtHrAlt":null,
         "fluxoCaixa":"RCMP - FLXCX -  "noContrCanaNF":1729,
         "cdEmpresadetalheQuinzena":"1",[
         "instContr":"1",
   {
      "cdMunic":5,
         "cdUsuarioInc":null,
         "dtHrInc      "dtHrAlt":null,
               "cdUsuarioAltvlTonCana":null62.1457,
               "dtHrAltdtHrInc":null,
               "fluxoCaixaddFinal":"RCMP - FLXCX - NF",
30,
               "detalheQuinzenavlFatorK":[1,
            {   "vlRef":0,
               "cdUsuarioInccdUsuarioAlt":null,
               "dtHrAltvlTotal":null23881.35,
               "vlTonCanavlAcertoAtr":62.1457null,
               "dtHrIncvlAcAtrReceb":null0,
               "ddFinalddInicial":3016,
               "vlFatorKcdTpCalc":199,
               "vlRefvlKgAtr":0.5881,
               "cdUsuarioAltvlAtr":null132.09,
               "vlTotalpcPgVlTon":23881.3580,
               "vlAcertoAtrqtdeCana":null384280,
               "vlAcAtrRecebvlRetencao":0null,
               "ddInicialvlSubsidio":16null,
               "cdTpCalcvlBonusTon":99,0
            }
   "vlKgAtr":0.5881,
      ],
         "vlAtrdetalheHistTx":132.09,[
               "pcPgVlTon":80,{
               "qtdeCanainstancia":384280"1",
               "vlRetencaonoNf":null24,
               "vlSubsidiocdSerieNf":null"8",
               "vlBonusToncdFornec":050774,
            }
   "cdUpnivel1":" 20526",
      ],
         "dtIniPer"detalheHistTx:":[2016-04-01T00:00:00",
            {   "dtFimPer":"2016-04-30T00:00:00",
               "instanciacdTxcontr":"1",
               "noNfvlTxContrib":24310.46,
               "cdSerieNfcdGrpTxcontr":"8"1,
               "cdFornecvlBaseTx":5077423881.35,
               "cdUpnivel1fgAcertoAnual":" 20526"null,
               "dtIniPer":"2016-04-01T00:00:00""fgIndividual":null,
               "dtFimPervlSubsidio":"2016-04-30T00:00:00"0,
               "cdTxcontrfgLiminarInss":1null,
               "vlTxContribcdUsuarioAlt":310.46null,
               "cdGrpTxcontrdtHrInc":1null,
               "vlBaseTxdtHrAlt":23881.35null,
               "fgAcertoAnualcdUsuarioInc":null,
               "fgIndividualinfComplTaxa":null,{
                  "vlSubsidiocdTxcontr":01,
                  "fgLiminarInss":null,
dtValIni":"2015-10-01T00:00:00",
                  "cdUsuarioAltdeTxcontr":null"INSS",
                  "dtHrIncpcTxcontr":null1.3,
                  "dtHrAltcdIndBase":null950,
                  "cdUsuarioIncpcRedBase":null,
                  "infComplTaxafgAcertoAno":{"S",
                  "cdTxcontrcdTxErp":1null,
                  "dtValInicodigoClassificacao":"2015-10-01T00:00:00CLAS 1",
                  "deTxcontrcodigoEspecie":"INSSESPECIE 1",
                  "pcTxcontr":1.3,}
            },
         "cdIndBase":950,
   {
               "pcRedBaseinstancia":null"1",
                  "fgAcertoAnonoNf":"S"24,
                  "cdTxErpcdSerieNf":null"8",
                  "codigoClassificacaocdFornec":"CLAS 1"50774,
                  "codigoEspeciecdUpnivel1":"ESPECIE 120526",
               }"dtIniPer":"2016-04-01T00:00:00",
            },
            {"dtFimPer":"2016-04-30T00:00:00",
               "instanciacdTxcontr":"1"2,
               "noNfvlTxContrib":2447.76,
               "cdSerieNfcdGrpTxcontr":"8"1,
               "cdFornecvlBaseTx":5077423881.35,
               "cdUpnivel1fgAcertoAnual":" 20526"null,
               "dtIniPerfgIndividual":"2016-04-01T00:00:00"null,
               "dtFimPervlSubsidio":"2016-04-30T00:00:00"0,
               "cdTxcontrfgLiminarInss":2null,
               "vlTxContribcdUsuarioAlt":47.76null,
               "cdGrpTxcontrdtHrInc":1null,
               "vlBaseTxdtHrAlt":23881.35null,
               "fgAcertoAnualcdUsuarioInc":null,
               "fgIndividualinfComplTaxa":null,{
                  "vlSubsidiocdTxcontr":02,
                  "fgLiminarInssdtValIni":null"2015-10-01T00:00:00",
                  "cdUsuarioAltdeTxcontr":null"SENAR",
                  "dtHrIncpcTxcontr":null0.2,
                  "dtHrAltcdIndBase":null950,
                  "cdUsuarioIncpcRedBase":null,
                  "infComplTaxafgAcertoAno":{"S",
                  "cdTxcontrcdTxErp":2null,
                  "dtValInicodigoClassificacao":"2015-10-01T00:00:00CLAS 2",
                  "deTxcontrcodigoEspecie":"SENARESPECIE 2",
               }
   "pcTxcontr":0.2,
         }
         "cdIndBase":950],
         "deducoes":[
         "pcRedBase":null,
   {
               "fgAcertoAnoinstancia":"S1",
                  "cdTxErpfgTpProc":null"Nota Mensal",
                  "codigoClassificacaocdFornec":"CLAS 2"50774,
                  "codigoEspeciedtiniPer":"ESPECIE 2"2016-04-01T00:00:00",
               }  "dtFinPer":"2016-04-30T00:00:00",
            }
   "cdEvto":162,
      ],
         "deducoesnoCtaContb":["110",
             {  "dtEvto":"2016-04-01T00:00:00",
               "instanciavlDeducao":"1"150,
               "fgTpProccdGrpEvto":"Nota Mensal"2,
               "cdFornecfgIndividual":50774"S",
               "dtiniPer":"2016-04-01T00:00:00cdUsuarioInc":"TOTVS",
               "dtFinPerdtHrInc":"20162024-0408-30T0006T03:00:00",
               "cdEvtocdUsuarioAlt":162"XXX",
               "dtEvtodtHrAlt":"20162024-0408-01T0007T21:00:00",
               "vlDeducaofgDedAdiant":150,"N"
            }
   "cdGrpEvto":2,
          ],        
            "fgIndividual":"S",deducoesGtm":[
            {
               "cdUsuarioIncinstancia":"TOTVS1",
               "dtHrIncfgTpProc":"2024-08-06T03:00:00Nota Mensal",
               "cdUsuarioAltcdFornec":"XXX"50774,
               "dtHrAltdtiniPer":"20242016-0804-07T2101T00:00:00",
            }
   "dtFinPer":"2016-04-30T00:00:00",
      ],
         "deducoesGtmcdEvto":[
            {110,
               "instancianoCtaContb":"1110",
               "fgTpProcdtEvto":"Nota Mensal2016-11-30T00:00:00",
               "cdFornecvlDeducao":5077478349.97,
               "dtiniPercdGrpEvto":"2016-04-01T00:00:00"1,
               "dtFinPerfgIndividual":"2016-04-30T00:00:00"null,
               "cdEvtocdUsuarioInc":110null,
               "dtEvtodtHrInc":"2016-11-30T00:00:00"null,
               "vlDeducaocdUsuarioAlt":78349.97null,
               "cdGrpEvtodtHrAlt":1null,
               "fgIndividualfgDedAdiant":null,"N"
               "cdUsuarioInc":null,}
         ],
           "dtHrIncinfoUpnivel1":null,[
               "cdUsuarioAlt":null,{
               "dtHrAltcdUpnivel1":null" 20526",
            }
   "deUpnivel1":"TOTVS",
      ],
         "infoUpnivel1cdFornec":[50774,
               {"fgTpPess":"J",
               "cdUpnivel1cdIntErp":" 20526",1_1133_4"
            }
   "deUpnivel1":"TOTVS",
      ],
         "cdFornecinfoFornecs":50774,[
               "fgTpPess":"J",{
               "cdIntErpcdFornec":"1_1133_4"50774,
            }
   "deFornec":"TOTVS FAZ",
     ],
          "infoFornecsfgTpFornec":["2",
            {   "deTpFornec":"FORNECEDOR",
               "cdFornecfgTpPess":50774"F",
               "deForneccdIntErp":"TOTVS FAZ50774",
            }
    "fgTpFornec":"2",
			     ],
         "deTpFornecinfoCanaDia": "FORNECEDOR",{
                	"fgTpPessprimeiraQuinzena": "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
languagejava
titleNotas fiscais de entrada de cana - Mensal
{ 
  "fgStatusERPfgStatusIntegracao": "S",
  "instancia": 31,
  "notaFiscal": 49,
  "cdSerieNf": "8",
  "fgTipoNotaFiscal": "M",
  "noNfErp": "123" 
} 
Dica
titleBloqueio 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.