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:

Atributos	Descrição	Tipo	Observação
instancia	Identificador da instância	String
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 "YYYY-MM-DDTHH:MM:SS"
dataEmissao	Data de emissão	DateTime	Formato ISO
safra	Ano da safra	Integer	Ex: 2018
vlToneladaCana	Valor por tonelada de cana	Decimal	Ex: 78.2908998
qtCanaEntregue	Quantidade de cana entregue	Integer	Ex: 16532711
vlBrutoRecibo	Valor bruto do recibo	Decimal
vlAcumTaxasContrib	Valor acumulado de taxas de contribuição	Decimal	Pode ser zero
vlAcumDeducoes	Valor acumulado de deduções	Decimal	Pode ser zero
vlAcumNFPromissorias	Valor acumulado de NFs promissórias	Decimal	Pode ser zero
vlLiquidoRecibo	Valor líquido do recibo	Decimal
cdTpPropriedade	Código do tipo de propriedade	Integer
fgProcIndividual	Flag de processamento individual	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	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	String	Ex: "TOTVS"
dtHrInclusao	Data/hora inclusão	DateTime	Formato ISO
cdUsuarioAlteracao	Usuário de alteração	String	Pode ser null
dtHtAlteracao	Data/hora alteração	DateTime	Pode ser null
fgStatusIntegracao	Status de integração	String	Pode ser null
fluxoCaixa	Fluxo de caixa associado	String	Parâmetro: Seção: RCMP_PGTCP - Entrada: CD_TP_FLXCX_REC_DS

Seção historicoTaxas

Atributos	Descrição	Tipo	Observação
dtFimPeriodo	Fim do período da taxa	DateTime
safra	Ano da safra	Integer
fgLiminarSuspCobrancaICMS	Suspensão ICMS	String	Pode ser null
vlBaseTaxa	Base de cálculo da taxa	Decimal
dtInicioPeriodo	Início do período	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	String
vlTaxaContribuicao	Valor da taxa de contribuição	Decimal
vlSubsidio	Valor do subsídio	Decimal	Pode ser zero
cdUsuarioAlteracao	Usuário de alteração	String	Pode ser null

Seção detalheCdTaxa (dentro de historicoTaxas)

Atributos	Descrição	Tipo	Observação
cdTaxaContribuicao	Código da taxa de contribuição	Integer
fgAcertoAno	Flag acerto anual	String	"S" ou "N"
codigoEspecie	Código da espécie	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	DateTime	Formato ISO
codigoClassificacao	Código de classificação	String	Ex: "CLAS 1"
deTaxaContribuicao	Descrição da taxa	String	Ex: "INSS"
percentualTaxaContribuicao	Percentual da taxa	Decimal	Ex: 1.3

Seção historicoDeducoesGtm

Atributos	Descrição	Tipo	Observação
cdGrupoEvento	Código do grupo do evento	Integer
dtFimPeriodo	Fim do período	DateTime
cdEvento	Código do evento	Integer
noCtaContb	Numero da Conta Contábil	Integer
fgTpFolha	Tipo de folha	String	Ex: "A"
vlDeducao	Valor da dedução	Decimal
dtInicioPeriodo	Início do período	DateTime
dtEvento	Data do evento	DateTime
cdUsuarioInclusao	Usuário de inclusão	String
cdUpnivel1	Código do upnivel1	String
cdFornecedor	Código do fornecedor	Integer
fgDedAdiant	Flag indicativa para dedução de Adiantamento	String	Ex: "S" ou "N"

Seção infoUpnivel1

Atributos	Descrição	Tipo	Observação
cdUpnivel1	Código upnivel1	String
deUpnivel1	Descrição upnivel1	String
cdFornec	Código do fornecedor	Integer
fgTpPess	Tipo de pessoa	String	"J" ou "F"
cdIntErp	Código ERP	String

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 tipo fornecedor	String	Ex: "PROPRIO"
fgTpPess	Tipo de pessoa	String	"J" ou "F"
cdIntErp	Código ERP	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

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

Método GET:

http:127.0.0.1:8080/query/v1/pagforReciboGtm

Estrutura de dados:

Bloco de código

language	java
title	Recibo de Pagamento de Cana por Fazenda

{
    "hasNext": false,
    "items": [
        {
            "instancia": "1",
            "fgTpFolha": "F",
            "tipoFolha": "FOLHA MENSAL DE FORNECEDOR",
            "fornecedor": 96096,
            "cdUpnivel1": " 20402",
            "dataFornecimento": "2016-07-01T00:00:00",
            "dataEmissao": "2016-08-05T00:00:00",
            "safra": 2016,
            "vlToneladaCana": 29.2456974,
            "qtCanaEntregue": 1565698,
            "vlBrutoRecibo": 45789.93,
            "vlAcumTaxasContrib": 2573.47,
            "vlAcumDeducoes": 0,
            "vlAcumNFPromissorias": 0,
            "vlLiquidoRecibo": 43216.46,
            "cdTpPropriedade": 5,
            "fgProcIndividual": null,
            "instanciaCompraDeCana": "1",
            "cdEmpresaCompraDeCana": "1",
            "noContratoCana": 2396,
            "pcPagamento": 100,
            "fgTipoSuspensaoPagamento": null,
            "cdUsuarioInclusao": null,
            "dtHrInclusao": null,
            "cdUsuarioAlteracao": null,
            "dtHtAlteracao": null,
            "fgStatusIntegracao": "S",
            "historicoTaxas": [
                {
                    "dtFimPeriodo": "2016-07-31T00:00:00",
                    "safra": 2016,
                    "fgLiminarSuspCobrancaICMS": null,
                    "vlBaseTaxa": 45789.93,
                    "dtInicioPeriodo": "2016-07-01T00:00:00",
                    "dtHtAlteracao": null,
                    "cdTaxa": 1,
                    "cdUsuarioInclusao": null,
                    "instancia": "1",
                    "dtHrInclusao": null,
                    "detalheCdTaxa": [
                        {
                            "cdTaxaContribuicao": 1,
                            "fgAcertoAno": "S",
                            "percentualReducaoBase": null,
                            "cdIndiceBase": 950,
                            "dtValidadeInicial": "2015-10-01T00:00:00",
                            "deTaxaContribuicao": "INSS",
                            "percentualTaxaContribuicao": 1.3
                        }
                    ],
                    "grupoTaxaContribuicao": 1,
                    "fgAcertoAnual": null,
                    "fornecedor": 96096,
                    "upnivel1": " 20402",
         "tipoFolha":"FOLHA ANUAL          "vlTaxaContribuicao": 961.59DE FORNECEDOR",
         "dataFornecimento":"2018-08-01T00:00:00",
           "dataEmissao"vlSubsidio": 0:"2018-08-10T00:00:00",
           "safra":2018,
         "cdUsuarioAlteracaovlToneladaCana": null78.2908998,
                },
      "qtCanaEntregue":16532711,
          {"vlBrutoRecibo":1294360.82,
         "vlAcumTaxasContrib":0,
           "dtFimPeriodovlAcumDeducoes": "2016-07-31T00:00:00"0,
           "vlAcumNFPromissorias":0,
         "safravlLiquidoRecibo": 20161294360.82,
         "cdTpPropriedade":2,
           "fgLiminarSuspCobrancaICMSfgProcIndividual": null,
         "instanciaCompraDeCana":"1",
            "vlBaseTaxacdEmpresaCompraDeCana": 45789.93"1",
         "noContratoCana":2861,
           "dtInicioPeriodopcPagamento": "2016-07-01T00:00:00"null,
         "fgTipoSuspensaoPagamento":null,
           "dtHtAlteracaocdUsuarioInclusao": null"TOTVS",
         "dtHrInclusao":"2025-09-24T12:55:50",
           "cdTaxacdUsuarioAlteracao": 2null,
           "dtHtAlteracao":null,
         "cdUsuarioInclusaofgStatusIntegracao": null,
         "fluxoCaixa":"RCMP - FLXCX - REC",
         "instanciahistoricoTaxas":[
 "1",
           {
         "dtHrInclusao": null,
     "dtFimPeriodo":"2018-08-31T00:00:00",
               "detalheCdTaxasafra": [
2016,
               "fgLiminarSuspCobrancaICMS":null,
              {
 "vlBaseTaxa":944.86,
               "dtInicioPeriodo":"2018-08-01T00:00:00",
               "cdTaxaContribuicaodtHtAlteracao": 2null,
               "cdTaxa":1,
               "fgAcertoAnocdUsuarioInclusao": "S"null,
               "instancia":"1",
               "percentualReducaoBasedtHrInclusao": null,
               "detalheCdTaxa":[
             "cdIndiceBase": 950,
    {
                        "dtValidadeInicialcdTaxaContribuicao": "2015-10-01T00:00:00"1,
                            "deTaxaContribuicao"fgAcertoAno": "SENARS",
                            "percentualTaxaContribuicao"codigoEspecie": 0.2"ESPECIE 1",
                     "percentualReducaoBase":null,
   }
                    ]"cdIndiceBase":950,
                     "grupoTaxaContribuicaocdTxErp": 1null,
                     "dtValidadeInicial"fgAcertoAnual:": null2015-10-01T00:00:00",
                     "fornecedorcodigoClassificacao":"CLAS 960961",
                     "upnivel1deTaxaContribuicao": " 20402INSS",
                     "vlTaxaContribuicaopercentualTaxaContribuicao": 911.58,3
                    "vlSubsidio": 0, }
                    "cdUsuarioAlteracao": null],
                }"grupoTaxaContribuicao":1,
                {
 "fgAcertoAnual":null,
                   "dtFimPeriodofornecedor": "2016-07-31T00:00:00"319,
                    "safraupnivel1":" 2016,
   10094",
                 "fgLiminarSuspCobrancaICMSvlTaxaContribuicao": null19.84,
                    "vlBaseTaxavlSubsidio": 121623.730,
                    "dtInicioPeriodocdUsuarioAlteracao": "2016-07-01T00:00:00",null
            },
        "dtHtAlteracao": null,
   {
                 "cdTaxadtFimPeriodo": 3"2018-08-31T00:00:00",
                    "cdUsuarioInclusaosafra": null2016,
                    "instanciafgLiminarSuspCobrancaICMS": "1"null,
                    "dtHrInclusaovlBaseTaxa": null944.86,
                    "detalheCdTaxa": ["dtInicioPeriodo":"2018-08-01T00:00:00",
                     "dtHtAlteracao":null,
   {
             "cdTaxa":2,
               "cdTaxaContribuicaocdUsuarioInclusao": 3null,
               "instancia":"1",
               "fgAcertoAnodtHrInclusao": null,
               "detalheCdTaxa":[
             "percentualReducaoBase": null,
     {
                       "cdIndiceBasecdTaxaContribuicao": 9502,
                            "dtValidadeInicial"fgAcertoAno": "2015-10-01T00:00:00"S",
                     "codigoEspecie":"ESPECIE 2",
            "deTaxaContribuicao": "TAXA",
         "percentualReducaoBase":null,
                     "percentualTaxaContribuicaocdIndiceBase": 1.25950,
                     "cdTxErp":null,
   }
                    ]"dtValidadeInicial":"2015-10-01T00:00:00",
                     "grupoTaxaContribuicaocodigoClassificacao":"CLAS 32",
                     "fgAcertoAnualdeTaxaContribuicao": null"SENAR",
                     "fornecedorpercentualTaxaContribuicao": 96096,0.2
                  }
  "upnivel1": " 20402",
           ],
         "vlTaxaContribuicao": 1520.3,
     "grupoTaxaContribuicao":1,
               "vlSubsidiofgAcertoAnual": 0null,
                    "cdUsuarioAlteracaofornecedor": null319,
                }"upnivel1":" 10094",
            ]   "vlTaxaContribuicao":1.87,
               "historicoDeducoesGtmvlSubsidio": [0,
                {"cdUsuarioAlteracao":null
            }
        "cdGrupoEvento": 1],
                    "dtFimPeriodo": "2016-07-31T00:00:00","historicoDeducoesGtm":[
            {
        "cdEvento": 102,
      "cdGrupoEvento":1,
               "fgTpFolhadtFimPeriodo": "F"2018-08-31T00:00:00",
                    "vlDeducaocdEvento": 0101,
                    "dtInicioPeriodonoCtaContb": "2016-07-01T00:00:00"110",
               "fgTpFolha":"A",
               "dtHtAlteracaovlDeducao": null132,
                    "dtEventodtInicioPeriodo": "20162018-0708-31T0001T00:00:00",
                    "cdUsuarioInclusaodtHtAlteracao": null,
                    "fgProcessaIndividual": null"dtEvento":"2016-05-29T00:00:00",
                    "instanciacdUsuarioInclusao": "1TOTVS",
   
                 "dtHrInclusaofgProcessaIndividual": null,
                    "cdUpnivel1instancia": " 204021",
                    "cdUsuarioAlteracao": null"dtHrInclusao":"2025-08-05T14:34:34",
               "cdUpnivel1":" 10094",
    "cdFornecedor": 96096
          "cdUsuarioAlteracao":null,
      }
         "cdFornecedor":319,
   ],
            "detalheFornecedorfgDedAdiant": ["N"
            }
    {
     ],
         "infoUpnivel1":[
      "cdUsuarioInclusao": "ERP",
     {
               "fgTipoFornecedorcdUpnivel1":" 10094"2",
                    "dtHrInclusaodeUpnivel1":"FAZENDA "2016-02-04T17:42:51"TOTVS  10094",
                    "cdPrestadorServicocdFornec": null319,
                    "fgAtivofgTpPess": "SJ",
                    "deFornecedorcdIntErp": "FORNECEDOR1_600_TOTVS94",
            }
        "deTipoFornecedor": "FORNECEDOR" ],
         "infoFornecs":[
           "cdFornecedor": 96096{
                }
"cdFornec":319,
               "deFornec":"FORNECEDOR TOTVS  2",
   ],
            "detalheUpnivel1fgTpFornec": ["4",
                {
     "deTpFornec":"PROPRIO",
               "cdUsuarioInclusaofgTpPess": null"J",
                    "dtHrInclusaocdIntErp": null,"319"
            }
        "cdUpnivel1": " 20402" ],
         "notasFiscais":[
            "deUpnivel1": "TOTVS",{
                    "fgTipoPessoacdSerieNf": "JUN",
                    "cdFornecedornoNf": 9609650001
              }
  }
      "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 13

Nova versão Atual

Chave

Contexto

Parâmetros Obrigatórios

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