Skip to main content

Receipts Guide

Document type (business): Receipt

RE not available via the Invoice API

Receipt nature RE cannot be created through this API. For payment-at-sale flows, use Invoice-Receipt (FR) with payments[] on the same document. This guide is kept for reference only.

Illustrative IDs

The values in the JSON examples (e.g. "documentTypeId": 6) are illustrations; the same number can represent a different document type in another client's database. Resolve the correct id with GET /gateway/document-type and match description / keyId to a receipt in the client's database. See Resolving document type IDs.


Overview

Receipts are documents that:

  • 💰 Prove payment received
  • DO NOT affect stock
  • 💳 Register payment method
  • 🧾 Linked to invoices (optional)
  • 📊 Integrate with treasury

When to Use

  • ✅ Customer makes payment
  • ✅ Prove receipt of funds
  • ✅ Register in treasury
  • ✅ Settle invoices

Receipt Characteristics

CharacteristicValueDescription
Affects Stock❌ NoPayment only
Requires Payment✅ YesRegisters payment
Can be Closed✅ YesMandatory finalization
Fiscal Validation✅ YesFiscal document
Allows Editing⚠️ LimitedOnly before closing
Cancellation⚠️ ComplexRequires reversal

Create Receipt

Simple Receipt

POST /gateway/invoice/invoices
Content-Type: application/json
Authorization: Bearer {token}
{
"serieId": 4,
"documentTypeId": 6,
"entityKeyId": "CLI001",
"currencyId": 1,
"entityDescription": "Example Client, Ltd",
"obs": "Payment for invoice INV A/123",
"paymentModeId": 1,
"payments": [
{
"paymentTypeId": 1,
"amount": 1000
}
],
"documentBodies": [
{
"itemKeyId": "PYMT001",
"itemDescription": "Payment",
"quantity": 1,
"retailPrice": 1000,
"taxId": 2,
"secondTaxId": 0
}
]
}

Receipt with Multiple Payment Methods

{
"serieId": 4,
"documentTypeId": 6,
"entityKeyId": "CLI001",
"currencyId": 1,
"obs": "Mixed payment - cash and bank transfer",
"payments": [
{
"paymentTypeId": 1,
"amount": 500
},
{
"paymentTypeId": 3,
"amount": 500
}
],
"documentBodies": [
{
"itemKeyId": "PYMT001",
"itemDescription": "Payment - Cash",
"quantity": 1,
"retailPrice": 500,
"taxId": 2,
"secondTaxId": 0
},
{
"itemKeyId": "PYMT001",
"itemDescription": "Payment - Bank Transfer",
"quantity": 1,
"retailPrice": 500,
"taxId": 2,
"secondTaxId": 0
}
]
}

Payment Types

CodeTypeDescription
1CashCurrency
2CheckBank check
3Bank TransferWire transfer
4ATMATM reference
5CardDebit/Credit
6MB WayMB Way
Check API

Use endpoint /gateway/payment-types for complete list.


Invoice Linking

Receipt for Specific Invoice

{
"serieId": 4,
"documentTypeId": 6,
"entityKeyId": "CLI001",
"currencyId": 1,
"obs": "Full settlement of invoice INV A/123",
"paymentModeId": 1,
"payments": [
{
"paymentTypeId": 1,
"amount": 1230
}
],
"documentBodies": [
{
"itemKeyId": "PYMT001",
"itemDescription": "Settlement INV A/123",
"quantity": 1,
"retailPrice": 1230,
"taxId": 2,
"secondTaxId": 0
}
]
}

Receipt for Multiple Invoices

{
"serieId": 4,
"documentTypeId": 6,
"entityKeyId": "CLI001",
"currencyId": 1,
"obs": "Payment for multiple invoices",
"payments": [
{
"paymentTypeId": 3,
"amount": 5000
}
],
"documentBodies": [
{
"itemKeyId": "PYMT001",
"itemDescription": "Settlement multiple invoices",
"quantity": 1,
"retailPrice": 5000,
"taxId": 2,
"secondTaxId": 0
}
]
}

Treasury Integration

Complete Flow

  1. Invoice issued - Receivable created
  2. Customer makes payment
  3. Create receipt - Prove receipt
  4. Register in treasury - Update cash/bank
  5. Mark invoice as paid - (accounting system)

Best Practices

  • Validate receipt amount vs invoice amount
  • Record correct payment method
  • Close receipt immediately after creation
  • Include bank details (if transfer)
  • Issue receipt on the same day as payment

❌ Avoid

  • Creating receipt without linked invoice
  • Receipt amount different from actual payment
  • Leaving receipts open
  • Issuing receipt before confirming payment
  • Forgetting to report payment method

Common Use Cases

Cash Payment

Customer pays invoice at time of purchase.

Credit Invoice Payment

Customer pays invoice 30/60 days after issuance.

Partial Payment

Customer pays part of invoice (create multiple receipts).

Advance Payment

Customer pays before invoice (standalone receipt).


Differences vs Invoices

AspectInvoiceReceipt
PurposeSalePayment
StockAffectsDoes not affect
ValueSalePayment
TimingAt saleAt payment
VATIncludesExempt

Receipt Cancellation

Attention

Canceling a receipt is complex and may require accounting reversal.

Scenario: Receipt Issued by Mistake

  1. Create Credit Note (if invoice adjustment needed)
  2. Record reversal in treasury
  3. Create new correct receipt

Next Steps


Last Updated: June 5, 2026