Histórico da Página
...
Disponibilizado endpoint para consulta das Notas Fiscais de Entrada de Cana.
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": 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 | ||||
|---|---|---|---|---|
| ||||
{
"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. |