List sales_taxes

GET 
/v1/entities/:entity_id/sales_taxes

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

Request

Path Parameters

entity_id stringrequired

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 stringrequired

Unique identifier for the Location object.

Responses

200

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

Schema

object stringrequired

Default value: list

total_records integerrequired
data object
locations object[]
Array [
location_id stringrequired
Unique identifier for the Location object.
location_name stringrequired
Name of Location.
dates object[]
Array [
date daterequired
gross_sales doublerequired
discounts doublerequired
refunds doublerequired
cash_payments doublerequired
non_cash_payments doublerequired
taxes object[]
Array [
id stringrequired
name stringrequired
taxable_revenue doublerequired
collected_amount doublerequired
rate doublerequired
city stringnullablerequired
county stringrequired
state stringrequired
updated_at date-timerequired
]
]
]
entity_id stringrequired
status stringrequired

Example (from schema)

{
  "object": "list",
  "total_records": 1,
  "data": {
    "locations": [
      {
        "location_id": "GBraaEVr7mNqW",
        "location_name": "JT Bottle Shop",
        "dates": [
          {
            "date": "2023-01-22",
            "gross_sales": 1438.25,
            "discounts": 32.53,
            "refunds": 0,
            "cash_payments": 42.56,
            "non_cash_payments": 1528.39,
            "taxes": [
              {
                "id": "aGmyPmwz0n4K",
                "name": "JT-CA 7.75%",
                "taxable_revenue": 1405.81,
                "collected_amount": 108.95,
                "rate": 0.0775,
                "city": "",
                "county": "SAN BERNARDINO",
                "state": "CA",
                "updated_at": "2023-11-16T23:41:47.987Z"
              }
            ]
          }
        ]
      }
    ],
    "entity_id": "nGBr7Vr7mNqW"
  },
  "status": "ok"
}

400

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

application/json

Schema

Schema

error object
message stringrequired
type stringrequired

Example (from schema)

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

401

HTTP Basic: Access denied.

404

Returns an error if a invalid entity identifier was provided.

application/json

Schema

Schema

error object
message stringrequired
type stringrequired
status stringrequired

Example (from schema)

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

Loading...