Statistical journals hold all non-monetary journal entries and do not have a debit or credit as a transaction. Instead, statistical journals simply increase or decrease a value.
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.
Subscription | General Ledger |
---|---|
User type | Business, Employee, Approver |
Permissions | List, View Statistical Journals |
OK
Bad Request
{- "ia::result": [
- {
- "key": "36",
- "id": "SMAXIMUM",
- "href": "/objects/general-ledger/statistical-journal/36"
}, - {
- "key": "34",
- "id": "TSSJ",
- "href": "/objects/general-ledger/statistical-journal/34"
}, - {
- "key": "35",
- "id": "SINAJ",
- "href": "/objects/general-ledger/statistical-journal/35"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new statistical Journal
Subscription | General Ledger |
---|---|
User type | Business |
Permissions | Add Statistical Journals |
Statistical journal to create
id required | string An abbreviation (symbol) for this journal, for example, APJ. In most places in Sage Intacct the symbol appears along with the title of the journal, as in "TS--Timesheets." Example: "TSSJ" |
name required | string The full name or title of the journal, as it should appear in reports. Example: "Timesheet Statistical Journal" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "TSSJ",
- "name": "Timesheet Statistical Journal",
- "status": "active"
}
{- "ia::result": {
- "key": "88",
- "id": "TSSJ",
- "href": "/objects/general-ledger/statistical-journal/88"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Get complete details for a specified statistical journal.
Subscription | General Ledger |
---|---|
User type | Business, Employee, Approver |
Permissions | List, View Statistical Journals |
key required | string System-assigned key for a statistical journal. Example: 88 |
OK
Bad Request
{- "ia::result": {
- "id": "TSSJ",
- "name": "Timesheet Statistical Journal",
- "status": "active",
- "audit": {
- "createdDateTime": "2021-06-27T17:16:13Z",
- "modifiedDateTime": "2021-06-27T17:16:13Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "key": "36",
- "href": "/objects/general-ledger/statistical-journal/36"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing statistical journal by setting field values. Any fields not provided remain unchanged.
Subscription | General Ledger |
---|---|
User type | Business |
Permissions | Edit Statistical Journals |
key required | string System-assigned key for a statistical journal. Example: 88 |
name | string The full name or title of the journal, as it should appear in reports. Example: "Timesheet Statistical Journal" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "name": "Timesheet Statistical Journal",
- "status": "active"
}
{- "ia::result": {
- "key": "88",
- "id": "TSSJ",
- "href": "/objects/general-ledger/statistical-journal/88"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a statistical journal. You can only delete a journal if there are no transactions in it.
Subscription | General Ledger |
---|---|
User type | Business |
Permissions | Delete Statistical Journals |
key required | string System-assigned key for a statistical journal. Example: 88 |
No Content
Bad Request
{- "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"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "general-ledger/statistical-journal" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "general-ledger/statistical-journal",
- "filters": [
- {
- "$eq": {
- "status": "inactive"
}
}
], - "fields": [
- "key",
- "id",
- "name",
- "status",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "33",
- "id": "TSSJ",
- "name": "Timesheet Statistical Journal",
- "status": "inactive",
- "href": "/objects/general-ledger/statistical-journal/33"
}
], - "ia::meta": {
- "totalCount": 1,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}