CreditSettlement

Return, create and delete settled customer credits

Date Released: Dec 2013 Date Updated: Dec 2020
URLSupports
/{cf_uri}/Sale/CreditSettlement 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 CreditSettlement. 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 settled credit note.
  • CreditFromInvoice
  • The following set of information pulls through details for a sales credit 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.
  • DateDateTime
  • Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-12-17 15:33:02' }
  • CreditAmountDecimal (13.2)
  • Total credit amount to be applied, can only be less than or equal to CreditFromInvoice amount.
  • MemoString (255)
  • Memo text describing the settled credit.
  • Lines []
  • The following set of information pulls through line details for the credit settlement.
    • TypeString
    • Sale type which can consist of the following:
      Invoice
      Order
    • Sale
    • The following set of information pulls through details for a sales transaction.
      • UIDGuid (36)
      • Foreign Key: Unique identifier for an sales transaction in the form of a guid.
      • Number String (8)
      • Sales transaction number.
      • URIString
      • Uniform resource identifier associated with the sales transaction object.
    • AmountAppliedDecimal (13.2)
    • Credit amount applied to sales transactions, amount must be greater than 0.
  • 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
  • Incrementing number that 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" : "de47923b-9cb7-4ade-a3eb-58d7f95460c1",
  • "CreditFromInvoice" : {
    • "UID" : "efb6261b-04a1-47c4-89fe-74f1538b89ac",
    • "Number" : "00000068",
    • "URI" : "{cf_uri}/Sale/Invoice/efb6261b-04a1-47c4-89fe-74f1538b89ac"
    • },
  • "Customer" : {
    • "UID" : "bda2dcf4-4db1-4f82-b208-5f9a8708fe5a",
    • "Name" : "Island Way Motel",
    • "DisplayID" : "CUS000006",
    • "URI" : "{cf_uri}/Contact/Customer/bda2dcf4-4db1-4f82-b208-5f9a8708fe5a"
    • },
  • "Number" : "SJ000001",
  • "Date" : "2013-10-25T00:00:00",
  • "CreditAmount" : 92.5,
  • "Memo" : "Island Way Motel: Credit from 00000068",
  • "Lines" : [
    • {
  • "Type" : "Invoice",
  • "Sale" : {
    • "UID" : "4dc0436d-1e89-4935-b8bb-3d3866626047",
    • "Number" : "00000081",
    • "URI" : "{cf_uri}/Sale/Invoice/4dc0436d-1e89-4935-b8bb-3d3866626047"
    • },
  • "AmountApplied" : 92.50
  • }
  • ],
  • "ForeignCurrency" : null,
  • "URI" : "{cf_uri}/Sale/CreditSettlement/de47923b-9cb7-4ade-a3eb-58d7f95460c1",
  • "RowVersion" : "-5217983118262140928"
  • }
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.