Returns export results as a List Response for Tax Ledgers for the authenticated User, with given search parameters.
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. |
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. |
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 |
OrderAcknowledgeDate | DateTime | Valid ISO 8601 DateTime format | Date when the Order was Acknowledged by the Seller |
OrderBillToName | string | string | Bill To name |
OrderBillToAddress1 | string | string | Bill To Address line 1 |
OrderBillToAddress2 | string | string | Bill To Address line 2 |
OrderBillToCity | string | string | Bill To City |
OrderBillToState | string | string | Bill To State |
OrderBillToPostalCode | string | string | Bill To Postal Code |
OrderBillToCountryCode | string | string | Bill To Country Code |
OrderBillToPhone | string | string | Bill To Phone Number |
OrderBillToEmail | string | string | Bill To Email Address |
OrderBuyerConfirmationDate | DateTime | Valid ISO 8601 DateTime format | Date when the buyer confirmed the price of the order |
OrderBuyerID | integer | integer | User ID for the Buyer |
OrderCancelDate | DateTime | Valid ISO 8601 DateTime format | Date when the Order was canceled |
OrderCashDiscountTotal | decimal | decimal | Total Cash Discount |
OrderComplianceFee | decimal | decimal | Compliance Fee charged on the order. |
OrderCouponValue | decimal | decimal | Coupon value |
OrderDate | DateTime | Valid ISO 8601 DateTime format | Date the Order was created. |
OrderFFLNumber | string | string | The FFL number belonging to the order. ( if the order needed a FFL ) |
OrderFFLReceivedDate | DateTime | Valid ISO 8601 DateTime format | Date when the FFL was received. ( if the order needed a FFL ) |
OrderID | integer | integer | Order ID associated to the ledger record. Value is 0 if ledger is not associated to specific Order. |
OrderLastModifiedDate | DateTime | Valid ISO 8601 DateTime format | Date the Order was last modified |
OrderLayawayAcceptanceDate | DateTime | Valid ISO 8601 DateTime format | Date when the buyer accepted layaway on the order |
OrderMiscCharge | decimal | decimal | Miscellaneous Charge |
OrderMiscDescription | string | string | Description of miscellaneous charge |
OrderOrderTotal | decimal | decimal | Order Total |
OrderPaymentInProcessDate | DateTime | Valid ISO 8601 DateTime format | The date time (in UTC) payment was initiated, if it was not immediately approved |
OrderPaymentMethod | key/pair (integer/string) |
2 - Certified Funds 4 - Personal Check 8 - Visa MasterCard 16 - COD 32 - GunTab Escrow 64 - AMEX 128 - Discover 512 - PayPal 8192 - Certified Check 16384 - USPS Money Order 32768 - Money Order |
The payment methods the buyer selected. |
OrderPaymentReceivedDate | DateTime | Valid ISO 8601 DateTime format | Date when the seller received payment |
OrderSalesTaxHandlingTotal | decimal | decimal | Sales Tax total for handling |
OrderSalesTaxInsuranceTotal | decimal | decimal | Sales Tax total for insurance |
OrderSalesTaxMiscTotal | decimal | decimal | Sales Tax total for miscellaneous |
OrderSalesTaxShippingTotal | Sales Tax total for shipping | decimal | xxx |
OrderSalesTaxTotal | decimal | decimal | Sales Tax total for order |
OrderSellerForcedCompleteDate | DateTime | Valid ISO 8601 DateTime format | Date when the Seller forced complete on the Order |
OrderSellerID | integer | integer | User ID for the Seller |
OrderSellerReviewCompleteDate | DateTime | Valid ISO 8601 DateTime format | Date when the seller reviewed |
OrderShipCarrier | key/pair (integer/string) |
0 - Unknown 1 - FedEx 2 - UPS 3 - USPS |
What shipping carrier is shipping this order. |
OrderShipClass | key/pair (integer/string) |
0 - None 1 - Overnight 2 - 2-Day 4 - 3-Day 8 - Ground 16 - USPS First Class 32 - USPS Priority Mail 64 - Other 128 - In Store Pick Up 256 - Alaska, Hawaii & Terr., Non-Continental US, Other |
What shipping carrier is shipping this order. |
OrderShipCost | decimal | decimal | Ship Cost |
OrderShipHandlingCost | decimal | decimal | Handling Cost |
OrderShipInsuranceCost | decimal | decimal | Insurance Cost |
OrderShipDate | DateTime | Valid ISO 8601 DateTime format | The date when the Order was shipped |
OrderShipFromCompany | string | string | Ship From Company Name |
OrderShipFromName | string | string | Ship From Name |
OrderShipFromAddress1 | string | string | Ship From Address line 1 |
OrderShipFromAddress2 | string | string | Ship From Address line 2 |
OrderShipFromCity | string | string | Ship From City |
OrderShipFromState | string | string | Ship From State |
OrderShipFromPostalCode | string | string | Ship From Postal Code |
OrderShipFromCountryCode | string | string | Ship From Country Code |
OrderShipFromPhone | string | string | Ship From Phone Number |
OrderShipFromEmail | string | string | Ship From Email Address |
OrderShipToName | string | string | Ship To To name |
OrderShipToAddress1 | string | string | Ship To Address line 1 |
OrderShipToAddress2 | string | string | Ship To Address line 2 |
OrderShipToCity | string | string | Ship To City |
OrderShipToState | string | string | Ship To State |
OrderShipToPostalCode | string | string | Ship To Postal Code |
OrderShipToCountryCode | string | string | Ship To Country Code |
OrderShipToPhone | string | string | Ship To Phone Number |
OrderShipToEmail | string | string | Ship To Email Address |
OrderStatus | key/pair (integer/string) |
1 - Pending Seller Review
2 - Pending Buyer Confirmation 3 - Pending Payment Received 4 - Pending Shipment 5 - Complete 6 - Cancelled 7 - Pending Buyer Review |
The status of the order. |
OrderTaxExempt | boolean | true/false | Is the Order Tax exempt |
OrderShipTrackingNumber | string | string | The tracking number belonging to the order. |
TaxDate | DateTime | Valid ISO 8601 DateTime format | Date the Tax Ledger record was created |
TaxIndicator | integer |
0 - Authorized
1 - Captured 2 - Canceled 3 - Paid not Captured 4 - Payment Processed 5 - Credited |
Tax Indicator for the ledger record |
TaxLedgerType | integer |
1 - Charges
2 - Payments and Credits |
The Tax ledger type |
TaxState | string | 2 character state code | Ship to State for the Order |
TaxStatementID | integer | integer | Statement ID if the ledger record is on a statement |