Statistical journals

Statistical journals hold all non-monetary journal entries, which do not have a debit or credit as a transaction. Instead, statistical journal entries simply increase or decrease a value.

List statistical journals

get/objects/general-ledger/statistical-journal

Returns a 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": "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
    }
}

Create a statistical journal

post/objects/general-ledger/statistical-journal

Creates a new statistical journal

SecurityOAuth2
Request
Request Body schema: application/json
required

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 name 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"
disallowDirectPosting
boolean
Default: false

Set to true to prevent direct entry of journal entries for this journal.

Example: false
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"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "id": "TSSJ",
  • "name": "Timesheet Statistical Journal",
  • "status": "active",
  • "disallowDirectPosting": false
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "88",
    • "id": "TSSJ",
    • "href": "/objects/general-ledger/statistical-journal/88"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a statistical Journal

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

Returns detailed information for a specified statistical journal.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for a statistical journal.

Example: 88
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "TSSJ",
    • "name": "Timesheet Statistical Journal",
    • "status": "active",
    • "disallowDirectPosting": false,
    • "bookId": "Accrual",
    • "bookType": "accrual",
    • "audit": {
      • "createdDateTime": "2024-06-27T17:16:13Z",
      • "modifiedDateTime": "2024-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
    }
}

Update a statistical journal

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

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

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for a statistical journal.

Example: 88
Request Body schema: application/json
name
string

The full name or title of the journal, as it should appear in reports.

Example: "Timesheet Statistical Journal"
disallowDirectPosting
boolean
Default: false

Set to true to prevent direct entry of journal entries for this journal.

Example: false
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"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "name": "Timesheet Statistical Journal",
  • "status": "active"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "88",
    • "id": "TSSJ",
    • "href": "/objects/general-ledger/statistical-journal/88"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a statistical journal

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

Deletes a statistical journal. You can only delete a journal if there are no transactions in it.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for a statistical journal.

Example: 88
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}