| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Active |
If not provided, gets all the active/inactive locations |
boolean |
None. |
| Customer |
If provided, customer locations will be filtered based on the customer Id or Number or Name. If all of them are provided, Id takes the first precedence, then the number and then the name. All matching customer locations will be returned. |
CustomerRef |
None. |
| DateCreatedRange |
The date and time (in company time zone) when the location was created. |
DateRange |
None. |
| LastUpdatedDateRange |
The date and time (in company time zone) when the location was last updated. |
DateRange |
None. |
| Phone |
customer locations will be filtered by matching all the phone numbers added to the locations. |
string |
None. |
| SortExpression |
Available Sort Expresstions: [LocationName Default ASC, DateCreated, LastUpdateDate] |
string |
None. |
| PageIndex |
zero-based page number |
integer |
None. |
| PageSize |
Default value is 100 |
integer |
Range: inclusive between 1 and 1000 |
| SortOrder |
Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending) |
integer |
Range: inclusive between 1 and 2 |
