Bank Account

Returns a list of Bank Accounts that are linked to Bankfeeds

Date Released: Feb 2015 Date Updated: Feb 2023
/{cf_uri}/Banking/BankAccount/ GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials.

For full details on the masking of information on this endpoint, take a look at our knowledgebase article Changes to the Banking/Bankaccount endpoint

The elements list below details information for Bank Account. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • UIDGuid (36)
  • Unique guid identifier created for a Bank Account.
  • FinancialInstitutionString (3)
  • The code for the Financial Institution
  • BankAccountNameString
  • The Name of the Account.This field is masked to comply with PII Standards.
  • BSBString (6)
    BSB as provided by the financial institution. This field is masked to comply with PII Standards.
  • BankAccountNumberString (9)
  • The bank account number for the account.This field is masked to comply with PII Standards.
  • CardNameString
  • The name on the credit card. This field is masked to comply with PII Standards.
  • CardNumberString
  • The credit card number. This field is masked to comply with PII Standards.
  • Account
  • The following set of information pulls through details for an Account that the Bank Account is linked to.
    • UIDGuid (36)
    • Unique identifier for the account in the form of a guid.
    • NameString (30)
    • Account name belonging to the account record.
    • DisplayIDString (6)
    • Account code format includes separator ie 1-1100{ 'DisplayID': '1-1200' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • BankLinkStatusString
  • Shows the status of the Bankfeed connection
  • LastReconciledDateDateTime
  • The date that the Account was last reconciled.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.

Example json GET response

  • {
  • "UID": "75df28f7-96b0-4b9c-84e5-d12e94fe854e",
  • "FinancialInstitution": "WBC",
  • "BankAccountName": "********",
  • "BSB": "********",
  • "BankAccountNumber": "********",
  • "CardName": null,
  • "CardNumber": null,
  • "BankLinkStatus": "ACTIVE",
  • "LastReconciledDate": "2018-04-30T00:00:00",
  • "URI" : "{cf_uri}/Banking/BankAccount/75df28f7-96b0-4b9c-84e5-d12e94fe854e9",
  • "RowVersion": "-2231252140385370112"
  • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.