SpendMoneyTxn

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.