List sales_taxes

GET https://api.bookkeep.com/v1/entities/:entity_id/sales_taxes

Returns a list of sales tax entries created. The sales taxes are returned in sorted order, with the most recent sales taxes appearing first.

Request

Path Parameters

entity_id string required
Unique identifier for the Entity object.

Query Parameters

date date
Date in YYYY-MM-DD format. Ex: 2023-01-22

updated_after date
A date used for selecting sales tax entries that were last updated after (or at) a specified time in YYYY-MM-DD format. Ex: 2023-01-22

updated_before date
A date used for selecting sales tax entries that were last updated before (or at) a specified time in YYYY-MM-DD format. Ex: 2023-01-22

location_id string required
Unique identifier for the Location object.

Responses

• 200
• 400
• 401
• 404

A dictionary with a data property that contains an array of objects. Each entry in the array is a separate sales tax entry object. If no more sales tax entries are available, the resulting array will be empty. You can list Sales Tax Entries by date or updated_after or updated_before.

• application/json

• Schema
  object string
  Default value: list
  Example: list

total_records integer
Example: 1

data object

locations object[]
Array [
location_id string
Unique identifier for the Location object.
Example: GBraaEVr7mNqW

  **location_name** string  
  Name of Location.  
  **Example:** `JT Bottle Shop`  

  **dates** object[]  
  Array [  
    **date** string<date>  
    **Example:** `2023-01-22`  

    **gross_sales** number<double>  
    **Example:** `1438.25`  

    **discounts** number<double>  
    **Example:** `32.53`  

    **refunds** number<double>  
    **Example:** `0`  

    **cash_payments** number<double>  
    **Example:** `42.56`  

    **non_cash_payments** number<double>  
    **Example:** `1528.39`  

    **taxes** object[]  
    Array [  
      **id** string  
      **Example:** `aGmyPmwz0n4K`  

      **name** string  
      **Example:** `JT-CA 7.75%`  

      **taxable_revenue** number<double>  
      **Example:** `1405.81`  

      **collected_amount** number<double>  
      **Example:** `108.95`  

      **rate** number<double>  
      **Example:** `0.0775`  

      **city** string nullable  
      **Example:**``  

      **county** string  
      **Example:** `SAN BERNARDINO`  

      **state** string  
      **Example:** `CA`  

      **updated_at** string<date-time>  
      **Example:** `2023-11-16T23:41:47.987Z`  
    ]  
  ]  
]

entity_id string
Example: nGBr7Vr7mNqW

status string
Example: ok

Returns an error if at least one param date, updated_before, or updated_after was not provided.

• application/json

• Schema
  error object

message string
Example: At least one param date, updated_before, or updated_after is required

type string
Example: invalid_request_error

{
  "error": {
    "message": "At least one param date, updated_before, or updated_after is required",
    "type": "invalid_request_error"
  }
}

HTTP Basic: Access denied.

Returns an error if an invalid entity identifier was provided.

• application/json

• 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  
authtype: 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

• nodejs

• python

• ruby

• csharp

• php

• CURL

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

Request Collapse all

Base URL
https://api.bookkeep.com

Auth
Username
Password

Parameters
entity_id — path required
location_id — query required

Show optional parameters

date — query

updated_after — query

updated_before — query

Send API Request

Response Clear
Click the Send API Request button above and see the response here!