Generate sales accrual report

The purpose of this API is to get the sales made by a center (on any particular day or over a time period) if the business follows accrual-based accounting.

Response object

Sales Accrual Report Response Class

JSON PropertyData TypeDescription
salesList<ReportInvoice>List of sales information
page_infoPaginationDetailsViewModelContains page information
totalSalesAccrualTotalTotal sales information

sales object (ReportInvoice)

JSON PropertyData TypeDescription
sale_dateDateTime?Date of the sale
invoice_idGuid?ID of the invoice
invoice_nostringInvoice number
receipt_nostringReceipt number
guest_idGuid?ID of the guest
guest_namestringName of the guest
guest_codestringCode of the guest
center_idGuid?ID of the center
center_namestringName of the center
center_codestringCode of the center
referral_sourcestringReferral source
referred_bystringReferred by
item_idGuid?ID of the item
item_namestringName of the item
item_codestringCode of the item
item_typestringType of the item
qtyint?Quantity
sales_exc_taxdecimal?Sales excluding tax
sales_inc_taxdecimal?Sales including tax
taxdecimal?Tax amount
collecteddecimal?Amount collected
redeemeddecimal?Amount redeemed
duedecimal?Amount due
invoice_dateDateTime?Date of the invoice
item_categorystringCategory of the item
item_category_codestringCode of the item category
business_unitstringBusiness unit
discount_namestringName of the discount
discountdecimal?Discount amount
payment_typestringType of payment
sale_typestringType of sale
roomstringRoom
equipmentstringEquipment
providerstringProvider
first_visitstringIndicates if it's the first visit
memberstringMember
closed_bystringClosed by
statusstringStatus
invoice_notesstringNotes on the invoice
sold_bystringSold by
sold_by_codestringCode of the one who sold
created_bystringCreated by
base_invoice_nostringBase invoice number
category_idGuid?ID of the category
sold_by_idGuid?ID of the one who sold
created_by_idGuid?ID of the creator
closed_by_idGuid?ID of the one who closed
pricedecimal?Price amount
taxable_redemptiondecimal?Taxable redemption amount
non_taxable_redemptiondecimal?Non-taxable redemption amount
item_sub_categorystringSubcategory of the item
invoice_closed_dateDateTime?Date when the invoice was closed
business_unit_idGuid?ID of the business unit
invoice_sourcestringSource of the invoice
additional_invoice_fieldstringAdditional field on the invoice
sales_excluding_redemptiondecimal?Sales excluding redemption
linked_invoice_idGuid?ID of the linked invoice
linked_invoice_numberstringNumber of the linked invoice
vendor_idGuid?ID of the vendor
vendor_namestringName of the vendor
brand_idGuid?ID of the brand
brand_namestringName of the brand
display_namestringDisplay name of the center
company_namestringCompany name of the center
tin_numberstringTIN (Taxpayer Identification Number) of the center
tot_numberstringTOT (Tourist Occupancy Tax) number of the center
vat_numberstringVAT (Value Added Tax) number of the center
optional_field_1stringOptional field 1 of the center
optional_field_2stringOptional field 2 of the center
optional_field_3stringOptional field 3 of the center
optional_field_4stringOptional field 4 of the center
optional_field_5stringOptional field 5 of the center
optional_field_6stringOptional field 6 of the center
optional_field_7stringOptional field 7 of the center
optional

total object (SalesAccrualTotal)

JSON PropertyData TypeDescription
sales_exc_taxdecimalSales excluding tax
taxdecimalTax amount
sales_inc_taxdecimalSales including tax
discountdecimal?Discount amount (nullable)
pricedecimal?Price amount (nullable)
qtyint?Quantity (nullable)

page_info object (PaginationDetailsViewModel)

JSON PropertyData TypeDescription
totalintTotal number of items
pageintCurrent page number
sizeintNumber of items per page

error object (ApiErrorModel)

JSON PropertyData TypeDescription
codeintError code
messagestringError message

SalesAccrualReportRequest

JSON PropertyData TypeDescription
guest_idsListList of guest IDs
sold_by_idsListList of IDs of those who sold
item_typesListList of item types
item_idsListList of item IDs
closed_by_idsListList of IDs of those who closed
created_by_idsListList of IDs of those who created
category_idsListList of category IDs
invoice_statusesListList of invoice statuses
invoice_dateDateTime?Date of the invoice
group_columnsListList of columns for grouping
base_idGuid?Base ID
date_typeint?Date type
liability_typeint?Liability type
invoice_closed_dateDateTime?Closed date of the invoice
business_unitsMultiGuidFilterRequestModelList of business units
vendorsMultiGuidFilterRequestModelList of vendors
brandsMultiGuidFilterRequestModelList of brands
Language
Credentials
Header
Click Try It! to start a request and see the response here!