ReceiveMoneyTxn

Return, update, create and delete Receive Money transactions

Date Released: Dec 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Banking/ReceiveMoneyTxn 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 ReceiveMoneyTxn. 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 receive money transaction.
    ONLY required for updating an existing recieve money.
    NOT required when creating a new receive money.
  • DepositToString
  • If allocating a banking account for the payment specify Account
    If using undeposited funds specify UndepositedFunds
    What are undeposited funds?
  • Account
  • The following set of information pulls through details for the DepositTo Account
    • UIDGuid (36)
    • Please note: Passing the Account UID is optional if you are assigning UndepositedFunds, if allocating a bank account the UID is required.

      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.
  • Contact
  • The following set of information pulls through details for the contact card.
    • TypeString (8)
    • Card type of the contact record, can be either Customer, Supplier, Employee or Personal.
    • UIDGuid (36)
    • Note: Contact is optional and can be left null.
      Foreign Key: Unique guid identifier belonging to the contact card assigned to the money received.
    • NameString (30)
    • Name of the contact.
    • DisplayIDString (15)
    • Contact Card ID, can also be used as a unique contact identifier.
    • URIString
    • Uniform resource identifier associated with the contact card object.
  • ReceiptNumber 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' }
  • AmountReceivedDecimal (13.2)
  • Total of all amounts received.
  • IsTaxInclusiveBoolean
  • True indicates the transaction is set to tax inclusive with the Amount inclusive of tax.
    False indicates the transaction is not tax inclusive with the Amount value tax exclusive.
  • TotalTaxDecimal (13.2)
  • Total of all tax amounts applicable to the receive money.
  • PaymentMethod PaymentMethod
  • Payment methods must exist in company file, default methods consist of the following: (Users can add new methods through AccountRight UI)

    American Express
    Bank Card
    Barter Card
    Cash
    Cheque
    Diners Club
    EFTPOS
    MasterCard
    Money Order
    Other
    Visa
  • Memo String (255)
  • Memo text describing the receive money transaction. Note must contain at least 1 character " " is an invalid string
  • Category
  • The following outlines category information for the receive money transction..
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the receive money.
    • 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
  • Lines []
  • An array of receive money line information
    • RowId Integer
    • Sequence of the entry within the receive money set.
      REQUIRED only when passing the RowVersion for updating an existing receive money line.
    • Account
    • The following set of information pulls through details for an account
      • 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.
    • Job
    • The following set of information pulls through the details for a job
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job for the line.
      • Number String (30)
      • Number assigned to the job
      • Name String (30)
      • Name assigned to the job
      • URI String
      • Uniform resource identifier associated with the job object
    • TaxCode
    • The following set of information pulls through details for the Tax Code
      • UID GUID (36)
      • Foreign Key: Unique tax code identifier in the form of a guid
      • Code String (3)
      • 3 digit code assigned to the tax code.
      • URI String
      • Uniform resource identifier associated with the tax code object.
    • MemoString (1000)
    • Memo text describing the transaction line,
    • AmountDecimal (13.2)
    • Amount to be allocated to the account.
    • UnitCountDecimal (19.6)
    • Quantity value of the receive money transaction.
    • RowVersion String
    • ONLY required on PUT for updating an existing receive money line.
      NOT required when creating a new receive money transaction.
  • ForeignCurrency
  • Null if no foreign currency is set.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the currency in the form of a guid.
    • CodeString (3)
    • The currency code.
    • CurrencyNameString
    • The full name of the currency
    • URIString
    • Uniform resource identifier associated with the currency 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 receieve money.
    NOT required when creating a new receive money.


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

Example json GET response

  • {
  • "UID" : "e4f75785-bfc2-4194-a6f4-1321b0f0c6bf",
  • "DepositTo" : "UndepositedFunds",
  • "Contact" : {
    • "UID" : "9420225c-ce2d-4cb9-a098-3f52fae1caa7",
    • "Name" : "Contact 1",
    • "Type" : "Customer",
    • "DisplayID" : "*None",
    • "URI" : "{cf_uri}/Contact/Customer/9420225c-ce2d-4cb9-a098-3f52fae1caa7"
    • },
  • "ReceiptNumber" : "CR000001",
  • "Date" : "2020-09-22T00:00:00",
  • "AmountReceived" : 37.690000,
  • "IsTaxInclusive" : true,
  • "TotalTax" : 3.420000,
  • "PaymentMethod" : "Visa",
  • "Memo" : "Contact 1",
  • "Category" : null,
  • "Lines" : [
    • {
      • "RowID" : 50,
      • "Job" : {
        • "UID" : "65287c98-2070-49c1-9df8-a8a311eab2f8",
        • "Number" : "ABC",
        • "Name" : "New Job",
        • "URI" : "{cf_uri}/GeneralLedger/Job/65287c98-2070-49c1-9df8-a8a311eab2f8"
        • },
      • "TaxCode" : {
        • "UID" : "e6d18c77-9fce-412a-9f60-9a3ad29bd4d6",
        • "Code" : "GST",
        • "URI" : "{cf_uri}/GeneralLedger/TaxCode/e6d18c77-9fce-412a-9f60-9a3ad29bd4d6"
        • },
      • "Memo" : "part payment",
      • "Amount" : 37.690000,
      • "UnitCount" : null,
      • "RowVersion" : "1591180242368593920"
      • }
    • ],
  • "ForeignCurrency" : {
    • "UID" : "f6f43810-c06d-45d9-8ab0-6abd5f433154",
    • "Code" : "AED",
    • "Name" : "Emirati Dirham",
    • "URI" : "{cf_uri}/GeneralLedger/Currency/f6f43810-c06d-45d9-8ab0-6abd5f433154"
    • },
  • "URI" : "{cf_uri}/Banking/ReceiveMoneyTxn/e4f75785-bfc2-4194-a6f4-1321b0f0c6bf",
  • "RowVersion" : "1519122648330665984"
  • }
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.