SpendMoneyTxn

Return, update, create and delete spend money transactions

Date Released: Dec 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Banking/SpendMoneyTxn 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 SpendMoneyTxn. 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 spend money transaction.
    ONLY required for updating an existing spend money.
    NOT required when creating a new spend money.
  • PayFromString
  • If allocating a banking account for the payment specify Account
    If using electronic payments specify ElectronicPayments
    What are electronic payments?
  • Account
  • The following set of information pulls through details for the Pay from Account
    • UIDGuid (36)
    • Please note: Passing the Account UID is optional if you are assigning ElectronicPayments, 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.
    Note: contact can be null on a void transaction.
    • UIDGuid (36)
    • Please note: only required if specifying a contact card on POST.
      Foreign Key: Unique guid identifier belonging to the contact card assigned to the money received.
    • NameString (30)
    • Name of the contact record.
    • TypeString (8)
    • Card type of the contact record, can be either Customer, Supplier, Employee or Personal.
    • DisplayIDString (15)
    • Contact Card ID, can also be used as a unique contact identifier.
    • URIString
    • Uniform resource identifier associated with the contact card object.
  • PayeeAddressString (255)
  • Name and address of Payee, if a contact is supplied on POST and PayeeAddress is left blank, Address 1 of the contact will default.
    If neither Contact or PayAddress are assigned on POST then will default to null.
  • StatementParticularsString
  • ONLY applicable for Electronic Payments.
    Particulars attached to electronic payment.
    What are electronic payments?
  • StatementCodeString
  • ONLY APPLICABLE FOR NZ REGION.
    Code attached to electronic payment.
  • StatementReferenceString
  • ONLY APPLICABLE FOR NZ REGION.
    Reference attached to electronic payment.
  • PaymentNumber 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': '2020-09-14 14:33:02' }
  • AmountPaidDecimal (13.2)
  • Total of all amounts paid.
  • 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 spend money.
  • Memo String (255)
  • Memo text describing the spend money transaction.
  • Lines []
  • An array of spend money line information
    • RowId Integer
    • Sequence of the entry within the spend money set.
      REQUIRED only when passing the RowVersion for updating an existing spend 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.
    • AmountDecimal (13.2)
    • Amount to be allocated to the account.
    • MemoString (1000)
    • Memo text describing the transaction line.
    • UnitCountDecimal (19.6)
    • Quantity value of the spend money transaction.
    • RowVersion String
    • ONLY required on PUT for updating an existing spend money line.
      NOT required when creating a new spend money transaction.
  • ChequePrintedBoolean
  • True indicates you don't need to print a cheque for this spend money.
    False indicates you can print a cheque for spend money .
  • DeliveryStatusString (20)
  • Delivery status assigned to payment:
    Print
    Email
    PrintAndEmail
    Nothing
  • Category
  • The following outlines category information.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the spend 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
  • 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 spend money.
    NOT required when creating a new spend money.

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

Example json GET response

  • {
  • "UID" : "f716e839-6b33-4b29-9724-5b0a7b5569e1",
  • "PayFrom" : "ElectronicPayments",
  • "Account" : {
    • "UID" : "c22baef5-df03-46ae-969f-f253817228ab",
    • "Name" : "Electronic Clearing Account",
    • "DisplayID" : "1-1220",
    • "URI" : "{cf_uri}/GeneralLedger/Account/c22baef5-df03-46ae-969f-f253817228ab"
    • },
  • "Contact" : {
    • "UID" : "9a1ac41b-eacf-4624-8cd7-7e25dc22ecbe",
    • "Name" : "Contact 2",
    • "Type" : "Supplier",
    • "DisplayID" : "*None",
    • "URI" : "{cf_uri}/Contact/Supplier/9a1ac41b-eacf-4624-8cd7-7e25dc22ecbe"
    • },
  • "PayeeAddress" : "Contact 2",
  • "StatementParticulars" : "PAYMENT 1",
  • "PaymentNumber" : "1",
  • "Date" : "2020-09-14T00:00:00",
  • "AmountPaid" : 186.830000,
  • "IsTaxInclusive" : true,
  • "TotalTax" : 16.990000,
  • "Memo" : "Contact 2",
  • "Lines" : [
    • {
      • "RowID" : 39,
      • "Account" : {
        • "UID" : "2de48063-4f9b-4b63-b856-3c6fc01e1e1f",
        • "Name" : "Accounting/Bookeeping Fees",
        • "DisplayID" : "6-1100",
        • "URI" : "{cf_uri}/GeneralLedger/Account/2de48063-4f9b-4b63-b856-3c6fc01e1e1f"
        • },
      • "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"
        • },
      • "Amount" : 186.830000,
      • "Memo" : null,
      • "UnitCount": null,
      • "RowVersion" : "824158731808800800"
      • }
    • ],
  • "ChequePrinted" : false,
  • "DeliveryStatus" : "Print",
  • "Category" : null,
  • "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/SpendMoneyTxn/f716e839-6b33-4b29-9724-5b0a7b5569e1"
  • "RowVersion" : "-5414171177029468160"
  • }
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.