Shopfront Developers
Register
Object
CashFloat
| Fields | Type | Description |
|---|---|---|
|
monday |
Float! |
The float for Monday |
|
tuesday |
Float! |
The float for Tuesday |
|
wednesday |
Float! |
The float for Wednesday |
|
thursday |
Float! |
The float for Thursday |
|
friday |
Float! |
The float for Friday |
|
saturday |
Float! |
The float for Saturday |
|
sunday |
Float! |
The float for Sunday |
Object
ClosurePrintSettings
| Fields | Type | Description |
|---|---|---|
|
payments |
Whether the register closure payments table should be printed |
|
|
tax |
Whether the register closure tax table should be printed |
|
|
movements |
Whether the register closure movements table should be printed |
|
|
account |
Whether the register closure account table should be printed |
|
|
accountPayments |
Whether the register closure account payments table should be printed |
|
|
refunds |
Whether the register closure refunds table should be printed |
|
|
discounts |
Whether the register closure discounts table should be printed |
|
|
giftCardsSold |
Whether the register closure gift cards sold table should be printed |
|
|
giftCardsRedeemed |
Whether the register closure gift cards redeemed table should be printed |
|
|
loyalty |
Whether the register closure loyalty table should be printed |
|
|
paymentSubtypes |
Boolean! |
Whether the register closure payment subtype table should be printed |
|
notes |
Boolean! |
Whether the register closure notes should be printed |
|
tags |
Boolean! |
Whether the register closure tags should be printed |
|
statistics |
Boolean! |
Whether the register closure statistics should be printed |
Object
SurchargeRule
| Fields | Type | Description |
|---|---|---|
|
periodDay |
The day this rule should apply to |
|
|
periodTimeStart |
The time this rule should start on the |
|
|
periodTimeEnd |
The time this rule should end on the |
|
|
surchargeType |
The type of surcharge to apply (percentage value or fixed dollar value) |
|
|
surchargeAmount |
Float! |
The amount to surcharge based on the |
|
name |
String! |
The name of the surcharge |
|
taxRate |
The tax rate that should be applied to the surcharge |
|
|
appliesTo |
The classifications that this applies to, returns null if this doesn't apply to anything. If this is empty, the classifications are probably deleted |
Object
Surcharging
| Fields | Type | Description |
|---|---|---|
|
enabled |
Boolean! |
Whether the surcharging schedule is currently enabled for the register |
|
rules |
The rules (scheduling, surcharge amount, etc) for the register |
Object
Register
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the register |
|
|
name |
String! |
The name of the register |
|
invoiceNumber |
String |
The latest invoice number the server has stored for this register |
|
outlet |
The outlet this register belongs to |
|
|
openTime |
The time the register was opened |
|
|
closed |
Boolean |
Whether the register is currently closed |
|
paymentMethods |
The payment methods attached to the register |
|
|
settings |
The settings for this object |
|
|
float |
The daily float for this register |
|
|
surcharging |
The surcharging rules to use for this register |
|
|
registerClosurePrintSettings |
The settings for what is printed in the register closure for this register |
|
|
registerClosureTags |
The tags to show revenue for on the close register screen |
|
|
deletedAt |
The time this register was deleted (or null if not deleted) |