v1

latestOpenAPI 3.0.32026-08-06150495.9 KB
Financial Reconciliation API

Store Wise Tax-Details

This endpoint makes an HTTP GET request to retrieve tax details for provide stores(listingIds). The request should include the client ID as a query parameter. The request body should be in raw format and include the start date, end date, listing IDs, channel, and payout dates.

Request Body

  • startDate (string): The start date for the tax details.

  • endDate (string): The end date for the tax details.

  • listingIds (array): An array of listing IDs.

  • channel (array): An array of channels.

  • payoutDates (array): An array of payout dates.

Example

{
  "startDate": "2025-02-23",
  "endDate": "2025-03-26",
  "listingIds": ["P5441"],
  "channel": ["DOORDASH"],
  "payoutDates": []
}

Response

Upon a successful execution, the endpoint returns a status code of 200 and a JSON response in the format below:

{
  "status": true,
  "statusCode": 0,
  "message": "",
  "result": {
    "storeWise": [
      {
        "storeId": "",
        "taxRemittedToState": 0,
        "taxRemittedToMerchant": 0
      }
    ]
  },
  "error": null
}

The response includes the status, status code, message, and tax details for each store, including the store ID, tax remitted to the state, and tax remitted to the merchant.

Summary

This endpoint retrieves tax details for a specific client based on the provided start date, end date, listing IDs, and channel. The response includes the status, status code, message, and tax details for each store, including the store ID, tax remitted to the state, and tax remitted to the merchant.

get/finance-manager/financial/tax-details

Query parameters

clientIdstring
Example:604517c0-fae8-41b7-8c20-0fe4778e415c

(required) – The common ID between Voosh and the partner, used to identify the client.

Headers

access-tokenstring
Example:{{access-token}}

(required) – The unique token ID provided to the partner for authentication and secure data access.

Request body

channelstring[]
endDatestring
listingIdsstring[]
startDatestring

Example request

{
  "channel": [
    "DOORDASH",
    "UBEREATS"
  ],
  "endDate": "2025-03-26",
  "listingIds": [
    "P5441",
    "P5461",
    "P5471",
    "P5481",
    "P5491",
    "P5501",
    "P5511",
    "P5531",
    "P5541",
    "P5551",
    "P5561",
    "P5571",
    "P5581",
    "P8191"
  ],
  "payoutDates": [],
  "startDate": "2025-02-23"
}

Response

200

{"stackTrail":"paths:/finance-manager/financial/tax-details:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}
messagestring
statusboolean
statusCodenumber

Example response

{
  "message": "Financial reconciliation Tax details generated successfully",
  "result": {
    "storeWise": [
      {
        "storeId": "P558",
        "taxRemittedToMerchant": 779.34,
        "taxRemittedToState": 0
      },
      {
        "storeId": "P819",
        "taxRemittedToMerchant": 0,
        "taxRemittedToState": 989.56
      },
      {
        "storeId": "P556",
        "taxRemittedToMerchant": 0,
        "taxRemittedToState": 1877.97
      },
      {
        "storeId": "P557",
        "taxRemittedToMerchant": 341.87,
        "taxRemittedToState": 0
      },
      {
        "storeId": "P554",
        "taxRemittedToMerchant": 184.3,
        "taxRemittedToState": 1298.03
      },
      {
        "storeId": "P555",
        "taxRemittedToMerchant": 113.03,
        "taxRemittedToState": 2146.4
      },
      {
        "storeId": "P544",
        "taxRemittedToMerchant": 2887.63,
        "taxRemittedToState": 767.88
      },
      {
        "storeId": "P546",
        "taxRemittedToMerchant": 2140.95,
        "taxRemittedToState": 968.45
      },
      {
        "storeId": "P547",
        "taxRemittedToMerchant": 6573.94,
        "taxRemittedToState": 3221.92
      },
      {
        "storeId": "P548",
        "taxRemittedToMerchant": 1840.58,
        "taxRemittedToState": 386.28
      },
      {
        "storeId": "P550",
        "taxRemittedToMerchant": 1870.17,
        "taxRemittedToState": 561.01
      },
      {
        "storeId": "P553",
        "taxRemittedToMerchant": 860.28,
        "taxRemittedToState": 382.65
      }
    ]
  },
  "status": true,
  "statusCode": 200
}