CreditRefund

Return, create and delete credit notes refunded to customers.

Date Released: Dec 2013 Date Updated: Dec 2020
URLSupports
/{cf_uri}/Sale/CreditRefund 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 CreditRefund. 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 credit note refund.
  • 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 4-1100{ 'DisplayID': '4-1100' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • Invoice
  • The following set of information pulls through details for a sale invoice.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for an invoice in the form of a guid.
    • Number String (8)
    • Sales invoice number
    • URIString
    • Uniform resource identifier associated with the invoice 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 credit refund.
    • NameString (30)
    • Name of the customer contact.
    • 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.
  • Number String (13)
  • Cheque credit number # optional on POST as will auto increment based upon last recorded if left blank.
  • PayeeString (255)
  • Payee address on the credit note belonging to the customer contact.
  • DateDateTime
  • Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-11-30 16:35:02' }
  • AmountDecimal (13.2)
  • Total credit amount to be refunded, can be equal to or less than the invoice amount.
  • MemoString (255)
  • Memo text describing the credit refund.
  • ChequePrintedBoolean
  • True indicates the credit refund has been already printed.
    False indicates the credit refund has not been printed.
  • DeliveryStatusString (20)
  • Remittance advise delivery status assigned to credit note:
    Print = ToBePrinted
    Email = ToBeEmailed
    PrintAndEmail = ToBePrintedAndEmailed
    Nothing = AlreadyPrintedOrSent
  • 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.
  • 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" : "96041019-25b7-4c19-9a92-31ae03e4a1d0",
  • "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"
    • },
  • "Invoice" : {
    • "UID" : "2460d043-2c7f-4728-bf4d-d240619d2d34",
    • "Number" : "00000013",
    • "URI" : "{cf_uri}/Sale/Invoice/2460d043-2c7f-4728-bf4d-d240619d2d34"
    • },
  • "Customer" : {
    • "UID" : "2d0e4d30-7bd6-40ce-85f9-a0cfc95e110c",
    • "Name" : "Chelsea Mosset",
    • "DisplayID" : "CUS000009",
    • "URI" : "{cf_uri}/Contact/Customer/2d0e4d30-7bd6-40ce-85f9-a0cfc95e110c"
    • },
  • "Number" : "107",
  • "Payee" : "Chelsea Mosset 63 Travers Drive Gosford NSW 2430 Australia",
  • "Date" : "2013-08-19T00:00:00",
  • "Amount" : 23.76,
  • "Memo" : "Chelsea Mosset: Credit from 00000013",
  • "ChequePrinted" : false,
  • "DeliveryStatus" : "Print",
  • "ForeignCurrency" : null,
  • "URI" : "{cf_uri}/Sale/CreditRefund/96041019-25b7-4c19-9a92-31ae03e4a1d0",
  • "RowVersion" : "6592988379493695488"
  • }
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.