Profit/Loss Distribution

Returns the Profit and Loss Distribution.

Date Released: Feb 2015 Date Updated: Dec 2020
URLSupports
/{cf_uri}/GeneralLedger/ProfitLossDistribution/ 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 Profit/Loss Distribution. 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

  • EntityString
  • The Entity is set as one of the following
    Partnership
    Company
    UnitTrust
  • ProfitLossDistributionAccounts
  • An array of the Accounts used for the Profit and Loss Distribution
    • HeaderAccount
    • The object that holds the Header account. This is a Equity type 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': '3-1200' }
      • URIString
      • Uniform resource identifier associated with the account object.
    • RetainedEarningsAccount
    • The object that holds the Retained Earnings account. This is a Equity type 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': '3-1200' }
      • URIString
      • Uniform resource identifier associated with the account object.
    • CurrentEarningsAccount
    • The object that holds the Current Earnings account. This is a Equity type 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': '3-1200' }
      • URIString
      • Uniform resource identifier associated with the account object.
    • ValueDecimal (3.2)
    • The Percentage amount that is split from thw total ammount.
    • Unit
    • States that the value is a Percentage
  • RowVersion String
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.

Example json GET response

  • {
  • "Entity": "Partnership",
  • "ProfitLossDistributionAccounts": [
    • {
      • "HeaderAccount": {
        • "UID": "966a972d-9a57-49a7-bc53-c8c77251164f",
        • "Name": "Partner 1",
        • "DisplayID": "3-1000",
        • "URI" : "{cf_uri}/GeneralLedger/Account/966a972d-9a57-49a7-bc53-c8c77251164f
        • },
      • "RetainedEarningsAccount": {
        • "UID": "830edbf8-625a-4ca8-a21f-d10d0c69e1c3",
        • "Name": "Retained Earnings Partner 1",
        • "DisplayID": "3-1001",
        • "URI" : "{cf_uri}/GeneralLedger/Account/830edbf8-625a-4ca8-a21f-d10d0c69e1c3
        • },
      • "CurrentEarningsAccount": {
        • "UID": "ac9d6f88-49db-492a-add5-df5ebb9a41d5",
        • "Name": "Current Earnings Partner 1",
        • "DisplayID": "3-1002",
        • "URI" : "{cf_uri}/GeneralLedger/Account/ac9d6f88-49db-492a-add5-df5ebb9a41d5
        • },
      • "Value": 50.000000,
      • "Unit": "Percent"
      • },
    • {
      • "HeaderAccount": {
        • "UID": "30d3cd9d-94c4-4d05-9a2d-6d240a8b1ba3",
        • "Name": "Partner 2",
        • "DisplayID": "3-2000",
        • "URI" : "{cf_uri}/GeneralLedger/Account/30d3cd9d-94c4-4d05-9a2d-6d240a8b1ba3
        • },
      • "RetainedEarningsAccount": {
        • "UID": "89aa454e-9eb7-4844-a7f9-5e5dad979955",
        • "Name": "Retained Earnings Partner 2",
        • "DisplayID": "3-2001",
        • "URI" : "{cf_uri}/GeneralLedger/Account/89aa454e-9eb7-4844-a7f9-5e5dad979955
        • },
      • "CurrentEarningsAccount": {
        • "UID": "b20b3397-8ba5-4e4f-bc67-cd7ef2dd1616",
        • "Name": "Current Earnings Partner 2",
        • "DisplayID": "3-2002",
        • "URI" : "{cf_uri}/GeneralLedger/Account/b20b3397-8ba5-4e4f-bc67-cd7ef2dd1616
        • },
      • "Value": 50.000000,
      • "Unit": "Percent"
      • }
    • ],
  • "RowVersion": "784066139813576704"
  • }
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.