Journal entries

Use journal entries to add, edit, or reverse transactions to a journal.

When writing journal entries, be sure to balance the general ledger by posting offsetting entries.

Note: If GL Outlier Detection is enabled for a company, information about outliers is included in journal entries and allocation splits when you get a journal entry object.

List journal entries

get/objects/general-ledger/journal-entry

Returns up to 100 journal entries from the collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find journal entries 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 user with Admin privileges, Employee, Payment Approver
Permissions	List, View Journal Entries

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": [{"key": "256",
"id": "256",
"href": "/objects/general-ledger/journal-entry/256"
},
{"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132"
},
{"key": "56",
"id": "56",
"href": "/objects/general-ledger/journal-entry/56"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}

Create a journal entry

post/objects/general-ledger/journal-entry

Creates a new journal entry (transaction). You can post a transaction to a journal right away, or save it as a draft.

Draft transactions do not have to be complete; they can be reviewed and updated before they are posted.
In order to post a journal entry, the entire transaction must balance and all required information must be entered.

Permissions and other requirements

Subscription	General Ledger, Projects (for revenue recognition of projects)
User type	Business
Permissions	Add Journal Entries

SecurityOAuth2

Request

Request Body schema: application/json

Journal entry to create

required

object

The journal to use for this entry.

key	string System-assigned key for the journal. Example: "3"
id	string The id of the journal. Example: "EJ"

postingDate

required

string <date>

Posting date.

Example: "2023-04-01"

description

required

string

Description of the transaction.

Example: "Revenue entries"

required

Array of objects >= 2 items

Journal entry lines included in this entry. Must have at least two lines, one debit and one credit.

Array (>= 2 items)

txnAmount required	string <decimal-precision-2> Transaction amount as an absolute value. Example: "100.45"
txnType required	string Default: "debit" Transaction type - debit or credit. Enum: "credit" "debit" Example: "credit"
required	object
documentId	string Document number of entry. Example: "Revenue_Documentation"
description	string Description of the journal entry line. Example: "Revenue Entries"
numberOfUnits	integer Number of units Example: 5
accountingPeriod	integer Accounting period if company uses custom accounting periods. Example: 11
isBillable	boolean Default: false Set to `true` to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) Example: false
	object Exchange rate details used to calculate the base amount.
state	string Default: "posted" State to update the entry to. Posted to post to the GL Enum: "approved" "declined" "draft" "paid" "partiallyApproved" "partiallyPaid" "posted" "reversal" "reversalPending" "reversed" "submitted" Example: "draft"
	object
	object Template to use for predefined transaction allocations.
	object
	object Journal entry that this journal entry line is owned by.

automaticReversalDate

string or null <date>

Reversal date if you want to reverse this transaction on a certain date. Must be greater than postingDate.

Example: "2023-04-04"

moduleName

string

Intacct module that the journal entry originates from.

Example: "2.GL"

referenceNumber

string

User-provided reference number.

Example: "Recurr_GL_101"

object

Base location for a multi-entity company. Required if a company is multi-entity enabled and entries do not balance by entity.

key	string Location key. Example: "32"
id	string Location unique ID. Example: "BC"

state

string

Default: "posted"

State of the entry. The only valid values when creating a new entry are posted (default) to post to the GL, and draft.

Enum: "approved" "declined" "draft" "partiallyApproved" "posted" "reversalPending" "reversed" "submitted"

Example: "draft"

Responses

201

Created

400

Bad Request

Request samples

application/json

{"glJournal": {"id": "GJ"
},
"postingDate": "2022-04-01",
"description": "March Revenue Posting",
"lines": [{"lineNumber": 1,
"txnType": "credit",
"entryDate": "2022-04-01",
"txnAmount": "200",
"glAccount": {"id": "1000"
},
"dimensions": {"department": {"key": "11"
},
"location": {"key": "192"
}
},
"documentId": "Revenue_attachment"
},
{"lineNumber": 2,
"txnType": "debit",
"entryDate": "2022-04-01",
"txnAmount": "200",
"glAccount": {"id": "1000"
},
"dimensions": {"department": {"key": "11"
},
"location": {"key": "192"
}
},
"documentId": "Revenue_attachment"
}
]
}

Response samples

application/json

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

Get journal entry

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

Returns detailed information for a specified journal entry.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal entry.

Example: 132

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"id": "132",
"key": "132",
"txnNumber": 40,
"description": "Revenue Entries",
"glJournal": {"key": "23",
"id": "CRJ",
"isAdjustment": false,
"href": "/objects/general-ledger/journal/23"
},
"postingDate": "2021-09-24",
"moduleName": "2.GL",
"referenceId": "CR0",
"automaticReversalDate": null,
"reversedBy": {"key": null
},
"reversedFromDate": null,
"baseLocation": {"id": null,
"key": null
},
"audit": {"createdDateTime": "2023-06-09T00:33:58Z",
"modifiedDateTime": "2023-06-09T00:33:59Z",
"createdBy": "68",
"modifiedBy": "68"
},
"state": "posted",
"sequenceNumber": null,
"taxSolutionId": {"id": null
},
"accountAllocationRun": {"id": null,
"key": null
},
"lines": [{"id": "8434",
"key": "8434",
"journalEntry": {"id": "3235",
"key": "3235",
"href": "/objects/general-ledger/journal-entry/3235"
},
"lineNumber": 1,
"txnType": "credit",
"entryDate": "2021-09-24",
"txnAmount": "100",
"account": {"key": "9",
"id": "4000",
"name": "Revenue",
"href": "/objects/general-ledger/account/9"
},
"dimensions": {"department": {"key": "1",
"id": "01",
"name": "Sales",
"href": "/objects/company-config/department/1"
},
"location": {"key": "1",
"id": "CA",
"name": "California",
"href": "/objects/company-config/location/1"
},
"class": {"key": null,
"id": null,
"name": null
},
"item": {"key": null,
"id": null,
"name": null
},
"customer": {"key": null,
"id": null,
"name": null
},
"vendor": {"key": null,
"id": null,
"name": null
},
"project": {"key": null,
"id": null,
"name": null
},
"employee": {"key": null,
"id": null,
"name": null
},
"warehouse": {"key": null,
"id": null,
"name": null
},
"task": {"key": null,
"id": null,
"name": null
}
},
"documentId": "Revenue_attachment",
"description": null,
"numberOfUnits": null,
"currency": {"baseCurrency": "USD",
"txnCurrency": "USD",
"exchangeRateDate": "2023-06-08",
"exchangeRateTypeId": null,
"exchangeRate": 1
},
"accountAllocationTimePeriod": null,
"allocation": {"id": null,
"key": null
},
"audit": {"createdDateTime": "2023-06-09T00:33:58Z",
"modifiedDateTime": "2023-06-09T00:33:59Z",
"createdBy": "68",
"modifiedBy": "68"
},
"state": "posted",
"isBillable": false,
"isBilled": null,
"href": "/objects/general-ledger/journal-entry-line/8434"
},
{"id": "8435",
"key": "8435",
"journalEntry": {"id": "3235",
"key": "3235",
"href": "/objects/general-ledger/journal-entry/3235"
},
"lineNumber": 2,
"transactionType": "Debit",
"entryDate": "2023-06-08",
"transactionAmount": 200,
"glAccount": {"key": "81",
"id": "1000",
"name": "Checking",
"href": "/objects/general-ledger/account/81"
},
"dimensions": {"department": {"key": "1",
"id": "01",
"name": "Sales",
"href": "/objects/company-config/department/1"
},
"location": {"key": "1",
"id": "CA",
"name": "California",
"href": "/objects/company-config/location/1"
},
"class": {"key": null,
"id": null,
"name": null
},
"item": {"key": null,
"id": null,
"name": null
},
"customer": {"key": null,
"id": null,
"name": null
},
"vendor": {"key": null,
"id": null,
"name": null
},
"project": {"key": null,
"id": null,
"name": null
},
"employee": {"key": null,
"id": null,
"name": null
},
"warehouse": {"key": null,
"id": null,
"name": null
},
"task": {"key": null,
"id": null,
"name": null
}
},
"documentId": "Revenue_attachment",
"description": null,
"numberOfUnits": null,
"currency": {"baseCurrency": "USD",
"txnCurrency": "USD",
"exchangeRateDate": "2023-06-08",
"exchangeRateTypeId": null,
"exchangeRate": 1
},
"accountAllocationTimePeriod": null,
"allocation": {"id": null,
"key": null
},
"audit": {"createdDateTime": "2023-06-09T00:33:59Z",
"modifiedDateTime": "2023-06-09T00:33:59Z",
"createdBy": "68",
"modifiedBy": "68"
},
"state": "posted",
"isBillable": false,
"isBilled": null,
"href": "/objects/general-ledger/journal-entry-line/8435"
}
],
"href": "/objects/general-ledger/journal-entry/3235"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update a journal entry

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

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

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal entry.

Example: 132

Request Body schema: application/json

object

The journal to use for this entry.

key	string System-assigned key for the journal. Example: "3"
id	string The id of the journal. Example: "EJ"

description

string

Description of the transaction.

Example: "Revenue entries"

postingDate

string <date>

Posting date.

Example: "2023-04-01"

automaticReversalDate

string or null <date>

Reversal date if you want to reverse this transaction on a certain date. Must be greater than postingDate.

Example: "2023-04-04"

moduleName

string

Intacct module that the journal entry originates from.

Example: "2.GL"

referenceNumber

string

User-provided reference number.

Example: "Recurr_GL_101"

object

Base location for a multi-entity company. Required if a company is multi-entity enabled and entries do not balance by entity.

key	string Location key. Example: "32"
id	string Location unique ID. Example: "BC"

Array of objects >= 2 items

Journal entry lines included in this entry. Must have at least two lines, one debit and one credit.

Array (>= 2 items)

txnType	string Default: "debit" Transaction type - debit or credit. Enum: "credit" "debit" Example: "credit"
txnAmount	string <decimal-precision-2> Transaction amount as an absolute value. Example: "100.45"
documentId	string Document number of entry. Example: "Revenue_Documentation"
description	string Description of the journal entry line. Example: "Revenue Entries"
numberOfUnits	integer Number of units Example: 5
accountingPeriod	integer Accounting period if company uses custom accounting periods. Example: 11
isBillable	boolean Default: false Set to `true` to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) Example: false
	object Exchange rate details used to calculate the base amount.
state	string Default: "posted" State to update the entry to. Posted to post to the GL Enum: "approved" "declined" "draft" "paid" "partiallyApproved" "partiallyPaid" "posted" "reversal" "reversalPending" "reversed" "submitted" Example: "draft"
	object
	object
	object Template to use for predefined transaction allocations.
	object
	object Journal entry that this journal entry line is owned by.

Responses

200

400

Bad Request

Request samples

application/json

{"postingDate": "2023-12-11",
"state": "posted",
"lines": [{"key": 195,
"txnType": "debit",
"txnAmount": "100",
"glAccount": {"id": "1000"
},
"dimensions": {"department": {"id": "11"
},
"location": {"id": "1"
}
},
"documentId": "test",
"currency": {"txnCurrency": "USD"
}
},
{"key": 196,
"txnType": "debit",
"txnAmount": "100",
"glAccount": {"id": "1000"
},
"dimensions": {"department": {"id": "11"
},
"location": {"id": "1"
}
},
"documentId": "test",
"currency": {"txnCurrency": "USD"
}
},
{"txnType": "credit",
"txnAmount": "200",
"glAccount": {"id": "4000"
},
"dimensions": {"department": {"id": "11"
},
"location": {"id": "1"
}
},
"documentId": "Test1",
"currency": {"txnCurrency": "USD"
}
}
]
}

Response samples

application/json

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

Delete a journal entry

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

Deletes a journal entry.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the journal entry.

Example: 132

Responses

204

No Content

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

Submit a journal entry

post/workflows/general-ledger/journal-entry/submit

Submit a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key

required

string

System-assigned key for the journal entry.

Example: "132"

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132"
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "submitted"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Approve a journal entry

post/workflows/general-ledger/journal-entry/approve

Approve a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key required	string System-assigned key for the journal entry. Example: "132"
notes	string Notes or comments about this journal entry. Example: "Approved, ready for use"

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132",
"notes": "Approved, ready for use"
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "approved"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Decline a journal entry

post/workflows/general-ledger/journal-entry/decline

Decline a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key required	string System-assigned key for the journal entry. Example: "132"
notes	string Notes or comments about this journal entry. Example: "Declined, missing information"

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132",
"notes": "Declined, missing information"
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "declined"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Recall a journal entry

post/workflows/general-ledger/journal-entry/recall

Recall a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key

required

string

System-assigned key for the journal entry.

Example: "132"

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132"
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "draft"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Reverse a journal entry

post/workflows/general-ledger/journal-entry/reverse

Reverse a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key required	string System-assigned key for the journal entry. Example: "132"
reverseDate required	string <date> Reversal date to reverse the transaction on a certain date. Must be greater than `postingDate`. Example: "2023-04-04"

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132",
"reverseDate": "2023-04-04"
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "reversed"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Reclassify a journal entry

post/workflows/general-ledger/journal-entry/reclassify

Reclassify a journal entry

SecurityOAuth2

Request

Request Body schema: application/json

key

required

string

System-assigned unique key for the journal entry. Used to identify the journal entry in URLs or JSON bodies for all operations on the journal entry.

Example: "132"

string

Same as key for this object.

Example: "132"

description

string

Description of the transaction.

Example: "Revenue entries"

referenceNumber

string

User-provided reference number.

Example: "Recurr_GL_101"

object

Supporting document for the journal batch.

key	string System-assigned key for the attachment. Example: "6"
id	string Unique ID of the attachment. Example: "Doc6331"

state

string

Default: "posted"

State of the entry. The only valid values when creating a new entry are posted (default) to post to the GL, and draft.

Value: "posted"

Example: "draft"

Array of objects

Journal entry lines included in this entry. Must have at least two lines, one debit and one credit.

Array

txnType	string Default: "debit" Transaction type - debit or credit. Enum: "credit" "debit" Example: "credit"
txnAmount	string <decimal-precision-2> Transaction amount as an absolute value. Example: "100.45"
documentId	string Document number of entry. Example: "Revenue_Documentation"
description	string Description of the journal entry line. Example: "Revenue Entries"
numberOfUnits	integer Number of units Example: 5
accountingPeriod	integer Accounting period if company uses custom accounting periods. Example: 11
isBillable	boolean Default: false Set to `true` to mark the line item as billable. (Requires Projects subscription and billable General Ledger transactions to be enabled.) Example: false
	object Exchange rate details used to calculate the base amount.
state	string Default: "posted" State to update the entry to. Posted to post to the GL Enum: "approved" "declined" "draft" "paid" "partiallyApproved" "partiallyPaid" "posted" "reversal" "reversalPending" "reversed" "submitted" Example: "draft"
	object
	object
	object Template to use for predefined transaction allocations.
	object
	object Journal entry that this journal entry line is owned by.

Responses

200

400

Bad Request

Request samples

application/json

{"key": "132",
"id": "132",
"description": "Revenue entries",
"referenceNumber": "Recurr_GL_101",
"attachment": {"key": "6",
"id": "Doc6331"
},
"state": "draft",
"lines": [{"txnType": "credit",
"txnAmount": "100.45",
"documentId": "Revenue_Documentation",
"description": "Revenue Entries",
"numberOfUnits": 5,
"accountingPeriod": 11,
"isBillable": false,
"exchangeRate": {"date": "2024-01-23",
"rate": 1.0789,
"typeId": "INR-Rate"
},
"state": "draft",
"currency": {"exchangeRateDate": "2014-01-08",
"exchangeRateTypeId": "Intacct Daily Rate",
"exchangeRate": 0.78,
"baseCurrency": "USD",
"txnCurrency": "GBP"
},
"glAccount": {"key": "144",
"id": "1112"
},
"allocation": {"key": "21",
"id": "FA_ALLOC"
},
"dimensions": {"location": {"key": "22",
"id": "LOC-22"
},
"department": {"key": "11",
"id": "DEP-11"
},
"employee": {"key": "10",
"id": "EMP-10"
},
"project": {"key": "2",
"id": "NET-XML30-2"
},
"customer": {"key": "13",
"id": "CUST-13"
},
"vendor": {"key": "357",
"id": "1605212096809"
},
"item": {"key": "13",
"id": "Case 13"
},
"warehouse": {"key": "6",
"id": "WH01"
},
"class": {"key": "731",
"id": "REST_CLS_001"
},
"task": {"id": "1",
"key": "1"
},
"costType": {"id": "2",
"key": "2"
},
"asset": {"id": "A001",
"key": "1"
},
"contract": {"id": "CON-0045-1",
"key": "12"
}
},
"journalEntry": {"id": "132",
"key": "132"
}
}
]
}

Response samples

application/json

{"ia::result": {"key": "132",
"id": "132",
"href": "/objects/general-ledger/journal-entry/132",
"state": "posted"
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
}

Query journal entries

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-entry"

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-entry",
"filters": [{"$eq": {"journalSymbol": "AP"
}
},
{"$between": {"postingDate": ["2022-01-01",
"2022-04-30"
]
}
}
],
"fields": ["key",
"id",
"href"
],
"orderBy": [{"postingDate": "asc"
}
]
}

Response samples

application/json

{"ia::result": [{"key": "17",
"id": "17",
"href": "/objects/general-ledger/journal-entry/17",
"postingDate": "2022-01-31"
},
{"key": "18",
"id": "18",
"href": "/objects/general-ledger/journal-entry/18",
"postingDate": "2022-02-28"
},
{"key": "20",
"id": "20",
"href": "/objects/general-ledger/journal-entry/20",
"postingDate": "2022-03-31"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}