latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Retrieve a list of sales details records

get/Business/Sales/SalesDetails

Query parameters

request.saleIdinteger

When provided, returns SalesDetails that belong to this Sale ID

request.startDatestring date-time

When provided, returns SalesDetails on and after this date

request.endDatestring date-time

When provided, returns SalesDetails before and on this date

request.excludedRevenueCategoryIdsinteger[]

When included, these revenue categories will be excluded from the results.

request.clientIdinteger

When provided, returns SalesDetails that belong to this client ID

request.limitinteger

Number of results to return, defaults to 100

request.offsetinteger

Number of results to skip, defaults to 0

Headers

SiteIdinteger required

Site ID

Response

OK

SaleIdinteger

The ID of the sale

SalesDetailIdinteger

The sales detail ID

ItemAmountnumber double

The amount of the item purchased

SaleDatestring date-time

The date when the sale took place

ContractIdinteger

The ID of the contract purchased

ClientContractIdinteger

The unique contract ID for the client

ContractTypestring

The type of contract

Autopayboolean

Whether the item was sold as part of an Autopay

ServiceCategoryIdinteger

The service category ID of the purchased item

ProductIdnumber double

The ID of the product purchased

ProductDescriptionstring

The product description

PaymentMethodstring

The type of payment method used

RevenueCategoryIdinteger

The revenue category ID of the purchased item

RevenueCategoryNamestring

The revenue category of the purchased item

DiscountAmountnumber double

The discount amount

TaxAmountnumber double

The summed tax amount

PromoCodeIdinteger

The ID of the promo code used (if any)

FirstNamestring

Client First name

LastNamestring

Client last name

Emailstring

Client Email

Phonestring

Client Phone no