Follow the question structure recommended by Dev Bot before submitting your integration questions.
Collects (registers) a payment for a sale
POST
https://evo-integracao-api.w12app.com.br/api/v1/receivables/collect
π API Reference/Receivables
Record Sale Receipt
Description
π§ Notes The specified sale must exist. The sale must have an outstanding balance to be collected. The endpoint must create a new financial receipt linked to the specified sale. The system must reflect the operation in the cash register, financial transactions, and audit logs. If the sale is already fully paid off, the API must return a validation error. It is possible to record amounts exceeding the outstanding balance, provided the specified employee has sufficient permission for this operation. If idEmployeeis not provided, the system must automatically useSUPORTEEVO(ID1).
π Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idBranch | int32 | No | Filters the operation by branch. Applicable only for multi-branch tokens. |
π¨ Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
idSale | int32 | Yes | ID of the sale receiving the payment. |
idEmployee | int32 | No | ID of the employee responsible for the receipt. If not provided, the system automatically assigns the default employee SUPORTEEVO (ID 1). |
paymentMethod | int32 | Yes | Payment method used in the operation. See below. |
receivingDate | datetime | Yes | Date and time of the payment. |
amount | number | Yes | Total transaction amount. |
amountPaid | number | Yes | Amount actually received after fees and discounts. |
tid | string | No | Transaction identifier. Applicable for credit cards. |
nsu | string | No | Transaction NSU. Applicable for credit cards. |
authorization | string | No | Authorization code. Applicable for credit cards. |
brand | string | No | Card brand. Applicable for credit cards. |
acquirer | string | No | Acquirer responsible for the transaction. Applicable for credit cards. |
totalInstallments | int32 | No | Total number of installments. Applicable for credit cards. |
reference | string | No | Transaction reference. Applicable for Boleto, Transfer, Pix, bank transfer, and gift card. |
π· Supported paymentMethod values
| Value | Payment method |
|---|---|
1 | Credit Card |
13 | Transfer |
14 | Cash |
15 | Gift Card |
π Additional fields by payment method
Credit Card (1)
| Parameter | Type | Required | Description |
|---|---|---|---|
| tid | string | No | Transaction identifier. |
| nsu | string | No | Transaction NSU. |
| authorization | string | No | Authorization code. |
| brand | string | No | Card brand. |
| acquirer | string | No | Acquirer responsible for the transaction. |
| totalInstallments | int32 | No | Total number of installments. |
Transfer (13)
| Parameter | Type | Required | Description |
|---|---|---|---|
| reference | string | No | Transfer reference. |
Gift Card (15)
| Parameter | Type | Required | Description |
|---|---|---|---|
| reference | string | No | Gift card reference. |
πρ Response Structure
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates whether the operation was successful. |
idSale | int32 | Sale ID. |
receiptWidth | int32 | Receipt width. |
receipt | string | Receipt generated by the operation. |
Notes
idEmployee is not provided, the system must automatically use SUPORTEEVO (ID 1).Request
Query Params
Body Params application/json-patch+json
Request Code Samples
Responses
Modified atΒ 2026-07-15 17:23:13