Transaction Types
| Type | API Value | Description | Effect on Balance |
|---|---|---|---|
| Payment | payment | Money received from a customer for products or services. | Increases till balance. |
| Refund | refund | Money returned to a customer for a previous payment. | Decreases till balance. |
| Adjustment | adjustment | Manual correction to a balance or till amount. | Varies by direction. |
| Void | void | Cancellation of a transaction before settlement. Reverses the original amount. | Reverses original. |
Payment Methods
| Method | API Value | Description | Settlement |
|---|---|---|---|
| Cash | cash | Physical currency collected at the till. | Immediate. |
| Credit Card | credit_card | Credit card payment via payment gateway. | 1—3 business days. |
| Debit Card | debit_card | Debit card payment via payment gateway. | 1—2 business days. |
| Check | check | Paper check. Requires manual deposit. | 3—5 business days. |
| House Account | house_account | Charged to the customer’s account for later invoicing. | Upon invoice payment. |
| Wire Transfer | wire | Bank wire transfer for large transactions. | 1—2 business days. |
| Gift Card | gift_card | Redeemed from an FBO-issued gift card balance. | Immediate. |
| Reward Points | reward_points | Redeemed from a customer’s reward card balance. | Immediate. |
Transaction Processing States
| Status | API Value | Description |
|---|---|---|
| Pending | pending | Transaction initiated but not yet processed (e.g., card authorization in progress). |
| Completed | completed | Transaction successfully processed and recorded. |
| Failed | failed | Transaction could not be processed (e.g., card declined). |
| Reversed | reversed | A completed transaction that was subsequently reversed by a void or refund. |
Transaction Fields
| Field | Type | Description |
|---|---|---|
transaction_id | String | Auto-generated unique identifier. |
order_id | String (optional) | Reference to the associated POS order. |
till_id | String (optional) | Reference to the till that processed the transaction. |
customer_id | String (optional) | Reference to the customer account. |
transaction_type | Enum | Payment, refund, adjustment, or void. |
payment_method | Enum | Cash, credit card, debit card, check, house account, etc. |
amount | Number | Transaction amount in USD. Always a positive value. |
description | String (optional) | Notes or reference information for the transaction. |
status | Enum | Pending, completed, failed, or reversed. |
processed_by | String | User who processed the transaction. |
created_at | Timestamp | Date and time the transaction was initiated. |
settled_at | Timestamp (optional) | Date and time the transaction was settled (funds received). |
Reconciliation
Till reconciliation compares the expected balance (calculated from transactions) against the actual counted balance at shift close.Reconciliation Calculation
End-of-Day Report Fields
| Field | Description |
|---|---|
| Till name | Which till the report covers. |
| Shift operator | Staff member who operated the till. |
| Opening balance | Cash amount at shift start. |
| Closing balance | Counted cash amount at shift end. |
| Expected balance | Calculated balance based on transactions. |
| Variance | Difference between expected and actual. |
| Transaction count | Total number of transactions during the shift. |
| Total sales | Sum of all payment transactions (all methods). |
| Total refunds | Sum of all refund transactions. |
| Net revenue | Total sales minus total refunds. |
Related
Manage POS Tills
Open, close, and reconcile tills.
Use the FBO Point of Sale
Process orders and manage POS operations.
FBO POS Reference
Product catalog, order fields, and inventory tracking.
Run FBO Reports
Financial reports including end-of-day reconciliation.