General Ledger API now available

We've launched our new General Ledger API, allowing you to programmatically generate and retrieve general ledger reports for payrolls.

For implementation details and response formats, refer to our API reference documentation.

Features

• Two-step report generation:
  • POST to /v1/payrolls/:uuid/reports/general_ledger to initiate report creation
  • GET from /v1/reports/:request_uuid to retrieve the completed report
• Flexible aggregation options. You can break down your general ledger data by either job or department.
• Structured JSON format. Receive comprehensive data including:
  • Company name and ledger description
  • Account types and descriptions
  • Debits and credits with appropriate allocation
  • Basic and detailed views with balanced totals

Example usage

1. Request a report with POST /v1/payrolls/:uuid/reports/general_ledger
2. Receive a request_uuid in the response, as in this example response:
   JSON

   {
     "payroll_uuid": "a83d0bd8-7d20-43b9-834c-6d514ef6cb20",
     "aggregation": "default",
     "request_uuid": "p83d0ca8-7d41-42a9-834y-7d218ef6cb20"
   }
   

3. Use GET /v1/reports/:request_uuid to check the status of the report and to download the report when it's ready