DebitRefund

Return, create and delete debit refunds paid from suppliers

Date Released: Dec 2013 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Purchase/DebitRefund 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 DebitRefund. 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 debit refund.
  • DepositToString
  • If allocating a banking account for the payment specify Account
    If using undeposited funds specify UndepositedFunds
  • Account
  • The following set of information pulls through details for an Account
    • UIDGuid (36)
    • Please note: Passing the Account UID is optional if you are assigning ElectronicPayments, if allocating a bank account the UID is required.

      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.
  • Bill
  • The following set of information pulls through details for a purchase bill.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for a bill in the form of a guid.
    • Number String (8)
    • Purchase bill number
    • URIString
    • Uniform resource identifier associated with the bill object.
  • Supplier
  • The following set of information pulls through details for the supplier contact.
    Note: Optional on POST, will default to Supplier on Bill.
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the supplier assigned to the debit refund.
    • 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 number assigned to transaction, if left blank on POST will auto-increment based upon last recorded.
  • DateDateTime
  • Transaction date, format YYYY-MM-DD HH:MM:SS { 'Date': '2013-11-29 10:33:02' }
  • AmountDecimal (13.2)
  • Total amount of the debit to be refunded, can be equal to or less than the bill amount.
  • MemoString (255)
  • Memo text describing the debit refund.
  • PaymentMethod String
  • Payment method text.
  • 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" : "ad917331-d14a-4e63-bd79-f00500dabbc6",
  • "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"
    • },
  • "Bill" : {
    • "UID" : "d2b2926c-f62f-4ad4-a446-c336b5a1557e",
    • "Number" : "00000025",
    • "URI" : "{cf_uri}/Purchase/Bill/d2b2926c-f62f-4ad4-a446-c336b5a1557e"
    • },
  • "Supplier" : {
    • "UID" : "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    • "Name" : "Huston & Huston Packaging",
    • "DisplayID" : "SUPP000004",
    • "URI" : "{cf_uri}/Contact/Supplier/63b984e5-241e-4c1a-bfe1-7868a69f5e29"
    • },
  • "Number" : "CR000043",
  • "Date" : "2013-10-31T00:00:00",
  • "Amount" : 244,
  • "Memo" : "Huston & Huston Packaging: Debit from 00000025",
  • "PaymentMethod" : null,
  • "ForeignCurrency" : null,
  • "URI" : "{cf_uri}/Purchase/DebitRefund/ad917331-d14a-4e63-bd79-f00500dabbc6",
  • "RowVersion" : "-8726764411735244800"
  • }
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.