AKakahu
Reports

Create report

An Akahu Apply report provides an aggregate, enriched view of the data from the application's resources.

The output of a report can be downloaded as an HTML or PDF document for human consumption, or as JSON data for further processing.

Report processing is asynchronous, so you must poll the GET /v1/applications/{applicationId}/reports/{reportId} endpoint until it reaches a final status. The output of a report can only be accessed once it has been assigned a status of completed. For PDF downloads, pdf_status must also be completed.

post/v1/applications/{applicationId}/reports

Request

  • Base URL
    https://api.apply.akahu.nz
  • URL
    https://api.apply.akahu.nz/v1/applications/{applicationId}/reports
  • Auth
    HTTP bearer

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a

Request body

_documentsDocumentId[]

Optionally specify which documents to include in the report. If omitted, all documents in the application will be included.

The provided value must reference a subset of the documents from this application. Documents from other applications cannot be included.

Example request

{
  "_documents": [
    "doc_tz4a98xxat96iws9zmbrgj3a"
  ]
}

Response

Success

_idstring required
report_type'standard' | 'income' required

The type of report generated for an application:

  • standard A full report covering accounts, income, expenses and transactions.

  • income A report focused on income.

status'processing' | 'completed' | 'failed' required

The status of a report:

  • processing This report is currently being synthesized.

  • completed This report has successfully been synthesized and data can now be retrieved from it.

  • failed This report has failed to be synthesized. See failure_reason for more information.

pdf_status'processing' | 'completed' | 'failed'

The PDF generation status. Absent until generation starts; completed when ready to download.

generated_atstring date-time

The date that this report completed synthesis.

expires_atstring date-time required

The date that this report expires. After this date the report will no longer be accessible.

insightsInsightCategoryCode[]

When this report is completed, this field will hold a list of all insights used in this report.

Example response

{
  "_id": "report_tz4a98xxat96iws9zmbrgj3a",
  "resources": [
    {
      "_id": "doc_tz4a98xxat96iws9zmbrgj3a"
    }
  ],
  "spending_categories": [
    {
      "code": "spending:000/useful-name-here"
    }
  ],
  "income_categories": [
    {
      "code": "income:000/useful-name-here"
    }
  ],
  "insights": [
    "insight:000/useful-name-here"
  ]
}

Changes

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