/
Retrieve a tax report

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 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

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=1000&offset=1000' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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": [
    { … }
  ]
}