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/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": false,
    "items": [
        {
            "instanciadtEmisNf": "31"2016-04-30T00:00:00",
            "notaFiscaldeMunic": 49"ALTINÓPOLIS",
            "cdSerieNfdeNatOper": "8TEST",
            "cdTpPropcdFiscOp": 21101,
            "uniProdNivel1deEnd": "50084A"SITIO:TOTVS,S/N",
            "deUniProdNivel1noCep": "SANTA BÁRBARA14350000",
            "cdForneccdUf": 21903"SP",
            "deFornecnoFone": "ALCIDES DO SACRAMENTO"null,
            "cdSafranoCgcCpf": 2016"99.999.999/0000-00",
            "amFornecfgSituacao": "2016-04-01T00:00:00"N",
            "acPesoacTxContrib": 801487358.22,
            "vlTotNfvlLiqNf": 4117323523.7513,
         "vlLiquida":null,
         "dtEmisNfcdTpCalc": "2016-04-30T00:00:00"99,
            "deMunicfgComplPreco": "MONTE CASTELO"null,
            "deNatOperfgManAuto": "COMPRAA",
            "cdFiscOpfgTipoNotaFiscal":"Mensal 1101Automático",
            "deEnddeObs": "FAZ:SANTA BÁRBARA,S/N",null,
            "noCepdeFiscOp": "17960000"null,
            "cdUfcdClasFisc": "SP"null,
            "noFonefgSubstituicao": null,
            "noCgcCpf": "07.988.733/0002-06",
   "vlCredIcms":null,
         "fgSituacaofgAcertoAnual": "N"null,
            "acTxContribfgCpr": 947null,
            "vlLiqNffgComplProduto": 40226.75null,
            "vlLiquidafgIndividual": 41173.75null,
            "cdTpCalcnoContrCana": 41729,
            "fgComplPrecocdEmpresa": null"1",
            "fgManAutoinstContr": "A1",
            "fgTipoNotaFiscal": "Mensal Automático",
  "cdMunic":5,
           "deObscdUsuarioInc": null,
            "deFiscOpdtHrInc": null,
            "cdClasFisccdUsuarioAlt": null,
            "fgSubstituicaodtHrAlt": null,
            "vlCredIcmsfluxoCaixa":"RCMP null,
- FLXCX - NF",
         "fgAcertoAnualdetalheQuinzena": null,[
            "fgCpr": null,
{
               "fgComplProdutocdUsuarioInc": null,
               "fgIndividualdtHrAlt": null,
               "noContrCanavlTonCana": 132262.1457,
               "cdEmpresadtHrInc": "31"null,
               "instContrddFinal": "31"30,
               "cdMunicvlFatorK": 24491,
               "cdUsuarioIncvlRef": null0,
               "dtHrInccdUsuarioAlt": null,
               "cdUsuarioAltvlTotal": "DCS_PEDRA"23881.35,
              "dtHrAlt": "2025-04-16T14:39:46",
vlAcertoAtr":null,
               "detalheQuinzenavlAcAtrReceb": [0,
                {"ddInicial":16,
                    "cdUsuarioInccdTpCalc": null99,
                    "dtHrAltvlKgAtr": null0.5881,
                    "vlTonCanavlAtr": 51132.371709,
                    "dtHrIncpcPgVlTon": null80,
                    "ddFinalqtdeCana": 30384280,
                    "vlFatorKvlRetencao": 1null,
               "vlSubsidio":null,
     "vlRef": 109.19,
         "vlBonusTon":0
           "cdUsuarioAlt": null, }
         ],
           "vlTotaldetalheHistTx": 41173.75,[
            {
        "vlAcertoAtr": null,
       "instancia":"1",
               "vlAcAtrRecebnoNf": 024,
                    "ddInicialcdSerieNf": 16"8",
                    "cdTpCalccdFornec": 450774,
                    "vlKgAtrcdUpnivel1":" 0.588120526",
                    "vlAtrdtIniPer": 129.24"2016-04-01T00:00:00",
                    "pcPgVlTon": 80,
   "dtFimPer":"2016-04-30T00:00:00",
                 "qtdeCanacdTxcontr": 8014871,
                    "vlRetencaovlTxContrib": null310.46,
                    "vlSubsidiocdGrpTxcontr": null1,
                    "vlBonusTonvlBaseTx": 023881.35,
                }
       "fgAcertoAnual":null,
     ],
            "detalheHistTxfgIndividual": [null,
                {
     "vlSubsidio":0,
               "instanciafgLiminarInss": "31"null,
                    "noNfcdUsuarioAlt": 49null,
                    "cdSerieNfdtHrInc": "8"null,
                    "cdFornecdtHrAlt": 21903null,
                    "cdUpnivel1cdUsuarioInc": "50084A"null,
                    "dtIniPer": "2016-04-01T00:00:00",
  "infComplTaxa":{
                  "dtFimPercdTxcontr": "2016-04-30T00:00:00"1,
                    "cdTxcontrdtValIni": 1"2015-10-01T00:00:00",
                    "vlTxContribdeTxcontr": 864.65"INSS",
                    "cdGrpTxcontrpcTxcontr": 1.3,
                    "vlBaseTxcdIndBase": 41173.75950,
                    "fgAcertoAnualpcRedBase": null,
                    "fgIndividualfgAcertoAno": null"S",
                    "vlSubsidiocdTxErp": null,
                    "fgLiminarInsscodigoClassificacao":"CLAS null1",
                    "cdUsuarioAltcodigoEspecie":"ESPECIE null,1"
               }
     "dtHrInc": null       },
            {
        "dtHrAlt": null,
       "instancia":"1",
               "cdUsuarioIncnoNf": null24,
                    "infComplTaxacdSerieNf": {
 "8",
               "cdFornec":50774,
        "cdTxcontr": 1,
         "cdUpnivel1":" 20526",
               "dtValInidtIniPer": "20152016-1004-01T00:00:00",
               "dtFimPer":"2016-04-30T00:00:00",
         "deTxcontr      "cdTxcontr": "INSS"2,
               "vlTxContrib":47.76,
               "pcTxcontrcdGrpTxcontr": 1.3,
                        "cdIndBasevlBaseTx": 95023881.35,
                        "pcRedBasefgAcertoAnual": null,
               "fgIndividual":null,
         "fgAcertoAno": "S"
     "vlSubsidio":0,
               }"fgLiminarInss":null,
                }"cdUsuarioAlt":null,
                {
     "dtHrInc":null,
               "instanciadtHrAlt": "31"null,
                    "noNfcdUsuarioInc": 49null,
                    "cdSerieNfinfComplTaxa": "8",{
                    "cdForneccdTxcontr": 219032,
                    "cdUpnivel1dtValIni": "50084A"2015-10-01T00:00:00",
                    "dtIniPerdeTxcontr": "2016-04-01T00:00:00"SENAR",
                    "dtFimPer": "2016-04-30T00:00:00" "pcTxcontr":0.2,
                    "cdTxcontrcdIndBase": 2950,
                    "vlTxContribpcRedBase": 82.35null,
                    "cdGrpTxcontrfgAcertoAno": 1"S",
                    "vlBaseTxcdTxErp": 41173.75null,
                    "fgAcertoAnualcodigoClassificacao":"CLAS null2",
                    "fgIndividualcodigoEspecie":"ESPECIE null,2"
               }
     "vlSubsidio": null,
       }
         ],
         "fgLiminarInssdeducoes":[
 null,
           {
         "cdUsuarioAlt": null,
     "instancia":"1",
               "dtHrIncfgTpProc":"Nota nullMensal",
                    "dtHrAltcdFornec": null50774,
                    "cdUsuarioInc": null,
   "dtiniPer":"2016-04-01T00:00:00",
                 "dtFinPer"infComplTaxa": {:"2016-04-30T00:00:00",
                        "cdTxcontr"cdEvto": 2162,
                        "dtValIni"noCtaContb": "2015-10-01T00:00:00"110",
                        "deTxcontrdtEvto": "SENAR"2016-04-01T00:00:00",
               "vlDeducao":150,
               "pcTxcontrcdGrpEvto": 0.2,
                        "cdIndBase": 950"fgIndividual":"S",
                        "pcRedBase": null,
        "cdUsuarioInc":"TOTVS",
                "fgAcertoAnodtHrInc": "S"
   "2024-08-06T03:00:00",
               "cdUsuarioAlt":"XXX",
  }
             "dtHrAlt":"2024-08-07T21:00:00",
   }
            ],"fgDedAdiant":"N"
            "deducoes": [}
         ],           {
           "deducoesGtm":[
          "instancia": "31",
     {
               "fgTpProcinstancia": "Nota Mensal1",
                    "cdFornecfgTpProc":"Nota 21903Mensal",
                    "dtiniPercdFornec": "2016-04-01T00:00:00"50774,
                    "dtFinPerdtiniPer": "2016-04-30T00:00:00",
                    "cdEvto": 162,
    01T00:00:00",
                "dtEvtodtFinPer": "2016-04-01T0030T00:00:00",
               "cdEvto":110,
     "vlDeducao": 150,
         "noCtaContb":"110",
               "cdGrpEvtodtEvto": 2,
     "2016-11-30T00:00:00",
               "fgIndividualvlDeducao": "S"78349.97,
                    "cdUsuarioInccdGrpEvto": "TOTVS"1,
                    "dtHrIncfgIndividual": "2024-08-06T03:00:00"null,
                    "cdUsuarioAltcdUsuarioInc": "DCS_PEDRA"null,
                    "dtHrAltdtHrInc": "2024-08-07T21:00:00"null,
                }
         "cdUsuarioAlt":null,
   ],
            "deducoesGtmdtHrAlt": []null,
               "dados FornecedorfgDedAdiant": ["N"
                {}
         ],
          "infoUpnivel1":[
      "cdFornec": 21903,
     {
               "desccdUpnivel1": "ALCIDES DO SACRAMENTO20526",
                    "fgTpFornecsdeUpnivel1": "2TOTVS",
                    "cdTranscdFornec": null50774,
                    "fgAtivofgTpPess": "SJ",
                    "dtInclusaocdIntErp": "2016-02-04T17:42:44","1_1133_4"
            }
        "usrInclusao": "ERP" ],
                }"infoFornecs":[
            ],{
            "unidade de Produção Nível 1"cdFornec": [50774,
                {
    "deFornec":"TOTVS FAZ",
                "uniProdNivel1fgTpFornec": "50084A2",
                    "cdFornecdeTpFornec": 21903"FORNECEDOR",
                    "descUniProdNivel1fgTpPess": "SANTA BÁRBARAF",
                    "tpPessoacdIntErp": "J50774",
            }
        "dtInclusao": null],
         "infoCanaDia": {
          	"usrInclusaoprimeiraQuinzena": null"",
            "segundaQuinzena": "29 = 4000; }
30 = 380280"
          ]},
		 "noNfReferencia": "5852, 8569, 4758"  
    }
    ]
}


Parâmetros Obrigatórios

  • fgTpNotafgTipoNotaFiscal: Flag Controlador de Tipo de Nota.
  • instancia: Código da Instância.
  • dataInicio: Data de Fornecimento (atributo AM_FORNEC).
  • dataFim: Data de Fornecimento (atributo AM_FORNEC).

...

  • cdSerieNf: Codigo da Serie da N.F.
  • cdFornecedor: Código do Fornecedor.
  • notaFiscal: Numero da N.notaFiscal: Numero da N.FF.
  • 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.