The API General Ledger endpoint returns a general ledger journal entry for a given company based on a batch or check date provided. See the API Reference page for an example response.
GET returns journal entry data scoped to a single company. Results can be filtered by batch ID or check date and are configurable through a set of optional parameters that control how line items are grouped, which date drives the journal post date, and what level of payroll detail is included in the response.
- Filter by batchId to limit results to a single payroll batch. When both batchId and checkDate are provided, batchId takes priority.
- Filter by checkDate (yyyy-MM-dd) to limit results to a single check date when a batch ID is not provided.
- Use combineBy to control how line items are grouped — by None (default), Department, or Memo.
- Use postDateOption to set the journal entry post date to CheckDate (default) or PayPeriodEnd. When PayPeriodEnd is selected and multiple pay groups have different end dates, it falls back to check date.
- Additional flags give you fine-grained control over the output:
- separatePhysicalChecks — separates physical check vouchers from total net pay (default: true).
- includeDeductionChecks — includes deduction check breakdown and settle tax liability details (default: true).
- excludeEmployerExpenses — excludes employer deduction amounts; employer match amounts are not affected (default: true).
- applyDeductionsToBase — applies all deductions to employees’ base departments instead of allocated departments (default: false).
- includeEmployeeDetail — includes employee-level detail; when enabled, forces grouping to Employee and enables deduction checks (default: true).
Note that sensitive data on the employee record – SSN, bank account, etc. – cannot be accessed through the API.