Class Invoice

Hierarchy

Implements

Constructors

Properties

_timestamp: number
action: Create

Action

activities: any[] = []

Invoice Activity

add_credit: number = 0

add credit

add_point: number = 0

Add point

adult_pax: number = 0

Number of Adult People

baby_pax: number = 0

Number of Baby People

call_num: number = 0

The number which will be printed on kitchen slip or receipt or display to call when order is ready

child_pax: number = 0

Number of Child People

created_at: Date = ...
customer: Customer = ...

Customer

customer_id: number = 0

Customer ID

deleted_at: any = null
deleted_lines: IInvoiceLine[] = []

Deleted invoice lines

delivery_by: string = ''

Online delivery driver

delivery_charge: number = 0

Online delivery charge

delivery_id: number = 0

Online delivery id

delivery_type: string = ''

Online delivery type

discount_amount: number = 0

Total discount amount

discountable_subtotal: number = 0

Invoice subtotal applicable to discount

discounts: any[] = []

Discount List

employee_name: string = ''

Employee Name

employee_uid: string = ''

Receipt Print Override

etc: Record<string, any> = {}

Etc

grand_total: number = 0

Grand Total

humanized_created_at: string = ''
humanized_paid_at: string = ''

Human readable date

humanized_voided_at: string = ''

Human readable date

id_in_server: number
is_duplicate: boolean = false

Is Duplicate

is_sales_exclusive: boolean = false

Is Sales Exclusive

kitchen_print_override: boolean = false

Kitchen Print Override

lines: IInvoiceLine[] = []

Invoice Lines

minus_credit: number = 0

minus credit

minus_point: number = 0

minus point

order_id: number = 0

Order ID

otp: string = ''

OTP

paid_at: Date = ...

Payment Method

pax: number = 0

Total number of people including adult, child and baby

payment_source_charge_ref: string = ''

Payment Source Charge Reference

payment_source_last4: string = ''

Payment Source Last4

payment_source_method: string = ''

Payment Source Method

payments: IPayment[] = []

Payment

point_subtotal: number = 0

Invoice point subtotal

receipt_print_job_uid: string = ''

Receipt printer unique id

receipt_print_override: boolean = false
ref_id: string = ''

Invoice reference number which is used for look-up

remark: string = ''

Remark

rewarded_credit: number = 0

Rewarded Credit

rewarded_credit_rate: number = 0

rewarded credit rate

rewarded_point: number = 0

Rewarded Point

rewarded_point_rate: number = 0

rewarded point rate

rounding: number = 0

Rounding

sales_user_uid: string = ''

Sales User ID

service_charge: number = 0

Invoice service charge

service_chargeable_subtotal: number = 0

Invoice subtotal applicable to service charge

status: InvoiceStatus = InvoiceStatus.Open

Status

subtotal: number = 0

Invoice subtotal

table_name: string = ''

Table name

table_switch_id: number = 0

Table Switch ID

table_uid: string = ''

Table unique id

tax: number = 0

Tax

tip: number = 0

Tip Amount

to_address: Address = ...

To Address

type: DineIn = InvoiceType.DineIn

Invoice type

uid: string = ...
updated_at: Date = ...
use_customer_balance: boolean = false

if customer balance is used in this invoice

use_customer_point: boolean = false

If customer point is used in this invoice

voided_at: Date = ...

Payment Method

Generated using TypeDoc