Journal entries

Journal entries record accounting entries in the general ledger by specifying affected accounts, amounts and descriptions. Use them to create, update, or reverse entries while ensuring the general ledger remains balanced with offsetting debits and credits.

If GL Outlier Detection is enabled, Sage Intacct identifies journal entries and allocation splits that deviate from expected patterns. Outlier details are included when retrieving a journal entry object.

List journal entries

get/objects/general-ledger/journal-entry

Returns a collection of journal entries 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
SubscriptionGeneral Ledger
User typeBusiness user with Admin privileges, Employee, Payment Approver
PermissionsList, View Journal Entries
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "56",
      • "id": "56",
      • "href": "/objects/general-ledger/journal-entry/56"
      },
    • {
      • "key": "132",
      • "id": "132",
      • "href": "/objects/general-ledger/journal-entry/132"
      },
    • {
      • "key": "256",
      • "id": "256",
      • "href": "/objects/general-ledger/journal-entry/256"
      }
    ],
  • "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. When creating a journal entry, you can either post it immediately or save it as a draft for review. Draft entries can be updated before posting, but all required information must be provided. To post a journal entry, debits and credits must balance, and all required details must be entered.


Note: The only valid values when creating a new entry are posted (default, system-defined state), and draft. Only populate the state field when creating a draft entry.



Permissions and other requirements



SubscriptionGeneral Ledger, Projects (for revenue recognition of projects)


User typeBusiness


PermissionsAdd Journal Entries







SecurityOAuth2 
Request 
Request Body schema: application/json
required
Create a new journal entry


required
object
Specifies the journal associated with this journal entry.


 
key
string
System-assigned unique key for the journal associated with this journal entry.


 
 Example:  "3"
id
string
Unique identifier for the journal associated with this journal entry.


 
 Example:  "EJ"
postingDate
required
string <date> 
The date when the journal entry is recorded in the journal and posted to the general ledger for tracking and reporting.


 
 Example:  "2023-04-01"
description
required
string
Description of the journal entry.


 
 Example:  "Revenue entries"
required
Array of objects  >= 2 items 
A collection of line items within the journal entry. At least two line items are required per journal entry, one debit and one credit.


 
 Array (>= 2 items)
txnAmount
required
string <decimal-precision-2> 
Amount of the line item as an absolute value within the journal entry.


 
 Example:  "100.45"
txnType
required
string
 Default:  "debit"
Specifies whether the line item in the journal entry is a debit or credit.


 Enum: "credit" "debit"  
 Example:  "credit"
required
object
 
documentId
string
Reference for the journal entry line item, this is a user-entered value that can contain numeric or alpha-numeric values.


 
 Example:  "CalOil_Credit_01-24"
description
string
Description of the journal entry line.


 
 Example:  "CalOil Credit entries January 2024"
numberOfUnits
integer
Quantity of units associated with the journal entry line item, representing a non-monetary measurement, such as hours or other measurable units.


 
 Example:  5
accountingPeriod
integer
Financial reporting period in which the line item is recorded. if company uses custom accounting periods.


 
 Example:  11
isBillable
boolean
 Default:  false
Indicates whether the line item is billable. Requires a Projects subscription and the billable option to be enabled for General Ledger transactions.


 
 Example:  false
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
Transaction allocation template, a predefined template used to allocate line items across accounts, departments, or entities.


 
object
 
object
Journal entry to which the line item belongs.


 
Array of objects
Tax-related details for the line item.


 
automaticReversalDate
string or null <date> 
The date a journal entry is automatically reversed in the general ledger. automaticReversalDate must be later than the postingDate.


 
 Example:  "2023-04-04"
moduleName
string
The Sage Intacct module from which the journal entry originates.


 
 Example:  "2.GL"
referenceNumber
string
Unique identifier assigned to the journal entry by the user for tracking and reconciliation.


 
 Example:  "Recurr_GL_101"
object
Supporting documents or files linked to the journal entry.


 
key
string
System-assigned unique key for the attachment linked to the journal entry.


 
 Example:  "6"
id
string
Unique identifier for the attachment linked to the journal entry.


 
 Example:  "Doc6331"
object
Specifies the base location for a multi-entity company. Required if multi-entity is enabled and entries do not balance by entity.


 
key
string
System-assigned unique key for the base location.


 
 Example:  "32"
id
string
Unique identifier for the base location.


 
 Example:  "BC"
state
string
 Default:  "posted"
Shows the current state of the journal entry. 


Note: The only valid values when creating a new entry are posted (default, system-defined state), and draft. Only populate the state field when creating a draft entry.


 Enum: "approved" "declined" "draft" "partiallyApproved" "posted" "reversalPending" "reversed" "submitted"  
 Example:  "draft"
object
Tax-related details applied to the journal entry, such as tax codes, rates and exemptions. This field applies only to companies using the Taxes application to track VAT or GST.


 
taxImplication
string or null
 Default:  null
Specifies the impact of a journal entry on tax calculations. This field applies only to companies using the Taxes application to track VAT or GST.


 Enum: "inbound" "none" null "outbound"  
 Example:  "inbound"
object
Specifies the vendor for tax-related information when taxImplication is set to inbound.


 
key
string
System-assigned unique key for the vendor.


 
 Example:  "15"
id
string
Unique identifier for the vendor.


 
 Example:  "V-00014"
object
Specifies the customer for tax-related information when taxImplication is set to outbound.


 
key
string
System-assigned unique key for the customer.


 
 Example:  "14"
id
string
Unique identifier for the customer.


 
 Example:  "C-00019"
object
Specifies the associated contact details for the journal entry such as a vendor, customer, or other relevant entity.


 
key
string
System-assigned unique key for the contact.


 
 Example:  "416"
id
string
Unique idetifier for the contact.


 
 Example:  "Klay Vanderbilt"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "glJournal": {
    • "id": "GJ"
    },
  • "postingDate": "2024-11-01",
  • "description": "October revenue posting",
  • "lines": [
    • {
      • "txnType": "credit",
      • "txnAmount": "200",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "October_revenue_credit_transactions"
      },
    • {
      • "txnType": "debit",
      • "txnAmount": "200",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "October_revenue_debit_transactions"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "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 unique key for the journal entry.


 
 Example:  132
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "30565",
    • "key": "30565",
    • "txnNumber": 493,
    • "description": "October revenue posting",
    • "glJournal": {
      • "id": "GJ",
      • "key": "4",
      • "isAdjustment": false,
      • "href": "/objects/general-ledger/journal/4"
      },
    • "postingDate": "2024-11-01",
    • "moduleName": "2.GL",
    • "referenceNumber": "Rev_Oct",
    • "reversedBy": {
      • "id": "663",
      • "key": "663",
      • "href": "/objects/general-ledger/journal-entry/663"
      },
    • "reversedFromDate": null,
    • "accountAllocationRun": {
      • "id": "87",
      • "key": "87",
      • "href": "/objects/general-ledger/account-allocation-run/87"
      },
    • "baseLocation": {
      • "key": "32",
      • "id": "BC",
      • "href": "/objects/company-config/location/32"
      },
    • "audit": {
      • "createdDateTime": "2025-03-17T10:07:00Z",
      • "modifiedDateTime": "2025-03-17T10:07:00Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "state": "posted",
    • "sequenceNumber": "1",
    • "tax": {
      • "taxImplication": "none",
      • "taxSolution": {
        }
      },
    • "attachment": {
      • "key": "6",
      • "id": "Doc-6331",
      • "href": "/objects/company-config/attachment/6"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "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 unique key for the journal entry.


 
 Example:  132
Request Body schema: application/json
object
Specifies the journal associated with this journal entry.


 
key
string
System-assigned unique key for the journal associated with this journal entry.


 
 Example:  "3"
id
string
Unique identifier for the journal associated with this journal entry.


 
 Example:  "EJ"
description
string
Description of the journal entry.


 
 Example:  "Revenue entries"
postingDate
string <date> 
The date when the journal entry is recorded in the journal and posted to the general ledger for tracking and reporting.


 
 Example:  "2023-04-01"
automaticReversalDate
string or null <date> 
The date a journal entry is automatically reversed in the general ledger. automaticReversalDate must be later than the postingDate.


 
 Example:  "2023-04-04"
moduleName
string
The Sage Intacct module from which the journal entry originates.


 
 Example:  "2.GL"
referenceNumber
string
Unique identifier assigned to the journal entry by the user for tracking and reconciliation.


 
 Example:  "Recurr_GL_101"
object
Supporting documents or files linked to the journal entry.


 
key
string
System-assigned unique key for the attachment linked to the journal entry.


 
 Example:  "6"
id
string
Unique identifier for the attachment linked to the journal entry.


 
 Example:  "Doc6331"
object
Specifies the base location for a multi-entity company. Required if multi-entity is enabled and entries do not balance by entity.


 
key
string
System-assigned unique key for the base location.


 
 Example:  "32"
id
string
Unique identifier for the base location.


 
 Example:  "BC"
object
Tax-related details applied to the journal entry, such as tax codes, rates and exemptions. This field applies only to companies using the Taxes application to track VAT or GST.


 
taxImplication
string or null
 Default:  null
Specifies the impact of a journal entry on tax calculations. This field applies only to companies using the Taxes application to track VAT or GST.


 Enum: "inbound" "none" null "outbound"  
 Example:  "inbound"
object
Specifies the vendor for tax-related information when taxImplication is set to inbound.


 
key
string
System-assigned unique key for the vendor.


 
 Example:  "15"
id
string
Unique identifier for the vendor.


 
 Example:  "V-00014"
object
Specifies the customer for tax-related information when taxImplication is set to outbound.


 
key
string
System-assigned unique key for the customer.


 
 Example:  "14"
id
string
Unique identifier for the customer.


 
 Example:  "C-00019"
object
Specifies the associated contact details for the journal entry such as a vendor, customer, or other relevant entity.


 
key
string
System-assigned unique key for the contact.


 
 Example:  "416"
id
string
Unique idetifier for the contact.


 
 Example:  "Klay Vanderbilt"
Array of objects  >= 2 items 
A collection of line items within the journal entry. At least two line items are required per journal entry, one debit and one credit.


 
 Array (>= 2 items)
txnType
string
 Default:  "debit"
Specifies whether the line item in the journal entry is a debit or credit.


 Enum: "credit" "debit"  
 Example:  "credit"
txnAmount
string <decimal-precision-2> 
Amount of the line item as an absolute value within the journal entry.


 
 Example:  "100.45"
documentId
string
Reference for the journal entry line item, this is a user-entered value that can contain numeric or alpha-numeric values.


 
 Example:  "CalOil_Credit_01-24"
description
string
Description of the journal entry line.


 
 Example:  "CalOil Credit entries January 2024"
numberOfUnits
integer
Quantity of units associated with the journal entry line item, representing a non-monetary measurement, such as hours or other measurable units.


 
 Example:  5
accountingPeriod
integer
Financial reporting period in which the line item is recorded. if company uses custom accounting periods.


 
 Example:  11
isBillable
boolean
 Default:  false
Indicates whether the line item is billable. Requires a Projects subscription and the billable option to be enabled for General Ledger transactions.


 
 Example:  false
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
Transaction allocation template, a predefined template used to allocate line items across accounts, departments, or entities.


 
object
 
object
Journal entry to which the line item belongs.


 
Array of objects
Tax-related details for the line item.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565",
  • "postingDate": "2024-12-11",
  • "lines": [
    • {
      • "key": "465744",
      • "txnType": "debit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Debit-USD-195",
      • "currency": {
        }
      },
    • {
      • "key": "465745",
      • "txnType": "credit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Credit-USD-196",
      • "currency": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "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 unique key for the journal entry.


 
 Example:  132
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
    }
}
Submit a journal entry
post/workflows/general-ledger/journal-entry/submit
Submits a draft or declined journal entry for approval. When a journal entry is submitted, it's sent for approval. Draft journal entries are not sent for approval. 


Pre-requisites: 


    

  1. Enable journal entry approval in the General Ledger configuration.
    2. 

  2. Grant journal entry approval permissions to users. Only users who already have the Journal Entry Approver permission will be selectable as approvers or substitute approvers.
    3. 

  3. Define journal entry approvals for each General Ledger journal that requires approval. Each journal can have either 1 or a chain of approvers.
    4. 



SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be submitted.


 
 Example:  "132"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "1"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "state": "submitted",
    • "href": "/objects/general-ledger/journal-entry/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Approve a journal entry
post/workflows/general-ledger/journal-entry/approve
Approves a submitted or partially approved journal entry. When approved, the journal entry is posted to the General Ledger. A journal entry that requires approval from multiple approvers remains partially approved until it has been approved by all approvers. If General Ledger Outlier Detection is enabled, the entry is evaluated for historical outliers. 


Pre-requisites: 


    

  1. Enable journal entry approval in the General Ledger configuration.
    2. 

  2. Grant journal entry approval permissions to users. Only users who already have the Journal Entry Approver permission will be selectable as approvers or substitute approvers.
    3. 

  3. Define journal entry approvals for each General Ledger journal that requires approval. Each journal can have either 1 or a chain of approvers.
    4. 



SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be approved.


 
 Example:  "132"
notes
string
Comments about the journal entry approval.


 
 Example:  "Approved, ready for use."
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565",
  • "notes": "Approved by the Accounting Manager"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "state": "approved",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Decline a journal entry
post/workflows/general-ledger/journal-entry/decline
Declines a submitted or partially approved journal entry. When declined, the entry is returned to the submitter to make any changes and resubmit. The approver can also decline the entry, edit, and then approve it. In this case, the journal entry remains partially approved, until it has been approved by all approvers.


Pre-requisites: 


    

  1. Enable journal entry approval in the General Ledger configuration.
    2. 

  2. Grant journal entry approval permissions to users. Only users who already have the Journal Entry Approver permission will be selectable as approvers or substitute approvers.
    3. 

  3. Define journal entry approvals for each General Ledger journal that requires approval. Each journal can have either 1 or a chain of approvers.
    4. 



SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be declined.


 
 Example:  "132"
notes
string
Comments about the journal entry decline.


 
 Example:  "Declined, missing information."
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565",
  • "notes": "Declined by the Accounting Manager"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "state": "declined",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Recall a journal entry
post/workflows/general-ledger/journal-entry/recall
Recalls a submitted journal entry that is unapproved. You can recall a journal entry as long as the journal entry hasn’t been approved.


You can only recall an entry if:


    

  • you are the submitter, are not the approver, and,
    • 

  • you have already submitted the entry but the approver hasn’t approved the entry.
    • 



SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be recalled.


 
 Example:  "132"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "state": "draft",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Reverse a journal entry
post/workflows/general-ledger/journal-entry/reverse
Reverses a journal entry that has been posted to the general ledger. You can reverse any journal entry that hasn't already been reversed, and which is in an open period. You can reverse statistical transactions, adjusting General Ledger transactions, and adjusting statistical transactions in the same way. After you reverse a journal entry, you cannot undo the reversal. However, you can create another journal entry to replace it.


SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be reversed.


 
 Example:  "132"
reverseDate
required
string <date> 
Date on which the journal entry should be reversed, must be later than postingDate.


 
 Example:  "2023-04-04"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565",
  • "reverseDate": "2024-07-02"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "state": "reversed",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Reclassify a journal entry
post/workflows/general-ledger/journal-entry/reclassify
Reclassifies a journal entry that has been posted to the general ledger. In the general ledger, reclassifying enables you to make certain changes to approved and posted journal entries. For example, you might want to add a reference number or change the department, location, or other dimension.


You can reclassify general ledger journal entries as long as:


    

  • you have the right permissions.
    • 

  • approvals are enabled in the company.
    • 

  • the transaction is in an open period.
    • 

  • the transaction has been approved and posted.
    • 

  • the transaction is within the same entity or at the top level in which it's created.
    • 

  • there are no tax implications for the transaction.
    • 



SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned unique key for the journal entry to be reclassified.


 
 Example:  "132"
id
string
Unique identifier of the journal entry, same as the key.


 
 Example:  "132"
description
string
Description of the journal entry.


 
 Example:  "Revenue entries"
referenceNumber
string
Reference for the journal entry.


 
 Example:  "Recurr_GL_101"
object
Supporting documents or files linked to the journal entry.


 
key
string
System-assigned unique key for the attachment.


 
 Example:  "6"
id
string
Unique identifier of the attachment.


 
 Example:  "Doc6331"
state
string
 Default:  "posted"
State of the journal entry being reclassified.


 Value: "posted"  
 Example:  "posted"
Array of objects
Journal entry lines included in the journal entry. At least two lines are required, one debit and one credit.


 
 Array 
txnType
string
 Default:  "debit"
Specifies whether the line item in the journal entry is a debit or credit.


 Enum: "credit" "debit"  
 Example:  "credit"
txnAmount
string <decimal-precision-2> 
Amount of the line item as an absolute value within the journal entry.


 
 Example:  "100.45"
documentId
string
Reference for the journal entry line item, this is a user-entered value that can contain numeric or alpha-numeric values.


 
 Example:  "CalOil_Credit_01-24"
description
string
Description of the journal entry line.


 
 Example:  "CalOil Credit entries January 2024"
numberOfUnits
integer
Quantity of units associated with the journal entry line item, representing a non-monetary measurement, such as hours or other measurable units.


 
 Example:  5
accountingPeriod
integer
Financial reporting period in which the line item is recorded. if company uses custom accounting periods.


 
 Example:  11
isBillable
boolean
 Default:  false
Indicates whether the line item is billable. Requires a Projects subscription and the billable option to be enabled for General Ledger transactions.


 
 Example:  false
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
Transaction allocation template, a predefined template used to allocate line items across accounts, departments, or entities.


 
object
 
object
Journal entry to which the line item belongs.


 
Array of objects
Tax-related details for the line item.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "30565",
  • "postingDate": "2024-12-11",
  • "state": "posted",
  • "lines": [
    • {
      • "key": "465744",
      • "txnType": "debit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Debit-USD-195",
      • "currency": {
        }
      },
    • {
      • "key": "465745",
      • "txnType": "credit",
      • "txnAmount": "100",
      • "glAccount": {
        },
      • "dimensions": {
        },
      • "documentId": "Credit-USD-196",
      • "currency": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30565",
    • "id": "30565",
    • "state": "posted",
    • "href": "/objects/general-ledger/journal-entry/30565"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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 has (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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "general-ledger/journal-entry",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$between": {
        }
      }
    ],
  • "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
    }
}
Feedback