v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Reports

Revenue Report

Generate a Revenue Report

post/v6/reports/revenue

Request body

exportType'JSON' | 'CSV'

Export format for the report

accountingMethod'ACCRUAL' | 'CASH'

Accounting method to generate the report in. Defaults to the company's configured accounting method.

Example request

{
  "filters": {
    "beginDate": "2025-01-01",
    "endDate": "2025-12-31"
  },
  "grouping": {
    "dimensionId": "tdim_439512",
    "column": "CUSTOMER"
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": {
    "json": [
      {
        "name": "East Region",
        "data": [
          {
            "name": "Jan 2025",
            "total": 150000,
            "count": 42,
            "data": [
              {
                "uri": "/v6/bankTransactions/query",
                "filters": {
                  "internal_key": "some_internal_key",
                  "some_other_field": 23434
                }
              }
            ]
          }
        ]
      }
    ],
    "meta": {
      "generatedBy": "John Doe",
      "footerLine": "Generated by Tight"
    }
  }
}