---
title: "Get Order Financials"
method: GET
path: "/orders/financial"
tags: ["Orders API"]
---

# Get Order Financials

`GET /orders/financial`

This endpoint retrieves orders with financial details

#### Request

- Method: GET
    
- URL: {{base-url}}/orders/financial
    
- Query Parameters:
    
    - limit (integer, optional): The maximum number of financial orders to retrieve.
        
    - offset (integer, optional): The offset for pagination.
        
    - clientId (string, required): The unique identifier of the client.
        
- { "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "listingIds": \["string"\], "channel": \["string"\] }
    
    - startDate (string): The start date for filtering financial orders.
        
    - endDate (string): The end date for filtering financial orders.
        
    - listingIds (array of strings): The listing IDs to filter financial orders by.
        
    - channel (array of strings): The channels to filter financial orders by.
        

#### Response

The response is a JSON object with the following schema:

``` json
{
  "status": boolean,
  "statusCode": integer,
  "message": string,
  "result": {
    "showDummyData": boolean,
    "ordersData": [
      {
        "listingId": string,
        "deliveryUUID": string,
        "orderId": string,
        "storeId": string,
        "orderDate": string,
        "channel": string,
        "orderStatus": {
          "value": string,
          "isPositive": boolean
        },
        "subTotal": {
          "offPremise": integer
        },
        "deductions": {
          "total": integer,
          "commission": integer,
          "promoValue": integer,
          "deliveryFee": integer,
          "tips": integer,
          "marketingFees": integer,
          "paymentTransactionFee": integer,
          "ezReward": integer,
          "preferredPartnerProgram": integer,
          "deliveryCommission": integer,
          "otherPayments": integer,
          "marketingAdjustments": integer,
          "commissionTax": integer,
          "taxWithHeld": integer,
          "merchantFee": integer
        },
        "tax": integer,
        "difference": {
          "errorCharges": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "adjustments": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "refundByVoosh": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "total": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          }
        },
        "netPayout": {
          "total": integer
        },
        "estimatedPayout": integer,
        "transactions": [
          {
            "transactionId": string,
            "transactionDate": string,
            "payoutId": string,
            "transactionType": string,
            "description": string,
            "netPayout": integer
          }
        ],
        "payoutDiff": string
      }
    ]
  },
  "error": string
}

 ```

## Query parameters

- `limit` string
- `offset` string
- `clientId` string

## Headers

- `access-token` string

## Request body

- object
  - `channel` string[]
  - `endDate` string
  - `listingIds` string[]
  - `startDate` string

## Response `200`

200

- object
  - `error` unknown
  - `message` string
  - `result` object
    - `ordersData` object[]
      - `channel` string
      - `deductions` object
        - `commission` number
        - `commissionTax` number
        - `deliveryCommission` number
        - `deliveryFee` number
        - `ezReward` number
        - `marketingAdjustments` number
        - `marketingFees` number
        - `merchantFee` number
        - `otherPayments` number
        - `paymentTransactionFee` number
        - `preferredPartnerProgram` number
        - `promoValue` number
        - `taxWithHeld` number
        - `tips` number
        - `total` number
      - `deliveryUUID` string
      - `difference` object
        - `adjustments` object
          - `itemTax` number
          - `itemValue` number
          - `total` number
        - `errorCharges` object
          - `itemTax` number
          - `itemValue` number
          - `total` number
        - `refundByVoosh` object
          - `itemTax` number
          - `itemValue` number
          - `total` number
        - `total` object
          - `itemTax` number
          - `itemValue` number
          - `total` number
      - `estimatedPayout` number
      - `listingId` string
      - `netPayout` object
        - `total` number
      - `orderDate` string
      - `orderId` string
      - `orderStatus` object
        - `isPositive` boolean
        - `value` string
      - `payoutDiff` unknown
      - `storeId` string
      - `subTotal` object
        - `offPremise` number
      - `tax` number
      - `transactions` object[]
        - `description` unknown
        - `netPayout` number
        - `payoutId` string
        - `transactionDate` string
        - `transactionId` string
        - `transactionType` string
    - `showDummyData` boolean
  - `status` boolean
  - `statusCode` number

## Other responses

- `400` — 400

---

[API](https://skmtc.net/voosh/apis/voosh-api-documentation.md) · [All operations](https://skmtc.net/voosh/apis/voosh-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voosh/voosh-api-documentation/revisions/d53ba6056960/schema)