{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rillet Accounting API Key Reports API",
    "version": "v4.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves ARR waterfall report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/arr-waterfall",
            "params": [
              {
                "name": "month",
                "value": "",
                "type": "query",
                "description": "The month and year to export. Uses ISO-8061 format (YYYY-MM)."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "whether to include committed or active entries"
              },
              {
                "name": "breakdown",
                "value": "",
                "type": "query",
                "description": "whether annual or monthly breakdowns"
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of rows to return in the page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor to navigate through the full response."
              }
            ]
          },
          "docs": "Returns the ARR waterfall dataset for the requested month with optional breakdown dimensions, subsidiary filters, and pagination cursors for large tenants.\nFinance teams use this to explain beginning ARR, new business, expansion, contraction, and churn between periods.\n"
        },
        {
          "info": {
            "name": "Retrieves trial balance report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/trial-balance",
            "params": [
              {
                "name": "from_date",
                "value": "2024-01-01",
                "type": "query",
                "description": "Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "to_date",
                "value": "2024-01-31",
                "type": "query",
                "description": "End date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              }
            ]
          },
          "docs": "Returns a trial balance report for the specified date range.\nRequired parameters: from_date and to_date (ISO-8601 format YYYY-MM-DD). Both must be provided or the call will fail.\nExample: from_date=2024-01-01, to_date=2024-12-31.\n"
        },
        {
          "info": {
            "name": "Retrieves balance sheet report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/balance-sheet",
            "params": [
              {
                "name": "as_of_date",
                "value": "2024-01-31",
                "type": "query",
                "description": "The date for the point-in-time report. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "breakdown_by",
                "value": "",
                "type": "query",
                "description": "How to break down the report columns. If not specified, returns a single total column."
              }
            ]
          },
          "docs": "Returns a balance sheet report as of the specified date.\nRequired parameter: as_of_date (ISO-8601 format YYYY-MM-DD). Must be provided or the call will fail.\nExample: as_of_date=2024-12-31.\n"
        },
        {
          "info": {
            "name": "Retrieves income statement report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/income-statement",
            "params": [
              {
                "name": "from_date",
                "value": "2024-01-01",
                "type": "query",
                "description": "Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "to_date",
                "value": "2024-01-31",
                "type": "query",
                "description": "End date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "breakdown_by",
                "value": "",
                "type": "query",
                "description": "How to break down the report columns. If not specified, returns a single total column."
              },
              {
                "name": "custom_field_id",
                "value": "",
                "type": "query",
                "description": "The ID of the custom field to break down by. Required when breakdown_by is CUSTOM_FIELD."
              }
            ]
          },
          "docs": "Returns an income statement (profit and loss) report for the specified date range."
        },
        {
          "info": {
            "name": "Retrieves cash flow statement report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/cash-flow-statement",
            "params": [
              {
                "name": "from_date",
                "value": "2024-01-01",
                "type": "query",
                "description": "Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "to_date",
                "value": "2024-01-31",
                "type": "query",
                "description": "End date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "breakdown_by",
                "value": "",
                "type": "query",
                "description": "How to break down the report columns. If not specified, returns a single total column."
              },
              {
                "name": "custom_field_id",
                "value": "",
                "type": "query",
                "description": "The ID of the custom field to break down by. Required when breakdown_by is CUSTOM_FIELD."
              }
            ]
          },
          "docs": "Returns a cash flow statement report for the specified date range."
        },
        {
          "info": {
            "name": "Retrieves executive P&L report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/executive-pl",
            "params": [
              {
                "name": "from_date",
                "value": "2024-01-01",
                "type": "query",
                "description": "Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "to_date",
                "value": "2024-01-31",
                "type": "query",
                "description": "End date for the report period. Uses ISO-8601 format (YYYY-MM-DD)."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "breakdown_by",
                "value": "",
                "type": "query",
                "description": "How to break down the report columns. If not specified, returns a single total column."
              },
              {
                "name": "custom_field_id",
                "value": "",
                "type": "query",
                "description": "The ID of the custom field to break down by. Required when breakdown_by is CUSTOM_FIELD."
              }
            ]
          },
          "docs": "Returns an executive profit and loss report with margins for the specified date range."
        },
        {
          "info": {
            "name": "Lists journal entries with reporting currency amounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rillet.com/reports/journal-entries",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of rows to return in the page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor to navigate through the full response."
              },
              {
                "name": "subsidiary_id",
                "value": "",
                "type": "query",
                "description": "Subsidiary to be used when filtering data"
              },
              {
                "name": "updated.gt",
                "value": "",
                "type": "query",
                "description": "Filter journal entries updated after this timestamp"
              },
              {
                "name": "date.gte",
                "value": "",
                "type": "query",
                "description": "Filter journal entries with a posting date on or after this date (inclusive)"
              },
              {
                "name": "date.lte",
                "value": "",
                "type": "query",
                "description": "Filter journal entries with a posting date on or before this date (inclusive)"
              },
              {
                "name": "account_ids",
                "value": "11111111-1111-1111-1111-111111111111,22222222-2222-2222-2222-222222222222",
                "type": "query",
                "description": "Filter journal entries that have at least one line item posting to any of these account ids (comma-separated)"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "the field the journal entries should be sorted by descending (either created or updated)"
              }
            ]
          },
          "docs": "Returns journal entries with line item amounts converted to the reporting currency."
        }
      ]
    }
  ],
  "bundled": true
}