Consulta dos Recibos de Pagamento de Cana por Fornecedor
Disponibilizado endpoint para consulta dos Recibos de Pagamento de Cana por Fornecedor.
Estruturas:
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| instancia | Identificador da instância | String | Valor do tipo string numérica |
| fgTpFolha | Tipo da folha | String | F - FOLHA MENSAL DE FORNECEDOR P - FOLHA MENSAL DE PARCERIA T - FOLHA MENSAL DE TERCEIROS A - FOLHA ANUAL DE FORNECEDOR B - FOLHA ANUAL DE PARCERIA G - FOLHA ANUAL DE TERCEIROS C - FOLHA FINAL DE FORNECEDOR D - FOLHA FINAL DE PARCERIA H - FOLHA FINAL DE TERCEIROS |
| tipoFolha | Descrição do tipo de folha | String | Ex.: "FOLHA ANUAL DE FORNECEDOR" |
| dataFornecimento | Data de fornecimento | DateTime | Formato ISO 8601: yyyy-MM-dd'T'HH:mm:ss |
| dataEmissao | Data de emissão | DateTime | Formato ISO 8601 |
| safra | Ano da safra | Integer | Ex.: 2016 |
| vlToneladaCana | Valor da tonelada de cana | Decimal | Ex.: 79.5347918 |
| qtCanaEntregue | Quantidade de cana entregue | Integer | Ex.: 242213106 |
| vlBrutoRecibo | Valor bruto do recibo | Decimal | |
| vlAcumTaxasContrib | Valor acumulado de taxas de contribuição | Decimal | |
| vlAcumDeducoes | Valor acumulado de deduções | Decimal | |
| vlAcumNFPromissorias | Valor acumulado de notas promissórias | Decimal | |
| vlLiquidoRecibo | Valor líquido do recibo | Decimal | |
| vlRetencao | Valor de retenção | Decimal | |
| cdTpPropriedade | Código do tipo de propriedade | Integer | |
| fgProcIndividual | Flag de processamento individual | String/Nullable | Pode ser nulo |
| pcPagamento | Percentual de pagamento | Decimal/Nullable | Pode ser nulo |
| cdUsuarioInclusao | Usuário que incluiu o registro | String | Ex.: "TOTVS" |
| dtHrInclusao | Data e hora de inclusão | DateTime | Formato ISO 8601 |
| cdUsuarioAlteracao | Usuário que alterou o registro | String/Nullable | Pode ser nulo |
| dtHtAlteracao | Data e hora da última alteração | DateTime/Nullable | Pode ser nulo |
| fgStatusIntegracao | Flag de status da integração | String | Ex.: "1" |
| fluxoCaixa | Descrição do fluxo de caixa | String | Parâmetro: Seção: RCMP_PGTCP - Entrada: CD_TP_FLXCX_REC_DS |
Seção historicoTaxas
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| dtFimPeriodo | Data final do período | DateTime | |
| safra | Ano da safra | Integer | |
| fgLiminarSuspCobrancaICMS | Flag liminar suspensão ICMS | String/Nullable | Pode ser nulo |
| vlBaseTaxa | Valor base da taxa | Decimal | |
| dtInicioPeriodo | Data inicial do período | DateTime | |
| cdTaxa | Código da taxa | Integer | |
| detalheCdTaxa | Lista de detalhes da taxa | Array | Contém informações detalhadas da taxa |
| grupoTaxaContribuicao | Grupo da taxa de contribuição | Integer | |
| fornecedor | Código do fornecedor | Integer | |
| upnivel1 | Código de hierarquia | String | |
| vlTaxaContribuicao | Valor da taxa de contribuição | Decimal | |
| vlSubsidio | Valor do subsídio | Decimal |
Seção detalheCdTaxa (dentro de historicoTaxas)
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| cdTaxaContribuicao | Código da taxa de contribuição | Integer | |
| fgAcertoAno | Flag de acerto anual | String | Ex.: "S" |
| codigoEspecie | Código da espécie | String | |
| percentualReducaoBase | Percentual de redução da base | Decimal/Nullable | Pode ser nulo |
| cdIndiceBase | Código do índice base | Integer | |
| cdTxErp | Código do ERP | Integer/Nullable | Pode ser nulo |
| dtValidadeInicial | Data inicial de validade | DateTime | |
| codigoClassificacao | Código de classificação | String | |
| deTaxaContribuicao | Descrição da taxa de contribuição | String | |
| percentualTaxaContribuicao | Percentual da taxa de contribuição | Decimal |
Seção historicoDeducoes
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| cdGrupoEvento | Código do grupo de evento | Integer | |
| dtFimPeriodo | Data final do período | DateTime | |
| cdEvento | Código do evento | Integer | |
| noCtaContb | Numero da Conta Contábil | Integer | |
| vlDeducao | Valor da dedução | Decimal | |
| dtInicioPeriodo | Data inicial do período | DateTime | |
| dtHtAlteracao | Data da última alteração | DateTime | |
| dtEvento | Data do evento | DateTime | |
| cdUsuarioInclusao | Usuário que incluiu o registro | String | |
| fgProcessaIndividual | Flag de processamento individual | String | Ex.: "S" |
| instancia | Instância do registro | String | |
| dtHrInclusao | Data e hora de inclusão | DateTime | |
| cdUsuarioAlteracao | Usuário que alterou o registro | String | |
| cdFornecedor | Código do fornecedor | Integer | |
| fgDedAdiant | Flag indicativa para dedução de Adiantamento | String | 'S' ou 'N' |
Seção infoFornecs
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| cdFornec | Código do fornecedor | Integer | |
| deFornec | Descrição do fornecedor | String | |
| fgTpFornec | Tipo de fornecedor | String | 1 - ACIONISTA 2 - FORNECEDOR 3 - EVENTUAL 4 - PROPRIO 5 - PARCEIRO |
| deTpFornec | Descrição do tipo de fornecedor | String | Ex.: "PROPRIO" |
| fgTpPess | Tipo de pessoa | String | Ex.: "J" |
| cdIntErp | Código interno no ERP | String/Integer |
Seção notasFiscais
| Atributos | Descrição | Tipo | Observação |
|---|---|---|---|
| cdSerieNf | Código da série NF | String | |
| noNf | Número da Nota Fiscal | Integer |
Método GET:
http:127.0.0.1:8080/api/query/v1/pagforReciboFor
Estrutura de dados:
Recibo de Pagamento de Cana por Fornecedor
{
"hasNext":true,
"items":[
{
"instancia":"1",
"fgTpFolha":"A",
"tipoFolha":"FOLHA ANUAL DE FORNECEDOR",
"dataFornecimento":"2016-05-01T00:00:00",
"dataEmissao":"2016-05-01T00:00:00",
"safra":2016,
"vlToneladaCana":79.5347918,
"qtCanaEntregue":242213106,
"vlBrutoRecibo":19264368.96,
"vlAcumTaxasContrib":0,
"vlAcumDeducoes":0,
"vlAcumNFPromissorias":0,
"vlLiquidoRecibo":19264368.96,
"vlRetencao":0,
"cdTpPropriedade":1,
"fgProcIndividual":null,
"pcPagamento":null,
"cdUsuarioInclusao":"TOTVS",
"dtHrInclusao":"2025-04-16T13:28:59",
"cdUsuarioAlteracao":null,
"dtHtAlteracao":null,
"fgStatusIntegracao":"1",
"fluxoCaixa":"RCMP - FLXCX - REC",
"historicoTaxas":[
{
"dtFimPeriodo":"2016-05-31T00:00:00",
"safra":2016,
"fgLiminarSuspCobrancaICMS":null,
"vlBaseTaxa":944.86,
"dtInicioPeriodo":"2016-05-01T00:00:00",
"dtHtAlteracao":null,
"cdTaxa":1,
"cdUsuarioInclusao":null,
"instancia":"1",
"dtHrInclusao":null,
"detalheCdTaxa":[
{
"cdTaxaContribuicao":1,
"fgAcertoAno":"S",
"codigoEspecie":"ESPECIE 1",
"percentualReducaoBase":null,
"cdIndiceBase":950,
"cdTxErp":null,
"dtValidadeInicial":"2015-10-01T00:00:00",
"codigoClassificacao":"CLAS 1",
"deTaxaContribuicao":"INSS",
"percentualTaxaContribuicao":1.3
}
],
"grupoTaxaContribuicao":1,
"fgAcertoAnual":null,
"fornecedor":319,
"upnivel1":" 10094",
"vlTaxaContribuicao":19.84,
"vlSubsidio":0,
"cdUsuarioAlteracao":null
},
{
"dtFimPeriodo":"2016-05-31T00:00:00",
"safra":2016,
"fgLiminarSuspCobrancaICMS":null,
"vlBaseTaxa":944.86,
"dtInicioPeriodo":"2016-05-01T00:00:00",
"dtHtAlteracao":null,
"cdTaxa":2,
"cdUsuarioInclusao":null,
"instancia":"1",
"dtHrInclusao":null,
"detalheCdTaxa":[
{
"cdTaxaContribuicao":2,
"fgAcertoAno":"S",
"codigoEspecie":"ESPECIE 2",
"percentualReducaoBase":null,
"cdIndiceBase":950,
"cdTxErp":null,
"dtValidadeInicial":"2015-10-01T00:00:00",
"codigoClassificacao":"CLAS 2",
"deTaxaContribuicao":"SENAR",
"percentualTaxaContribuicao":0.2
}
],
"grupoTaxaContribuicao":1,
"fgAcertoAnual":null,
"fornecedor":319,
"upnivel1":" 10094",
"vlTaxaContribuicao":1.87,
"vlSubsidio":0,
"cdUsuarioAlteracao":null
}
],
"historicoDeducoes":[
{
"cdGrupoEvento":2,
"dtFimPeriodo":"2016-05-31T00:00:00",
"cdEvento":162,
"noCtaContb":162,
"vlDeducao":150,
"dtInicioPeriodo":"2016-05-01T00:00:00",
"dtHtAlteracao":"2024-08-07T21:00:00",
"dtEvento":"2016-04-01T00:00:00",
"cdUsuarioInclusao":"TOTVS",
"fgProcessaIndividual":"S",
"instancia":"1",
"dtHrInclusao":"2024-08-06T03:00:00",
"cdUsuarioAlteracao":"TOTVS",
"cdFornecedor":319,
"fgDedAdiant":"S"
}
],
"infoFornecs":[
{
"cdFornec":319,
"deFornec":"FORNECEDOR TOTVS 2",
"fgTpFornec":"4",
"deTpFornec":"PROPRIO",
"fgTpPess":"J",
"cdIntErp":"319"
}
],
"notasFiscais":[
{
"cdSerieNf":"8",
"noNf":363
},
{
"cdSerieNf":"8",
"noNf":364
},
{
"cdSerieNf":"8",
"noNf":365
}
]
}
]
}
Parâmetros Obrigatórios
- instancia: Código da Instância.
Parâmetros Opcionais
- fgTpProc: Flag Controlador de Tipo de Processo.
- cdFornecedor: Código do Fornecedor.
- dataFornecimento: Data de Fornecimento (atributo AM_FORNEC).
Atualizar status de integração - Recibos de Pagamento de Cana por Fornecedor
Disponibilizado endpoint para atualizar status de integração dos registros relacionados aos Recibos de Pagamento de Cana por Fornecedor.
Método PUT:
http:127.0.0.1:8080/api/query/v1/pagforReciboFor
Body da Requisição - Recibo de Pagamento de Cana por Fornecedor
{
"fgStatusIntegracao":"1", // Campo String
"instancia": 1,
"fgTpProc": "M",
"cdFornecedor": 3404,
"dataFornecimento": "2018-01-01T00:00:00"
}
Bloqueio 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.
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.
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 Folha de Fornecedores":
- Seção: PGFOCOSA;
- Entrada: CD_CAD_STATUS_INT_FFORNEC;
Para mais detalhes sobre a funcionalidade citada acima, acesse a página Cadastro de Bloqueio de Movimentações via API.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas