Received Transactions Report

GET

https://api-beta.monoova.com/receivables/v7/report/{date}

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.

Direct 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.

What this report returns

Each 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.

What's new in v7

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.

Requesting the report

Supply date on its own to return the received transactions for that day.
Add 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.
Use 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.
Add accountNumber, clientUniqueId, transactionType, transactionCode, payId or payIdName to filter the report. transactionCode applies to Direct Entry transactions only.

Possible transaction codes

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

datestringFormat: <code>yyyyMMddHHmmss</code>. 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 <code>endDate</code> is not supplied, the report returns the received transactions for the day specified.

endDatestringOptional. Format: <code>yyyyMMddHHmmss</code>. Use this to fetch the report for a date range that starts at <code>date</code>. A maximum of one month of transactions is retrieved at a time. Where <code>endDate</code> is supplied, the maximum <code>take</code> is 10000.

skipstringOptional. Number of records to skip. 0 is the first record. Use together with <code>take</code> to page through large reports.

takestringOptional. Number of records to take. Conditional limit: if <code>endDate</code> is provided, the maximum <code>take</code> is 10000.

accountNumberstringOptional. Payee bank account number. Filters the report to transactions received to this account number.

clientUniqueIdstringOptional. 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.

transactionTypestringOptional. Filters the report by transaction type. Possible values: <code>DE</code> (Direct Entry) or <code>NPP</code>. If not supplied, both Direct Entry and NPP transactions are returned.

transactionCodestringConditional. Only applicable when <code>transactionType</code> is <code>DE</code>. Industry standard Direct Entry transaction code. Possible values: <code>13</code> for debit or <code>50</code> for credit. Refer to the Direct Entry standard for the definitions of codes 51 to 57, listed under Possible transaction codes.

payIdstringOptional. Email address for the PayID. Filters the report to transactions received against this PayID.

payIdNamestringOptional. 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.

acceptstringGenerated from available response content types

200Successful validation. The received transactions report was generated and is returned as an <code>application/octet-stream</code> 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.

400Bad request. One or more parameters failed validation, for example a <code>date</code> or <code>endDate</code> that is not in <code>yyyyMMddHHmmss</code> format.

401Unauthorised. 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.

403Forbidden. 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.

404Not found. The requested URL does not match an available endpoint, for example the <code>date</code> path parameter is missing or the path is incorrect. Check the URL and resend the request.

500Internal server error. An unexpected error prevented the Platform from generating the report. Retry the request and contact Monoova support if the error persists.

502Bad 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.

504Gateway 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 <code>endDate</code>, <code>take</code> or a filter such as <code>accountNumber</code>. Contact Monoova support if the error persists.

curl --request GET \
     --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' \
     --header 'accept: application/octet-stream'