DebitSettlement

Return, create and delete debit settlements.

Date Released: Dec 2013 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Purchase/DebitSettlement 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

The elements list below details information for DebitSettlement. 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 debit note.
  • DebitFromBill
  • The following set of information pulls through details for a purchase bill debit.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for a purchase bill in the form of a guid.
    • Number String (8)
    • Purchase bill number
    • URIString
    • Uniform resource identifier associated with the purchase bill object.
  • Supplier
  • The following set of information pulls through details for supplier contact.
    Note: This is optional on POST, defaults to supplier on DebitFromBill
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the supplier assigned to the debit settlement.
    • NameString (30)
    • Name of the supplier contact.
    • DisplayIDString (15)
    • Supplier contact Card ID, can also be used as a unique supplier contact identifier.
    • URIString
    • Uniform resource identifier associated with the supplier object.
  • Number String (8)
  • ID transaction number, if left blank on POST will auto increment based upon last recorded.
  • DateDateTime
  • Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-12-19 11:33:02' }
  • DebitAmountDecimal (13.2)
  • Total debit amount to be applied, can only be less than or equal to DebitFromBill amount.
  • MemoString (255)
  • Memo text describing the settled debit.
  • Lines []
  • The following set of information pulls through line details for the debit settlement.
    • TypeString
    • Purchase type which can consist of the following:
      Bill
      Order
    • Purchase
    • The following set of information pulls through details for a purchase.
      • UIDGuid (36)
      • Foreign Key: Unique identifier for a purchase in the form of a guid.
      • Number String (8)
      • Purchase transaction number.
      • URIString
      • Uniform resource identifier associated with the purchase transaction object.
    • AmountAppliedDecimal (13.2)
    • Debit amount applied to purchases 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
  • 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" : "81f72366-be5e-435b-8c1e-27eebdda67b7",
  • "DebitFromBill" : {
    • "UID" : "f1b01e15-df87-4266-a280-e96d3fc657c1",
    • "Number" : "00000068",
    • "URI" : "{cf_uri}/Purchase/Bill/f1b01e15-df87-4266-a280-e96d3fc657c1"
    • },
  • "Supplier" : {
    • "UID" : "55d7948c-283b-4cc8-b99e-ec634f63b53c",
    • "Name" : "Mountain Spring",
    • "DisplayID" : "SUPP000007",
    • "URI" : "{cf_uri}/Contact/Supplier/55d7948c-283b-4cc8-b99e-ec634f63b53c"
    • },
  • "Number" : "PJ001009",
  • "Date" : "2013-11-12T00:00:00",
  • "DebitAmount" : 350.63,
  • "Memo" : "Mountain Spring: Debit from 00000068",
  • "Lines" : [
    • {
  • "Type" : "Bill",
  • "Purchase" : {
    • "UID" : "c18700bd-cabc-4fc0-922f-44115e33d347",
    • "Number" : "00000067",
    • "URI" : {cf_uri}/Purchase/Bill/c18700bd-cabc-4fc0-922f-44115e33d347"
    • },
  • "AmountApplied" : 350.63
  • }
  • ],
  • "ForeignCurrency" : null,
  • "URI" : "{cf_uri}/Purchase/DebitSettlement/81f72366-be5e-435b-8c1e-27eebdda67b7",
  • "RowVersion" : "8927346127557099520"
  • }
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.