GeneralJournal

Return, update, create and delete general journal transactions

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/GeneralLedger/GeneralJournal 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 GeneralJournal. 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

  • UID GUID (36)
  • Unique guid identifier created for a general journal transaction.
    ONLY required for updating an existing general journal entry
    NOT required when creating a new general journal entry.
  • DisplayID String (13)
  • General journal number, if left null when posting, a number will automatically be assigned and incremented based upon last recorded
  • DateOccurred DateTime
  • Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'DateOccured': '2013-03-04 13:33:02' }
  • IsTaxInclusive Boolean
  • True indicates the transaction default status is set to tax inclusive
    False indicates the transaction status is not tax inclusive
  • Memo String (255)
  • Header memo of the general journal entry
  • GSTReportingMethod
  • Reporting Method used on the general journal transaction which accepts the following:
    Sale (Supply)
    Purchase (Acquisition) { 'GSTReportingMethod': 'Purchase' }
  • IsYearEndAdjustment Boolean
  • True indicates the transaction is a YearEndAdjustment
    False indicates the transaction is not a YearEndAdjustment
  • Category
  • The following outlines the category information for this general journal item.
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned to the general journal entry
    • Name String (30)
    • Name of the category
    • DisplayID String (13)
    • Display id for the category
    • URI String
    • Uniform resource identifier associated with the category object
  • Lines []
  • An array of line item information
    • RowIDInteger
    • Sequence of the entry within the general journal set.
      REQUIRED only when passing the RowVersion for updating an existing general journal line.
    • Account
    • The following set of information pulls through the details for the accounts
      • UIDGUID (36)
      • Foreign Key: Unique guid identifier belonging to the account for this line of the general journal entry
      • Name String (60)
      • Account name belonging to the account record
      • DisplayID String (6)
      • Account code format includes separator ie 1-1100 { 'DisplayID': '1-1100' }
      • URI String
      • Uniform resource identifier associated with the account object
    • Job
    • The following set of information pulls through the details for the jobs
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job for this line of the general journal entry
      • Number String (30)
      • Number assigned to the job
      • Name String (30)
      • Name assigned to the job
      • URI String
      • Uniform resource identifier associated with the job object
    • Memo String (1000)
    • Memo text applied to the line of the transaction
    • TaxCode
    • The following set of information pulls through the details for the TaxCodes
      • UIDGUID (36)
      • Foreign Key: Unique guid identifier belonging to the tax code for this line of the general journal entry
      • Code String (3)
      • 3 digit Code belonging to the tax code for this line of the general journal entry
      • URI String
      • Uniform resource identifier associated with the TaxCode object
    • AmountDecimal (13.6)
    • Dollar amount posted to the line of the transaction.
      Note: if posting with tax, the amount is always tax exclusive.
    • AmountForeignDecimal (13.6)
    • Mandatory if a ForeignCurrency is supplied for POST.
      Dollar amount posted to the line of the transaction in foreign currency.
      Note: If posting with foreign tax, the amount is always tax exclusive.
    • IsCreditBoolean
    • True indicates the amount posted to the account as a credit.
      False indicates the amount posted to the account as a debit.
    • TaxAmount Decimal (13.6)
    • Tax amount for the line of the journal if using an applicable TaxCode.
    • TaxAmountForeignDecimal (13.6)
    • Foreign currency tax amount for the line of the journal if using an applicable TaxCod.
    • IsOverriddenTaxAmount Boolean,
    • True indicates the tax amount has been altered
      False indicates the tax amount has not been altered
    • UnitCountDecimal (19.6)
    • Quantity value of the general journal entry
    • RowVersion String
    • ONLY required on PUT for updating an existing general journal line.
      NOT required when creating a new general journal.
  • ForeignCurrency
  • Foreign currency information in the transaction.
    • 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.
  • URI String
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web
  • CurrencyExchangeRateDecimal (13.8)
  • The exchange rate between the Local and Foreign currency
  • 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.
    ONLY required for updating an existing general journal entry.
    NOT required when creating a new general journal entry.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID": "d24ce081-bab2-4477-8548-aa88803a4f89",
  • "DisplayID": "GJ000001",
  • "DateOccurred": "2013-06-17T13:11:07.777",
  • "IsTaxInclusive": false,
  • "Memo": "Bank charges money transfer",
  • "GSTReportingMethod": "Purchase",
  • "IsYearEndAdjustment": false,
  • "Category": {
    • "UID": "0c55818c-855a-452e-be92-d8a1595fc5e9",
    • "Name": "Category 001",
    • "DisplayID": "CAT001",
    • "URI": "{cf_uri}/GeneralLedger/Category/0c55818c-855a-452e-be92-d8a1595fc5e9"
    • },
  • "Lines": [
    • {
    • "RowID": 548,
    • "Account": {
      • "UID": "08c7b342-48bf-4013-bd31-c5be38397804",
      • "Name": "General Cheque Account 1",
      • "DisplayID": "1-1110",
      • "URI": "{cf_uri}/GeneralLedger/Account/08c7b342-48bf-4013-bd31-c5be38397804,"
      • },
    • "Job": null,
    • "Memo": "TestAPI1",
    • "TaxCode": {
      • "UID": "46bdada1-adb1-4758-9bee-9a95a97da91f",
      • "Code": "N-T",
      • "URI": "{cf_uri}/GeneralLedger/TaxCode/46bdada1-adb1-4758-9bee-9a95a97da91f"
      • },
    • "Amount": 10,
    • "AmountForeign" : null,
    • "IsCredit": false,
    • "TaxAmount": 0,
    • "TaxAmountForeign" : null,
    • "IsOverriddenTaxAmount": false,
    • "UnitCount": 5.5,
    • "RowVersion": "5881473514438918144"
    • },
    • {
    • "RowID": 549,
    • "Account":
      • {
      • "UID": "4e518323-2380-4817-8e15-471db4b1a7f1",
      • "Name": "BankCharges",
      • "DisplayID": "6-1120",
      • "URI": "{cf_uri}/GeneralLedger/Account/4e518323-2380-4817-8e15-471db4b1a7f1"
      • },
    • "Job": null,
    • "Memo": "TestAPI2",
    • "TaxCode": {
      • "UID": "46bdada1-adb1-4758-9bee-9a95a97da91f",
      • "Code": "N-T",
      • "URI": "{cf_uri}/GeneralLedger/TaxCode/46bdada1-adb1-4758-9bee-9a95a97da91f"
      • },
    • "Amount": 10,
    • "AmountForeign" : null,
    • "IsCredit": true,
    • "TaxAmount": 0,
    • "TaxAmountForeign" : null,
    • "IsOverriddenTaxAmount": false,
    • "UnitCount": null,
    • "RowVersion": "9881473524438918145"
    • }
  • ],
  • "ForeignCurrency" : null,
  • "Uri": "{cf_uri}/GeneralJournal/GJ000001/d24ce081-bab2-4477-8548-aa88803a4f89",
  • "CurrencyExchangeRate" : null,
  • "RowVersion": "3860992255540068400"
  • }
  • 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.