Financial Deduction Breakdown

This endpoint retrieves the financial overview for a specific client.

Request

• Method: GET

• Base URL: {{base-url}}

• Path: /finance-manager/financial/overview

• Query Parameters:

  • clientId (string, required): The unique identifier of the client for whom the financial overview is being requested.

Request Body

• Type: Raw (JSON)

• Description: The request body includes the following parameters:

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

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

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

  • channel (array): An array of channels.

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

Response

• Status: 200

• Content-Type: application/json

• Description: The response will be a JSON object with the following schema:

{
  "status": boolean,
  "statusCode": number,
  "message": string,
  "result": {
    "dashboard": string,
    "startDate": string,
    "endDate": string,
    "previousStartDate": string,
    "previousEndDate": string,
    "overview": {
      "payout": {
        "totalRevenue": number,
        "deductions": {
          "total": number,
          "commission": number,
          "merchantFee": number,
          "promoValue": {
            "promoValue": number,
            "ezReward": number,
            "preferredPartnerProgram": number
          },
          "paymentTransactionFee": number,
          "deliveryFee": {
            "deliveryFee": number,
            "deliveryCommission": number
          },
          "marketing": {
            "marketingAdjustments": number
          },
          "miscellaneous": {
            "tips": number,
            "taxWithHeld": number,
            "commissionTax": number,
            "otherPayments": number
          }
        },
        "tax": {
          "taxToBePaid": number
        },
        "estimatedPayout": number,
        "differenceBifurcation": {
          "total": number,
          "errorCharges": {
            "total": number,
            "itemValue": number,
            "itemTax": number
          },
          "adjustments": {
            "total": number,
            "itemValue": number,
            "itemTax": number
          }
        },
        "netPayout": {
          "total": number,
          "refundByVoosh": number
        },
        "payoutDiff": {
          "total": number,
          "itemValue": number,
          "itemTax": number
        }
      },
      "tax": {
        "taxRemittedToState": number,
        "taxRemittedToMerchant": number
      }
    },
    "graph": [
      {
        "key": string,
        "range": [number],
        "value": number,
        "type": string,
        "bifurcation": {}
      }
    ]
  },
  "error": string
}