Registrar Recebimento da Venda

Descrição

Cria um novo recebimento financeiro vinculado a uma venda existente, registrando o pagamento e executando as regras financeiras necessárias do EVO.

🚧 Observações
A venda informada deve existir.
A venda deve possuir saldo pendente para recebimento.
O endpoint deve criar um novo recebimento financeiro vinculado à venda informada.
O sistema deve refletir a operação no caixa, nos movimentos financeiros e na auditoria.
Caso a venda já esteja totalmente quitada, a API deve retornar erro de validação.
Será possível registrar valores acima do saldo pendente desde que o colaborador informado possua permissão suficiente para essa operação.
Se idEmployee não for informado, o sistema deve utilizar automaticamente SUPORTEEVO (ID 1).

🔑 Parâmetro de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idBranch`	int32	Não	Filtra a operação pela filial. Aplicável apenas para token multifilial..

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idSale`	int32	Sim	ID da venda que receberá o recebimento.
`idEmployee`	int32	Não	ID do colaborador responsável pelo recebimento. Caso não seja informado, o sistema atribui automaticamente o colaborador padrão `SUPORTEEVO` (ID `1`).
`paymentMethod`	int32	Sim	Meio de pagamento utilizado na operação. Ver mais abaixo.
`receivingDate`	datetime	Sim	Data e hora do pagamento.
`amount`	number	Sim	Valor total da transação.
`amountPaid`	number	Sim	Valor efetivamente recebido após taxas e descontos.
`tid`	string	Não	Identificador da transação. Aplicável para cartão de crédito.
`nsu`	string	Não	NSU da transação. Aplicável para cartão de crédito.
`authorization`	string	Não	Código de autorização. Aplicável para cartão de crédito.
`brand`	string	Não	Bandeira do cartão. Aplicável para cartão de crédito.
`acquirer`	string	Não	Adquirente responsável pela transação. Aplicável para cartão de crédito.
`totalInstallments`	int32	Não	Quantidade total de parcelas. Aplicável para cartão de crédito.
`reference`	string	Não	Referência da transação. Aplicável para boleto, transferência, Pix, transferência bancária e gift card.

🔷 Valores suportados de `paymentMethod`

Valor	Meio de pagamento
`1`	Credit Card
`13`	Transfer
`14`	Cash
`15`	Gift Card

📌 Campos adicionais por meio de pagamento

Credit Card (`1`)

Parâmetro	Tipo	Obrigatoriedade	Descrição
tid	string	Não	Identificador da transação.
nsu	string	Não	NSU da transação.
authorization	string	Não	Código de autorização.
brand	string	Não	Bandeira do cartão.
acquirer	string	Não	Adquirente responsável pela transação.
totalInstallments	int32	Não	Quantidade total de parcelas.

Transfer (`13`)

Parâmetro	Tipo	Obrigatoriedade	Descrição
reference	string	Não	Referência da transferência.

Gift Card (`15`)

Parâmetro	Tipo	Obrigatoriedade	Descrição
reference	string	Não	Referência do gift card.

📤 Estrutura da Resposta

Campo	Tipo	Descrição
`success`	boolean	Informa se a operação foi bem-sucedida.
`idSale`	int32	ID da venda.
`receiptWidth`	int32	Largura do recibo.
`receipt`	string	Recibo gerado pela operação.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros de Consulta

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "idSale": 0,
    "idEmployee": 0,
    "paymentMethod": 1,
    "receivingDate": "2019-08-24T14:15:22.123Z",
    "amount": 0,
    "amountPaid": 0,
    "tid": "string",
    "nsu": "string",
    "authorization": "string",
    "brand": "string",
    "acquirer": "string",
    "totalInstallments": 0,
    "reference": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Collects (registers) a payment for a sale

Registrar Recebimento da Venda

Descrição

🔑 Parâmetro de Consulta (Query Params)

📨 Corpo da Requisição (Request Body)

🔷 Valores suportados de `paymentMethod`

📌 Campos adicionais por meio de pagamento

Credit Card (`1`)

Transfer (`13`)

Gift Card (`15`)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Collects (registers) a payment for a sale

Registrar Recebimento da Venda#

Descrição#

🔑 Parâmetro de Consulta (Query Params)#

📨 Corpo da Requisição (Request Body)#

🔷 Valores suportados de paymentMethod#

📌 Campos adicionais por meio de pagamento#

Credit Card (1)#

Transfer (13)#

Gift Card (15)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Registrar Recebimento da Venda

Descrição

🔑 Parâmetro de Consulta (Query Params)

📨 Corpo da Requisição (Request Body)

🔷 Valores suportados de `paymentMethod`

📌 Campos adicionais por meio de pagamento

Credit Card (`1`)

Transfer (`13`)

Gift Card (`15`)

📤 Estrutura da Resposta