Lavu · Schema

OrderPayment

A payment record from the order_payments table.

RestaurantPoint of SalePaymentsInventoryMenu Management

Properties

Name	Type	Description
id	string	Payment row identifier.
order_id	string	Identifier of the parent order (may include a check suffix, e.g. 1-2).
check	string	Check number.
amount	string	Payment amount.
card_desc	string	Card description.
transaction_id	string	Payment transaction identifier.
refunded	string	Whether refunded (1) or not (0).
refund_notes	string	Refund notes.
refunded_by	string	Identifier of the employee who refunded.
refund_pnref	string	Refund processor reference.
tip_amount	string	Tip amount.
auth	string	Authorization flag.
loc_id	string	Location identifier.
processed	string	Whether processed (1) or not (0).
auth_code	string	Authorization code.
card_type	string	Card type.
datetime	string	Payment timestamp.
pay_type	string	Payment type (e.g. Cash).
voided	string	Whether voided (1) or not (0).
void_notes	string	Void notes.
voided_by	string	Identifier of the employee who voided.
void_pnref	string	Void processor reference.
register	string	Register name.
got_response	string	Whether a processor response was received (1) or not (0).
transtype	string	Transaction type.
split_tender_id	string	Split tender identifier.
temp_data	string	Temporary data.
change	string	Change returned.
total_collected	string	Total amount collected.
record_no	string	Record number.
server_name	string	Server name.
action	string	Payment action (e.g. Sale).
ref_data	string	Reference data.
process_data	string	Processing data.
voice_auth	string	Whether voice authorized (1) or not (0).
server_id	string	Server identifier.
preauth_id	string	Pre-authorization identifier.
tip_for_id	string	Identifier the tip applies to.
swipe_grade	string	Card swipe grade.
batch_no	string	Batch number.
register_name	string	Register name.
pay_type_id	string	Payment type identifier.
first_four	string	First four digits of the card.
mpshc_pid	string	Processor product identifier.
server_time	string	Server-side timestamp.
info	string	Additional information.
signature	string	Whether a signature was captured (1) or not (0).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderPayment",
  "description": "A payment record from the order_payments table.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lavu/refs/heads/main/json-schema/poslavu-api-order-payment-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Payment row identifier.",
      "example": "1239"
    },
    "order_id": {
      "type": "string",
      "description": "Identifier of the parent order (may include a check suffix, e.g. 1-2).",
      "example": "1-2"
    },
    "check": {
      "type": "string",
      "description": "Check number.",
      "example": "1"
    },
    "amount": {
      "type": "string",
      "description": "Payment amount.",
      "example": "5.50"
    },
    "card_desc": {
      "type": "string",
      "description": "Card description.",
      "example": ""
    },
    "transaction_id": {
      "type": "string",
      "description": "Payment transaction identifier.",
      "example": ""
    },
    "refunded": {
      "type": "string",
      "description": "Whether refunded (1) or not (0).",
      "example": "0"
    },
    "refund_notes": {
      "type": "string",
      "description": "Refund notes.",
      "example": ""
    },
    "refunded_by": {
      "type": "string",
      "description": "Identifier of the employee who refunded.",
      "example": "0"
    },
    "refund_pnref": {
      "type": "string",
      "description": "Refund processor reference.",
      "example": ""
    },
    "tip_amount": {
      "type": "string",
      "description": "Tip amount.",
      "example": ""
    },
    "auth": {
      "type": "string",
      "description": "Authorization flag.",
      "example": "0"
    },
    "loc_id": {
      "type": "string",
      "description": "Location identifier.",
      "example": "9"
    },
    "processed": {
      "type": "string",
      "description": "Whether processed (1) or not (0).",
      "example": "0"
    },
    "auth_code": {
      "type": "string",
      "description": "Authorization code.",
      "example": ""
    },
    "card_type": {
      "type": "string",
      "description": "Card type.",
      "example": ""
    },
    "datetime": {
      "type": "string",
      "description": "Payment timestamp.",
      "example": "2011-10-10 11:50:38"
    },
    "pay_type": {
      "type": "string",
      "description": "Payment type (e.g. Cash).",
      "example": "Cash"
    },
    "voided": {
      "type": "string",
      "description": "Whether voided (1) or not (0).",
      "example": "0"
    },
    "void_notes": {
      "type": "string",
      "description": "Void notes.",
      "example": ""
    },
    "voided_by": {
      "type": "string",
      "description": "Identifier of the employee who voided.",
      "example": "0"
    },
    "void_pnref": {
      "type": "string",
      "description": "Void processor reference.",
      "example": ""
    },
    "register": {
      "type": "string",
      "description": "Register name.",
      "example": "receipt"
    },
    "got_response": {
      "type": "string",
      "description": "Whether a processor response was received (1) or not (0).",
      "example": "0"
    },
    "transtype": {
      "type": "string",
      "description": "Transaction type.",
      "example": ""
    },
    "split_tender_id": {
      "type": "string",
      "description": "Split tender identifier.",
      "example": ""
    },
    "temp_data": {
      "type": "string",
      "description": "Temporary data.",
      "example": ""
    },
    "change": {
      "type": "string",
      "description": "Change returned.",
      "example": ""
    },
    "total_collected": {
      "type": "string",
      "description": "Total amount collected.",
      "example": "5.50"
    },
    "record_no": {
      "type": "string",
      "description": "Record number.",
      "example": ""
    },
    "server_name": {
      "type": "string",
      "description": "Server name.",
      "example": "Ancori"
    },
    "action": {
      "type": "string",
      "description": "Payment action (e.g. Sale).",
      "example": "Sale"
    },
    "ref_data": {
      "type": "string",
      "description": "Reference data.",
      "example": ""
    },
    "process_data": {
      "type": "string",
      "description": "Processing data.",
      "example": ""
    },
    "voice_auth": {
      "type": "string",
      "description": "Whether voice authorized (1) or not (0).",
      "example": "0"
    },
    "server_id": {
      "type": "string",
      "description": "Server identifier.",
      "example": "15"
    },
    "preauth_id": {
      "type": "string",
      "description": "Pre-authorization identifier.",
      "example": ""
    },
    "tip_for_id": {
      "type": "string",
      "description": "Identifier the tip applies to.",
      "example": "0"
    },
    "swipe_grade": {
      "type": "string",
      "description": "Card swipe grade.",
      "example": ""
    },
    "batch_no": {
      "type": "string",
      "description": "Batch number.",
      "example": ""
    },
    "register_name": {
      "type": "string",
      "description": "Register name.",
      "example": "receipt"
    },
    "pay_type_id": {
      "type": "string",
      "description": "Payment type identifier.",
      "example": "1"
    },
    "first_four": {
      "type": "string",
      "description": "First four digits of the card.",
      "example": ""
    },
    "mpshc_pid": {
      "type": "string",
      "description": "Processor product identifier.",
      "example": ""
    },
    "server_time": {
      "type": "string",
      "description": "Server-side timestamp.",
      "example": "2011-10-10 12:49:26"
    },
    "info": {
      "type": "string",
      "description": "Additional information.",
      "example": ""
    },
    "signature": {
      "type": "string",
      "description": "Whether a signature was captured (1) or not (0).",
      "example": "0"
    }
  }
}