Objects / Closures — Shopfront Developer Documentation

Object

Denomination

Fields	Type	Description
denomination	Float!	The denomination of currency that was used
amount	Float!	The number of the denomination that was used
direction	MovementDirectionEnum!	The direction of the denomination movement

Object

RegisterClosureDiscount

Fields	Type	Description
id	ID!	The ID of the register closure discount
invoiceId	String!	The ID of the invoice (normally numbers, but can contain any string) (typically called "invoice number")
user	User	The user who performed the discount
customer	Customer	The customer who received the discount
discount	Float	The amount the item was discounted by
discountReason	String	The reason for the discount
totalPrice	Float	The total price for the item that was discounted
createdAt	DateTime	The time the discount was performed

Object

RegisterClosureGiftCard

Fields	Type	Description
id	ID!	The ID of the gift card for the register closure
user	User	The user who sold the gift card
customer	Customer	The customer who purchased to gift card
sale	Sale	The sale that the gift card was sold on
code	String	The code of the gift card
amount	Float	The amount the gift card was sold for
createdAt	DateTime	The time the gift card was sold

Object

RegisterClosureLoyalty

Fields	Type	Description
accrued	Float!	The loyalty amount that was accrued during the register closure
redeemed	Float!	The amount of loyalty that was redeemed during the register closure

Object

RegisterClosureMovements

Fields	Type	Description
id	ID!	The ID of the movement for the register closure
register	Register	The register the the movement occurred on
user	User	The user that performed the movement
paymentMethod	PaymentMethod	The payment method that was used to perform the movement
amount	Float	The amount of money that was moved either to or from the payment method
reason	String	The reason for moving the money
denominations	[Denomination]	A list of denominations that were used for the movement
timestamp	DateTime	The time that the movement occurred

Object

RegisterClosureNote

Fields	Type	Description
id	Int!	The ID of the note for the register closure
note	String	The note
user	User	The user that added the note
createdAt	DateTime	The time the note was added to the register closure

Object

RegisterClosurePayment

Fields	Type	Description
id	Int!	The ID of the payment for the register closure
paymentMethod	PaymentMethod	The payment method that was used
expected	Float	The expected amount for the payment method
received	Float	The amount actually received for the payment method
additional	JSON	Additional information relating to the payment method

Object

RegisterClosureTax

Fields	Type	Description
id	Int!	The ID of the tax for the register closure
taxRate	TaxRate	The tax rate used
revenue	Float	The sale value for the tax rate
cost	Float	The total cost of the products for this tax rate (always inclusive of tax)
tax	Float	The amount of tax that was paid for the tax rate
surcharge	Float!	The surcharge that was charged to this tax rate, this figure is included in the revenue amount

Object

RegisterClosure

Fields	Type	Description
id	ID!	The ID of the register closure
user	User	The user who performed the register closure
register	Register	The register that was closed
movement	Float	The total amount of movement that occurred
totalExpected	Float	The total amount of money expected to be received
totalReceived	Float	The total amount of money actually received
totalTransactions	Int	The total number of transactions that occurred during the time the register was open
totalSurcharge	Float	The total surcharge that was charged while the register was open
notes	[RegisterClosureNote]	The notes on the register closure
sales	[Sale]	The sales that occurred while the register was open
accountSales	[Sale]	The account sales that occurred while the register was open
refunds	[Sale]	The refunds that occurred while the register was open
tax	[RegisterClosureTax]	The amount of tax per tax rate that was paid while the register was open
movements	[RegisterClosureMovements]	How much money was moved in and out of the register while it was open
payments	[RegisterClosurePayment]	The payment methods that were used while the register was open
accountPayments	[CustomerPayment]	The account payments that were made while the register was open
soldGiftCards	[RegisterClosureGiftCard]	The gift cards that were sold while the register was open
redeemedGiftCards	[RegisterClosureGiftCard]	The gift cards that were redeemed while the register was open
discounts	[RegisterClosureDiscount]	The discounts that occurred while the register was open
loyalty	RegisterClosureLoyalty!	The loyalty usage that occurred while the register was open
openedAt	DateTime	The time the register was opened
closedAt	DateTime	The time the register was closed