/TaxLedger GET

Returns search results as a List Response for Tax Ledgers for the authenticated User, with given search parameters.

URL
/TaxLedger
Verb
GET

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string Optional The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter Data Type Valid Values Description
FromDate date A valid date Specifies the minimum date to return records for. Can only go back 24 months and must be before ToDate. Only used when RecentTransactions is false.
RecentTransactions boolean true/false When true, any specified date range will be ignored and only Tax Ledgers created since the last statement will be returned. If false, you must specify a valid date range.
Sort integer 0 - Order Date (default)

1 - Tax Ledger Type

2 - Order ID

3 - Tax Date

4 - Tax State
The field to sort on. Note: When sorting by Order Date and the Tax Ledger entry is not associated to an Order, Tax Date will be used.
SortOrder integer 0 - Ascending

1 - Descending (Default)
Sort direction.
State string 2 character state code Search in the specified ship to State.
TaxLedgerType integer 0 - All
1 - Charges
2 - Payments and Credits
Filter by tax ledger type.
ToDate date A valid date Specifies the maximum date to return records for. Must be after FromDate. Only used when RecentTransactions is false.

Optional PagingParameters

Output

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
Amount decimal decimal The Tax Ledger record amount
Description string string Description for the Tax Ledger record
OrderDate DateTime Valid ISO 8601 DateTime format Date the Order was created. For Tax Ledger entries not associated to and Order, the Tax Date will be returned.
OrderID integer positive # The ID of the Order.
TaxDate DateTime Valid ISO 8601 DateTime format Date the Tax Ledger record was created
TaxLedgerType integer 1 - Charges
2 - Payments and Credits
The Tax ledger type
TaxState string 2 character state code Ship to State for the Order