v1
latestOpenAPI 3.0.32026-08-06150495.9 KBFinancial Reconciliation API
Store Wise Estimted Vs Actual Payout
Financial Estimate vs Actual Payouts Details
This endpoint retrieves the financial estimate versus actual payouts details for a specific client.
Request
Endpoint
GET /finance-manager/financial/estimate-vs-actual-payouts-details
Query Parameters
- clientId (string, required): The unique identifier of the client.
Request Body
{
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD",
"listingIds": ["string"],
"channel": ["string"],
"payoutDates": []
}
-
startDate (string): The start date for the financial estimate.
-
endDate (string): The end date for the financial estimate.
-
listingIds (array of strings): The listing IDs for which the estimate is being calculated.
-
channel (array of strings): The channels for which the estimate is being calculated.
-
payoutDates (array): The payout dates.
Response
JSON Schema
{
"type": "object",
"properties": {
"status": {"type": "boolean"},
"statusCode": {"type": "integer"},
"message": {"type": "string"},
"result": {
"type": "object",
"properties": {
"storeWise": {
"type": "array",
"items": {
"type": "object",
"properties": {
"store": {"type": "string"},
"revenue": {"type": "number"},
"deductions": {
"type": "object",
"properties": {
"total": {"type": "number"},
"commission": {"type": "number"},
"promoValue": {"type": "number"},
"deliveryFee": {"type": "number"},
"tips": {"type": "number"},
"marketingFees": {"type": "number"},
"paymentTransactionFee": {"type": "number"},
"ezReward": {"type": "number"},
"preferredPartnerProgram": {"type": "number"},
"deliveryCommission": {"type": "number"},
"marketingAdjustments": {"type": "number"},
"otherPayments": {"type": "number"},
"taxWithHeld": {"type": "number"},
"commissionTax": {"type": "number"},
"merchantFee": {"type": "number"}
}
},
"tax": {"type": "number"},
"estimatedPayout": {"type": "number"},
"difference": {
"type": "object",
"properties": {
"total": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"errorCharges": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"adjustments": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"refundByVoosh": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
}
}
},
"netPayout": {
"type": "object",
"properties": {
"total": {"type": "number"}
}
}
}
}
},
"error": {"type": "null"}
}
}
}
}
The response returns the status of the request, along with the financial estimate versus actual payouts details for the specified client.
get/finance-manager/financial/estimate-vs-actual-payouts-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
Example request
{
"channel": [
"DOORDASH",
"UBEREATS",
"GRUBHUB",
"EZCATER"
],
"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
Example response
{
"message": "Financial reconciliation Estimate vs Actual payout details",
"result": {
"storeWise": [
{
"deductions": {
"commission": -2795.53,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 0,
"ezReward": 0,
"marketingAdjustments": 1534.6,
"marketingFees": 0,
"merchantFee": -459.97,
"otherPayments": -357.25,
"paymentTransactionFee": 0,
"preferredPartnerProgram": 0,
"promoValue": -3845.75,
"taxWithHeld": 0,
"tips": 0,
"total": -5923.9
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": 0
},
"errorCharges": {
"itemTax": 0,
"itemValue": 0,
"total": -12.43
},
"refundByVoosh": {
"itemTax": 0,
"itemValue": 0,
"total": 12.43
},
"total": {
"itemTax": 0,
"itemValue": 0,
"total": 0
}
},
"estimatedPayout": 11070.83,
"netPayout": {
"total": 11070.83
},
"revenue": 16987.09,
"store": "P819",
"tax": 0
},
{
"deductions": {
"commission": -4901.01,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 0,
"ezReward": 0,
"marketingAdjustments": 1300.85,
"marketingFees": 0,
"merchantFee": -771.46,
"otherPayments": -1170.65,
"paymentTransactionFee": 0,
"preferredPartnerProgram": 0,
"promoValue": -3365.25,
"taxWithHeld": 0,
"tips": 0,
"total": -8907.52
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": 0
},
"errorCharges": {
"itemTax": 0,
"itemValue": -91.63,
"total": -95.92
},
"refundByVoosh": {
"itemTax": 0,
"itemValue": 37.4,
"total": 41.69
},
"total": {
"itemTax": 0,
"itemValue": 54.23,
"total": -54.23
}
},
"estimatedPayout": 17947.39,
"netPayout": {
"total": 17893.16
},
"revenue": 26833.64,
"store": "P556",
"tax": 0
},
{
"deductions": {
"commission": -947.08,
"commissionTax": -6.46,
"deliveryCommission": 0,
"deliveryFee": 0,
"ezReward": 0,
"marketingAdjustments": 325.88,
"marketingFees": 0,
"merchantFee": -188.47,
"otherPayments": -978.35,
"paymentTransactionFee": 0,
"preferredPartnerProgram": 0,
"promoValue": -814.45,
"taxWithHeld": 0,
"tips": 0,
"total": -2608.93
},
"difference": {
"adjustments": {
"itemTax": 2.31,
"itemValue": 23.86,
"total": 26.17
},
"errorCharges": {
"itemTax": -7.47,
"itemValue": -86.38,
"total": -168.76
},
"refundByVoosh": {
"itemTax": 3.3,
"itemValue": 40,
"total": 78.66
},
"total": {
"itemTax": 1.86,
"itemValue": 22.51,
"total": -63.93
}
},
"estimatedPayout": 2733.68,
"netPayout": {
"total": 2669.75
},
"revenue": 5043.16,
"store": "P557",
"tax": 339.57
},
{
"deductions": {
"commission": -1681.17,
"commissionTax": -6.92,
"deliveryCommission": 0,
"deliveryFee": 463.4,
"ezReward": -224.7,
"marketingAdjustments": 198.99,
"marketingFees": 0,
"merchantFee": -189.03,
"otherPayments": -1322.64,
"paymentTransactionFee": -159.28,
"preferredPartnerProgram": -674.09,
"promoValue": -482,
"taxWithHeld": 0,
"tips": 0,
"total": -4077.45
},
"difference": {
"adjustments": {
"itemTax": 0.21,
"itemValue": 3.75,
"total": 24.04
},
"errorCharges": {
"itemTax": -2.78,
"itemValue": -53.83,
"total": -86.64
},
"refundByVoosh": {
"itemTax": 1.65,
"itemValue": 20,
"total": 51.68
},
"total": {
"itemTax": 0.91,
"itemValue": 30.07,
"total": -10.91
}
},
"estimatedPayout": 6484.05,
"netPayout": {
"total": 6473.14
},
"revenue": 9893.21,
"store": "P558",
"tax": 768.09
},
{
"deductions": {
"commission": -3576.01,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 100,
"ezReward": -21.78,
"marketingAdjustments": 971.1,
"marketingFees": 0,
"merchantFee": -502.83,
"otherPayments": -1074.65,
"paymentTransactionFee": -38.31,
"preferredPartnerProgram": -163.35,
"promoValue": -2504,
"taxWithHeld": 0,
"tips": 0,
"total": -6809.84
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": -29.74
},
"errorCharges": {
"itemTax": 0,
"itemValue": -88.5,
"total": -110.57
},
"refundByVoosh": {
"itemTax": 0,
"itemValue": 74.75,
"total": 96.82
},
"total": {
"itemTax": 0,
"itemValue": 13.75,
"total": -43.49
}
},
"estimatedPayout": 12645.47,
"netPayout": {
"total": 12661.46
},
"revenue": 19501.31,
"store": "P554",
"tax": 184.3
},
{
"deductions": {
"commission": -5012,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 60,
"ezReward": -11.5,
"marketingAdjustments": 1602.61,
"marketingFees": 0,
"merchantFee": -491.24,
"otherPayments": -975.63,
"paymentTransactionFee": -20.68,
"preferredPartnerProgram": -86.25,
"promoValue": -4070.25,
"taxWithHeld": 0,
"tips": 0,
"total": -9004.93
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": 0
},
"errorCharges": {
"itemTax": 0,
"itemValue": -148.89,
"total": -148.89
},
"refundByVoosh": {
"itemTax": 0,
"itemValue": 36.35,
"total": 56.43
},
"total": {
"itemTax": 0,
"itemValue": 112.53,
"total": -92.45
}
},
"estimatedPayout": 19184.48,
"netPayout": {
"total": 19092.02
},
"revenue": 28189.42,
"store": "P555",
"tax": 113.03
},
{
"deductions": {
"commission": -7464.66,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 150,
"ezReward": -122.19,
"marketingAdjustments": 1075.4,
"marketingFees": 0,
"merchantFee": -1627.01,
"otherPayments": -353.85,
"paymentTransactionFee": -271.97,
"preferredPartnerProgram": -601.66,
"promoValue": -2749.5,
"taxWithHeld": 0,
"tips": 356.3,
"total": -11609.15
},
"difference": {
"adjustments": {
"itemTax": 1.32,
"itemValue": 14.72,
"total": 16.04
},
"errorCharges": {
"itemTax": -6.65,
"itemValue": -98.57,
"total": -149.35
},
"refundByVoosh": {
"itemTax": 10.7,
"itemValue": 108.89,
"total": 133.67
},
"total": {
"itemTax": -5.36,
"itemValue": -25.04,
"total": 0.34
}
},
"estimatedPayout": 32565.17,
"netPayout": {
"total": 32565.52
},
"revenue": 41286.69,
"store": "P544",
"tax": 2887.63
},
{
"deductions": {
"commission": -5895.34,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 150,
"ezReward": -69.07,
"marketingAdjustments": 1379.1,
"marketingFees": 0,
"merchantFee": -1393.35,
"otherPayments": -786.01,
"paymentTransactionFee": -66.03,
"preferredPartnerProgram": -273.33,
"promoValue": -4000.5,
"taxWithHeld": 0,
"tips": 247.2,
"total": -10707.34
},
"difference": {
"adjustments": {
"itemTax": 1.45,
"itemValue": 15.64,
"total": 46
},
"errorCharges": {
"itemTax": -7.45,
"itemValue": -87.46,
"total": -157.43
},
"refundByVoosh": {
"itemTax": 8.04,
"itemValue": 88.85,
"total": 143.33
},
"total": {
"itemTax": -2.04,
"itemValue": -17.02,
"total": 31.9
}
},
"estimatedPayout": 28673.25,
"netPayout": {
"total": 28705.16
},
"revenue": 37293.45,
"store": "P546",
"tax": 2087.14
},
{
"deductions": {
"commission": -23861.9,
"commissionTax": 0,
"deliveryCommission": -319.72,
"deliveryFee": 300,
"ezReward": -369.13,
"marketingAdjustments": 4232.09,
"marketingFees": 0,
"merchantFee": -4380.97,
"otherPayments": -813.9,
"paymentTransactionFee": -358.76,
"preferredPartnerProgram": -307.08,
"promoValue": -10812,
"taxWithHeld": 0,
"tips": 669.65,
"total": -36021.74
},
"difference": {
"adjustments": {
"itemTax": 1.23,
"itemValue": 15.34,
"total": 72.36
},
"errorCharges": {
"itemTax": -6.45,
"itemValue": -188.36,
"total": -220.28
},
"refundByVoosh": {
"itemTax": 3.73,
"itemValue": 89.61,
"total": 118.8
},
"total": {
"itemTax": 1.48,
"itemValue": 83.4,
"total": -29.1
}
},
"estimatedPayout": 96990.21,
"netPayout": {
"total": 96961.11
},
"revenue": 126332.19,
"store": "P547",
"tax": 6573.94
},
{
"deductions": {
"commission": -4494.51,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 330,
"ezReward": -269.83,
"marketingAdjustments": 665.99,
"marketingFees": 0,
"merchantFee": -714.04,
"otherPayments": 1880.25,
"paymentTransactionFee": -213.4,
"preferredPartnerProgram": -765.18,
"promoValue": -1662.5,
"taxWithHeld": -380.71,
"tips": 330.3,
"total": -4912.94
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": 50000
},
"errorCharges": {
"itemTax": 0,
"itemValue": -21.25,
"total": -59.32
},
"refundByVoosh": {
"itemTax": 1.32,
"itemValue": 35.99,
"total": 67.35
},
"total": {
"itemTax": -1.32,
"itemValue": -14.74,
"total": 50008.03
}
},
"estimatedPayout": 22829.18,
"netPayout": {
"total": 72837.21
},
"revenue": 26281.42,
"store": "P548",
"tax": 1840.58
},
{
"deductions": {
"commission": -4624.19,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 330,
"ezReward": -290.28,
"marketingAdjustments": 365.9,
"marketingFees": 0,
"merchantFee": -942.94,
"otherPayments": -630.37,
"paymentTransactionFee": -203.4,
"preferredPartnerProgram": -893.04,
"promoValue": -1123.25,
"taxWithHeld": 0,
"tips": 264,
"total": -7747.58
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": -30
},
"errorCharges": {
"itemTax": -3.42,
"itemValue": -58.86,
"total": -237.42
},
"refundByVoosh": {
"itemTax": 1.94,
"itemValue": 27.72,
"total": 188.99
},
"total": {
"itemTax": 1.48,
"itemValue": 31.14,
"total": -78.43
}
},
"estimatedPayout": 19239.13,
"netPayout": {
"total": 19220.7
},
"revenue": 25159.36,
"store": "P550",
"tax": 1870.17
},
{
"deductions": {
"commission": -2947.51,
"commissionTax": 0,
"deliveryCommission": 0,
"deliveryFee": 0,
"ezReward": 0,
"marketingAdjustments": 484.08,
"marketingFees": 0,
"merchantFee": -208.25,
"otherPayments": -394.45,
"paymentTransactionFee": -144.11,
"preferredPartnerProgram": -17.28,
"promoValue": -1202,
"taxWithHeld": 0,
"tips": 0,
"total": -4429.52
},
"difference": {
"adjustments": {
"itemTax": 0,
"itemValue": 0,
"total": 0
},
"errorCharges": {
"itemTax": 0,
"itemValue": -18.75,
"total": -55.91
},
"refundByVoosh": {
"itemTax": 0,
"itemValue": 3.75,
"total": 40.91
},
"total": {
"itemTax": 0,
"itemValue": 15,
"total": -15
}
},
"estimatedPayout": 10875.82,
"netPayout": {
"total": 10860.82
},
"revenue": 14640.27,
"store": "P553",
"tax": 665.06
}
]
},
"status": true,
"statusCode": 200
}