CustomerPayment

Return, create and delete customer payments

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Sale/CustomerPayment 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 or the AccountRight Browser

The elements list below details information for CustomerPayment. 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 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.

Example json GET response

  • {
  • "UID" : "292c4c5a-0f42-4fc3-8f78-d53f135e1a11",
  • "DepositTo" : "Account",
  • "Account" : {
    • "UID" : "7772dc25-5ee6-4a61-994e-28c04b8a35fc",
    • "Name" : "General Cheque Account 1",
    • "DisplayID" : "1-1110",
    • "URI" : "{cf_uri}/GeneralLedger/Account/7772dc25-5ee6-4a61-994e-28c04b8a35fc"
    • },
  • "Customer" : {
    • "UID" : "d61a6a86-453a-48bf-9402-6eb6b4ea23cf",
    • "Name" : "A-Z Stationery Supplies",
    • "DisplayID" : "CUS000001",
    • "URI" : "{cf_uri}/Contact/Customer/d61a6a86-453a-48bf-9402-6eb6b4ea23cf"
    • },
  • "ReceiptNumber" : "CR000022",
  • "Date" : "2014-03-26T00:00:00",
  • "AmountReceived" : 46.2,
  • "AmountReceivedForeign" : null,
  • "PaymentMethod" : "Visa",
  • "Memo" : "Payment; A-Z Stationery Supplies",
  • "Invoices" : [
    • {
  • "RowID" : 433,
  • "Number" : "00000028",
  • "UID" : "962db553-3a04-43c6-a45e-d77d3d94bf87",
  • "AmountApplied" : 46.2,
  • "AmountAppliedForeign" : null,
  • "Type" : "Invoice",
  • "URI" : "{cf_uri}/Sale/Invoice/Item/962db553-3a04-43c6-a45e-d77d3d94bf87"
  • }
  • ],
  • "TransactionID" : null,
  • "ForeignCurrency" : null,
  • "CurrencyExchangeRate" : null,
  • "URI" : "{cf_uri}/Sale/CustomerPayment/292c4c5a-0f42-4fc3-8f78-d53f135e1a11",
  • "RowVersion" : "-6665890398461755392"
  • }
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.