Retrieve a tax report
Experimental

Request

Retrieves a tax report, which displays taxes collected on sales. Tax amounts are aggregated by state and municipality.
Security
SecretApiKey or JWT
Query
periodStartstring, (date-time)
Date and time when the report starts. If no value is provided, the report starts from the beginning of the previous month.
periodEndstring, (date-time)
Date and time when the report ends. If no value is provided, the report ends at the end of the current month.
accountingMethodstring
Accounting method to use when generating the report. If no value is provided, cash is used.
Enum:"cash""accrual"
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, >= 0
Starting point within the collection of items to return.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/tax?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&accountingMethod=cash&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
dataArray of objects
Tax data.
Response
{
  "data": [
    { … }
  ]
}