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.

Permissions and other requirements

Subscription	General Ledger
User type	Business, Employee, Approver, Project Manager, and Warehouse
Permissions	List, View Journals

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

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
}
}

Create a journal

post/objects/general-ledger/journal

Creates a new journal object. New journals are immediately available for users to enter journal entries through the General Ledger. They are also available to be used in the configuration of other applications. For example, you might create a Labor Cost journal to be used by the Projects application.

SecurityOAuth2

Request

Request Body schema: application/json

Journal to create

id required	string An abbreviation (symbol) for this journal, for example, AP. In most places in Sage Intacct, the symbol appears along with the title of the journal, as in "AP--Accounts Payable." Example: "EJ"
name required	string The full name of the journal, as it should appear in reports. Example: "Expense Journal"
isBillable	boolean Default: false Set to `true` to enable journal entry line items for a project to be marked as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) Example: true
status	string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Enum: "active" "inactive" Example: "active"
isAdjustment	boolean Default: false Set to `true` if the journal is an adjustments journal. Example: false
bookType	string Default: "accrual" A book type could be Accrual, Cash, Cash and Accrual or Consolidation. For most companies, the reporting book is accrual. If the company is set up for dual-method reporting, the choices are accrual, cash, or accrual and cash. Enum: "accrual" "cash" "cashAndAccrual" "consolidation" Example: "accrual"

Responses

201

Created

400

Bad Request

Request samples

application/json

{"id": "EJ",
"name": "Expense Journal",
"bookType": "accrual"
}

Response samples

application/json

{"ia::result": {"key": "3",
"id": "EJ",
"href": "/objects/general-ledger/journal/3"
},
"ia::meta": {"totalCount": 1
}
}

Get a journal

get/objects/general-ledger/journal/{key}

Returns detailed information for a specified journal.

Permissions and other requirements

Subscription	General Ledger
User type	Business, Employee, Approver, Project Manager, and Warehouse
Permissions	List, View Journals

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal.

Example: 411

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"key": "3",
"id": "EJ",
"status": "active",
"name": "Expense Journal",
"isAdjustment": true,
"bookId": "Accrual",
"bookType": "accrual",
"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
}
}

Update a journal

patch/objects/general-ledger/journal/{key}

Updates an existing journal by setting field values. Any fields not provided remain unchanged.

Permissions and other requirements

Subscription	General Ledger
User type	Business user with admin privileges
Permissions	Edit Journals

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal.

Example: 411

Request Body schema: application/json

id	string An abbreviation (symbol) for this journal, for example, AP. In most places in Sage Intacct, the symbol appears along with the title of the journal, as in "AP--Accounts Payable." Example: "EJ"
name	string The full name of the journal, as it should appear in reports. Example: "Expense Journal"
isBillable	boolean Default: false Set to `true` to enable journal entry line items for a project to be marked as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) Example: true
status	string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Enum: "active" "inactive" Example: "active"
isAdjustment	boolean Default: false Set to `true` if the journal is an adjustments journal. Example: false
bookType	string Default: "accrual" A book type could be Accrual, Cash, Cash and Accrual or Consolidation. For most companies, the reporting book is accrual. If the company is set up for dual-method reporting, the choices are accrual, cash, or accrual and cash. Enum: "accrual" "cash" "cashAndAccrual" "consolidation" Example: "accrual"

Responses

200

400

Bad Request

Request samples

application/json

{"name": "Expense Journal",
"isBillable": true
}

Response samples

application/json

{"ia::result": {"key": "3",
"id": "EJ",
"href": "/objects/general-ledger/journal/3"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete a journal

delete/objects/general-ledger/journal/{key}

Deletes a journal. You can only delete a journal if it does not have any transactions in it. Deleted journals cannot be recovered.

Permissions and other requirements

Subscription	General Ledger
User type	Business user with admin privileges
Permissions	Delete Journals

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal.

Example: 411

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "Payload contains errors",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"errorId": "REST-1064",
"additionalInfo": {"messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
"placeholders": { },
"propertySet": { }
},
"details": [{"code": "invalidRequest",
"message": "/testDate is not a valid field",
"errorId": "REST-1043",
"target": "/testDate",
"additionalInfo": {"messageId": "IA.NOT_A_VALID_FIELD",
"placeholders": {"FIELD": "/testDate"
},
"propertySet": { }
}
}
]
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
},
"ia::error": {"code": "invalidRequest",
"message": "Malformed URL",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"details": [{"code": "invalidRequest",
"message": "The content type is not valid",
"correction": "TODO"
}
]
}
}

Query journals

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2

Request

Request Body schema: application/json

object

string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "general-ledger/journal"

fields

Array of strings

List of fields to include in the response. Can be any combination of these:

The name of a field in the object that you are querying, such as id.
The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
- count
- avg
- sum
- min
- max
The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

Example: ["key","id","max:vendor.creditLimit"]

Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]

Array

Any of:

Field value must be equal to this specified value.

For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:

today
currentWeek
currentMonth
currentQuarter
currentYear

yesterday
lastWeek
priorMonth
priorQuarter
priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}

filterExpression

string

Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

and by itself means that all conditions must be true.
or by itself means that at least one condition must be true.

Example: "(1 and 2) or 3"

object

Pre-defined filter options.

asOfDate	string <date> The "as of" date to use with any relative date comparisons in `filters`. For example, if `asOfDate` is set to "2022-04-01" then `priorMonth` will be "03". The current date is used if `asOfDate` is not set. Example: "2022-04-01"
includeHierarchyFields	boolean Default: false Set to `true` to include hierarchical structure information with each object in the response. Example: false
caseSensitiveComparison	boolean Default: true Queries are case-sensitive by default. Set to `false` to ignore case in a query. Example: true
includePrivate	boolean Default: false By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities. Example: false

Array of objects

Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.

Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]

Array

property name*

additional property

string

Enum: "asc" "desc"

start

integer

First record of the result set to include in the response.

Example: 1

size

integer

Number of records to include in the response.

Example: 100

Responses

200

400

Bad Request

Request samples

application/json

{"object": "general-ledger/journal",
"filters": [{"$eq": {"bookId": "Accrual"
}
}
],
"fields": ["key",
"id",
"name",
"status",
"href"
],
"orderBy": [{"id": "asc"
}
]
}

Response samples

application/json

{"ia::result": [{"key": "14",
"id": "ADJ",
"name": "Adjustment journal",
"status": "active",
"href": "/objects/general-ledger/journal/14"
},
{"key": "2",
"id": "AP",
"name": "Accounts Payable",
"status": "active",
"href": "/objects/general-ledger/journal/2"
},
{"key": "1",
"id": "AR",
"name": "Accounts Receivable",
"status": "active",
"href": "/objects/general-ledger/journal/1"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}