JUjustifi
Reports

Create a report

Create a report for any of the available report types

post/reports

Request

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Request body

OR
OR
OR
OR

Example request

{
  "start_date": "2025-12-25",
  "end_date": "2025-12-30",
  "nickname": "My Report"
}

Response

Report was queued successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "report",
  "data": {
    "id": "rpt_xyz",
    "report_type": "proceeds",
    "nickname": "My Report",
    "status": "scheduled",
    "scheduled_at": "2025-12-25T14:44:45.026Z",
    "run_at": "2025-12-30T14:44:45.026Z",
    "created_at": "2025-12-31T14:44:45.026Z",
    "account_id": "acc_xyz",
    "platform_account_id": "acc_xyz",
    "parameters": {
      "start_date": "2025-12-25",
      "end_date": "2025-12-30",
      "nickname": "My Report",
      "account_id": "acc_xyz",
      "platform_account_id": "acc_xyz"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.