Journals

Journals serve to categorize transactions that are directly entered in the General Ledger and the transactions that are posted from subledgers such as Accounts Payable. For more information see What journals do you need?

List journals

get/objects/general-ledger/journal

Returns up to 100 journals from the collection with a key, ID, and link for each journal. This operation is mostly for use in testing; use the query service to find journals that meet certain criteria and to specify the properties that you want in the response.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "AR",
      • "href": "/objects/general-ledger/journal/1"
      },
    • {
      • "key": "2",
      • "id": "AP",
      • "href": "/objects/general-ledger/journal/2"
      },
    • {
      • "key": "14",
      • "id": "ADJ",
      • "href": "/objects/general-ledger/journal/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a journal
get/objects/general-ledger/journal/{key}
Returns detailed information for a specified journal.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the journal.


 
 Example:  411
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "EJ",
    • "status": "active",
    • "name": "Expense Journal",
    • "isAdjustment": true,
    • "bookId": "Accrual",
    • "bookType": "accrual",
    • "disallowDirectPosting": false,
    • "audit": {
      • "createdDateTime": "2023-01-20T10:25:30Z",
      • "modifiedDateTime": "2023-11-02T08:30:22Z",
      • "createdBy": "68",
      • "modifiedBy": "72"
      },
    • "isBillable": false,
    • "href": "/objects/general-ledger/journal/3"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}