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.


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": falsetrue,
    "items": [[
      {
        { "instancia":"1",
         "notaFiscal":24,
         "instanciacdSerieNf": "318",
         "cdTpProp":7,
         "notaFiscalcdSafra": 492016,
            "cdSerieNfamFornec": "8"2016-04-01T00:00:00",
            "cdTpPropacPeso": 2384280,
            "uniProdNivel1vlTotNf": "50084A"23881.35,
            "deUniProdNivel1dtEmisNf": "SANTA BÁRBARA"2016-04-30T00:00:00",
            "cdFornecdeMunic": 21903"ALTINÓPOLIS",
            "deFornecdeNatOper": "ALCIDES DO SACRAMENTOTEST",
            "cdSafracdFiscOp": 20161101,
            "amFornecdeEnd": "2016-04-01T00:00:00SITIO:TOTVS,S/N",
            "acPesonoCep": 801487,
            "vlTotNf": 41173.75"14350000",
            "dtEmisNfcdUf": "2016-04-30T00:00:00"SP",
            "deMunicnoFone": "MONTE CASTELO"null,
            "deNatOpernoCgcCpf": "COMPRA"99.999.999/0000-00",
            "cdFiscOpfgSituacao": 1101"N",
            "deEndacTxContrib": "FAZ:SANTA BÁRBARA,S/N",
   358.22,
         "noCepvlLiqNf": "17960000"23523.13,
            "cdUfvlLiquida": "SP"null,
            "noFonecdTpCalc": null99,
            "noCgcCpffgComplPreco": "07.988.733/0002-06"null,
            "fgSituacaofgManAuto": "NA",
            "acTxContribfgTipoNotaFiscal":"Mensal 947Automático",
            "vlLiqNfdeObs": 40226.75null,
            "vlLiquidadeFiscOp": 41173.75null,
            "cdTpCalccdClasFisc": 4null,
            "fgComplPrecofgSubstituicao": null,
            "fgManAutovlCredIcms": "A"null,
            "fgTipoNotaFiscalfgAcertoAnual": "Mensal Automático"null,
            "deObsfgCpr": null,
            "deFiscOpfgComplProduto": null,
            "cdClasFiscfgIndividual": null,
            "fgSubstituicaonoContrCana": null1729,
            "vlCredIcms": null,
  "cdEmpresa":"1",
          "fgAcertoAnualinstContr": null"1",
            "fgCprcdMunic": null5,
            "fgComplProdutocdUsuarioInc": null,
            "fgIndividualdtHrInc": null,
            "noContrCanacdUsuarioAlt": 1322null,
            "cdEmpresadtHrAlt": "31"null,
         "fluxoCaixa":"RCMP - FLXCX "instContr":- NF"31",
            "cdMunicdetalheQuinzena": 2449,[
            "cdUsuarioInc": null,
{
               "dtHrInccdUsuarioInc": null,
               "cdUsuarioAltdtHrAlt": "DCS_PEDRA"null,
               "dtHrAltvlTonCana": "2025-04-16T14:39:46"62.1457,
               "detalheQuinzenadtHrInc": [null,
                {
 "ddFinal":30,
                   "cdUsuarioIncvlFatorK": null1,
                    "dtHrAltvlRef": null0,
                    "vlTonCanacdUsuarioAlt": 51.3717null,
                    "dtHrIncvlTotal": null23881.35,
                    "ddFinalvlAcertoAtr": 30null,
                    "vlFatorKvlAcAtrReceb": 10,
                    "vlRefddInicial": 109.1916,
                    "cdUsuarioAltcdTpCalc": null,
   99,
                 "vlTotalvlKgAtr": 411730.755881,
                    "vlAcertoAtrvlAtr": null132.09,
                    "vlAcAtrRecebpcPgVlTon": 080,
                    "ddInicialqtdeCana": 16384280,
                    "cdTpCalcvlRetencao": 4null,
                    "vlKgAtrvlSubsidio": 0.5881null,
               "vlBonusTon":0
     "vlAtr": 129.24,
         }
         ],
         "pcPgVlTondetalheHistTx": 80,[
            {
        "qtdeCana": 801487,
      "instancia":"1",
               "vlRetencaonoNf": null24,
                    "vlSubsidiocdSerieNf": null"8",
                    "vlBonusToncdFornec":50774,
 0
              "cdUpnivel1":" 20526",
   }
            ]"dtIniPer":"2016-04-01T00:00:00",
            "detalheHistTx": [   "dtFimPer":"2016-04-30T00:00:00",
                {"cdTxcontr":1,
                    "instanciavlTxContrib": "31"310.46,
               "cdGrpTxcontr":1,
       "noNf": 49,
        "vlBaseTx":23881.35,
               "cdSerieNffgAcertoAnual": "8"null,
                    "cdFornecfgIndividual": 21903null,
                    "cdUpnivel1vlSubsidio": "50084A"0,
                    "dtIniPerfgLiminarInss": "2016-04-01T00:00:00"null,
                    "dtFimPercdUsuarioAlt": "2016-04-30T00:00:00"null,
                    "cdTxcontrdtHrInc": 1null,
                    "vlTxContribdtHrAlt": 864.65null,
                    "cdGrpTxcontrcdUsuarioInc": 1null,
                    "vlBaseTxinfComplTaxa": 41173.75,{
                    "fgAcertoAnualcdTxcontr": null1,
                    "dtValIni"fgIndividual:": null2015-10-01T00:00:00",
                    "vlSubsidiodeTxcontr": null"INSS",
                    "fgLiminarInsspcTxcontr": null1.3,
                    "cdUsuarioAltcdIndBase": null950,
                    "dtHrIncpcRedBase": null,
                    "dtHrAltfgAcertoAno": null"S",
                    "cdUsuarioInccdTxErp": null,
                    "infComplTaxacodigoClassificacao":"CLAS {1",
                        "cdTxcontr"codigoEspecie":"ESPECIE 1,"
               }
           "dtValIni": "2015-10-01T00:00:00",
 },
            {
               "deTxcontrinstancia": "INSS1",
               "noNf":24,
         "pcTxcontr": 1.3,
      "cdSerieNf":"8",
                  "cdIndBasecdFornec": 95050774,
               "cdUpnivel1":" 20526",
        "pcRedBase": null,
         "dtIniPer":"2016-04-01T00:00:00",
               "fgAcertoAnodtFimPer": "S""2016-04-30T00:00:00",
                    }"cdTxcontr":2,
                }"vlTxContrib":47.76,
                {"cdGrpTxcontr":1,
                    "instanciavlBaseTx": "31"23881.35,
                    "noNffgAcertoAnual": 49,
   null,
                 "cdSerieNffgIndividual": "8"null,
                    "cdFornecvlSubsidio": 219030,
                    "cdUpnivel1fgLiminarInss": "50084A"null,
                    "dtIniPercdUsuarioAlt": "2016-04-01T00:00:00"null,
                    "dtFimPerdtHrInc": "2016-04-30T00:00:00",
   null,
                 "cdTxcontrdtHrAlt": 2null,
                    "vlTxContribcdUsuarioInc": 82.35null,
                    "cdGrpTxcontrinfComplTaxa": 1,{
                    "vlBaseTxcdTxcontr": 41173.752,
                    "fgAcertoAnualdtValIni": null"2015-10-01T00:00:00",
                    "fgIndividualdeTxcontr": null"SENAR",
                    "vlSubsidiopcTxcontr": null0.2,
                    "fgLiminarInsscdIndBase": null950,
                    "cdUsuarioAltpcRedBase": null,
                    "dtHrIncfgAcertoAno": null"S",
                    "dtHrAltcdTxErp": null,
                    "cdUsuarioInccodigoClassificacao":"CLAS null2",
                    "infComplTaxacodigoEspecie":"ESPECIE {2"
               }
         "cdTxcontr": 2,
  }
            ],
          "dtValInideducoes": "2015-10-01T00:00:00",
[
            {
               "deTxcontrinstancia": "SENAR1",
               "fgTpProc":"Nota Mensal",
         "pcTxcontr      "cdFornec": 0.250774,
               "dtiniPer":"2016-04-01T00:00:00",
         "cdIndBase": 950,
      "dtFinPer":"2016-04-30T00:00:00",
               "cdEvto":162,
               "pcRedBasenoCtaContb": null"110",
               "dtEvto":"2016-04-01T00:00:00",
         "fgAcertoAno      "vlDeducao": "S"
150,
               "cdGrpEvto":2,
        }
       "fgIndividual":"S",
         }
         "cdUsuarioInc":"TOTVS",
   ],
            "dtHrInc"deducoes:": [2024-08-06T03:00:00",
                {"cdUsuarioAlt":"XXX",
                    "instanciadtHrAlt": "31"2024-08-07T21:00:00",
                    "fgTpProcfgDedAdiant": "Nota MensalN",
            }
        "cdFornec": 21903],
        
           "deducoesGtm":[
      "dtiniPer": "2016-04-01T00:00:00",
     {
               "dtFinPerinstancia": "2016-04-30T00:00:00"1",
                    "cdEvtofgTpProc":"Nota 162Mensal",
                    "dtEvtocdFornec": "2016-04-01T00:00:00"50774,
                    "dtiniPer"vlDeducao": 150:"2016-04-01T00:00:00",
                    "cdGrpEvto": 2,
  "dtFinPer":"2016-04-30T00:00:00",
                  "fgIndividualcdEvto": "S"110,
                    "cdUsuarioIncnoCtaContb": "TOTVS110",
                    "dtHrIncdtEvto": "20242016-0811-06T0330T00:00:00",
                    "cdUsuarioAltvlDeducao": "DCS_PEDRA"78349.97,
                    "dtHrAltcdGrpEvto": "2024-08-07T21:00:00"1,
                }
"fgIndividual":null,
               ]"cdUsuarioInc":null,
               "deducoesGtmdtHrInc": []null,
               "dados FornecedorcdUsuarioAlt": [null,
                {"dtHrAlt":null,
               "fgDedAdiant":"N"
     "cdFornec": 21903,
      }
         ],
          "descinfoUpnivel1": "ALCIDES DO SACRAMENTO",
[
            {
               "fgTpFornecscdUpnivel1":" 20526"2",
                    "cdTransdeUpnivel1": null"TOTVS",
                    "fgAtivocdFornec": "S"50774,
                    "dtInclusaofgTpPess": "2016-02-04T17:42:44"J",
               "cdIntErp":"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

  • fgTipoNotaFiscal: 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).


Parâmetros Opcionais

  • 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.