General Ledger

Monitor this page to keep up with the General Ledger API latest changes and SKY API service releases.

2018-06-20

Changed

We made changes to the following endpoints:

  • The Journal entry batch (List) endpoint now includes a new search_text request parameter that can match description or ui_batch_id. For example, ?search_text=100 returns a list of batches with a ui_batch_id that contains "100" or a description that contains "100".
  • The Budget (List) endpoint now includes a new scenario_id field that returns the scenario ID associated with the budget.

2018-06-12

Announcement: Changes for General Ledger API

We implemented new operation ID values in the OpenApi (fka Swagger) definitions for all endpoints in the General Ledger API. Note that any existing code relying on these endpoints will continue to function, since all routes and parameters are unchanged. However, if you make use of client-side generated code and want to regenerate your client wrapper, compile-time errors in your code stemming from new operation ID values will arise and need to be addressed.

2018-06-04

Announcement: Changes Planned for Accounts Payable, General Ledger, and Treasury (Beta) APIs

We will implement new operation ID values in the OpenApi (fka Swagger) definitions for several SKY APIs. This change will improve client-side tooling support for code generation by making these values more deterministic and friendlier across different languages. Going forward, we expect high stability of these values (meaning, we won’t need to change them again).

Note that any existing code that has been deployed will continue to function with no problems, since we are not changing any routes or parameters. If you make use of client-side generated code and want to regenerate your client wrapper, you’ll need to fix any compile-time errors in your code stemming from new method names.

May

2018-05-24

Changed

We made changes to the following endpoints:

April

2018-04-20

New

Added the following endpoint:

Operation Method Route
Journal entry batch PATCH /journalentrybatches/{batch_id}

With the new endpoint, note the following:

  • You can edit the description, create_interfund_sets, and create_bank_account_adjustments values of an existing journal entry batch.
  • Posted journal entry batches cannot be edited.
  • Omitting a field from a PATCH request does not edit that field with a default value. In the example below, only create_interfund_entries is edited, but the other fields are not.
{
        “create_interfund_sets”: false
}

March

2018-03-02

New

Added the following endpoints:

Operation Method Route
Client names (List) GET /configuration/client_names
Grant status (List) GET /grants/statuses
Grant type (List) GET /grants/types
Grant custom field (List) GET /grants/customfields

Changed

For the Period summary process (Start) endpoint, a fiscal_period_id was previously required. Now, when no object is sent or when a fiscal_period_id with value 0 is sent, all open and unoptimized fiscal periods are summarized.

January

2018-01-17

Changed

For the Journal entry batch (Post) endpoint, transaction_code_value can now include “” empty string for value.

2017

2017-11-20

New

Added the following endpoints:

Operation Method Route
Period summary (List) GET /periodsummary/summaries
Period summary process GET /periodsummary/processinginfo
Period summary process (Start) POST /periodsummary/summarize

2017-08-14

New

Added the following endpoints:

Operation Method Route
Journal entry batch attachment POST /journalentrybatches/attachments
Media type (List) GET /mediaTypes

Changed

  • For the following endpoint, we added the division, department, location, and type filters. Additional data is also returned:
Operation Method Route
Project GET /projects
  • For the following endpoint, we added the encumbrance and post date filters. Additional data is also returned:
Operation Method Route
Transaction distribution (List) GET /transactiondistributions

2017-06-15

Changed

We made several changes to the Get Account (Search), Get Project (Search), Get Journal entry batch (List), and Get Transaction distribution (List) endpoints.

  • The following properties are now returned: date_added, date_modified, added_by, and modified_by.

  • The last_modified filter is now included. This filter causes the response to only include results where date_modified is greater than or equal to the last_modified filter value.

2017-05-05

New

Added the following endpoints:

Operation Method Route
Budget grant (List) GET /budgets/{scenario_id}/grants
Budget project (List) GET /budgets/{scenario_id}/projects

Changed

We increased the maximum record limit from 500 to 5000 on the following Get endpoint:

Operation Method Route
Transaction distribution GET /transactiondistributions

2017-01-18

New

Added the following endpoints:

Operation Method Route
Account GET /accounts/{account_id}
Project GET /projects/{project_id}
Account cashflows (List) GET /accounts/cashflows
Account working capitals (List) GET /accounts/workingcapitals
Account custom fields (List) GET /accounts/customfields

2016

2016-12-06

New

  • Added the following endpoints:
Operation Method Route
Journal entry custom field (List) GET /journalentries/customfields
Project custom field (List) GET /projects/customfields
Budget GET /budgets
Budget (List) GET /budgets/{scenario_id}
Budget account (List) GET /budgets/{scenario_id}/accounts
Ledger summary (List) GET /summary/{fiscal_year_id}
  • Added new custom field entities to the following endpoints:
Operation Method Route
Project POST /projects
Journal entry POST /journalentrybatches/{batch_id}/journalentries
Journal entry batch GET /journalentrybatches/{batch_id}

Changed

For consistency across APIs, all responses to GET endpoints that return collections now return an object with "count" and "value" properties. The following endpoints are affected:

Operation Method Route
Class (List) GET /classes
Journal code (List) GET /journalcodes
Project department (List) GET /projects/departments
Project division (List) GET /projects/divisions
Project location (List) GET /projects/locations
Project status (List) GET /projects/statuses
Project type (List) GET /projects/types
Transaction code (List) GET /transactioncodes
Transaction code value (List) GET /transactioncodes/{transaction_code_id}/values

2016-11-14

Announcement: Breaking Change Planned for General Ledger API

For consistency across APIs, we will implement the following changes:

  • All responses to GET endpoints that return collections will return an object with "count" and "value" properties.
  • The following endpoints are affected:
Operation Method Route
Class (List) GET /classes
Journal code (List) GET /journalcodes
Project department (List) GET /projects/departments
Project division (List) GET /projects/divisions
Project location (List) GET /projects/locations
Project status (List) GET /projects/statuses
Project type (List) GET /projects/types
Transaction code (List) GET /transactioncodes
Transaction code value (List) GET /transactioncodes/{transaction_code_id}/values

2016-11-01

New

Added the following endpoints:

Operation Method Route
Create project (Post) POST /projects
Create project contact (Post) POST /projects/{project_id}/contacts

2016-10-06

New

Added the following endpoints:


Operation Method Route
Fiscal year (List) GET /fiscalyears
Class (List) GET /classes
Account structure GET /accounts/structure
Account segment value (List) GET /accounts/segments
Account code (List) GET /accounts/codes
Account fund (List) GET /accounts/funds
Project type (List) GET /projects/types
Project status (List) GET /projects/statuses
Project division (List) GET /projects/divisions
Project department (List) GET /projects/departments
Project location (List) GET /projects/locations

Changed

You can now specify Class on journal entries (this affects all endpoints associated with journal entry batches).

2016-08-12

Breaking Change

We changed the default and maximum record limits on the following search and list endpoints. The default is now 100 records, and the maximum is 500 records.

Operation Method Route
Transaction distribution (Search) GET /transactiondistributions
Account (Search) GET /accounts
Project (Search) GET /projects
Journal entry batch (List) GET /journalentrybatches

2016-07-05

Changed

We implemented a previously announced, breaking change. We removed the Journal entry batch (Edit) PUT endpoint. At a later date, we plan to replace PUT with PATCH, instead.

2016-06-30

Announcement: Breaking Change Planned for General Ledger API

In the coming days, a breaking change will be placed into effect. We will remove the Journal entry batch (Edit) PUT endpoint. At a later date, we plan to replace PUT with PATCH, instead.

2016-06-22

New

Added the following endpoint:

Operation Method Route
Transaction distribution (Search) GET /transactiondistributions

2016-06-15

Changed

We've added a versioning indicator to the General Ledger API's base URL. Specifically, all new API requests must begin with https://api.sky.blackbaud.com/generalledger/v1.

2016-06-10

Announcement: Breaking Changes Planned for General Ledger API

  • We will be adding a versioning indicator to the General Ledger API's base URL. Specifically, all new API requests should begin with https://api.sky.blackbaud.com/generalledger/v1.
  • This change is planned to take effect on Wednesday, June 15.

2016-05-27

New