Histórico da Página
...
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:
| 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
Estrutura de dados:
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"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 | ||||
| ||||
{ "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 | ||||
|---|---|---|---|---|
| ||||
{
"fgStatusERPfgStatusIntegracao": "S",
"instancia": 31,
"notaFiscal": 49,
"cdSerieNf": "8",
"fgTipoNotaFiscal": "M",
"noNfErp": "123"
} |
| Dica | ||
|---|---|---|
| ||
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, 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":
Para mais detalhes sobre a funcionalidade citada acima, acesse a página Cadastro de Bloqueio de Movimentações via API. |