Returns a report of all received transactions for the day with associated details. This includes Direct Entry (DE) and NPP receivables. If requested multiple times on the current date (calendar day, AEDT), the report is cumulative. For example, if a report is requested at 10am and another one at 1pm on the same day, the 1pm report contains all the transactions already contained in the 10am report, in addition to any new transactions.
\nDirect Entry transactions arrive in batches 7 times throughout the day, at 8.30am, 11.30am, 2.30pm, 5.30pm, 7.45pm, 9.45pm and 10.50pm (emergency), on business days only. NPP transactions may arrive at any time, so we recommend subscribing to a webhook to receive new transaction notifications.
\nEach row is one transaction received to one of your virtual account numbers. The report is returned as an application/octet-stream of comma-separated values: the first row holds the column headers, and each following row is one received transaction. Where a comma (,) or double quote (\") is present in any field, the field is encased in double quotes and/or escaped as per RFC 4180. Every column is described in the 200 response below.
Source account details (SourceBsb, SourceAccountNumber and SourceAccountName) do not appear by default. Please contact Monoova for further information.
Version 7 replaces /receivables/v6/report as part of Release 10 (R10). The request parameters are unchanged and all existing columns remain. Three Conditional columns are added at the end of each row:
| Column | When it is populated |
|---|---|
PayrollPaymentDate | Super contributions with category purpose code PENS only, in YYYY-MM-DD format. |
PaymentPurposeCode | Only when the sending institution includes it. |
BatchIdentification | Only when the sending institution includes it. |
Your integration should accept these columns when they hold a value and continue to work when they are blank.
\ndate on its own to return the received transactions for that day.endDate to return the received transactions for a date range that starts at date. A maximum of one month of transactions is retrieved at a time, and the maximum take is 10000.skip and take to page through the report. skip is the number of records to skip, where 0 is the first record, and take is the number of records to return.accountNumber, clientUniqueId, transactionType, transactionCode, payId or payIdName to filter the report. transactionCode applies to Direct Entry transactions only.| Code | Transaction description |
|---|---|
| 13 | Externally initiated debit items |
| 50 | Externally initiated credit items, with the exception of those bearing transaction codes 51 to 57 |
| 51 | Australian Government Security Interest |
| 52 | Family Allowance |
| 53 | Pay |
| 54 | Pension |
| 55 | Allotment |
| 56 | Dividend |
| 57 | Debenture/Note Interest |
Format: yyyyMMddHHmmss. The date and time from which transactions are reported. This becomes the start date of the report if the report is being fetched for a date range. Where endDate is not supplied, the report returns the received transactions for the day specified.
Optional. Format: yyyyMMddHHmmss. Use this to fetch the report for a date range that starts at date. A maximum of one month of transactions is retrieved at a time. Where endDate is supplied, the maximum take is 10000.
Optional. Number of records to skip. 0 is the first record. Use together with take to page through large reports.
Optional. Number of records to take. Conditional limit: if endDate is provided, the maximum take is 10000.
Optional. Payee bank account number. Filters the report to transactions received to this account number.
", "default": "153884104", "pattern": "^\\d{1,9}$" }, { "kind": "optional", "name": "clientUniqueId", "type": "string", "example": "862944D057FC408B9B04541C2BA12", "description": "Optional. The unique identifier for the account, as supplied by you or generated by Monoova when the account was created. Filters the report to transactions received to this account.
", "default": "862944D057FC408B9B04541C2BA12", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "kind": "optional", "name": "transactionType", "type": "string", "example": "DE", "description": "Optional. Filters the report by transaction type. Possible values: DE (Direct Entry) or NPP. If not supplied, both Direct Entry and NPP transactions are returned.
Conditional. Only applicable when transactionType is DE. Industry standard Direct Entry transaction code. Possible values: 13 for debit or 50 for credit. Refer to the Direct Entry standard for the definitions of codes 51 to 57, listed under Possible transaction codes.
Optional. Email address for the PayID. Filters the report to transactions received against this PayID.
", "default": "MW9GM4@monoova.me", "pattern": "^[^@\\s]{1,64}@[^@\\s]{1,191}$" }, { "kind": "optional", "name": "payIdName", "type": "string", "example": "Jones Island Dairy", "description": "Optional. Name displayed to the payers when they address a payment to the PayID. Filters the report to transactions received against the PayID with this name.
", "default": "Jones Island Dairy", "pattern": "^.{1,140}$" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "description": "To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.
", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful validation. The received transactions report was generated and is returned as an application/octet-stream of comma-separated values (CSV): a header row followed by one row per received transaction. The schema below describes each column, in the order the columns appear.
Bad request. One or more parameters failed validation, for example a date or endDate that is not in yyyyMMddHHmmss format.
The status of the request. A code other than Ok, such as Error, indicates that the request failed validation and no report was generated.
A description of the validation failure, for example a date or endDate that is not in yyyyMMddHHmmss format.
Unauthorised. The API key supplied as the basic authentication username is missing or invalid. In the live environment, the Sign-In Account is locked for one hour after five failed authentication attempts, and the response indicates that the account is locked and the time (UTC) that it will be unlocked.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":2,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\"}", "description": "Returned when the request could not be authenticated.", "customType": "unauthorisedResponse_V7", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the authentication failure was returned.\n", "example": 2, "default": 2, "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Unauthorized indicates that the credentials supplied were not accepted.
Forbidden. The API key was authenticated, but your Sign-In Account is not permitted to access reporting. Contact Monoova support to request access to this report.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":3,\"status\":\"Forbidden\",\"statusDescription\":\"The Sign-In Account is not permitted to access this report.\"}", "description": "Returned when the authenticated Sign-In Account is not permitted to access the report.
", "customType": "forbiddenResponse_V7", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the authorisation failure was returned.\n", "example": 3, "default": 3, "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Forbidden indicates that the Sign-In Account is not permitted to access this report and no report was generated.
Not found. The requested URL does not match an available endpoint, for example the date path parameter is missing or the path is incorrect. Check the URL and resend the request.
The status of the request. A code other than Ok, such as Error, indicates that the request failed and no report was generated.
A description of the error. Check that the URL is correct and includes the date path parameter.
The status of the request. A code of Error indicates that the request could not be completed and should be retried.
Bad gateway. The Platform received an invalid response from an upstream service while generating the report, so no report was returned. The report is read-only, so you can safely retry the request after a short wait. Contact Monoova support if the error persists.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":1520,\"status\":\"Error\",\"statusDescription\":\"An invalid response was received from an upstream service. Please try again later.\"}", "description": "Returned when an upstream service returns an invalid response while the report is being generated.", "customType": "badGatewayResponse_V7", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.\n", "example": 1520, "default": 1520, "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Error indicates that the request could not be completed and should be retried.
Gateway timeout. An upstream service did not respond in time while the report was being generated, so no report was returned. Retry the request after a short wait, or reduce the size of the report with endDate, take or a filter such as accountNumber. Contact Monoova support if the error persists.
The status of the request. A code of Error indicates that the request could not be completed and should be retried.
A description of the timeout. Retry the request after a short wait, or reduce the size of the report.
", "example": "The request timed out before the report was generated. Please try again later.", "default": "The request timed out before the report was generated. Please try again later.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/gatewayTimeoutResponse_V7", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api-beta.monoova.com/receivables/v7/report/{date}?endDate=20261029235959&skip=0&take=1000&accountNumber=153884104&clientUniqueId=862944D057FC408B9B04541C2BA12&transactionType=DE&transactionCode=50&payId=MW9GM4%40monoova.me&payIdName=Jones%20Island%20Dairy' \\\n --header 'accept: application/octet-stream'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/octet-stream\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/receivables/v7/report/{date}?endDate=20261029235959&skip=0&take=1000&accountNumber=153884104&clientUniqueId=862944D057FC408B9B04541C2BA12&transactionType=DE&transactionCode=50&payId=MW9GM4@monoova.me&payIdName=Jones Island Dairy\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-beta.monoova.com/receivables/v7/report/{date}?endDate=20261029235959&skip=0&take=1000&accountNumber=153884104&clientUniqueId=862944D057FC408B9B04541C2BA12&transactionType=DE&transactionCode=50&payId=MW9GM4@monoova.me&payIdName=Jones Island Dairy\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/octet-stream\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api-beta.monoova.com/receivables/v7/report/{date}?endDate=20261029235959&skip=0&take=1000&accountNumber=153884104&clientUniqueId=862944D057FC408B9B04541C2BA12&transactionType=DE&transactionCode=50&payId=MW9GM4@monoova.me&payIdName=Jones Island Dairy\"\n\npayload = {}\nheaders = {\n 'accept': 'application/octet-stream',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful validation. The received transactions report was generated and is returned as an application/octet-stream of comma-separated values (CSV): a header row followed by one row per received transaction. The schema below describes each column, in the order the columns appear.\n" }, { "id": "response-1-400", "language": "400", "code": "// Bad request. One or more parameters failed validation, for example a date or endDate that is not in yyyyMMddHHmmss format.\n{\n \"durationMs\": 4,\n \"status\": \"Error\",\n \"statusDescription\": \"The date supplied is invalid. Provide the date in yyyyMMddHHmmss format, for example 20261029000000.\"\n}" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorised. The API key supplied as the basic authentication username is missing or invalid. In the live environment, the Sign-In Account is locked for one hour after five failed authentication attempts, and the response indicates that the account is locked and the time (UTC) that it will be unlocked.\n{\n \"durationMs\": 2,\n \"status\": \"Unauthorized\",\n \"statusDescription\": \"Authentication failed. Supply a valid API key as the basic authentication username.\"\n}" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden. The API key was authenticated, but your Sign-In Account is not permitted to access reporting. Contact Monoova support to request access to this report.\n{\n \"durationMs\": 3,\n \"status\": \"Forbidden\",\n \"statusDescription\": \"The Sign-In Account is not permitted to access this report.\"\n}" }, { "id": "response-4-404", "language": "404", "code": "// Not found. The requested URL does not match an available endpoint, for example the date path parameter is missing or the path is incorrect. Check the URL and resend the request.\n{\n \"durationMs\": 1,\n \"status\": \"Error\",\n \"statusDescription\": \"The requested resource was not found. Check the URL and include the date path parameter.\"\n}" }, { "id": "response-5-500", "language": "500", "code": "// Internal server error. An unexpected error prevented the Platform from generating the report. Retry the request and contact Monoova support if the error persists.\n{\n \"durationMs\": 118,\n \"status\": \"Error\",\n \"statusDescription\": \"An unexpected error occurred while processing the request. Please try again later.\"\n}" }, { "id": "response-6-502", "language": "502", "code": "// Bad gateway. The Platform received an invalid response from an upstream service while generating the report, so no report was returned. The report is read-only, so you can safely retry the request after a short wait. Contact Monoova support if the error persists.\n{\n \"durationMs\": 1520,\n \"status\": \"Error\",\n \"statusDescription\": \"An invalid response was received from an upstream service. Please try again later.\"\n}" }, { "id": "response-7-504", "language": "504", "code": "// Gateway timeout. An upstream service did not respond in time while the report was being generated, so no report was returned. Retry the request after a short wait, or reduce the size of the report with endDate, take or a filter such as accountNumber. Contact Monoova support if the error persists.\n{\n \"durationMs\": 30012,\n \"status\": \"Error\",\n \"statusDescription\": \"The request timed out before the report was generated. Please try again later.\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }