CustomerPayment

Attribute Details

• UIDGuid (36)
• Unique guid identifier created for a customer payment.
• 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 Account
• • UIDGuid (36)
  • 
    Foreign Key: Unique identifier for the account in the form of a guid.
  • NameString (60)
  • 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.
• Customer
• The following set of information pulls through details for the Customer contact
• • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the customer assigned to the customer payment.
  • NameString (30)
  • Name of the customer.
  • DisplayIDString (15)
  • Customer contact Card ID, can also be used as a unique customer contact identifier.
  • URIString
  • Uniform resource identifier associated with the customer object.
• ReceiptNumber String (13)
• ID No of payment transaction.
• 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 applicable to the sale invoice.
• AmountReceivedForeignDecimal (13.2)
• Total of all amounts applicable to the sale invoice in foreign currency.
• 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 of the customer payment entry.
• Invoices []
• An array of line invoice information
• • RowId Integer
  • Sequence of the entry within the customer payment set.
  • Number String (8)
  • Sales invoice number
  • UIDGuid (36)
  • Foreign Key: Unique guid identifier belonging to the invoice assigned to the customer payment.
  • AmountAppliedDecimal (13.2)
  • Mandatory for a Local currency record : Amount applied to invoice.
  • AmountAppliedForeignDecimal (13.2)
  • Mandatory for a Foreign currency record : Amount applied to invoice in foreign currency.
  • TypeString
  • Sale type, can consist of the following:
    Invoice
    Order
  • TransactionIDString
  • Transaction ID of payment transaction.
  • ForeignCurrency
  • Foreign currency information in the transaction.
  • • UIDGuid (36)
    • Foreign Key: Unique identifier for the currency in the form of a guid.
    • CodeString (3)
    • The currency code.
    • NameString
    • The full name of the currency.
    • URIString
    • Uniform resource identifier associated with the currency object.
  • CurrencyExchangeRateDecimal
  • Currency exchange rate in the associated currency object.
  • 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.

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