Local Receivable Report
Local Receivable
The Local Receivable Report is a comprehensive financial report used exclusively for Brazil in the LOCAL_LATAM tenant. This report provides a comprehensive view of all receivable transactions for Brazilian merchants during a specified period, focusing on expected receivables based on deposit dates rather than already-processed settlements. It serves as a cash flow forecasting tool, showing when funds will become available to the merchant based on the configured deposit date schedule.
Local Receivable Report Sample
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| deposited_date | Date (YYYY-MM-DD) | Date when the receivable was deposited into the merchant's account. | 2024-09-17 | Bank holidays, failed deposits, weekend processing delays |
| open_date | DateTime (ISO 8601, UTC) | Date and time the payment was initially created. | 2024-09-15T08:30:25Z | Future-dated payments, system clock drift, timezone issues |
| confirmed_date | DateTime (ISO 8601, UTC) | Date and time the payment was confirmed and approved. | 2024-09-15T10:45:30Z | Delayed confirmations, manual overrides, confirmation before open date |
| batch_id | String (identifier, nullable) | Identifier of the processing batch that generated the receivable entry, used to group entries settled together and to reconcile the report with EBANX support. | BR-20240917-0001 | Only available for merchants configured to receive the identifier columns; empty for entries created outside a batch |
| currency | 3-letter ISO 4217 currency code | Currency of the receivable amounts in the entry, corresponding to the local currency of the processing country. | BRL | Only available for merchants configured to receive the currency column |
| pmt_code | String (alphanumeric, 50 chars) | Merchant's internal payment code identifier. | PMT-BR-2024-09-15-001 | Missing or duplicate codes, format changes |
| order_number | String (alphanumeric, 50 chars) | Organization's payment identifier for internal tracking. | ORG-12345-ABC-2024 | Missing numbers, format inconsistencies, legacy formats |
| entry_type | String (enum, 20 chars) | Classification of the receivable entry type. | PAYMENT | Misclassification, new unrecognized entry types |
| pmt_type | String (enum, 20 chars) | Payment method type classification. | creditcard | Deprecated types, type mismatches with method |
| pmt_method | String (enum, 30 chars) | Specific payment method used for the transaction. | visa | Method availability changes, unsupported methods |
| charge_amount | Decimal (12,4) | Total amount charged to the customer in local currency. | 1500.0000 | Zero amounts, negative amounts from refunds, precision issues |
| fee_amount | Decimal (12,4) | Total processing fees charged for the transaction. Calculated from refund and chargeback fee structures. | 75.0000 | Negative fees, calculation errors, fee structure changes |
| net_amount | Decimal (12,4) | Net receivable amount for the entry. For payment entries it is charge_amount - fee_amount; for refund and chargeback entries it is charge_amount + fee_amount, since the fee is also charged to the merchant. | 1425.0000 | Reported as an absolute value, so refund and chargeback entries are positive even though they reduce the receivable balance; rounding on the last decimal place |
| hash | String (alphanumeric, 50 chars) | Unique payment hash identifier for transaction tracking. Generated payment hash from the payment system. | 7f8e9d6c5b4a3210... | Hash collisions, missing hashes, format changes |
| country | 2-letter ISO 3166-1 alpha-2 country code | Country where the payment was processed. | BR | Only available for merchants configured to receive the country column |
| customer_name | String (varchar 255, UTF-8) | Full name of the customer who made the payment. | Maria Silva Santos | Missing names, encoding issues, format inconsistencies |
| customer_document | String (14 chars, numbers only) | Customer's identification document. Customer CPF (11 digits) or CNPJ (14 digits) | 12345678901 | Invalid formats, missing documents, validation failures |
| instalment | Integer (positive, nullable) | Current installment number for installment payments. | 2 | Number exceeds total, missing info, sequence errors |
| total_instalments | Integer (positive, nullable) | Total number of installments for the payment. | 6 | Count changes after creation, mismatched counts |
| anticipation_fee | Decimal (12,4) | Fee charged for anticipating the receivable, when the merchant receives the funds before the original deposit date. Reported in a separate column from fee_amount. | 10.0000 | Zero when the receivable is not anticipated; only available for merchants with anticipation enabled |
| payment_amount | Decimal (12,4) | Net payment amount after fee deduction: charge_amount - fee_amount. | 1425.0000 | May differ from charge_amount due to processing fees. Negative amounts are converted to absolute values. |
| refund_code | String (alphanumeric, 30 chars, nullable) | Reference code for refund transactions. | REF-2024-09-16-001 | Missing or duplicate codes, orphaned refund records |
| recipient_code | String (alphanumeric, 30 chars, nullable) | Identifier for split payment recipients in marketplaces. | RCP-SELLER-001 | Missing codes, split payment calculation errors |
| original_merchant_pmt_code | String (alphanumeric, 50 chars, nullable) | Original payment merchant code for linked transactions. | PMT-BR-2024-09-14-001 | Missing references, circular references, orphaned transactions |
| merchant_name | String (varchar 255, UTF-8) | Business name of the merchant processing the payment. | Loja Virtual Brasil Ltda | Name changes not reflected, encoding issues |
| merchant_id | String (identifier) | EBANX identifier of the merchant that owns the receivable entry, useful for merchants operating multiple accounts. | 54A9 | Only available for merchants configured to receive the identifier columns |
| refund_id | String (identifier, nullable) | Identifier of the refund that originated the entry. | 7412563211 | Empty for entries that are not refunds (payments, chargebacks); only available for merchants configured to receive the identifier columns |
| chargeback_id | String (identifier, nullable) | Identifier of the chargeback that originated the entry. | 7412563219 | Empty for entries that are not chargebacks; only available for merchants configured to receive the identifier columns |
Example Local Receivable Calculation
Scenario: Brazilian local merchant processing credit card payment with installments
Transaction Details:
Deposited Date: 2024-09-17
Open Date: 2024-09-15T08:30:25Z
Confirmed Date: 2024-09-15T10:45:30Z
PMT Code: PMT-BR-2024-09-15-001
Order Number: ORG-12345-ABC-2024
Payment Information:
Entry Type: PAYMENT
PMT Type: creditcard
PMT Method: visa
Customer: Maria Silva Santos
Customer Document: 12345678901
Hash: 7f8e9d6c5b4a3210fedcba9876543210
Financial Calculation:
Charge Amount: BRL 1,500.0000
Installment: 2
Total Installments: 6
Fee Amount: BRL 75.0000
Payment Amount: BRL 1,425.0000
Additional References:
Refund Code: null
Recipient Code: null
Original Merchant PMT Code: null
Merchant Name: EBANX Demo Merchant
Business Context:
This Local Receivable entry represents a Brazilian credit card payment processed in 6 installments, with processing fees of BRL 75.00 deducted from the gross amount.
Settlement Impact:
Gross receivable: BRL 1,500.0000
Processing fees: BRL 75.0000
Net receivable: BRL 1,425.0000
Deposited to merchant account: BRL 1,425.0000
Remaining installments: 4
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.
