Fetch location detail | Build with Bookkeep

Fetch location detail

GET https://api.bookkeep.com/v1/entities/:entity_id/locations/:id

The Location object represents a sales tax location. Locations are identified by a unique ID.

Request

Path Parameters

entity_id string required
Unique identifier for the Entity object.

id string required
Unique identifier for the Location object.

Responses

Returns a location if a valid identifier was provided, and returns an error otherwise.

Schema

id string
Unique identifier for the Location object.

Example: nGBr7Vr7mNqW

entity_id string
Unique identifier for the Entity object.

Example: 9zOe70LNPwlN

name string
Name of Location.

Example: JT Bottle Shop

address1 string
Address line 1.

Example: 61707 29 Palms Hwy

address2 string nullable
Address line 2.

city string
City.

Example: Joshua Tree

state string
State.

Example: CA

postal_code string
Postal code.

Example: 92252

phone_number string
Phone number.

Example: +1917xxxxx00

email string
Email address.

Example: jason@bookkeep.co

headquarters boolean
Indicates if this is the headquarters location.

Example: true

end_of_day string
Time of day that the business closes.

Example: 00:00

timezone string
Timezone.

Example: Pacific Time (US & Canada)

updated_at string

Example: 2023-05-23T07:57:26.851Z

closeout_offset integer
Defaults to 0, minutes after midnight in the timezone of this address the location considers its end of day ie. closes at 2am, so through 2am is included in prior day

Example: 0

{
  "id": "nGBr7Vr7mNqW",
  "entity_id": "9zOe70LNPwlN",
  "name": "JT Bottle Shop",
  "address1": "61707 29 Palms Hwy",
  "address2": "string",
  "city": "Joshua Tree",
  "state": "CA",
  "postal_code": "92252",
  "phone_number": "+1917xxxxx00",
  "email": "jason@bookkeep.co",
  "headquarters": true,
  "end_of_day": "00:00",
  "timezone": "Pacific Time (US & Canada)",
  "updated_at": "2023-05-23T07:57:26.851Z",
  "closeout_offset": 0
}

HTTP Basic: Access denied.

Returns an error if an invalid entity identifier or invalid location identifier was provided.

Schema

error object

message string

Example: Couldn't find Organization

type string

Example: invalid_request_error

status string

Example: ok

{
  "error": {
    "message": "Couldn't find Organization",
    "type": "invalid_request_error",
    "status": "ok"
  }
}

Authorization: http

name: basic  
type: http  
description: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the [Bookkeep Developer Dashboard](https://app.bookkeep.com/developers/api_keys).
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl -L -X GET 'https://api.bookkeep.com/v1/entities' \
  -H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI='

curl -L 'https://api.bookkeep.com/v1/entities/:entity_id/locations/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'