AKakahu
Applications

Create application

post/v1/applications

Request

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

Request body

referencestring required

A value used to identify the application in a way that makes sense to the creator.

For some this may include the applicant names, for others it may be a unique reference from their CRM.

It does not need to be unique.

report_type'standard' | 'income'

If report_type is omitted, the application uses your organisation's default report type.

Response

Success

_idstring required
referencestring required

A value used to identify the application in a way that makes sense to the creator.

For some this may include the applicant names, for others it may be a unique reference from their CRM.

It does not need to be unique.

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'active' | 'archived' required
last_applicant_submission_atstring date-time

The date of the last submission by an applicant from a sharing request.

archived_atstring date-time

If this application has been archived, the date that it happened.

created_atstring date-time required

The date this application was created.

updated_atstring date-time required

The date this application was last updated.

Example response

{
  "_id": "application_tz4a98xxat96iws9zmbrgj3a"
}

Changes

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