Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Location

Retrieves the collection of Location resources.

Retrieves the collection of Location resources.

get/locations

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Location collection

idstring

unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y"

integrationstring

The key of the integration source e.g. "square""

srcIdstring

The unique identifier of the source 3rd party integration

createdstring date-time nullable

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

businessNamestring nullable

Name of the business e.g. "Bowman and Co"

currencystring nullable

Currency code e.g. "USD"

typestring nullable

Type of the Sales term e.g. STANDARD

countrystring nullable

Country of the address * e.g. "United States"

citystring nullable

City of the address e.g. "St Paul"

statestring nullable

Vendor state address e.g. "Alaska"

postalCodestring nullable

Postal code of the address * e.g. "99660"

addressstring nullable

First line of customer address e.g. "708 Woodland Avenue"

Example response

[
  {
    "id": "quickbooks-34",
    "integration": "square",
    "created": "2013-11-18T02:17:40.080Z",
    "businessName": "Bowman and Co",
    "currency": "USD",
    "country": "United States",
    "city": "St Paul",
    "state": "Alaska",
    "postalCode": "99660",
    "address": "708 Woodland Avenue"
  }
]