Blackbaud Summary API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: General Ledger Summary API'
  description: This API is used to manage the general ledger, including accounts, projects, and journal entries. This API has a maximum request size limit of 8mb.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/56eb17a0a9db9516c46bff6f
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/generalledger/v1
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Summary
paths:
  /summary/{fiscal_year_id}:
    get:
      operationId: ListLedgerSummaries
      summary: Ledger summary (List)
      description: 'Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed or optimized fiscal years.

        If any activity occurs in a fiscal period that has not since been closed or optimized, it will not be included in the GL summary record(s).'
      parameters:
      - name: fiscal_year_id
        in: path
        required: true
        schema:
          type: integer
        description: The fiscal year identifier.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: 'Represents the number of records to skip.

          For use with pagination.'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: "Represents the number of records to return. \nThe default is 100. \nThe maximum allowed value is 5000."
      - name: fiscal_period_id
        in: query
        required: false
        schema:
          type: integer
        description: The fiscal period identifier.
      - name: account_number
        in: query
        required: false
        schema:
          type: string
        description: The account number.
      - name: ui_project_id
        in: query
        required: false
        schema:
          type: string
        description: The project user-visible identifier.
      responses:
        '200':
          description: Returned when the operation is successful. The response body contains a list of summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCollection_LedgerSummary'
              example:
                count: 52548
                value:
                - fiscal_year: '2011'
                  fiscal_year_id: 12
                  fiscal_period: '8'
                  fiscal_period_id: 133
                  period_start_date: '2008-01-01T00:00:00Z'
                  period_end_date: '2008-01-31T00:00:00Z'
                  account_number: 03-7000-00
                  ui_project_id: '1004'
                  transaction_codes:
                  - name: Jurisdiction
                    value: None
                    id: 1
                  - name: Spendable?
                    value: Spendable
                    id: 2
                  beginning_balance: 0
                  debit: 14760.32
                  credit: 0
                  encumbered_beginning_balance: 0
                  encumbered_debit: 0
                  encumbered_credit: 0
                - fiscal_year: '2011'
                  fiscal_year_id: 12
                  fiscal_period: '8'
                  fiscal_period_id: 133
                  period_start_date: '2008-01-01T00:00:00Z'
                  period_end_date: '2008-01-31T00:00:00Z'
                  account_number: 03-7000-00
                  ui_project_id: '1018'
                  transaction_codes:
                  - name: Jurisdiction
                    value: None
                    id: 1
                  - name: Spendable?
                    value: Spendable
                    id: 2
                  beginning_balance: 0
                  debit: 6792.52
                  credit: 0
                  encumbered_beginning_balance: 0
                  encumbered_debit: 0
                  encumbered_credit: 0
        '403':
          description: Returned when the user does not have permission to view summaries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicErrorMessage'
              example:
                error: The specified record could not be found. The record has either been deleted or you do not have rights to view it.
      tags:
      - Summary
components:
  schemas:
    BasicErrorMessage:
      type: object
      properties:
        Error:
          type: string
          x-ms-summary: Error
      x-display-name: Basic error message
      x-ms-summary: Basic error message
    TransactionCodeValue:
      description: Transaction code value
      required:
      - value
      - id
      type: object
      properties:
        name:
          description: The transaction code name.
          type: string
          x-ms-summary: Name
        value:
          description: The transaction code value.
          type: string
          x-ms-summary: Value
        id:
          format: int32
          description: The transaction code value id.
          type: integer
          x-ms-summary: Id
        inactive:
          description: Indicate if record is inactive or not.
          type: boolean
          x-ms-summary: Inactive
      x-display-name: Transaction code value
      x-ms-summary: Transaction code value
    LedgerSummary:
      description: Summarized record of GL activity for a particular period
      type: object
      properties:
        fiscal_year:
          description: The summarized fiscal year.
          type: string
          x-ms-summary: Fiscal year
        fiscal_year_id:
          format: int32
          description: The summarized fiscal year database identifier.
          type: integer
          x-ms-summary: Fiscal year id
        fiscal_period:
          description: The summarized fiscal period.
          type: string
          x-ms-summary: Fiscal period
        fiscal_period_id:
          format: int32
          description: The summarized fiscal period database identifier.
          type: integer
          x-ms-summary: Fiscal period id
        period_start_date:
          format: date-time
          description: The start date of the summarized period.
          type: string
          x-ms-summary: Period start date
        period_end_date:
          format: date-time
          description: The end date of the summarized period.
          type: string
          x-ms-summary: Period end date
        account_number:
          description: The account number of summarized transactions.
          type: string
          x-ms-summary: Account number
        ui_project_id:
          description: The project identifier of summarized transactions.
          type: string
          x-ms-summary: Ui project id
        transaction_codes:
          description: The transaction code values of summarized transactions.
          type: array
          items:
            $ref: '#/components/schemas/TransactionCodeValue'
          x-ms-summary: Transaction codes
        beginning_balance:
          format: double
          description: The total transaction balance at the beginning of the summarized period.
          type: number
          x-ms-summary: Beginning balance
        debit:
          format: double
          description: The sum of transaction debits int he summarized period.
          type: number
          x-ms-summary: Debit
        credit:
          format: double
          description: The sum of transaction credits int he summarized period.
          type: number
          x-ms-summary: Credit
        encumbered_beginning_balance:
          format: double
          description: The encumbered transaction balance at the beginning of the summarized period.
          type: number
          x-ms-summary: Encumbered beginning balance
        encumbered_debit:
          format: double
          description: The sum of encumbered transaction debits int he summarized period.
          type: number
          x-ms-summary: Encumbered debit
        encumbered_credit:
          format: double
          description: The sum of encumbered transaction credits int he summarized period.
          type: number
          x-ms-summary: Encumbered credit
      x-display-name: Ledger summary
      x-ms-summary: Ledger summary
    ApiCollection_LedgerSummary:
      type: object
      properties:
        count:
          format: int32
          type: integer
          x-ms-summary: Count
        value:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSummary'
          x-ms-summary: Value
      x-hidden: true
      x-display-name: Api collection `1
      x-ms-summary: Api collection `1
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}