# 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:
    



Endpoint: GET /finance-manager/financial/overview
Version: 1.0.0
Security: apiKey

## Query parameters:

  - `clientId` (string)
    (required) – The common ID between Voosh and the partner, used to identify the client.
    Example: "604517c0-fae8-41b7-8c20-0fe4778e415c"

## Header parameters:

  - `access-token` (string)
    (required) – The unique token ID provided to the partner for authentication and secure data access.
    Example: "{{access-token}}"

## Request fields (application/json):

  - `channel` (array)
    Example: ["DOORDASH","UBEREATS","GRUBHUB","EZCATER"]

  - `endDate` (string)
    Example: "2025-03-25"

  - `listingIds` (array)
    Example: ["P5441","P5461","P5471","P5481","P5491","P5501","P5511","P5531","P5541","P5551","P5561","P5571","P5581","P8191"]

  - `payoutDates` (array)
    Example: []

  - `startDate` (string)
    Example: "2025-02-23"

## Response 400 fields (application/json):

  - `error` (string)
    Example: "Bad Request"

  - `message` (string)
    Example: "client id is required"

  - `status` (boolean)

  - `statusCode` (number)
    Example: 400

## Response 401 fields (application/json):

  - `error` (string)
    Example: "Unauthorized"

  - `message` (string)
    Example: "Unauthorized, token is required"

  - `status` (boolean)

  - `statusCode` (number)
    Example: 401