Histórico da Página

Contexto

A API de Recibo

...

de Pagamento de Cana por Fazenda

...

tem como objetivo disponibilizar a consulta das informações consolidadas de pagamento de cana, organizadas por fazenda e período de referência.
Por meio dessa API, é possível acessar dados como valores pagos, descontos, deduções e totais processados, assegurando transparência e rastreabilidade nas operações de pagamento.

Integrada ao TOTVS Agro API-Hub, a API garante padronização, segurança e atualização em tempo real, facilitando a integração com sistemas parceiros e o acompanhamento detalhado das movimentações por fazenda.

Estruturas

Disponibilizado endpoint para consulta dos Recibos de Pagamento de Cana por Fazenda.

Estrutura:

Atributos	Descrição

Tamanho

	Tipo	Observação
instancia	Identificador da instância

-

	String
fgTpFolha	Tipo da folha

1StringValores possíveis: "A", "M", etc.

	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

50

	String	Ex: "FOLHA ANUAL DE FORNECEDOR"
dataFornecimento	Data de fornecimento

19

	DateTime	Formato ISO "YYYY-MM-DDTHH:MM:SS"
dataEmissao	Data de emissão

19

	DateTime	Formato ISO
safra	Ano da safra

4

	Integer	Ex: 2018
vlToneladaCana	Valor por tonelada de cana

15

Decimal	Ex: 78.2908998
qtCanaEntregue	Quantidade de cana entregue

15

Integer	Ex: 16532711
vlBrutoRecibo	Valor bruto do recibo

15

Decimal
vlAcumTaxasContrib	Valor acumulado de taxas de contribuição

15

	Decimal	Pode ser zero
vlAcumDeducoes	Valor acumulado de deduções

15

Decimal	Pode ser zero
vlAcumNFPromissorias	Valor acumulado de NFs promissórias

15

	Decimal	Pode ser zero
vlLiquidoRecibo	Valor líquido do recibo

15

	Decimal
cdTpPropriedade	Código do tipo de propriedade

2

	Integer
fgProcIndividual	Flag de processamento individual

1

	String	Pode ser null
instanciaCompraDeCana	Instância de compra de cana

-

String
cdEmpresaCompraDeCana	Código da empresa de compra de cana

-

String
noContratoCana	Número do contrato de cana

10

	Integer
pcPagamento	Percentual de pagamento

-

Decimal	Pode ser null
fgTipoSuspensaoPagamento	Flag tipo de suspensão

-

	String	Pode ser null
cdUsuarioInclusao	Usuário de inclusão

50

	String	Ex: "TOTVS"
dtHrInclusao	Data/hora inclusão

19

	DateTime	Formato ISO
cdUsuarioAlteracao	Usuário de alteração

50

	String	Pode ser null
dtHtAlteracao	Data/hora alteração

19

DateTime	Pode ser null
fgStatusIntegracao	Status de integração

-

String	Pode ser null
fluxoCaixa	Fluxo de caixa associado

50

String

Parâmetro:

Ex

Seção:

"

RCMP_PGTCP -

FLXCX - REC"

Entrada: CD_TP_FLXCX_REC_DS

Seção historicoTaxas

Atributos	Descrição

Tamanho

Tipo	Observação
dtFimPeriodo	Fim do período da taxa

19

	DateTime
safra	Ano da safra

4

	Integer
fgLiminarSuspCobrancaICMS	Suspensão ICMS

-

	String	Pode ser null
vlBaseTaxa	Base de cálculo da taxa

15

	Decimal
dtInicioPeriodo	Início do período

19

DateTime
cdTaxa	Código da taxa

-

Integer
detalheCdTaxa	Detalhe da contribuição

-

	Array/Object	Contém `cdTaxaContribuicao`, `fgAcertoAno`, etc.
grupoTaxaContribuicao	Grupo da taxa de contribuição

-

Integer
fornecedor	Código do fornecedor

-

	Integer
upnivel1	Código do upnivel1

10

	String
vlTaxaContribuicao	Valor da taxa de contribuição

15

	Decimal
vlSubsidio	Valor do subsídio

15

	Decimal	Pode ser zero
cdUsuarioAlteracao	Usuário de alteração

50

String

Pode ser null

Seção detalheCdTaxa (dentro de historicoTaxas)

Atributos	Descrição

Tamanho

Tipo	Observação
cdTaxaContribuicao	Código da taxa de contribuição

-

Integer
fgAcertoAno	Flag acerto anual

1

	String	"S" ou "N"
codigoEspecie	Código da espécie

20

String	Ex: "ESPECIE 1"
percentualReducaoBase	Percentual redução base

-

	Decimal	Pode ser null
cdIndiceBase	Código do índice base

-

	Integer
dtValidadeInicial	Data de validade inicial

19

	DateTime	Formato ISO
codigoClassificacao	Código de classificação

20

	String	Ex: "CLAS 1"
deTaxaContribuicao	Descrição da taxa

50

String	Ex: "INSS"
percentualTaxaContribuicao	Percentual da taxa

5

Decimal

Ex: 1.3

Seção historicoDeducoesGtm

Atributos	Descrição

Tamanho

	Tipo	Observação
cdGrupoEvento	Código do grupo do evento

-

Integer
dtFimPeriodo	Fim do período

19

	DateTime
cdEvento	Código do evento

-

	Integer
noCtaContb	Numero da Conta Contábil	Integer
fgTpFolha	Tipo de folha

1

String	Ex: "A"
vlDeducao	Valor da dedução

15

	Decimal
dtInicioPeriodo	Início do período

19

DateTime
dtEvento	Data do evento

19

	DateTime
cdUsuarioInclusao	Usuário de inclusão

50

	String
cdUpnivel1	Código do upnivel1

10

	String
cdFornecedor	Código do fornecedor

-

	Integer
fgDedAdiant	Flag indicativa para dedução de Adiantamento	String	Ex: "S" ou "N"

Integer

Seção infoUpnivel1

Atributos	Descrição

Tamanho

Tipo	Observação
cdUpnivel1	Código upnivel1

10

	String
deUpnivel1	Descrição upnivel1

50

String
cdFornec	Código do fornecedor

-

	Integer
fgTpPess	Tipo de pessoa

1

	String	"J" ou "F"
cdIntErp	Código ERP

20

String

Seção infoFornecs

Atributos	Descrição

Tamanho

	Tipo	Observação
cdFornec	Código do fornecedor

-

Integer
deFornec	Descrição do fornecedor

50

String
fgTpFornec	Tipo de fornecedor	String	1

StringEx: "4"

- ACIONISTA

2 - FORNECEDOR

3 - EVENTUAL

4 - PROPRIO

5 - PARCEIRO

deTpFornec

Descrição tipo fornecedor

20

	String	Ex: "PROPRIO"
fgTpPess	Tipo de pessoa

1

	String	"J" ou "F"
cdIntErp	Código ERP

20

String

Seção notasFiscais

Atributos	Descrição	Tipo
cdSerieNf	Código da série NF	String
noNf	Número da Nota Fiscal	Integer
cdEspecie	Tipo de Espécie	String

Método GET:

http:127.0.0.1:8080/api/query/v1/pagforReciboGtm

Estrutura de dados:

Bloco de código

language	java
title	Recibo de Pagamento de Cana por Fazenda

{
   "hasNext":true,
   "items":[
      {
         "instancia":"1",
         "fgTpFolha":"A",
         "tipoFolha":"FOLHA ANUAL DE FORNECEDOR",
         "dataFornecimento":"2018-08-01T00:00:00",
         "dataEmissao":"2018-08-10T00:00:00",
         "safra":2018,
         "vlToneladaCana":78.2908998,
         "qtCanaEntregue":16532711,
         "vlBrutoRecibo":1294360.82,
         "vlAcumTaxasContrib":0,
         "vlAcumDeducoes":0,
         "vlAcumNFPromissorias":0,
         "vlLiquidoRecibo":1294360.82,
         "cdTpPropriedade":2,
         "fgProcIndividual":null,
         "instanciaCompraDeCana":"1",
         "cdEmpresaCompraDeCana":"1",
         "noContratoCana":2861,
         "pcPagamento":null,
         "fgTipoSuspensaoPagamento":null,
         "cdUsuarioInclusao":"TOTVS",
         "dtHrInclusao":"2025-09-24T12:55:50",
         "cdUsuarioAlteracao":null,
         "dtHtAlteracao":null,
         "fgStatusIntegracao":null,
         "fluxoCaixa":"RCMP - FLXCX - REC",
         "historicoTaxas":[
            {
               "dtFimPeriodo":"2018-08-31T00:00:00",
               "safra":2016,
               "fgLiminarSuspCobrancaICMS":null,
               "vlBaseTaxa":944.86,
               "dtInicioPeriodo":"2018-08-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":"2018-08-31T00:00:00",
               "safra":2016,
               "fgLiminarSuspCobrancaICMS":null,
               "vlBaseTaxa":944.86,
               "dtInicioPeriodo":"2018-08-01T00:00:00":00:00",
               "dtHtAlteracao":null,
               "cdTaxa":2,
               "cdUsuarioInclusao":null,
               "dtHtAlteracaoinstancia":null"1",
               "cdTaxadtHrInclusao":2null,
               "cdUsuarioInclusaodetalheCdTaxa":null,[
               "instancia":"1",
   {
                     "dtHrInclusaocdTaxaContribuicao":null2,
                     "detalheCdTaxafgAcertoAno":[
"S",
                    {    "codigoEspecie":"ESPECIE 2",
                     "cdTaxaContribuicaopercentualReducaoBase":2null,
                     "fgAcertoAnocdIndiceBase":"S"950,
                     "codigoEspeciecdTxErp":"ESPECIE 2"null,
                     "percentualReducaoBase":nulldtValidadeInicial":"2015-10-01T00:00:00",
                     "cdIndiceBasecodigoClassificacao":950"CLAS 2",
                     "cdTxErpdeTaxaContribuicao":null"SENAR",
                     "dtValidadeInicialpercentualTaxaContribuicao":"2015-10-01T00:00:00",0.2
                  }
   "codigoClassificacao":"CLAS 2",
            ],
               "deTaxaContribuicaogrupoTaxaContribuicao":"SENAR"1,
               "fgAcertoAnual":null,
               "percentualTaxaContribuicaofornecedor":0.2319,
                  }"upnivel1":" 10094",
               ]"vlTaxaContribuicao":1.87,
               "grupoTaxaContribuicaovlSubsidio":10,
               "fgAcertoAnualcdUsuarioAlteracao":null,
            }
   "fornecedor":319,
      ],
         "upnivel1historicoDeducoesGtm":" 10094",[
               "vlTaxaContribuicao":1.87,{
               "vlSubsidiocdGrupoEvento":01,
               "dtFimPeriodo"cdUsuarioAlteracao:":null2018-08-31T00:00:00",
            }   "cdEvento":101,
         ],
         "historicoDeducoesGtmnoCtaContb":[
"110",
               {"fgTpFolha":"A",
               "cdGrupoEventovlDeducao":1132,
               "dtFimPeriododtInicioPeriodo":"2018-08-31T0001T00:00:00",
               "dtHtAlteracao":null,
                "cdEvento":101"dtEvento":"2016-05-29T00:00:00",
               "fgTpFolhacdUsuarioInclusao":"ATOTVS",
               "vlDeducaofgProcessaIndividual":132null,
               "dtInicioPeriodoinstancia":"2018-08-01T00:00:001",
               "dtHrInclusao"dtHtAlteracao:":null2025-08-05T14:34:34",
               "dtEventocdUpnivel1":"2016-05-29T00:00:00 10094",
               "cdUsuarioInclusaocdUsuarioAlteracao":"TOTVS"null,
               "fgProcessaIndividualcdFornecedor":null319,
               "instanciafgDedAdiant":"1N",
            }
   "dtHrInclusao":"2025-08-05T14:34:34",
      ],
         "cdUpnivel1infoUpnivel1":" 10094",[
               "cdUsuarioAlteracao":null,{
               "cdFornecedorcdUpnivel1":319" 10094",
            }
   "deUpnivel1":"FAZENDA TOTVS  10094",
     ],
          "infoUpnivel1cdFornec":[319,
             {  "fgTpPess":"J",
               "cdUpnivel1cdIntErp":" 10094",
1_600_94"
            }
      "deUpnivel1":"FAZENDA TOTVS  10094"],
         "infoFornecs":[
            "cdFornec":319,{
               "fgTpPess":"J"cdFornec":319,
               "cdIntErpdeFornec":"1_600_94"FORNECEDOR TOTVS 2",
            }
   "fgTpFornec":"4",
      ],
         "infoFornecsdeTpFornec":["PROPRIO",
            {   "fgTpPess":"J",
               "cdForneccdIntErp":"319,"
            }
   "deFornec":"FORNECEDOR TOTVS 2",
      ],
         "fgTpFornecnotasFiscais":"4",[
               "deTpFornec":"PROPRIO",{
               "fgTpPesscdSerieNf":"JUN",
               "cdIntErpnoNf":"319"50001
            }
        "cdEspecie": null
          ]
      }
   ]
}

Parâmetros Obrigatórios

...

fgTpProc: Flag Controlador de Tipo de Processo.
cdFornecedor: Código do Fornecedor.
cdUpnivel1: Código do Upnivel1 (Fazenda, por exemplo).
fgStatusIntegracao; Status da Integração ( ex: S;N;P ou nulo)

Atualizar status de integração - Recibos de Pagamento de Cana por Fazenda

...

Método PUT:

http:127.0.0.1:8080/api/query/v1/pagforReciboGtm

...

Páginas filhas

Versões comparadas

Versão antiga 16

Nova versão Atual

Chave

Contexto

Parâmetros Obrigatórios

Atualizar status de integração - Recibos de Pagamento de Cana por Fazenda