Sales
Retrieves a list of sale objects based on a given criteria.
Columns
| Name | Type | References | |
| Id [KEY] | Integer | ||
| SaleType | String |
The allowed values are Quote, SalesOrder, Invoice, QuickSale, CreditMemo. | |
| Date | Datetime | ||
| CreatedAt | Datetime | ||
| DueDate | Datetime | ||
| Closed | Boolean | ||
| Void | Boolean | ||
| TaxAmount | Double | ||
| Subtotal | Double | ||
| GrandTotal | Double | ||
| Phone | String | ||
| AltPhone | String | ||
| StatusActive | Boolean | ||
| StatusId | Integer | ||
| StatusName | String | ||
| SalespersonId | String | ||
| CreatedBy | String | ||
| Class | String | ||
| CustomerId | Integer | ||
| CustomerName | String | ||
| CustomerPhone | String | ||
| CustomerActive | Boolean | ||
| CustomerBalance | Double | ||
| CustomerBillingAddressCity | String | ||
| CustomerBillingAddressCountry | String | ||
| CustomerBillingAddressId | Integer | ||
| CustomerBillingAddressLine1 | String | ||
| CustomerBillingAddressName | String | ||
| CustomerBillingAddressState | String | ||
| CustomerBillingAddressZipcode | String | ||
| CustomerContact | String | ||
| CustomerCreatedAt | Datetime | ||
| CustomerCreditHold | Boolean | ||
| CustomerEmail | String | ||
| CustomerStatusUpdateViaText | Boolean | ||
| CustomerWebsite | String | ||
| PaymentTerm | String | ||
| ShippingMethod | String | ||
| TaxItemId | String | ||
| TaxItemName | String | ||
| TaxItemRate | String | ||
| TaxItemActive | Boolean | ||
| TaxItemMemo | String | ||
| TaxItemTaxAgency | String | ||
| TaxGroupId | String | ||
| TaxGroupName | String | ||
| TaxGroupRate | String | ||
| TaxGroupActive | Boolean | ||
| TaxGroupMemo | String | ||
| TaxGroupTaxItems | String | ||
| SiteId | Integer | ||
| SiteName | String | ||
| SiteActive | Boolean | ||
| SiteAddressCity | String | ||
| SiteAddressCountry | String | ||
| SiteAddressId | Integer | ||
| SiteAddressLine1 | String | ||
| SiteAddressState | String | ||
| SiteAddressZipcode | String | ||
| BillingAddressCity | String | ||
| BillingAddressCountry | String | ||
| BillingAddressId | Integer | ||
| BillingAddressLine1 | String | ||
| BillingAddressName | String | ||
| BillingAddressState | String | ||
| BillingAddressZipcode | String | ||
| ShippingAddressCity | String | ||
| ShippingAddressCountry | String | ||
| ShippingAddressId | Integer | ||
| ShippingAddressLine1 | String | ||
| ShippingAddressName | String | ||
| ShippingAddressState | String | ||
| ShippingAddressZipcode | String | ||
| QuickSalePaymentDetail | String | ||
| Lines | String |