TransferMoneyTxn

Return, update, create and delete transfer money transactions

Date Released: Mar 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Banking/TransferMoneyTxn 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

The elements list below details information for TransferMoneyTxn. 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 transfer money transaction.
    ONLY required for updating an existing transfer money transaction.
    NOT required when creating a new transfer money transaction.
  • FromAccount
  • The following set of information pulls through details for the FromAccount
    • UIDGuid (36)
    • Foreign Key: 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-1100' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • ToAccount
  • The following set of information pulls through details for the ToAccount
    • UIDGuid (36)
    • Foreign Key: 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-1100' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • TransferNumber String (13)
  • ID No of payment transaction, if left blank on POST will auto increment based upon last recorded #
  • DateDateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-08-11 13:33:02' }
  • AmountDecimal (13.2)
  • Amount to be allocated to the account, must be non zero.
  • Memo String (1000)
  • Memo text describing the transfer money transaction.
  • Category
  • The following outlines category information for the transfer money transaction.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the transfer money transaction.
    • Name String (30)
    • Name of the category
    • DisplayID String (15)
    • Display id for the category
    • URI String
    • Uniform resource identifier associated with the category object
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersion String
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing transfer money.
    NOT required when creating a new transfer money transaction.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID" : "bfaade84-1adf-4e2d-acfd-629e95d09de7",
  • "FromAccount": {
    • "UID" : "7772dc25-5ee6-4a61-994e-28c04b8a35fc",
    • "Name" : "General Cheque Account 1",
    • "DisplayID" : "1-1110",
    • "URI" : "{cf_uri}/GeneralLedger/Account/7772dc25-5ee6-4a61-994e-28c04b8a35fc"
    • },
  • "ToAccount": {
    • "UID" : "f91cbf7f-6b65-4a14-94df-393188fbe992",
    • "Name" : "General Cheque Account 2",
    • "DisplayID" : "1-1110",
    • "URI" : "{cf_uri}/GeneralLedger/Account/f91cbf7f-6b65-4a14-94df-393188fbe992"
    • },
  • "TransferNumber" : "TR000007",
  • "Date" : "2014-03-29T00:00:00",
  • "Amount" : 59.95,
  • "Memo" : "Funds Transfer",
  • "Category" : {
    • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
    • "Name" : "Melbourne",
    • "DisplayID" : "CAT101",
    • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
    • },
  • "URI" : "{cf_uri}/Banking/TransferMoneyTxn/bfaade84-1adf-4e2d-acfd-629e95d09de7",
  • "RowVersion" : "-253046004062879744"
  • }
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.