{ "openapi": "3.0.2", "info": { "title": "REPORTING", "version": "3.0.0", "termsOfService": "https://docs.basiq.io/en/collections/440849-privacy-terms-and-common-questions", "license": { "name": "Commercial", "url": "https://basiq.io" } }, "servers": [ { "url": "https://au-api.basiq.io", "description": "Production server" } ], "paths": { "/reports": { "post": { "summary": "Create a report", "operationId": "createreport", "tags": [ "Reports" ], "description": "\nUse this endpoint to create a new report. Report creation is an asynchronous task, meaning a job will be returned to let you know the progress of the report generation.\nYou can poll the job to know when the report has been generated. You can create any supported report (see reportTypes for a list of supported reports). Ensure you provide the necessary filters when generating a report.\nAll created reports, will store a copy of the data as a snapshot - this ensures that you have access to the raw data that was used to create the report.\nThis API allows generating reports with various filters. The `filters` field in the report request enables you to specify parameters for customizing the report content.\n> πŸ“˜ Note: The report title cannot be longer than 50 characters.\n\n> πŸ“˜ **Reminder:** When Enrich data is updated, the transactions' Enrich results won’t automatically reflect these updates. To ensure your report reflects the latest Enrich data, purge and refresh connections before generating a new report.\n\n### Filters \nFilters are used to narrow down the data included in the report. The available filters are:\n- `fromDate`: Specifies the start date for the report data (format: YYYY-MM-DD).\n- `toDate`: Specifies the end date for the report data (format: YYYY-MM-DD).\n- `accounts`: List of account IDs to include in the report.\n- `users`: List of user IDs to include in the report.\n- `includeMetrics`: List of metric codes to include in the report. Supported values are specific to the report type. Rules for `includeMetrics`:\n - If the array is empty (`\"value\": []`), all metrics will be shown.\n - If no filter is provided, all metrics will be shown.\n - If an array of codes is provided, only these specific metrics will be shown.\n - If the value is `null`, no metrics will be shown.\n\n- `includeGroups`: List of group codes to include in the report. Supported values are specific to the report type. Rules for `includeGroups`:\n - If the array is empty (`\"value\": []`), all groups will be shown.\n - If no filter is provided, all groups will be shown.\n - If an array of codes is provided, only these specific groups will be shown.\n - If the value is `null`, no groups will be shown.\n", "requestBody": { "description": "Include the details of the report you would like to create along with the filters.", "required": true, "content": { "application/json": { "schema": { "required": [ "reportType", "title", "filters" ], "properties": { "reportType": { "type": "string", "example": "CON_AFFOR_01" }, "title": { "type": "string", "example": "John Smith Affordability Report 2022-03-26" }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "fromDate" }, "value": { "oneOf": [ { "type": "string", "title": "Object", "format": "date", "example": "2022-01-01", "description": "A single string in YYYY-MM-DD format, used when 'name' is 'fromDate' or 'toDate', 'accounts', or 'users'." }, { "type": "array", "title": "Array", "items": { "type": "string", "format": "date" }, "example": [ "2021-12-01", "2022-01-01" ], "description": "The name of the filter, which determines the type of values expected. Can be 'fromDate', 'toDate', 'accounts', 'users', 'includeMetrics', or 'includeGroups'." }, { "type": "array", "title": "Array", "items": { "type": "string" }, "example": [ "ME002", "ME003", "ME004" ], "description": "Array of metrics or groups to be included in the report. Can be 'includeMetrics' or 'includeGroups'." }, { "type": "string", "title": "Object", "example": null, "description": "Use 'null' to indicate no metrics/groups should be shown." } ] } } } } }, "x-readme-ref-name": "reportRequest" }, "examples": { "CONN_AFFOR_REPORT": { "summary": "For Report type", "value": { "reportType": "CON_AFFOR_01", "title": "John Smith Affordability Report 2022-03-26", "filters": [ { "name": "fromDate", "value": "2022-01-01" }, { "name": "toDate", "value": "2023-01-01" }, { "name": "accounts", "value": [ "ag829sj", "aj82gka" ] }, { "name": "users", "value": [ "272af9fa-0f4a-44dc-bf88-a63bec2d0662" ] }, { "name": "includeMetrics", "value": [ "ME002", "ME003", "ME004" ] }, { "name": "includeGroups", "value": [ "INC-001", "INC-002", "EXP-001" ] } ] } }, "STATEMENT": { "summary": "For Statement type", "value": { "reportType": "STATEMENT_01", "title": "Bank Statement 2024-03-20", "filters": [ { "name": "fromDate", "value": "2022-01-01" }, { "name": "toDate", "value": "2023-01-01" }, { "name": "account", "value": "ag829sj" }, { "name": "user", "value": "272af9fa-0f4a-44dc-bf88-a63bec2d0662" } ] } } } } } }, "responses": { "202": { "description": "The server will return link to a job endpoint which can be polled to track the progress of the report creation.\n", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string", "example": "job" }, "id": { "type": "string", "example": "b1824ad0-73f1-0138-3700-0a58a9feac09" }, "links": { "type": "object", "properties": { "self": { "type": "string", "example": "https://au-api.basiq.io/jobs/a3dgf4567a89" } } } }, "x-readme-ref-name": "job" }, "example": { "type": "job", "id": "b1824ad0-73f1-0138-3700-0a58a9feac09", "links": { "self": "https://au-api.basiq.io/jobs/b1824ad0-73f1-0138-3700-0a58a9feac09" } } } } }, "400": { "description": "Returns an error indicating that the server cannot or will not process the request due to something that is perceived to be a client error.\n", "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" }, { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access" }, "title": { "type": "string", "description": "Title of the error", "enum": [ "Connection source not supported.\n", "Invalid users filter. Maximum 5 users allowed.\n", "The following accounts are duplicated: \n['121', '332'], ['232', '949', '433'].\n", "Following user ID(s)/account ID(s) have been entered more than once: \n[\"123\", \"123\"].\n" ] }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "detail": { "type": "string", "description": "Connection source has to be web or open banking." } } } } }, "x-readme-ref-name": "BadRequestErrorforbidden-access" } ] } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } } } } } }, "get": { "summary": "List all reports", "operationId": "listallreports", "tags": [ "Reports" ], "description": "\nUse this endpoint to retrieve a list of created reports. Every created report is saved as a snapshot and can be retrieved up to 24 hours after creation.You can call the reports/types endpoint to see the list of supported reports. reports.\n", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "count": { "type": "integer", "description": "Count of items in the response.", "example": 500 }, "size": { "type": "integer", "description": "Size of the pages in the response." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "report" }, "id": { "type": "string", "example": "b1824ad0-73f1-0138-3700-0a58a9feac09" }, "title": { "type": "string", "example": "John Smith Affordability Report 2022-03-26" }, "reportType": { "type": "string", "example": "affordability-consumer" }, "createdDate": { "type": "string", "example": "2022-03-26T06:56:44.000Z" }, "expiresAt": { "type": "string", "example": "2023-03-26T06:56:44.000Z" }, "createdBy": { "type": "string", "example": "David Smith" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "value": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "format": "date", "example": "2022-01-01T00:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "self": { "type": "string", "example": "https://au-api.basiq.io/reports/51cef931-81f2-4639-af74-b0ced85083c8" } } } }, "x-readme-ref-name": "reportSummary" } }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "Self reference URL.", "example": "https://au-api.basiq.io/users/6a52015e/transactions" }, "next": { "type": "string", "description": "Url to next result.", "example": "https://au-api.basiq.io/users/6a52015e/transactions?next=bf1ec9d4" } } } }, "x-readme-ref-name": "collection" }, "example": { "type": "list", "count": 2, "size": 2, "data": [ { "type": "report", "id": "b1824ad0-73f1-0138-3700-0a58a9feac09", "title": "John Smith Affordability Report 2022-03-26", "reportType": "CON_AFFOR_01", "createdDate": "2022-03-26T06:56:44", "createdBy": "David Smith", "expiresAt": "2022-12-25T06:56:44", "filters": [ { "name": "fromDate", "value": "2022-01-01" }, { "name": "toDate", "value": "2022-12-01" }, { "name": "accounts", "value": [ "ag829sj", "aj82gka" ] }, { "name": "users", "value": [ "sj29sjd" ] } ], "links": { "self": "https://au-api.basiq.io/reports/b1824ad0-73f1-0138-3700-0a58a9feac09" } }, { "type": "report", "id": "a2a17e84-460c-43f4-9c94-1398a5b4c148", "title": "Statements", "reportType": "STATEMENT_01", "createdDate": "2024-03-21T23:51:37Z", "expiresAt": "2024-04-04T23:51:37Z", "createdBy": "Basiq", "filters": [ { "name": "fromDate", "value": "2023-03-01" }, { "name": "toDate", "value": "2024-03-21" }, { "name": "account", "value": "ag829sj" }, { "name": "user", "value": "sj29sjd" } ], "links": { "self": "https://au-api.basiq.io/reports/a2a17e84-460c-43f4-9c94-1398a5b4c148" } } ], "links": { "self": "https://au-api.basiq.io/reports", "next": "https://au-api.basiq.io/reports?next=bf1ec9d4" } } } } }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } } } } }, "/reports/{id}": { "summary": "", "description": "", "get": { "summary": "Retrieve a report", "operationId": "retrieveReport", "tags": [ "Reports" ], "description": "Use this endpoint to retrieve a specific report. Ensure you check the\ndocumentation for the schema of each report type.\n\n| Request Header | Description | \n|----------------|-----------------------------------------------------------------------------|\n| Accept | Specifies the format of the response. Use `application/pdf` | \n\nIf you want to generate the PDF, make sure to change `accept`\nin the CURL request to `application/pdf` for PDF generation.\n", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "The ID of the generated report" } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "report" }, "id": { "type": "string", "format": "uuid", "example": "a2a17e84-460c-43f4-9c94-1398a5b4c148" }, "title": { "type": "string", "example": "Statements" }, "reportType": { "type": "string", "example": "STATEMENT_01" }, "createdDate": { "type": "string", "format": "date-time", "example": "2024-03-21T23:51:37Z" }, "createdBy": { "type": "string", "example": "Basiq" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "data": { "type": "object", "properties": { "institution": { "type": "object", "properties": { "logo": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" } }, "required": [ "logo", "name" ] }, "identity": { "type": "object", "properties": { "customerType": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "DOB": { "type": "string", "format": "date" }, "occupationCode": { "type": "string" }, "occupationCodeVersion": { "type": "string" }, "phoneNumbers": { "type": "array", "items": { "type": "string", "format": "phone" } }, "emails": { "type": "array", "items": { "type": "string", "format": "email" } }, "agentName": { "type": "string" }, "agentFirstName": { "type": "string" }, "agentLastName": { "type": "string" }, "agentRole": { "type": "string" }, "businessName": { "type": "string" }, "legalName": { "type": "string" }, "shortName": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "physicalAddresses": { "type": "array", "items": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "postCode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" } } } } }, "required": [ "customerType", "fullName", "phoneNumbers", "emails", "physicalAddresses" ] }, "accreditation": { "type": "object", "properties": { "cdrAccessModel": { "type": "string" }, "entityName": { "type": "string" }, "title": { "type": "string" }, "licenceNo": { "type": "string" }, "description": { "type": "string" } }, "required": [ "cdrAccessModel", "entityName", "title", "licenceNo", "description" ] }, "account": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "creationDate": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "name": { "type": "string" }, "maskedNumber": { "type": "string" }, "accountNo": { "type": "string" }, "accountHolder": { "type": "string" }, "isOwned": { "type": "boolean" }, "accountOwnership": { "type": "string" }, "balance": { "type": "string" }, "availableFunds": { "type": "string" }, "currency": { "type": "string" }, "class": { "type": "object", "properties": { "type": { "type": "string" }, "product": { "type": "string" } } }, "connection": { "type": "string" }, "institution": { "type": "string" }, "meta": { "type": "object", "properties": { "fees": { "type": "object" }, "depositRates": { "type": "object" }, "lendingRates": { "type": "object" }, "features": { "type": "object" }, "termDeposit": { "type": "object" }, "loan": { "type": "object" }, "creditCard": { "type": "object" }, "addresses": { "type": "object" } } }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "transactions": { "type": "string" }, "institution": { "type": "string" } } } } }, "required": [ "type", "id", "lastUpdated", "status", "name", "maskedNumber", "accountNo", "accountHolder", "isOwned", "accountOwnership", "balance", "availableFunds", "currency", "class", "connection", "institution", "meta", "links" ] }, "transactions": { "type": "string", "format": "uri" } } } }, "required": [ "type", "id", "title", "reportType", "createdDate", "createdBy", "filters", "data", "links" ], "x-readme-ref-name": "STATEMENT" } }, "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the report" }, "id": { "type": "string", "description": "Unique identifier for the report" }, "title": { "type": "string", "description": "Title of the report" }, "reportType": { "type": "string", "description": "Type of the report" }, "createdDate": { "type": "string", "format": "date-time", "description": "Date and time when the report was created" }, "createdBy": { "type": "string", "description": "Creator of the report" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the filter" }, "value": { "oneOf": [ { "type": "array" }, { "type": "string", "description": "Value of the filter" } ] } } } }, "data": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the metric" }, "title": { "type": "string", "description": "Title of the metric" }, "description": { "type": "string", "description": "Description of the metric" }, "sections": { "type": "array", "items": { "type": "string", "description": "Sections related to the metric" } }, "result": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "integer", "description": "Value of the metric" } ] }, "format": { "type": "string", "description": "Format of the metric value" } } } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the group" }, "title": { "type": "string", "description": "Title of the group" }, "sections": { "type": "array", "items": { "type": "string", "description": "Sections related to the group" } }, "analysis": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "transactionCount": { "type": "integer", "description": "Total number of transactions in the group" }, "overallPercentage": { "type": "object", "properties": { "credit": { "type": "number", "description": "Percentage of credit transactions" }, "debit": { "type": "number", "description": "Percentage of debit transactions" } } } } }, "range": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "Start date of the analysis range" }, "endDate": { "type": "string", "format": "date", "description": "End date of the analysis range" }, "duration": { "type": "integer", "description": "Duration of the analysis range in days" } } }, "amount": { "type": "object", "properties": { "total": { "type": "string", "description": "Total amount for the group" }, "min": { "type": "string", "description": "Minimum amount for the group" }, "max": { "type": "string", "description": "Maximum amount for the group" }, "average": { "type": "object", "properties": { "transaction": { "type": "string", "description": "Average transaction amount" }, "month": { "type": "string", "description": "Average monthly amount" }, "medianTransaction": { "type": "string", "description": "Median transaction amount" }, "medianMonth": { "type": "string", "description": "Median monthly amount" }, "ongoingMonth": { "type": "string", "description": "Ongoing month's average amount" } } }, "stableMonths": { "type": "integer", "description": "Number of stable months" }, "secureMonths": { "type": "integer", "description": "Number of secure months" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "description": "Frequency type" }, "amount": { "type": "string", "description": "Frequency amount" }, "display": { "type": "string", "description": "Display name of the frequency" }, "next": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Next frequency date" }, "amount": { "type": "string", "description": "Next frequency amount" } } } } } } }, "subgroup": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the subgroup" }, "name": { "type": "string", "description": "Name of the subgroup" }, "analysis": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "transactionCount": { "type": "integer", "description": "Total number of transactions in the subgroup" }, "overallPercentage": { "type": "object", "properties": { "credit": { "type": "number", "description": "Percentage of credit transactions" }, "debit": { "type": "number", "description": "Percentage of debit transactions" } } } } }, "range": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "Start date of the analysis range" }, "endDate": { "type": "string", "format": "date", "description": "End date of the analysis range" }, "duration": { "type": "integer", "description": "Duration of the analysis range in days" } } }, "amount": { "type": "object", "properties": { "total": { "type": "string", "description": "Total amount for the subgroup" }, "min": { "type": "string", "description": "Minimum amount for the subgroup" }, "max": { "type": "string", "description": "Maximum amount for the subgroup" }, "average": { "type": "object", "properties": { "transaction": { "type": "string", "description": "Average transaction amount" }, "month": { "type": "string", "description": "Average monthly amount" }, "medianTransaction": { "type": "string", "description": "Median transaction amount" }, "medianMonth": { "type": "string", "description": "Median monthly amount" }, "ongoingMonth": { "type": "string", "description": "Ongoing month's average amount" } } }, "stableMonths": { "type": "integer", "description": "Number of stable months" }, "secureMonths": { "type": "integer", "description": "Number of secure months" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "description": "Frequency type" }, "amount": { "type": "string", "description": "Frequency amount" }, "display": { "type": "string", "description": "Display name of the frequency" }, "next": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Next frequency date" }, "amount": { "type": "string", "description": "Next frequency amount" } } } } } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the transaction" }, "date": { "type": "string", "format": "date", "description": "Date of the transaction" }, "description": { "type": "string", "description": "Description of the transaction" }, "amount": { "type": "string", "description": "Amount of the transaction" } } } } } } } } } }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the account" }, "accountNo": { "type": "string", "description": "Account number" }, "name": { "type": "string", "description": "Name of the account" }, "currency": { "type": "string", "description": "Currency of the account" }, "balance": { "type": "string", "description": "Current balance of the account" }, "availableFunds": { "type": "string", "description": "Available funds in the account" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Date and time when the account was last updated" }, "institution": { "type": "string", "description": "Institution of the account" }, "class": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the account class" }, "product": { "type": "string", "description": "Product of the account class" } } }, "transactionIntervals": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "format": "date", "description": "Start date of the transaction interval" }, "to": { "type": "string", "format": "date", "description": "End date of the transaction interval" } } } }, "accountHolder": { "type": "string", "description": "Holder of the account" }, "accountOwnership": { "type": "string", "description": "Ownership status of the account" }, "connection": { "type": "string", "description": "connectionID of that account" }, "status": { "type": "string", "description": "Status of the account" }, "creditLimit": { "type": "string", "description": "Credit limit of the account" }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "Link to retrieve the account details" }, "transactions": { "type": "string", "description": "Link to retrieve the transactions for the account" }, "institution": { "type": "string", "description": "Link to retrieve the institution details" } } } } } } } }, "transactions": { "type": "string", "description": "Link to retrieve the transactions for the account" }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "link of report" } } } }, "x-readme-ref-name": "Conn_Affor_Report" }, "example": { "type": "report", "id": "b1824ad0-73f1-0138-3700-0a58a9feac09", "title": "John Smith Affordability Report 2022-03-26", "reportType": "CON_AFFOR_01", "createdDate": "2022-03-26T06:56:44", "createdBy": "David Smith", "filters": [ { "name": "fromDate", "value": "2022-01-01" }, { "name": "toDate", "value": "2022-12-01" }, { "name": "accounts", "value": [ "ag829sj", "aj82gka" ] }, { "name": "users", "value": [ "272af9fa-0f4a-44dc-bf88-a63bec2d0662" ] } ], "data": { "metrics": [ { "id": "ME001", "title": "# OF IDENTIFIED SALARY SOURCES", "description": "Number of recent salary income sources", "sections": [ "Income Sources" ], "result": { "value": "4", "format": "integer" } }, { "id": "ME002", "title": "Average monthly amount from salary", "description": "Mean monthly amount from salary income sources over the reporting period", "sections": [ "Income Sources" ], "result": { "value": "7228.00", "format": "money" } }, { "id": "ME004", "title": "OTHER POSSIBLE INCOME MONTHLY", "description": "Mean monthly income from sources not covered within Salary and Benefits", "sections": [ "Income Sources" ], "result": { "value": "266.00", "format": "money" } }, { "id": "ME005", "title": "Youth Allowance monthly", "description": "Mean monthly income from Youth Allowance", "sections": [ "Government Services" ], "result": { "value": "125.00", "format": "money" } }, { "id": "ME006", "title": "Rental Assistance monthly", "description": "Mean monthly income from Rental Assistance", "sections": [ "Government Services" ], "result": { "value": "0.00", "format": "money" } }, { "id": "ME007", "title": "Misc Government services monthly", "description": "Mean monthly income through government benefits other than Rental Assistance and Youth Allowance", "sections": [ "Government Services" ], "result": { "value": "488.00", "format": "money" } }, { "id": "ME008", "title": "Average monthly amount", "description": "Mean monthly repayments to lenders", "sections": [ "Financial Commitments" ], "result": { "value": "-2553.00", "format": "money" } }, { "id": "ME009", "title": "# of identified companies", "description": "Number of relationships with lending merchants", "sections": [ "Financial Commitments" ], "result": { "value": "8", "format": "integer" } }, { "id": "ME010", "title": "Total credit card limit", "description": "Total limits on available credit card accounts", "sections": [ "Financial Commitments" ], "result": { "value": "5000.00", "format": "money" } }, { "id": "ME011", "title": "Total credit card balance", "description": "Total of latest available balances on available credit card accounts", "sections": [ "Financial Commitments" ], "result": { "value": "-2625.00", "format": "money" } }, { "id": "ME012", "title": "Monthly spend on non-discretionary expenses (inc. liabilities)", "description": "Mean monthly spend on non-discretionary expenses", "sections": [ "Expenses" ], "result": { "value": "-3851.00", "format": "money" } }, { "id": "ME013", "title": "% of spend on non-discretionary expenses", "description": "Mean monthly spend on non-discretionary expenses as a percentage of total expenses", "sections": [ "Expenses" ], "result": { "value": "26.2", "format": "percent" } }, { "id": "ME014", "title": "Mean monthly spend on discretionary expenses", "description": "Mean monthly spend on discretionary expenses", "sections": [ "Expenses" ], "result": { "value": "-2632.00", "format": "money" } }, { "id": "ME015", "title": "% of spend on discretionary expenses", "description": "Mean monthly spend on discretionary expenses as a percentage of total expenses", "sections": [ "Expenses" ], "result": { "value": "53.1", "format": "percent" } }, { "id": "ME016", "title": "Monthly spend on other expenses", "description": "Mean monthly spend on other expenses", "sections": [ "Expenses" ], "result": { "value": "-1054.00", "format": "money" } }, { "id": "ME017", "title": "# of SACC loans", "description": "Number of relationships with SACC lenders", "sections": [ "Risk Metrics" ], "result": { "value": "3", "format": "integer" } }, { "id": "ME018", "title": "% OF SALARY INCOME WITHDRAWN VIA ATM", "description": "Percentage of salary income withdrawn as cash at ATM's over the reporting period", "sections": [ "Risk Metrics" ], "result": { "value": "6.1", "format": "percent" } }, { "id": "ME019", "title": "# of financial dishonours", "description": "Number of financial dishonour transactions detected during reporting period", "sections": [ "Risk Metrics" ], "result": { "value": "3", "format": "integer" } }, { "id": "ME020", "title": "% of income spent on High Risk Activities", "description": "Percentage of salary income withdrawn at ATM's (including from credit cards), spent on gambling and credit card interest, and withdrawn via redraws", "sections": [ "Risk Metrics" ], "result": { "value": "12.4", "format": "percent" } }, { "id": "ME021", "title": "Total spend on High Risk Activities", "description": "Total withdrawn at ATM's (including from credit cards), spent on gambling and credit card interest, and withdrawn via redraws during reporting period", "sections": [ "Risk Metrics" ], "result": { "value": "-3690.00", "format": "money" } }, { "id": "ME022", "title": "Has recent changes to income circumstances", "description": "Indicates new income source in 2 months before end of reporting period or income source stopping in 2 months prior to end of reporting period", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME023", "title": "Has received crisis support payments", "description": "Indicates if any crisis support income has been received during reporting period", "sections": [ "Risk Flags" ], "result": { "value": "false", "format": "boolean" } }, { "id": "ME024", "title": "Has superannuation credits", "description": "Indicates if any superannuation income has been received during reporting period", "sections": [ "Risk Flags" ], "result": { "value": "false", "format": "boolean" } }, { "id": "ME025", "title": "Has cash advances", "description": "Indicates cash withdrawals from credit card accounts during reporting period", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME026", "title": "Has redraws", "description": "Indicates transfers from mortgage accounts during reporting period", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME027", "title": "Has High-Cost Finance", "description": "Indicates repayments (during reporting period) to lenders that may charge high interest rates", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME031", "title": "Has Unemployment Benefit", "description": "Indicates if Jobseeker payments have been received", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME028", "title": "Missing non-discretionary expenses: groceries", "description": "no instances of non-discretionary expenses: groceries detected", "sections": [ "Risk Flags" ], "result": { "value": "false", "format": "boolean" } }, { "id": "ME032", "title": "Receives Child Support", "description": "Indicates if child support payments have been detected", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME029", "title": "Missing non-discretionary expenses: telecommunication", "description": "no instances of non-discretionary expenses: telecommunication detected", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME030", "title": "Missing non-discretionary expenses: utilities", "description": "no instances of non-discretionary expenses: utilities detected", "sections": [ "Risk Flags" ], "result": { "value": "false", "format": "boolean" } }, { "id": "ME033", "title": "Average Income monthly", "description": "Mean monthly total income excluding benefits, tax, insurance, superannuation credits", "sections": [ "Income Sources" ], "result": { "value": "125.00", "format": "money" } }, { "id": "ME034", "title": "Average Outgoings monthly", "description": "Mean monthly total outgoings", "sections": [ "Expenses" ], "result": { "value": "-325.00", "format": "money" } }, { "id": "ME035", "title": "Total Income has been stable for (months)", "description": "Number of months within report over which total income has been stable", "sections": [ "Expenses" ], "result": { "value": "-325.00", "format": "money" } }, { "id": "ME036", "title": "Median monthly amount from Salary", "description": "Median of the monthly sum of transaction amounts for all transactions in Group INC009", "sections": [ "Income Sources" ], "result": { "value": "8000.00", "format": "integer" } }, { "id": "ME037", "title": "Median Income monthly", "description": "Sum of the individual group medians for all INC groups used in Metric ME033", "sections": [ "Income Sources" ], "result": { "value": "10812.95", "format": "money" } }, { "id": "ME039", "title": "Average Outgoings Excluding Liabilities", "description": "Mean monthly total outgoings excluding liability payments", "sections": [ "Expenses" ], "result": { "value": "-300", "format": "integer" } }, { "id": "ME040", "title": "Average Monthly Credits", "description": "Mean monthly credits excluding internal transfers", "sections": [ "Expenses" ], "result": { "value": "0.01", "format": "money" } }, { "id": "ME041", "title": "Average Monthly Debits", "description": "Mean monthly debits excluding internal transfers", "sections": [ "Expenses" ], "result": { "value": "-300", "format": "money" } }, { "id": "ME042", "title": "# of recent income sources", "description": "Number of recent income sources across all income groups", "sections": [ "Income" ], "result": { "value": 0, "format": "money" } }, { "id": "ME043", "title": "# of ongoing regular income sources", "description": "Number of recent income sources across all income groups where an income frequency has been detected", "sections": [ "Income" ], "result": { "value": 0, "format": "money" } }, { "id": "ME046", "title": "Average monthly ongoing amount to lenders", "description": "Ongoing monthly repayments to lenders", "sections": [ "Risk Metrics" ], "result": { "value": 0, "format": "money" } }, { "id": "ME047", "title": "HAS UNSHARED MORTGAGE ACCOUNT", "description": "Indicates if mortgage payments are detected without a mortgage account having been shared", "sections": [ "Risk Flags" ], "result": { "value": "true", "format": "boolean" } }, { "id": "ME048", "title": "ONGOING MONTHLY MORTGAGE REPAYMENT", "description": "Projected ongoing monthly mortgage repayments", "sections": [ "Financial Commitments" ], "result": { "value": 8344, "format": "money" } } ], "groups": [ { "id": "INC-001", "title": "Benefits", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-002", "title": "Child Support Income", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-003", "title": "Insurance Credits", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-004", "title": "Interest Income", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-005", "title": "Investment Income", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-006", "title": "Other Earnings", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-007", "title": "Other Credits", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-008", "title": "Rent & Board Income", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-009", "title": "Salary", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3 }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-010", "title": "Superannuation Credits", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-012", "title": "Youth Allowance", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-013", "title": "Rental Assistance", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-014", "title": "Centrelink", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-015", "title": "Medicare", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-016", "title": "Jobseeker", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-018", "title": "Pension", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-019", "title": "Carers", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-020", "title": "Education", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "INC-021", "title": "Crisis Support", "sections": [ "Income" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "300.00", "min": "100.00", "max": "100.00", "average": { "transaction": "100.00", "month": "100.00", "medianTransaction": "20.00", "medianMonth": "20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "100.00" } ] } ] }, { "id": "EXP-002", "title": "Automotive", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-004", "title": "Children's Retail", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-007", "title": "Department Stores", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-008", "title": "Dining Out", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-010", "title": "Donations", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-012", "title": "Entertainment", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-014", "title": "Gambling", "sections": [ "Discretionary Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-015", "title": "Government & Council Services", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-017", "title": "Gyms and memberships", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-018", "title": "Medical", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-019", "title": "Home Improvement", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-024", "title": "Online Retail", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-027", "title": "Personal Care", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-028", "title": "Pet Care", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-031", "title": "Retail", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-034", "title": "Subscription Services", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-035", "title": "Subscription Media", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-038", "title": "Travel", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-039", "title": "Uncategorised Debits", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-041", "title": "Vehicle and Transport", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-011", "title": "Education and Childcare", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-016", "title": "Groceries", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-021", "title": "Insurance", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-030", "title": "Rent", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-036", "title": "Telecommunication", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-040", "title": "Utilities", "sections": [ "Non-Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-003", "title": "Cash Advances", "sections": [ "Other Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-009", "title": "Dishonours", "sections": [ "Other Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-013", "title": "External Transfers", "sections": [ "Other Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-032", "title": "Returns & Refunds", "sections": [ "Other Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-037", "title": "Third Party Payment Providers", "sections": [ "Other Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-001", "title": "ATM Withdrawals", "sections": [ "Other Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-006", "title": "Debt Interest Accrual", "sections": [ "Other Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-029", "title": "Redraws", "sections": [ "Other Expenses", "High Risk Activities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-005", "title": "Collection Agencies", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-020", "title": "Insolvency", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-023", "title": "Motor Finance", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-025", "title": "Other Finance", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-026", "title": "Peer to Peer Finance", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-033", "title": "Small Amount Lending", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-051", "title": "Alcohol and Tobacco", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-052", "title": "Sports and Hobbies", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-054", "title": "Other Categorised", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-055", "title": "Clothing and Footwear", "sections": [ "Discretionary Expenses" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-056", "title": "Mortgage Repayments", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-057", "title": "Loan Repayments", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-058", "title": "Mortgage Transfers", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 2, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-061", "title": "Credit Card Repayments", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-062", "title": "Credit Card Transfers", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] }, { "id": "EXP-063", "title": "Loan Transfers", "sections": [ "Liabilities" ], "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00", "ongoingMonth": "0.00" }, "stableMonths": 1, "secureMonths": 0 }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "subgroup": [ { "id": "6d97ec2e37e4d1d24a105bdaea33b427", "name": "SAMPLE TRANSACTION", "analysis": { "summary": { "transactionCount": 3, "overallPercentage": { "credit": 0, "debit": 0 } }, "range": { "startDate": "2022-01-01", "endDate": "2022-03-01", "duration": 59 }, "amount": { "total": "-300.00", "min": "-100.00", "max": "-100.00", "average": { "transaction": "-100.00", "month": "-100.00", "medianTransaction": "-20.00", "medianMonth": "-20.00" } }, "frequency": { "type": "P1M", "amount": "-100.00", "display": "Monthly", "next": { "date": "2022-04-01", "amount": "-100.00" } } }, "transactions": [ { "id": "59018149cab77cd2ab7df477f6760cc9", "date": "2022-01-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "01aae7dd1e6ace6bb3d31bc4ada58bb5", "date": "2022-02-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" }, { "id": "ad775e551f8f66b8fe693071cd024cef", "date": "2022-03-01T00:00:00Z", "description": "SAMPLE TRANSACTION 0000023", "amount": "-100.00" } ] } ] } ], "accounts": [ { "id": "271f2f4b-243e-4ebb-b598-639ff8fee4c8", "accountNo": "600000-157441965", "name": "Master Savings", "currency": "AUD", "balance": "356.50", "availableFunds": "420.28", "lastUpdated": "2023-01-19T13:00:00Z", "institution": "AU00000", "class": { "type": "savings", "product": "saver" }, "transactionIntervals": [ { "from": "2020-12-31", "to": "2022-02-20" } ], "accountHolder": "GAVIN BELSON", "accountOwnership": "UNKNOWN", "status": "available", "creditLimit": "0.00", "links": { "self": "/users/6a52015e/accounts/31eb30a0", "transactions": "/users/6a52015e/transactions?filter=account.id.eq('31eb30a0')", "institution": "/institutions/AU00000" } }, { "id": "a6e4dc76-03e0-46e9-9fb3-04b6623b3392", "accountNo": "600000-9292938", "name": "My Credit Card", "currency": "AUD", "balance": "890.50", "availableFunds": "716.50", "lastUpdated": "2022-02-19T12:00:00Z", "institution": "AU00000", "class": { "type": "credit-card", "product": "Shopper Plus CC" }, "transactionIntervals": [ { "from": "2020-12-31", "to": "2022-02-20" } ], "accountHolder": "GAVIN BELSON", "accountOwnership": "UNKNOWN", "connection": "a59e4077-2626-45f2-ae5a-39ea7ffbf51a", "status": "available", "creditLimit": "2000.00", "links": { "self": "/users/6a52015e/accounts/31eb30a0", "transactions": "/users/6a52015e/transactions?filter=account.id.eq('31eb30a0')", "institution": "/institutions/AU00000" } } ], "transactions": "https://au-api.basiq.io/reports/51cef931-81f2-4639-af74-b0ced85083c8/transactions?next=2f889b75-8fee-490e-a075-65a6b9527784" }, "links": { "self": "https://au-api.basiq.io/reports/51cef931-81f2-4639-af74-b0ced85083c8" } } } } }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } } } } } }, "delete": { "tags": [ "Reports" ], "summary": "Delete a report", "operationId": "deleteReport", "description": "\nPermanently deletes a report and all associated snapshot data.\n", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "The ID of the generated report" } ], "responses": { "204": { "description": "Deletion succeeded.", "content": {} }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } } } } } } }, "/reports/{reportId}/transactions": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Report transactions", "operationId": "retrieveReportTransactions", "description": "Retrieve transactions belonging to the report identified by {reportId}.", "parameters": [ { "in": "path", "name": "reportId", "schema": { "type": "string" }, "required": true, "description": "The ID of the generated report" }, { "in": "query", "name": "filter", "description": "- account.id.eq('15a28893-e8c9-4441-a076-470195218738')\n- transaction.postDate.bt('2022-10-01,2022-10-10')\n- transaction.postDate.(eq|gt|lt|gteq|lteq)('2022-12-03T00:00:00Z')\n- institution.id.eq('AU00001')\n- connection.id.eq('12857a4c-931d-4a5a-ab74-399dafb03bfe')\n- transaction.id.eq('14198297-b3b5-415c-b6ad-8a14476ef61c')\n- transaction.direction.eq('credit')\n- transaction.class.eq('transfer')\n- transaction.status.eq('posted')\n\nTransactions can be filtered based on date & datetime.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list with a data property that contains an array of transactions. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. ", "content": { "application/json": { "schema": { "title": "Transactions container object.", "required": [ "size", "count", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Value is \"list\".", "example": "list" }, "count": { "type": "integer", "description": "Count of the transactions in the response.", "format": "int64", "example": 500 }, "size": { "type": "integer", "description": "Size of the transactions in the response.", "format": "int64", "example": 2000 }, "data": { "type": "array", "items": { "required": [ "account", "amount", "balance", "class", "connection", "description", "direction", "enrich", "id", "institution", "links", "postDate", "status", "transactionDate", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Value is \"transaction\".", "example": "transaction" }, "id": { "type": "string", "description": "Uniquely identifies the transaction for this connection. Note that when a connection is refreshed pending transactions will receive new id's, whilst posted transactions will receive the same id's as before the refresh.", "example": "d3de1ca1" }, "account": { "type": "string", "description": "The id of the account resource the transaction belongs to.", "example": "d3de1ca1" }, "amount": { "type": "string", "description": "Transaction amount. Outgoing funds are expressed as negative values.", "example": "123.12" }, "balance": { "type": "string", "description": "Value of the account balance at time the transaction was completed.", "example": "123.12" }, "class": { "type": "string", "description": "Describes the class(type) of transaction.", "example": "payment", "enum": [ "bank-fee", "payment", "cash-withdrawal", "transfer", "loan-interest", "refund", "direct-credit", "interest", "loan-repayment" ] }, "connection": { "type": "string", "description": "The id of the connection resource that was used to retrieve the transaction.", "example": "d3de1ca1" }, "description": { "type": "string", "description": "The transaction description as submitted by the institution.." }, "direction": { "type": "string", "description": "Identifies if the transaction is of debit or credit type.", "example": "debit", "enum": [ "debit", "credit" ] }, "enrich": { "required": [ "cleanDescription", "tags", "category", "location", "merchant" ], "type": "object", "properties": { "cleanDescription": { "type": "string", "description": "", "x-readme-ref-name": "TransactionscleanDescription" }, "tags": { "type": "object", "x-readme-ref-name": "Transactionstags" }, "category": { "type": "object", "properties": { "anzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" } }, "x-readme-ref-name": "TransactionsCategory" }, "location": { "type": "object", "properties": { "country": { "type": "string", "description": "Country", "example": "Australia" }, "formattedAddress": { "type": "string", "description": "Address", "example": "1/39 E Esplanade, Manly NSW 2095" }, "geometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "2095" }, "route": { "type": "string", "description": "Route Name", "example": "E Esplanade" }, "routeNo": { "type": "string", "description": "Route Number", "example": "29" }, "state": { "type": "string", "description": "State", "example": "NSW" }, "suburb": { "type": "string", "description": "Suburb", "example": "Manly" } }, "x-readme-ref-name": "TransactionsLocation" }, "merchant": { "required": [ "id", "businessName", "ABN", "website", "logoMaster", "logoThumb" ], "type": "object", "properties": { "id": { "type": "string", "description": "id", "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8" }, "businessName": { "type": "string", "description": "Merchant name", "example": "Garfish Manly" }, "ABN": { "type": "string", "description": "ABN", "example": 90065628864 }, "logoMaster": { "type": "string", "description": "full merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png" }, "logoThumb": { "type": "string", "description": "thumbnail merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png" }, "phoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "website": { "type": "string", "description": "Merchant Website", "example": "http://garfish.com.au/garfish-manly/" } }, "x-readme-ref-name": "TransactionsMerchant" } }, "x-readme-ref-name": "TransactionsEnrich" }, "institution": { "type": "string", "description": "The id of the institution resource the transaction originated from.", "example": "AU00000" }, "postDate": { "type": "string", "description": "Date the transaction was posted as provided by the institution (this is the same date that appears on a bank statement). This value is null if the record is pending. e.g. \"2017-11-10T21:46:44Z\" or 2017-11-10T00:00:00Z.", "example": "2018-11-02T00:00:00Z" }, "status": { "type": "string", "description": "Identifies if a transaction is pending or posted. A pending transaction is an approved debit or credit transaction that has not been fully processed yet (i.e. has not been posted). Find out more about pending transaction and how to deal with them within your app. Note that pending transactions are not available for all institutions.", "example": "posted", "enum": [ "pending", "posted" ] }, "transactionDate": { "type": "string", "description": "Date that the user executed the transaction as provided by the institution. Note that not all transactions provide this value (varies by institution) e.g. \"2017-11-10T00:00:00Z\"", "example": null } }, "x-readme-ref-name": "TransactionData" } } }, "description": "A transaction object is created whenever money is debited or credited from a particular account.", "x-readme-ref-name": "TransactionsGetResource" } } } }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } } }, "security": [ { "services_token": [] } ] } }, "/reports/types": { "get": { "summary": "List report types", "operationId": "listReportTypes", "tags": [ "Reports" ], "description": "Use this endpoint to retrieve a list of supported reports. This identifies the complete list of supported reports, which can be used to create reports on.\n", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "description": "Report ID." }, "name": { "type": "string", "description": "Name of the report.", "example": "Consumer Affordability Report." }, "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "description": { "type": "string", "description": "In depth consumer affordability assessment." }, "count": { "type": "integer", "description": "Total count of report.", "example": 5 }, "filters": { "type": "array", "description": "filters for reports." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reportType" }, "id": { "type": "string", "example": "CON_AFFOR_01" }, "name": { "type": "string", "example": "Consumer Affordability Report" }, "description": { "type": "string", "example": "In depth consumer affordability assessment." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "type": { "type": "string", "example": "string" }, "required": { "type": "boolean", "example": true } } } } } } } }, "x-readme-ref-name": "reportType" }, "example": { "type": "list", "count": 3, "data": [ { "type": "report", "id": "BUS_AFFOR_01", "name": "Business Affordability Report", "description": "In depth business affordability assessment.", "filters": [ { "name": "fromDate", "type": "string", "required": true }, { "name": "accounts", "type": "array", "required": true }, { "name": "users", "type": "array", "required": true }, { "name": "includeGroups", "type": "array", "required": false }, { "name": "includeMetrics", "type": "array", "required": false } ] }, { "type": "report", "id": "CON_AFFOR_01", "name": "Consumer Affordability Report", "description": "In depth consumer affordability assessment.", "filters": [ { "name": "fromDate", "type": "string", "required": true }, { "name": "toDate", "type": "string", "required": true }, { "name": "accounts", "type": "array", "required": true }, { "name": "users", "type": "array", "required": true }, { "name": "includeGroups", "type": "array", "required": false }, { "name": "includeMetrics", "type": "array", "required": false } ] }, { "type": "report", "id": "STATEMENT_01", "name": "Bank Statement", "description": "Generates a bank statement for a specified account and date range, providing transaction details, balances, and more in a standard format.", "filters": [ { "name": "fromDate", "type": "string", "required": true }, { "name": "account", "type": "string", "required": true }, { "name": "user", "type": "string", "required": true } ] } ] } } } }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } } } } } } }, "/reports/types/{reportTypeId}": { "get": { "summary": "Retrieve a report type", "operationId": "retrieveSpecificReportType", "description": "Retrieve information about a specific report type identified by {reportId}.", "tags": [ "Reports" ], "parameters": [ { "in": "path", "name": "reportTypeId", "schema": { "type": "string" }, "required": true, "description": "The type of the report" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "description": "Report ID." }, "name": { "type": "string", "description": "Name of the report.", "example": "Consumer Affordability Report." }, "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "description": { "type": "string", "description": "In depth consumer affordability assessment." }, "count": { "type": "integer", "description": "Total count of report.", "example": 5 }, "filters": { "type": "array", "description": "filters for reports." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reportType" }, "id": { "type": "string", "example": "CON_AFFOR_01" }, "name": { "type": "string", "example": "Consumer Affordability Report" }, "description": { "type": "string", "example": "In depth consumer affordability assessment." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "type": { "type": "string", "example": "string" }, "required": { "type": "boolean", "example": true } } } } } } } }, "x-readme-ref-name": "reportTypeID" } } } }, "400": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" } } } }, "403": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" } } } }, "404": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" } } } }, "500": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } } } } } } } }, "components": { "responses": { "400BadRequest": { "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "403Forbidden": { "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "404NotFound": { "description": "Returns error indicating that server can't find requested resource.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } }, "500Server": { "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" } } } } }, "schemas": { "STATEMENT": { "type": "object", "properties": { "type": { "type": "string", "example": "report" }, "id": { "type": "string", "format": "uuid", "example": "a2a17e84-460c-43f4-9c94-1398a5b4c148" }, "title": { "type": "string", "example": "Statements" }, "reportType": { "type": "string", "example": "STATEMENT_01" }, "createdDate": { "type": "string", "format": "date-time", "example": "2024-03-21T23:51:37Z" }, "createdBy": { "type": "string", "example": "Basiq" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "data": { "type": "object", "properties": { "institution": { "type": "object", "properties": { "logo": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" } }, "required": [ "logo", "name" ] }, "identity": { "type": "object", "properties": { "customerType": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "DOB": { "type": "string", "format": "date" }, "occupationCode": { "type": "string" }, "occupationCodeVersion": { "type": "string" }, "phoneNumbers": { "type": "array", "items": { "type": "string", "format": "phone" } }, "emails": { "type": "array", "items": { "type": "string", "format": "email" } }, "agentName": { "type": "string" }, "agentFirstName": { "type": "string" }, "agentLastName": { "type": "string" }, "agentRole": { "type": "string" }, "businessName": { "type": "string" }, "legalName": { "type": "string" }, "shortName": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "physicalAddresses": { "type": "array", "items": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "postCode": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" } } } } }, "required": [ "customerType", "fullName", "phoneNumbers", "emails", "physicalAddresses" ] }, "accreditation": { "type": "object", "properties": { "cdrAccessModel": { "type": "string" }, "entityName": { "type": "string" }, "title": { "type": "string" }, "licenceNo": { "type": "string" }, "description": { "type": "string" } }, "required": [ "cdrAccessModel", "entityName", "title", "licenceNo", "description" ] }, "account": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "creationDate": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "name": { "type": "string" }, "maskedNumber": { "type": "string" }, "accountNo": { "type": "string" }, "accountHolder": { "type": "string" }, "isOwned": { "type": "boolean" }, "accountOwnership": { "type": "string" }, "balance": { "type": "string" }, "availableFunds": { "type": "string" }, "currency": { "type": "string" }, "class": { "type": "object", "properties": { "type": { "type": "string" }, "product": { "type": "string" } } }, "connection": { "type": "string" }, "institution": { "type": "string" }, "meta": { "type": "object", "properties": { "fees": { "type": "object" }, "depositRates": { "type": "object" }, "lendingRates": { "type": "object" }, "features": { "type": "object" }, "termDeposit": { "type": "object" }, "loan": { "type": "object" }, "creditCard": { "type": "object" }, "addresses": { "type": "object" } } }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "transactions": { "type": "string" }, "institution": { "type": "string" } } } } }, "required": [ "type", "id", "lastUpdated", "status", "name", "maskedNumber", "accountNo", "accountHolder", "isOwned", "accountOwnership", "balance", "availableFunds", "currency", "class", "connection", "institution", "meta", "links" ] }, "transactions": { "type": "string", "format": "uri" } } } }, "required": [ "type", "id", "title", "reportType", "createdDate", "createdBy", "filters", "data", "links" ], "x-readme-ref-name": "STATEMENT" }, "error": { "required": [ "type", "correlationId", "data" ], "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "code": { "type": "string", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ], "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid" }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "connection/id", "description": "The location to the object or attribute that the error relates to" }, "parameter": { "type": "string", "example": "id", "description": "A string indicating which URI query parameter caused the error." } } } } } } }, "x-readme-ref-name": "error" }, "Source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "NotFoundError": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "resource-not-found", "enum": [ "resource-not-found" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Resource not found." }, "title": { "type": "string", "description": "Title of the error", "example": "Requested resource is not found." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "NotFoundError" }, "TransactionData": { "required": [ "account", "amount", "balance", "class", "connection", "description", "direction", "enrich", "id", "institution", "links", "postDate", "status", "transactionDate", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Value is \"transaction\".", "example": "transaction" }, "id": { "type": "string", "description": "Uniquely identifies the transaction for this connection. Note that when a connection is refreshed pending transactions will receive new id's, whilst posted transactions will receive the same id's as before the refresh.", "example": "d3de1ca1" }, "account": { "type": "string", "description": "The id of the account resource the transaction belongs to.", "example": "d3de1ca1" }, "amount": { "type": "string", "description": "Transaction amount. Outgoing funds are expressed as negative values.", "example": "123.12" }, "balance": { "type": "string", "description": "Value of the account balance at time the transaction was completed.", "example": "123.12" }, "class": { "type": "string", "description": "Describes the class(type) of transaction.", "example": "payment", "enum": [ "bank-fee", "payment", "cash-withdrawal", "transfer", "loan-interest", "refund", "direct-credit", "interest", "loan-repayment" ] }, "connection": { "type": "string", "description": "The id of the connection resource that was used to retrieve the transaction.", "example": "d3de1ca1" }, "description": { "type": "string", "description": "The transaction description as submitted by the institution.." }, "direction": { "type": "string", "description": "Identifies if the transaction is of debit or credit type.", "example": "debit", "enum": [ "debit", "credit" ] }, "enrich": { "required": [ "cleanDescription", "tags", "category", "location", "merchant" ], "type": "object", "properties": { "cleanDescription": { "type": "string", "description": "", "x-readme-ref-name": "TransactionscleanDescription" }, "tags": { "type": "object", "x-readme-ref-name": "Transactionstags" }, "category": { "type": "object", "properties": { "anzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" } }, "x-readme-ref-name": "TransactionsCategory" }, "location": { "type": "object", "properties": { "country": { "type": "string", "description": "Country", "example": "Australia" }, "formattedAddress": { "type": "string", "description": "Address", "example": "1/39 E Esplanade, Manly NSW 2095" }, "geometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "2095" }, "route": { "type": "string", "description": "Route Name", "example": "E Esplanade" }, "routeNo": { "type": "string", "description": "Route Number", "example": "29" }, "state": { "type": "string", "description": "State", "example": "NSW" }, "suburb": { "type": "string", "description": "Suburb", "example": "Manly" } }, "x-readme-ref-name": "TransactionsLocation" }, "merchant": { "required": [ "id", "businessName", "ABN", "website", "logoMaster", "logoThumb" ], "type": "object", "properties": { "id": { "type": "string", "description": "id", "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8" }, "businessName": { "type": "string", "description": "Merchant name", "example": "Garfish Manly" }, "ABN": { "type": "string", "description": "ABN", "example": 90065628864 }, "logoMaster": { "type": "string", "description": "full merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png" }, "logoThumb": { "type": "string", "description": "thumbnail merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png" }, "phoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "website": { "type": "string", "description": "Merchant Website", "example": "http://garfish.com.au/garfish-manly/" } }, "x-readme-ref-name": "TransactionsMerchant" } }, "x-readme-ref-name": "TransactionsEnrich" }, "institution": { "type": "string", "description": "The id of the institution resource the transaction originated from.", "example": "AU00000" }, "postDate": { "type": "string", "description": "Date the transaction was posted as provided by the institution (this is the same date that appears on a bank statement). This value is null if the record is pending. e.g. \"2017-11-10T21:46:44Z\" or 2017-11-10T00:00:00Z.", "example": "2018-11-02T00:00:00Z" }, "status": { "type": "string", "description": "Identifies if a transaction is pending or posted. A pending transaction is an approved debit or credit transaction that has not been fully processed yet (i.e. has not been posted). Find out more about pending transaction and how to deal with them within your app. Note that pending transactions are not available for all institutions.", "example": "posted", "enum": [ "pending", "posted" ] }, "transactionDate": { "type": "string", "description": "Date that the user executed the transaction as provided by the institution. Note that not all transactions provide this value (varies by institution) e.g. \"2017-11-10T00:00:00Z\"", "example": null } }, "x-readme-ref-name": "TransactionData" }, "TransactionsAnzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" }, "TransactionsCategory": { "type": "object", "properties": { "anzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" } }, "x-readme-ref-name": "TransactionsCategory" }, "TransactionsClass": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "TransactionsDivision": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "TransactionsEnrich": { "required": [ "cleanDescription", "tags", "category", "location", "merchant" ], "type": "object", "properties": { "cleanDescription": { "type": "string", "description": "", "x-readme-ref-name": "TransactionscleanDescription" }, "tags": { "type": "object", "x-readme-ref-name": "Transactionstags" }, "category": { "type": "object", "properties": { "anzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" } }, "x-readme-ref-name": "TransactionsCategory" }, "location": { "type": "object", "properties": { "country": { "type": "string", "description": "Country", "example": "Australia" }, "formattedAddress": { "type": "string", "description": "Address", "example": "1/39 E Esplanade, Manly NSW 2095" }, "geometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "2095" }, "route": { "type": "string", "description": "Route Name", "example": "E Esplanade" }, "routeNo": { "type": "string", "description": "Route Number", "example": "29" }, "state": { "type": "string", "description": "State", "example": "NSW" }, "suburb": { "type": "string", "description": "Suburb", "example": "Manly" } }, "x-readme-ref-name": "TransactionsLocation" }, "merchant": { "required": [ "id", "businessName", "ABN", "website", "logoMaster", "logoThumb" ], "type": "object", "properties": { "id": { "type": "string", "description": "id", "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8" }, "businessName": { "type": "string", "description": "Merchant name", "example": "Garfish Manly" }, "ABN": { "type": "string", "description": "ABN", "example": 90065628864 }, "logoMaster": { "type": "string", "description": "full merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png" }, "logoThumb": { "type": "string", "description": "thumbnail merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png" }, "phoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "website": { "type": "string", "description": "Merchant Website", "example": "http://garfish.com.au/garfish-manly/" } }, "x-readme-ref-name": "TransactionsMerchant" } }, "x-readme-ref-name": "TransactionsEnrich" }, "Transactionstags": { "type": "object", "x-readme-ref-name": "Transactionstags" }, "TransactionscleanDescription": { "type": "string", "description": "", "x-readme-ref-name": "TransactionscleanDescription" }, "TransactionsGeometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "TransactionsGetResource": { "title": "Transactions container object.", "required": [ "size", "count", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Value is \"list\".", "example": "list" }, "count": { "type": "integer", "description": "Count of the transactions in the response.", "format": "int64", "example": 500 }, "size": { "type": "integer", "description": "Size of the transactions in the response.", "format": "int64", "example": 2000 }, "data": { "type": "array", "items": { "required": [ "account", "amount", "balance", "class", "connection", "description", "direction", "enrich", "id", "institution", "links", "postDate", "status", "transactionDate", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Value is \"transaction\".", "example": "transaction" }, "id": { "type": "string", "description": "Uniquely identifies the transaction for this connection. Note that when a connection is refreshed pending transactions will receive new id's, whilst posted transactions will receive the same id's as before the refresh.", "example": "d3de1ca1" }, "account": { "type": "string", "description": "The id of the account resource the transaction belongs to.", "example": "d3de1ca1" }, "amount": { "type": "string", "description": "Transaction amount. Outgoing funds are expressed as negative values.", "example": "123.12" }, "balance": { "type": "string", "description": "Value of the account balance at time the transaction was completed.", "example": "123.12" }, "class": { "type": "string", "description": "Describes the class(type) of transaction.", "example": "payment", "enum": [ "bank-fee", "payment", "cash-withdrawal", "transfer", "loan-interest", "refund", "direct-credit", "interest", "loan-repayment" ] }, "connection": { "type": "string", "description": "The id of the connection resource that was used to retrieve the transaction.", "example": "d3de1ca1" }, "description": { "type": "string", "description": "The transaction description as submitted by the institution.." }, "direction": { "type": "string", "description": "Identifies if the transaction is of debit or credit type.", "example": "debit", "enum": [ "debit", "credit" ] }, "enrich": { "required": [ "cleanDescription", "tags", "category", "location", "merchant" ], "type": "object", "properties": { "cleanDescription": { "type": "string", "description": "", "x-readme-ref-name": "TransactionscleanDescription" }, "tags": { "type": "object", "x-readme-ref-name": "Transactionstags" }, "category": { "type": "object", "properties": { "anzsic": { "type": "object", "properties": { "class": { "type": "object", "properties": { "title": { "type": "string", "description": "Class Details", "example": "Cafes and Restaurants" }, "code": { "type": "string", "description": "Class Code", "example": "4511" } }, "x-readme-ref-name": "TransactionsClass" }, "division": { "type": "object", "properties": { "title": { "type": "string", "description": "Division Details", "example": "Accommodation and Food Services" }, "code": { "type": "string", "description": "Division Code", "example": "H" } }, "x-readme-ref-name": "TransactionsDivision" }, "group": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "subdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" } }, "x-readme-ref-name": "TransactionsAnzsic" } }, "x-readme-ref-name": "TransactionsCategory" }, "location": { "type": "object", "properties": { "country": { "type": "string", "description": "Country", "example": "Australia" }, "formattedAddress": { "type": "string", "description": "Address", "example": "1/39 E Esplanade, Manly NSW 2095" }, "geometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "2095" }, "route": { "type": "string", "description": "Route Name", "example": "E Esplanade" }, "routeNo": { "type": "string", "description": "Route Number", "example": "29" }, "state": { "type": "string", "description": "State", "example": "NSW" }, "suburb": { "type": "string", "description": "Suburb", "example": "Manly" } }, "x-readme-ref-name": "TransactionsLocation" }, "merchant": { "required": [ "id", "businessName", "ABN", "website", "logoMaster", "logoThumb" ], "type": "object", "properties": { "id": { "type": "string", "description": "id", "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8" }, "businessName": { "type": "string", "description": "Merchant name", "example": "Garfish Manly" }, "ABN": { "type": "string", "description": "ABN", "example": 90065628864 }, "logoMaster": { "type": "string", "description": "full merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png" }, "logoThumb": { "type": "string", "description": "thumbnail merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png" }, "phoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "website": { "type": "string", "description": "Merchant Website", "example": "http://garfish.com.au/garfish-manly/" } }, "x-readme-ref-name": "TransactionsMerchant" } }, "x-readme-ref-name": "TransactionsEnrich" }, "institution": { "type": "string", "description": "The id of the institution resource the transaction originated from.", "example": "AU00000" }, "postDate": { "type": "string", "description": "Date the transaction was posted as provided by the institution (this is the same date that appears on a bank statement). This value is null if the record is pending. e.g. \"2017-11-10T21:46:44Z\" or 2017-11-10T00:00:00Z.", "example": "2018-11-02T00:00:00Z" }, "status": { "type": "string", "description": "Identifies if a transaction is pending or posted. A pending transaction is an approved debit or credit transaction that has not been fully processed yet (i.e. has not been posted). Find out more about pending transaction and how to deal with them within your app. Note that pending transactions are not available for all institutions.", "example": "posted", "enum": [ "pending", "posted" ] }, "transactionDate": { "type": "string", "description": "Date that the user executed the transaction as provided by the institution. Note that not all transactions provide this value (varies by institution) e.g. \"2017-11-10T00:00:00Z\"", "example": null } }, "x-readme-ref-name": "TransactionData" } } }, "description": "A transaction object is created whenever money is debited or credited from a particular account.", "x-readme-ref-name": "TransactionsGetResource" }, "TransactionsGroup": { "type": "object", "properties": { "code": { "type": "string", "description": "Group Code", "example": "451" }, "title": { "type": "string", "description": "Group Details", "example": "Cafes, Restaurants and Takeaway Food Services" } }, "x-readme-ref-name": "TransactionsGroup" }, "TransactionsLocation": { "type": "object", "properties": { "country": { "type": "string", "description": "Country", "example": "Australia" }, "formattedAddress": { "type": "string", "description": "Address", "example": "1/39 E Esplanade, Manly NSW 2095" }, "geometry": { "type": "object", "properties": { "lat": { "type": "string", "description": "Latitude", "example": "-33.79988520000001" }, "lng": { "type": "string", "description": "Longitude", "example": "151.2858021" } }, "x-readme-ref-name": "TransactionsGeometry" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "2095" }, "route": { "type": "string", "description": "Route Name", "example": "E Esplanade" }, "routeNo": { "type": "string", "description": "Route Number", "example": "29" }, "state": { "type": "string", "description": "State", "example": "NSW" }, "suburb": { "type": "string", "description": "Suburb", "example": "Manly" } }, "x-readme-ref-name": "TransactionsLocation" }, "TransactionsMerchant": { "required": [ "id", "businessName", "ABN", "website", "logoMaster", "logoThumb" ], "type": "object", "properties": { "id": { "type": "string", "description": "id", "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8" }, "businessName": { "type": "string", "description": "Merchant name", "example": "Garfish Manly" }, "ABN": { "type": "string", "description": "ABN", "example": 90065628864 }, "logoMaster": { "type": "string", "description": "full merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png" }, "logoThumb": { "type": "string", "description": "thumbnail merchant logo", "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png" }, "phoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "website": { "type": "string", "description": "Merchant Website", "example": "http://garfish.com.au/garfish-manly/" } }, "x-readme-ref-name": "TransactionsMerchant" }, "TransactionsPhoneNumber": { "type": "object", "properties": { "international": { "type": "string", "description": "International Phone Number", "example": "+61 2 9977 0707" }, "local": { "type": "string", "description": "Local Phone Number", "example": "(02) 9977 0707" } }, "x-readme-ref-name": "TransactionsPhoneNumber" }, "TransactionsSubdivision": { "type": "object", "properties": { "code": { "type": "string", "description": "Subdivision Code", "example": "45" }, "title": { "type": "string", "description": "Subdivision Details", "example": "Food and Beverage Services" } }, "x-readme-ref-name": "TransactionsSubdivision" }, "ForbiddenAccessError": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "source", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access", "enum": [ "forbidden-access", "no-production-access", "access-denied" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Access to this resource is forbidden." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Forbidden Access" }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "ForbiddenAccessError" }, "BadRequestError": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "parameter-not-valid", "enum": [ "parameter-not-supplied", "parameter-not-valid", "unsupported-accept", "invalid-content", "institution-not-supported", "invalid-credentials" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "ID value is not valid." }, "source": { "title": "Source", "type": "object", "properties": { "parameter": { "type": "string", "description": "String indicating which URI query parameter caused the error.", "example": "userId" }, "pointer": { "type": "string", "description": "Location to the object or attribute that the error relates to.", "example": "users/userId" } }, "description": "An object containing references to the source of the error.", "x-readme-ref-name": "Source" }, "title": { "type": "string", "description": "Title of the error", "example": "Parameter not valid." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "BadRequestError" }, "BadRequestErrorforbidden-access": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "forbidden-access" }, "title": { "type": "string", "description": "Title of the error", "enum": [ "Connection source not supported.\n", "Invalid users filter. Maximum 5 users allowed.\n", "The following accounts are duplicated: \n['121', '332'], ['232', '949', '433'].\n", "Following user ID(s)/account ID(s) have been entered more than once: \n[\"123\", \"123\"].\n" ] }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" }, "detail": { "type": "string", "description": "Connection source has to be web or open banking." } } } } }, "x-readme-ref-name": "BadRequestErrorforbidden-access" }, "collection": { "properties": { "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "count": { "type": "integer", "description": "Count of items in the response.", "example": 500 }, "size": { "type": "integer", "description": "Size of the pages in the response." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "report" }, "id": { "type": "string", "example": "b1824ad0-73f1-0138-3700-0a58a9feac09" }, "title": { "type": "string", "example": "John Smith Affordability Report 2022-03-26" }, "reportType": { "type": "string", "example": "affordability-consumer" }, "createdDate": { "type": "string", "example": "2022-03-26T06:56:44.000Z" }, "expiresAt": { "type": "string", "example": "2023-03-26T06:56:44.000Z" }, "createdBy": { "type": "string", "example": "David Smith" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "value": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "format": "date", "example": "2022-01-01T00:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "self": { "type": "string", "example": "https://au-api.basiq.io/reports/51cef931-81f2-4639-af74-b0ced85083c8" } } } }, "x-readme-ref-name": "reportSummary" } }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "Self reference URL.", "example": "https://au-api.basiq.io/users/6a52015e/transactions" }, "next": { "type": "string", "description": "Url to next result.", "example": "https://au-api.basiq.io/users/6a52015e/transactions?next=bf1ec9d4" } } } }, "x-readme-ref-name": "collection" }, "reportSummary": { "properties": { "type": { "type": "string", "example": "report" }, "id": { "type": "string", "example": "b1824ad0-73f1-0138-3700-0a58a9feac09" }, "title": { "type": "string", "example": "John Smith Affordability Report 2022-03-26" }, "reportType": { "type": "string", "example": "affordability-consumer" }, "createdDate": { "type": "string", "example": "2022-03-26T06:56:44.000Z" }, "expiresAt": { "type": "string", "example": "2023-03-26T06:56:44.000Z" }, "createdBy": { "type": "string", "example": "David Smith" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "value": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array" } ] }, "format": "date", "example": "2022-01-01T00:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "self": { "type": "string", "example": "https://au-api.basiq.io/reports/51cef931-81f2-4639-af74-b0ced85083c8" } } } }, "x-readme-ref-name": "reportSummary" }, "reportType": { "properties": { "id": { "type": "string", "description": "Report ID." }, "name": { "type": "string", "description": "Name of the report.", "example": "Consumer Affordability Report." }, "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "description": { "type": "string", "description": "In depth consumer affordability assessment." }, "count": { "type": "integer", "description": "Total count of report.", "example": 5 }, "filters": { "type": "array", "description": "filters for reports." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reportType" }, "id": { "type": "string", "example": "CON_AFFOR_01" }, "name": { "type": "string", "example": "Consumer Affordability Report" }, "description": { "type": "string", "example": "In depth consumer affordability assessment." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "type": { "type": "string", "example": "string" }, "required": { "type": "boolean", "example": true } } } } } } } }, "x-readme-ref-name": "reportType" }, "reportTypeID": { "properties": { "id": { "type": "string", "description": "Report ID." }, "name": { "type": "string", "description": "Name of the report.", "example": "Consumer Affordability Report." }, "type": { "type": "string", "description": "Always \"list\".", "example": "list" }, "description": { "type": "string", "description": "In depth consumer affordability assessment." }, "count": { "type": "integer", "description": "Total count of report.", "example": 5 }, "filters": { "type": "array", "description": "filters for reports." }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "reportType" }, "id": { "type": "string", "example": "CON_AFFOR_01" }, "name": { "type": "string", "example": "Consumer Affordability Report" }, "description": { "type": "string", "example": "In depth consumer affordability assessment." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fromDate" }, "type": { "type": "string", "example": "string" }, "required": { "type": "boolean", "example": true } } } } } } } }, "x-readme-ref-name": "reportTypeID" }, "reportRequest": { "required": [ "reportType", "title", "filters" ], "properties": { "reportType": { "type": "string", "example": "CON_AFFOR_01" }, "title": { "type": "string", "example": "John Smith Affordability Report 2022-03-26" }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "fromDate" }, "value": { "oneOf": [ { "type": "string", "title": "Object", "format": "date", "example": "2022-01-01", "description": "A single string in YYYY-MM-DD format, used when 'name' is 'fromDate' or 'toDate', 'accounts', or 'users'." }, { "type": "array", "title": "Array", "items": { "type": "string", "format": "date" }, "example": [ "2021-12-01", "2022-01-01" ], "description": "The name of the filter, which determines the type of values expected. Can be 'fromDate', 'toDate', 'accounts', 'users', 'includeMetrics', or 'includeGroups'." }, { "type": "array", "title": "Array", "items": { "type": "string" }, "example": [ "ME002", "ME003", "ME004" ], "description": "Array of metrics or groups to be included in the report. Can be 'includeMetrics' or 'includeGroups'." }, { "type": "string", "title": "Object", "example": null, "description": "Use 'null' to indicate no metrics/groups should be shown." } ] } } } } }, "x-readme-ref-name": "reportRequest" }, "job": { "properties": { "type": { "type": "string", "example": "job" }, "id": { "type": "string", "example": "b1824ad0-73f1-0138-3700-0a58a9feac09" }, "links": { "type": "object", "properties": { "self": { "type": "string", "example": "https://au-api.basiq.io/jobs/a3dgf4567a89" } } } }, "x-readme-ref-name": "job" }, "Conn_Affor_Report": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the report" }, "id": { "type": "string", "description": "Unique identifier for the report" }, "title": { "type": "string", "description": "Title of the report" }, "reportType": { "type": "string", "description": "Type of the report" }, "createdDate": { "type": "string", "format": "date-time", "description": "Date and time when the report was created" }, "createdBy": { "type": "string", "description": "Creator of the report" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the filter" }, "value": { "oneOf": [ { "type": "array" }, { "type": "string", "description": "Value of the filter" } ] } } } }, "data": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the metric" }, "title": { "type": "string", "description": "Title of the metric" }, "description": { "type": "string", "description": "Description of the metric" }, "sections": { "type": "array", "items": { "type": "string", "description": "Sections related to the metric" } }, "result": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "integer", "description": "Value of the metric" } ] }, "format": { "type": "string", "description": "Format of the metric value" } } } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the group" }, "title": { "type": "string", "description": "Title of the group" }, "sections": { "type": "array", "items": { "type": "string", "description": "Sections related to the group" } }, "analysis": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "transactionCount": { "type": "integer", "description": "Total number of transactions in the group" }, "overallPercentage": { "type": "object", "properties": { "credit": { "type": "number", "description": "Percentage of credit transactions" }, "debit": { "type": "number", "description": "Percentage of debit transactions" } } } } }, "range": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "Start date of the analysis range" }, "endDate": { "type": "string", "format": "date", "description": "End date of the analysis range" }, "duration": { "type": "integer", "description": "Duration of the analysis range in days" } } }, "amount": { "type": "object", "properties": { "total": { "type": "string", "description": "Total amount for the group" }, "min": { "type": "string", "description": "Minimum amount for the group" }, "max": { "type": "string", "description": "Maximum amount for the group" }, "average": { "type": "object", "properties": { "transaction": { "type": "string", "description": "Average transaction amount" }, "month": { "type": "string", "description": "Average monthly amount" }, "medianTransaction": { "type": "string", "description": "Median transaction amount" }, "medianMonth": { "type": "string", "description": "Median monthly amount" }, "ongoingMonth": { "type": "string", "description": "Ongoing month's average amount" } } }, "stableMonths": { "type": "integer", "description": "Number of stable months" }, "secureMonths": { "type": "integer", "description": "Number of secure months" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "description": "Frequency type" }, "amount": { "type": "string", "description": "Frequency amount" }, "display": { "type": "string", "description": "Display name of the frequency" }, "next": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Next frequency date" }, "amount": { "type": "string", "description": "Next frequency amount" } } } } } } }, "subgroup": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the subgroup" }, "name": { "type": "string", "description": "Name of the subgroup" }, "analysis": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "transactionCount": { "type": "integer", "description": "Total number of transactions in the subgroup" }, "overallPercentage": { "type": "object", "properties": { "credit": { "type": "number", "description": "Percentage of credit transactions" }, "debit": { "type": "number", "description": "Percentage of debit transactions" } } } } }, "range": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "Start date of the analysis range" }, "endDate": { "type": "string", "format": "date", "description": "End date of the analysis range" }, "duration": { "type": "integer", "description": "Duration of the analysis range in days" } } }, "amount": { "type": "object", "properties": { "total": { "type": "string", "description": "Total amount for the subgroup" }, "min": { "type": "string", "description": "Minimum amount for the subgroup" }, "max": { "type": "string", "description": "Maximum amount for the subgroup" }, "average": { "type": "object", "properties": { "transaction": { "type": "string", "description": "Average transaction amount" }, "month": { "type": "string", "description": "Average monthly amount" }, "medianTransaction": { "type": "string", "description": "Median transaction amount" }, "medianMonth": { "type": "string", "description": "Median monthly amount" }, "ongoingMonth": { "type": "string", "description": "Ongoing month's average amount" } } }, "stableMonths": { "type": "integer", "description": "Number of stable months" }, "secureMonths": { "type": "integer", "description": "Number of secure months" } } }, "frequency": { "type": "object", "properties": { "type": { "type": "string", "description": "Frequency type" }, "amount": { "type": "string", "description": "Frequency amount" }, "display": { "type": "string", "description": "Display name of the frequency" }, "next": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Next frequency date" }, "amount": { "type": "string", "description": "Next frequency amount" } } } } } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the transaction" }, "date": { "type": "string", "format": "date", "description": "Date of the transaction" }, "description": { "type": "string", "description": "Description of the transaction" }, "amount": { "type": "string", "description": "Amount of the transaction" } } } } } } } } } }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the account" }, "accountNo": { "type": "string", "description": "Account number" }, "name": { "type": "string", "description": "Name of the account" }, "currency": { "type": "string", "description": "Currency of the account" }, "balance": { "type": "string", "description": "Current balance of the account" }, "availableFunds": { "type": "string", "description": "Available funds in the account" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Date and time when the account was last updated" }, "institution": { "type": "string", "description": "Institution of the account" }, "class": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the account class" }, "product": { "type": "string", "description": "Product of the account class" } } }, "transactionIntervals": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "format": "date", "description": "Start date of the transaction interval" }, "to": { "type": "string", "format": "date", "description": "End date of the transaction interval" } } } }, "accountHolder": { "type": "string", "description": "Holder of the account" }, "accountOwnership": { "type": "string", "description": "Ownership status of the account" }, "connection": { "type": "string", "description": "connectionID of that account" }, "status": { "type": "string", "description": "Status of the account" }, "creditLimit": { "type": "string", "description": "Credit limit of the account" }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "Link to retrieve the account details" }, "transactions": { "type": "string", "description": "Link to retrieve the transactions for the account" }, "institution": { "type": "string", "description": "Link to retrieve the institution details" } } } } } } } }, "transactions": { "type": "string", "description": "Link to retrieve the transactions for the account" }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "link of report" } } } }, "x-readme-ref-name": "Conn_Affor_Report" }, "InternalServerError": { "required": [ "correlationId", "data", "type" ], "type": "object", "properties": { "correlationId": { "type": "string", "description": "Unique identifier for this particular occurrence of the problem.", "example": "ac5ah5i" }, "data": { "type": "array", "description": "Error data.", "items": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code, expressed as a string value.", "example": "internal-server-error", "enum": [ "internal-server-error" ] }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence of the problem.", "example": "Internal Server error. Contact support." }, "title": { "type": "string", "description": "Title of the error", "example": "Internal Server error." }, "type": { "type": "string", "description": "Type of the response, always \"error\"", "example": "error" } } } } }, "x-readme-ref-name": "InternalServerError" } }, "securitySchemes": { "services_token": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "services_token": [] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true, "samples-languages": [ "curl", "node", "ruby", "javascript", "python" ] } }