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":true,
"hasNext": false "items":[
{
"instancia":"1",
"notaFiscal":24,
"itemscdSerieNf":"8",
[
{
"cdTpProp":7,
"instanciacdSafra": "31"2016,
"notaFiscalamFornec": 49"2016-04-01T00:00:00",
"cdSerieNfacPeso": "8"384280,
"cdTpPropvlTotNf": 223881.35,
"uniProdNivel1dtEmisNf": "50084A"2016-04-30T00:00:00",
"deUniProdNivel1deMunic": "SANTA BÁRBARAALTINÓPOLIS",
"cdFornecdeNatOper": 21903"TEST",
"deForneccdFiscOp": "ALCIDES DO SACRAMENTO"1101,
"cdSafra": 2016"deEnd":"SITIO:TOTVS,S/N",
"amFornecnoCep": "2016-04-01T00:00:00"14350000",
"acPesocdUf": 801487"SP",
"vlTotNfnoFone": 41173.75null,
"dtEmisNfnoCgcCpf": "2016-04-30T00:00:"99.999.999/0000-00",
"deMunicfgSituacao": "MONTE CASTELON",
"deNatOperacTxContrib": "COMPRA"358.22,
"cdFiscOpvlLiqNf": 110123523.13,
"vlLiquida":null,
"deEnd": "FAZ:SANTA BÁRBARA,S/N",
"cdTpCalc":99,
"noCepfgComplPreco": "17960000"null,
"cdUffgManAuto": "SPA",
"noFonefgTipoNotaFiscal":"Mensal nullAutomático",
"noCgcCpfdeObs": "07.988.733/0002-06"null,
"fgSituacaodeFiscOp": "N"null,
"acTxContribcdClasFisc": 947null,
"vlLiqNffgSubstituicao": 40226.75null,
"vlLiquidavlCredIcms": 41173.75null,
"cdTpCalcfgAcertoAnual": 4null,
"fgComplPrecofgCpr": null,
"fgManAutofgComplProduto": "A"null,
"fgTipoNotaFiscalfgIndividual": "Mensal Automático"null,
"deObsnoContrCana": null1729,
"deFiscOpcdEmpresa": null"1",
"cdClasFisc": null"instContr":"1",
"fgSubstituicaocdMunic": null5,
"vlCredIcmscdUsuarioInc": null,
"fgAcertoAnualdtHrInc": null,
"fgCprcdUsuarioAlt": null,
"fgComplProdutodtHrAlt": null,
"fgIndividualfluxoCaixa":"RCMP null,
- FLXCX - NF",
"noContrCanadetalheQuinzena":[
1322,
{
"cdEmpresa": "31",
"instContr": "31cdUsuarioInc":null,
"cdMunicdtHrAlt": 2449null,
"cdUsuarioIncvlTonCana": null62.1457,
"dtHrInc": null,
"cdUsuarioAltddFinal": "DCS_PEDRA"30,
"dtHrAltvlFatorK": "2025-04-16T14:39:46"1,
"detalheQuinzenavlRef": [0,
{
"cdUsuarioAlt":null,
"cdUsuarioIncvlTotal": null23881.35,
"dtHrAltvlAcertoAtr": null,
"vlTonCanavlAcAtrReceb": 51.37170,
"dtHrIncddInicial": null16,
"ddFinalcdTpCalc": 3099,
"vlFatorKvlKgAtr": 10.5881,
"vlRefvlAtr": 109132.19,
09,
"cdUsuarioAltpcPgVlTon": null80,
"vlTotalqtdeCana": 41173.75384280,
"vlAcertoAtrvlRetencao": null,
"vlAcAtrRecebvlSubsidio": 0null,
"ddInicialvlBonusTon": 16,0
}
"cdTpCalc": 4],
"vlKgAtrdetalheHistTx":[
0.5881,
{
"vlAtr": 129.24,
"instancia":"1",
"pcPgVlTonnoNf": 8024,
"qtdeCanacdSerieNf": 801487"8",
"vlRetencaocdFornec": null50774,
"vlSubsidiocdUpnivel1":" null20526",
"vlBonusTondtIniPer": 0"2016-04-01T00:00:00",
}"dtFimPer":"2016-04-30T00:00:00",
],
"detalheHistTx"cdTxcontr": [1,
{"vlTxContrib":310.46,
"instanciacdGrpTxcontr": "31"1,
"noNfvlBaseTx": 49,
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",
"cdTxcontrcodigoEspecie":"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,
"fgAcertoAnual":null,
"noNf": 49,
"fgIndividual":null,
"cdSerieNfvlSubsidio": "8"0,
"cdFornecfgLiminarInss": 21903null,
"cdUpnivel1cdUsuarioAlt": "50084A"null,
"dtIniPerdtHrInc": "2016-04-01T00:00:00"null,
"dtHrAlt":null,
"dtFimPer": "2016-04-30T00:00:00",
"cdUsuarioInc":null,
"cdTxcontrinfComplTaxa": 2,{
"vlTxContribcdTxcontr": 82.352,
"cdGrpTxcontrdtValIni": 1"2015-10-01T00:00:00",
"vlBaseTxdeTxcontr": 41173.75"SENAR",
"fgAcertoAnualpcTxcontr": null0.2,
"fgIndividualcdIndBase": null950,
"vlSubsidiopcRedBase": null,
"fgLiminarInssfgAcertoAno": null"S",
"cdUsuarioAltcdTxErp": null,
"dtHrInccodigoClassificacao":"CLAS null2",
"dtHrAltcodigoEspecie":"ESPECIE null,2"
}
"cdUsuarioInc": null,
}
],
"infComplTaxadeducoes":[
{
{
"cdTxcontrinstancia": 2"1",
"dtValInifgTpProc": "2015-10-01T00:00:00"Nota Mensal",
"cdFornec":50774,
"deTxcontrdtiniPer": "SENAR"2016-04-01T00:00:00",
"pcTxcontr": 0.2,
"dtFinPer":"2016-04-30T00:00:00",
"cdIndBasecdEvto": 950162,
"noCtaContb":"110",
"pcRedBase": nulldtEvto":"2016-04-01T00:00:00",
"vlDeducao":150,
"fgAcertoAnocdGrpEvto": "S"
2,
"fgIndividual":"S",
}
"cdUsuarioInc":"TOTVS",
}
"dtHrInc":"2024-08-06T03:00:00",
],
"deducoescdUsuarioAlt": ["XXX",
{
"dtHrAlt":"2024-08-07T21:00:00",
"instanciafgDedAdiant": "31N",
}
"fgTpProc": "Nota Mensal",
],
"deducoesGtm":[
"cdFornec": 21903,
{
"dtiniPerinstancia": "2016-04-01T00:00:00"1",
"dtFinPerfgTpProc":"Nota "2016-04-30T00:00:00",
Mensal",
"cdEvtocdFornec": 16250774,
"dtEvtodtiniPer": "2016-04-01T00:00:00",
"dtFinPer"vlDeducao:": 1502016-04-30T00:00:00",
"cdGrpEvtocdEvto": 2110,
"fgIndividualnoCtaContb": "S110",
"cdUsuarioIncdtEvto": "TOTVS"2016-11-30T00:00:00",
"dtHrIncvlDeducao": "2024-08-06T03:00:00",
78349.97,
"cdUsuarioAltcdGrpEvto": "DCS_PEDRA"1,
"dtHrAltfgIndividual": "2024-08-07T21:00:00"null,
}
"cdUsuarioInc":null,
]"dtHrInc":null,
"deducoesGtmcdUsuarioAlt": []null,
"dados FornecedordtHrAlt": [
null,
"fgDedAdiant":"N"
{
}
],
"cdFornecinfoUpnivel1": 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
- 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
- fgTpNota: Flag Controlador de Tipo de Nota.
- 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. |