Receivable Report
Receivable
The Receivable Report is a specialized financial report created exclusively for the LOCAL LATAM tenant that consolidates receivable amounts from the system. The report serves as a comprehensive receivable tracking tool that shows payment entries, refunds, chargebacks, and reversals with their effective dates and deposited dates.
Summary Section Fields
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| PAYMENT | Decimal number with 2 decimal places | Sum of all payment entry net amounts. Sum of net amounts where entry_type = payment | 100.00, 200.00 | Always positive or zero. |
| REFUND | Decimal number with 2 decimal places (negative) | Sum of all refund entry net amounts (negative). Sum of net amounts where entry_type = refund. | -50.00, -100.00 | Always negative or zero. |
| CHARGEBACK | Decimal number with 2 decimal places (negative) | Sum of all chargeback entry net amounts (negative). Sum of net amounts where entry_type = chargeback. | -20.00, -75.00 | Always negative or zero. |
| CHARGEBACK REVERSAL | Decimal number with 2 decimal places (positive) | Sum of all chargeback reversal entry net amounts (positive). Sum of net amounts where entry_type = reversal. | (Not provided) | (Not provided) |
Receivable Report - Detailed Fields
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| DEPOSITED DATE | Date string (YYYY-MM-DD) or null | Date when the transaction amount was deposited/settled in the system. | 2022-05-20, null | Null for transactions not yet deposited; uses America/Sao_Paulo timezone. |
| OPEN DATE | Date string (YYYY-MM-DD) | Date when the original payment was created/opened in the system. | 2022-04-15 | Always populated for valid payments. |
| CONFIRMED DATE | Date string (YYYY-MM-DD) | Date when the payment was confirmed/approved. | 2022-04-20 | Only populated for confirmed payments. |
| PMT CODE | String (merchant-defined) | Merchant-provided payment code identifier. | INV-2024-001 | Can be empty; format varies by merchant. |
| ORDER NUMBER | String | Order number associated with the payment. | ORDER-12345 | Can be empty or duplicate across different payments. |
| ENTRY TYPE | String enumeration (payment, etc.) | Type of entry in the receivable report. | payment, refund | Maps to EntryEntityType enum values. |
| PMT TYPE | String | Payment type category. | creditcard, pix | Varies by country and availability. |
| PMT METHOD | String | Specific payment method used. | mastercard, visa | More specific than PMT TYPE. |
| CHARGE AMOUNT | Decimal number (in cents) | Gross charge amount for the entry. | 2500 (BRL 25.00) | Stored in cents; negative for refunds/chargebacks. |
| FEE AMOUNT | Decimal number (in cents, negative) | Processing fee amount charged for the transaction. Calculated from fee entries. | -20 (BRL -0.20) | Always negative or zero; represents cost to the merchant. |
| NET AMOUNT | Decimal number (in cents) | Net amount after fee deduction (charge amount + fee amount). CHARGE AMOUNT + FEE AMOUNT. | 2480 (BRL 24.80) | Can be negative for refunds/chargebacks. |
| HASH | Hexadecimal string (48 characters) | Unique EBANX payment hash identifier. | 54154bb...44a4ac | Always populated; immutable after payment creation. |
| CUSTOMER NAME | String (UTF-8 encoded) | Full name of the customer who made the payment. | Maria Silva Santos | May be masked for privacy. |
| CUSTOMER DOCUMENT | String (varies by country) | Customer's government-issued document number (CPF, etc.). | 05444444927 | Format varies by country; may be masked. |
| INSTALMENT | Integer string | Current installment number for the entry. | 1, 2, 3 | Always '1' for single-payment transactions. |
| TOTAL INSTALMENTS | Integer string | Total number of installments for the payment. | 1, 3, 12 | '1' for non-installment payments. |
| TOTAL AMOUNT | Decimal number (in cents) | Total confirmed payment amount. | 10000 (BRL 100.00) | Represents the full payment amount regardless of installments. |
| RECIPIENT CODE | String | Code identifying the recipient/flow type. | me (local), ebanx-xb | Can be empty; determines settlement routing. |
| CHARGED FROM MARKETPLACE | String ("YES" or "NO") | Indicates if the transaction was charged from marketplace balance. | YES, NO | Only relevant for marketplace merchants. |
Example Receivable Report Calculation
Scenario: Brazilian LOCAL_LATAM merchant with credit card, debit card entries and PIX transactions on June 14, 2023
Base Transaction Data Report Date: June 14, 2023 Merchant: EBANX Demo Merchant Currency: BRL Report Type: RECEIVABLE_REPORT
Transaction Breakdown by Type
Payment Entry 1 - Acceleration (Installment 2): Deposited Date: 2022-05-31 Open Date: 2022-05-21 Confirmed Date: 2022-05-22 Payment Code: 3522936224633431506 Charge Amount: BRL 10.00 (1000 cents) Fee Amount: BRL 0.00 Net Amount: BRL 10.00 Installment: 2/3 Recipient Code: me Entry Type: ACCELERATION
Payment Entry 2 - Acceleration Fee (Installment 3): Charge Amount: BRL 0.00 Fee Amount: BRL -1.00 (100 cents) Net Amount: BRL -1.00 Installment: 3/3 Entry Type: ACCELERATION
Refund Entry 1: Charge Amount: BRL -9.00 (900 cents) Fee Amount: BRL 0.00 Net Amount: BRL -9.00 Refund Code: my_ref_1 Entry Type: REFUND
Refund Entry 2: Charge Amount: BRL -10.00 (1000 cents) Fee Amount: BRL -10.00 (1000 cents) Net Amount: BRL -20.00 Refund Code: my_ref_2 Entry Type: REFUND
Chargeback Entry: Charge Amount: BRL -25.00 (2500 cents) Fee Amount: BRL 0.00 Net Amount: BRL -25.00 Entry Type: CHARGEBACK
Payment Entry 3 - Main Payment (Installment 1): Charge Amount: BRL 50.00 (5000 cents) Fee Amount: BRL -5.00 (500 cents) Net Amount: BRL 45.00 Installment: 1/1 Entry Type: ACCELERATION
PIX Transaction Entries
PIX Payment: Deposited Date: 2023-06-14 Open Date: 2023-06-14 Confirmed Date: 2023-06-14 Payment Code: merchant_payment_code_bar Charge Amount: BRL 100.00 Fee Amount: BRL 0.00 (no PIX fee configured) Net Amount: BRL 100.00 Payment Type: PIX Entry Type: PAYMENT
Summary Calculation PAYMENT: BRL 100.00 (PIX payment only) REFUND: BRL -29.00 (refunds: 9.00 + 20.00 from entries) CHARGEBACK: BRL -25.00 (chargeback) CHARGEBACK REVERSAL: BRL 0.00 (no reversals) ───────────────────────────────────────────────── TOTAL: BRL +46.00
Calculation Breakdown: Total Payments: BRL 100.00 (PIX only; acceleration entries not counted in summary) Total Refunds: BRL 29.00 (9.00 + 20.00 from refund entries) Total Chargebacks: BRL 25.00 Total Reversals: BRL 0.00 Net Total: 100.00 - 29.00 - 25.00 + 0.00 = BRL +46.00
Report Output Structure
Summary Section: PAYMENT | REFUND | CHARGEBACK | CHARGEBACK REVERSAL | TOTAL 100.00 | -29.00 | -25.00 | 0.00 | +46.00
Detail Section (7 entries total): Acceleration entry (installment 2): BRL 10.00 net Acceleration fee (installment 3): BRL -1.00 net Refund 1: BRL -9.00 net Refund 2: BRL -20.00 net Chargeback: BRL -25.00 net Main payment acceleration: BRL 45.00 net PIX payment: BRL 100.00 net
Still need help?
We hope this article was helpful. If you still have questions, you can explore the following options:
- Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
- Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.