Histórico da Página

...

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

EstruturaEstruturas:

Atributos	Descrição

Tamanho

Tipo	Observação
instancia	Identificador da instância

1

String	Valor do tipo string numérica
fgTpFolha	Tipo da folha

1tipoFolhaDescrição do tipo de folha50StringEx.: "FOLHA ANUAL DE FORNECEDOR"dataFornecimentoData de fornecimento-

String

Ex.: "A"

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

4

	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

1

String/Nullable	Pode ser nulo
pcPagamento	Percentual de pagamento

-

Decimal/Nullable	Pode ser nulo
cdUsuarioInclusao	Usuário que incluiu o registro

50

	String	Ex.: "TOTVS"
dtHrInclusao	Data e hora de inclusão

-

DateTime	Formato ISO 8601
cdUsuarioAlteracao	Usuário que alterou o registro

50

	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

1

	String	Ex.: "1"
fluxoCaixa	Descrição do fluxo de caixa

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	Data final do período

-

	DateTime
safra	Ano da safra

4

	Integer
fgLiminarSuspCobrancaICMS	Flag liminar suspensão ICMS

1

	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

10

	String
vlTaxaContribuicao	Valor da taxa de contribuição

-

	Decimal
vlSubsidio	Valor do subsídio

-

Decimal

Seção detalheCdTaxa (dentro de historicoTaxas)

Atributos	Descrição

Tamanho

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

-

Integer
fgAcertoAno	Flag de acerto anual

1

String	Ex.: "S"
codigoEspecie	Código da espécie

20

	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

20

String
deTaxaContribuicao	Descrição da taxa de contribuição

50

	String
percentualTaxaContribuicao	Percentual da taxa de contribuição

-

Decimal

Seção historicoDeducoes

Atributos	Descrição

Tamanho

	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

50

	String
fgProcessaIndividual	Flag de processamento individual

1

	String	Ex.: "S"
instancia	Instância do registro

1

	String
dtHrInclusao	Data e hora de inclusão

-

	DateTime
cdUsuarioAlteracao	Usuário que alterou o registro

50

	String
cdFornecedor	Código do fornecedor

-

Integer

infoFornecs


fgDedAdiant	Flag indicativa para dedução de Adiantamento	String	'S' ou 'N'

Seção infoFornecs

Atributos	Descrição

AtributosDescriçãoTamanho

	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 do tipo de fornecedor

20

	String	Ex.: "PROPRIO"
fgTpPess	Tipo de pessoa

1

	String	Ex.: "J"
cdIntErp	Código interno no ERP

-

String/Integer

Método GET:

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:http:127.0.0.1:8080/api/query/v1/pagforReciboFor

...

Bloco de código

language	java
title	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,
         "instanciacdUsuarioInclusao":"1TOTVS",
         "fgTpFolhadtHrInclusao":"A2025-04-16T13:28:59",
         "tipoFolhacdUsuarioAlteracao":"FOLHA ANUAL DE FORNECEDOR"null,
         "dtHtAlteracao":null,
         "dataFornecimentofgStatusIntegracao":"2016-05-01T00:00:001",
         "dataEmissaofluxoCaixa":"2016-05-01T00:00:00RCMP - FLXCX - REC",
         "safrahistoricoTaxas":2016,[
         "vlToneladaCana":79.5347918,
   {
      "qtCanaEntregue":242213106,
         "vlBrutoRecibodtFimPeriodo":19264368.96,
"2016-05-31T00:00:00",
               "vlAcumTaxasContribsafra":02016,
         "vlAcumDeducoes":0,
         "vlAcumNFPromissoriasfgLiminarSuspCobrancaICMS":0null,
         "vlLiquidoRecibo":19264368.96,
         "vlRetencaovlBaseTaxa":0944.86,
         "cdTpPropriedade":1,
         "dtInicioPeriodo"fgProcIndividual":null,
   :"2016-05-01T00:00:00",
      "pcPagamento":null,
         "cdUsuarioInclusaodtHtAlteracao":"TOTVS",
null,
               "dtHrInclusaocdTaxa":"2025-04-16T13:28:59"1,
               "cdUsuarioAlteracaocdUsuarioInclusao":null,
         "dtHtAlteracao":null,
         "fgStatusIntegracaoinstancia":"1",
               "fluxoCaixadtHrInclusao":"RCMP - FLXCX - REC",
null,
               "historicoTaxasdetalheCdTaxa":[
            {
        {
       "dtFimPeriodo":"2016-05-31T00:00:00",
               "safracdTaxaContribuicao":20161,
               "fgLiminarSuspCobrancaICMS":null,
         "fgAcertoAno":"S",
      "vlBaseTaxa":944.86,
               "dtInicioPeriodo":"2016-05-01T00:00:00codigoEspecie":"ESPECIE 1",
               "dtHtAlteracao      "percentualReducaoBase":null,
                     "cdTaxacdIndiceBase":1950,
                     "cdUsuarioInclusaocdTxErp":null,
                     "instanciadtValidadeInicial":"12015-10-01T00:00:00",
               "dtHrInclusao":null,
               "detalheCdTaxacodigoClassificacao":["CLAS 1",
                  {   "deTaxaContribuicao":"INSS",
                     "cdTaxaContribuicaopercentualTaxaContribuicao":1,
.3
                  }
        "fgAcertoAno":"S",
       ],
               "codigoEspeciegrupoTaxaContribuicao":"ESPECIE 1",
                     "percentualReducaoBasefgAcertoAnual":null,
                     "cdIndiceBasefornecedor":950319,
               "upnivel1":" 10094",
       "cdTxErp":null,
        "vlTaxaContribuicao":19.84,
               "dtValidadeInicialvlSubsidio":"2015-10-01T00:00:00"0,
               "cdUsuarioAlteracao":null
           "codigoClassificacao":"CLAS 1" },
            {
         "deTaxaContribuicao      "dtFimPeriodo":"INSS2016-05-31T00:00:00",
                     "percentualTaxaContribuicaosafra":1.32016,
                  }"fgLiminarSuspCobrancaICMS":null,
               ]"vlBaseTaxa":944.86,
                "grupoTaxaContribuicao":1"dtInicioPeriodo":"2016-05-01T00:00:00",
               "fgAcertoAnualdtHtAlteracao":null,
               "fornecedorcdTaxa":3192,
               "upnivel1cdUsuarioInclusao":" 10094"null,
               "vlTaxaContribuicaoinstancia":19.84"1",
               "vlSubsidiodtHrInclusao":0null,
               "cdUsuarioAlteracaodetalheCdTaxa":null[
            },
      {
      {
               "dtFimPeriodocdTaxaContribuicao":"2016-05-31T00:00:00"2,
                     "safrafgAcertoAno":2016"S",
                     "fgLiminarSuspCobrancaICMScodigoEspecie":null"ESPECIE 2",
                     "vlBaseTaxapercentualReducaoBase":944.86null,
               "dtInicioPeriodo":"2016-05-01T00:00:00",
          "cdIndiceBase":950,
     "dtHtAlteracao":null,
                "cdTaxacdTxErp":2null,
                     "cdUsuarioInclusaodtValidadeInicial":null"2015-10-01T00:00:00",
                     "instanciacodigoClassificacao":"1CLAS 2",
                     "dtHrInclusaodeTaxaContribuicao":null"SENAR",
               "detalheCdTaxa":[
      "percentualTaxaContribuicao":0.2
            {
      }
               "cdTaxaContribuicao":2],
                     "fgAcertoAnogrupoTaxaContribuicao":"S"1,
                     "codigoEspeciefgAcertoAnual":"ESPECIE 2"null,
                     "percentualReducaoBasefornecedor":null319,
                     "cdIndiceBaseupnivel1":950,
     " 10094",
                "cdTxErpvlTaxaContribuicao":null1.87,
                     "dtValidadeInicial":"2015-10-01T00:00:00""vlSubsidio":0,
               "cdUsuarioAlteracao":null
        "codigoClassificacao":"CLAS 2",
   }
         ],
         "deTaxaContribuicaohistoricoDeducoes":"SENAR",
[
            {
               "percentualTaxaContribuicaocdGrupoEvento":0.2,
                  }"dtFimPeriodo":"2016-05-31T00:00:00",
               ]"cdEvento":162,
               "grupoTaxaContribuicaonoCtaContb":1162,
               "fgAcertoAnualvlDeducao":null150,
               "dtInicioPeriodo"fornecedor":319:"2016-05-01T00:00:00",
               "upnivel1":" 10094""dtHtAlteracao":"2024-08-07T21:00:00",
               "vlTaxaContribuicao":1.87dtEvento":"2016-04-01T00:00:00",
               "vlSubsidiocdUsuarioInclusao":0"TOTVS",
               "cdUsuarioAlteracaofgProcessaIndividual":null"S",
            }
   "instancia":"1",
      ],
         "dtHrInclusao"historicoDeducoes":[:"2024-08-06T03:00:00",
            {   "cdUsuarioAlteracao":"TOTVS",
               "cdGrupoEventocdFornecedor":2319,
               "dtFimPeriodofgDedAdiant":"2016-05-31T00:00:00",S"
            }
   "cdEvento":162,
      ],
         "vlDeducaoinfoFornecs":150,
        [
       "dtInicioPeriodo":"2016-05-01T00:00:00",     {
               "dtHtAlteracaocdFornec":"2024-08-07T21:00:00"319,
               "dtEventodeFornec":"2016-04-01T00:00:00FORNECEDOR TOTVS 2",
               "cdUsuarioInclusaofgTpFornec":"TOTVS4",
               "fgProcessaIndividualdeTpFornec":"SPROPRIO",
               "instanciafgTpPess":"1J",
               "dtHrInclusao":"2024-08-06T03:00:00","cdIntErp":"319"
            }
   "cdUsuarioAlteracao":"TOTVS",
      ],
         "cdFornecedornotasFiscais":319[
            }{
             ]  "cdSerieNf":"8",
               "infoFornecsnoNf":[363
            {},
               "cdFornec":319,{
               "deForneccdSerieNf":"FORNECEDOR TOTVS 28",
               "fgTpFornecnoNf":"4",364
            },
            "deTpFornec":"PROPRIO",{
               "fgTpPesscdSerieNf":"J8",
               "cdIntErpnoNf":"319"365
            }
         ]
      }
   ]
}

Parâmetros Obrigatórios

...

fgTpProc: Flag Controlador de Tipo de Processo.
cdFornecedor: Código do Fornecedor.
dataFornecimento: Data de Fornecimento (atributo AM_FORNEC).
fgStatusIntegracao; Status da Integração ( ex: S;N;P ou nulo)

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

...

Método PUT:

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

...

Páginas filhas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

Parâmetros Obrigatórios

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