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/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": 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 | ||||
|---|---|---|---|---|
| ||||
{
"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. |