Cadastrar lançamento de ajuste

Use este endpoint para cadastrar um lançamento de ajuste.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/agenda-lojista/lancamentos/ajuste' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "idLoja": 1, "idTipoAjuste": 123, "valor": 100, "dataVencimentoAgenda": "2022-05-15", "tipoAgenda": "SAQUE" }'

{ "id": 1, "idLoja": 1, "idOrigem": "123", "idTransacao": "321", "tipoLancamento": "VENDA_A_VISTA", "descricaoModalidade": "transacao-compra", "cartaoNumeroTruncado": "2721XXXXXXXX5570", "valorOriginal": 100, "valor": 110, "valorTaxa": 10, "totalParcelas": 5, "parcelaAtual": 2, "dataProcessamento": "2025-03-13T15:01:10.086Z", "dataLancamento": "2025-03-13T15:01:10.086Z", "dataFechamentoAgenda": "2025-03-13T15:01:10.086Z", "dataVencimentoAgenda": "2025-03-13T15:01:10.086Z", "idAgenda": 123, "faturado": false, "idTransacaoLancamentoCancelado": "123", "idOrigemLancamentoCancelado": "122", "dataLancamentoCancelado": "2025-03-13T15:01:10.086Z", "observação": "cadastro de lançamento" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

idLoja

integer <int64>

requerido

Identificador do estabelecimento.

Exemplo:

idTipoAjuste

integer <int64>

requerido

Identificador do tipo de ajuste.

Exemplo:

123

valor

number

requerido

Valor do ajuste.

>= 0.01

Exemplo:

100

dataVencimentoAgenda

string <date>

requerido

Data do fechamento da agenda, no formato yyyy-MM-dd.

Exemplo:

2022-05-15

tipoAgenda

enum<string>

requerido

Tipo de agenda.

Valores permitidos:

SAQUEVENDAROLAGEM_CREDITO

Exemplo:

SAQUE

Examples

Respostas

🟢200OK

application/json

OK.

Body

integer <int64>

opcional

Identificador do lançamento.

Exemplo:

idLoja

integer <int64>

opcional

Identificador da estabelecimento.

Exemplo:

idOrigem

string

opcional

Identificador da origem do lançamento.

Exemplo:

123

idTransacao

string

opcional

Identificador da transação.

Exemplo:

321

tipoLancamento

enum<string>

opcional

Tipo de lançamento.

VENDA_PSJ representa uma venda parcelada sem juros e VENDA_PCJ indica uma venda parcelada com juros.

Valores permitidos:

VENDA_A_VISTAVENDA_PSJVENDA_PCJCANCELAMENTO_VENDASAQUECANCELAMENTO_SAQUE

Exemplo:

VENDA_A_VISTA

descricaoModalidade

string

opcional

Descrição da modalidade.

Exemplo:

transacao-compra

cartaoNumeroTruncado

string

opcional

Número truncado do cartão.

Exemplo:

2721XXXXXXXX5570

valorOriginal

number

opcional

Valor original.

Exemplo:

100

valor

number

opcional

Valor do lançamento.

Exemplo:

110

valorTaxa

number

opcional

Valor da taxa.

Exemplo:

totalParcelas

integer <int32>

opcional

Número total de parcelas.

Exemplo:

parcelaAtual

integer <int32>

opcional

Número da parcela atual.

Exemplo:

dataProcessamento

string <date-time>

opcional

Data e hora do processamento.

Exemplo:

2025-03-13T15:01:10.086Z

dataLancamento

string <date-time>

opcional

Data e hora do lançamento.

Exemplo:

2025-03-13T15:01:10.086Z

dataFechamentoAgenda

string <date-time>

opcional

Data e hora do fechamento da Agenda.

Exemplo:

2025-03-13T15:01:10.086Z

dataVencimentoAgenda

string <date-time>

opcional

Data e hora de vencimento da Agenda.

Exemplo:

2025-03-13T15:01:10.086Z

idAgenda

integer <int64>

opcional

Identificador da Agenda.

Exemplo:

123

faturado

boolean

opcional

Indica se o lançamento já foi faturado.

Exemplo:

false

idTransacaoLancamentoCancelado

string

opcional

Identificador da transação de lançamento cancelada.

Exemplo:

123

idOrigemLancamentoCancelado

string

opcional

Identificador da origem do lançamento cancelado.

Exemplo:

122

dataLancamentoCancelado

string <date-time>

opcional

Data do cancelamento do lançamento.

Exemplo:

2025-03-13T15:01:10.086Z

observação

string

opcional

Observação do lançamento.

Exemplo:

cadastro de lançamento

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor