Blackbaud Deposits API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Treasury Deposits API'
  description: This API is used to manage bank accounts and transactions.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/58e3b2880528ab71c796492e
    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/treasury/v1
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Deposits
paths:
  /deposits/{deposit_id}:
    get:
      operationId: GetDeposit
      summary: Deposit (Get)
      description: Retrieves information about a given deposit.
      parameters:
      - name: deposit_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier for the deposit to retrieve.
      responses:
        '200':
          description: Returned when the operation is successful. The response body contains the specified deposit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositDetail'
              example:
                deposit_id: 118
                bank_account_id: 2
                number: '91'
                projected_count: 1
                actual_count: 1
                projected_amount: 1000
                actual_amount: 10
                date: '2017-03-08T00:00:00Z'
                transaction_status: Outstanding
                status: Closed
                post_status: NotYetPosted
                post_date: '2017-03-08T00:00:00Z'
                distributions:
                - distribution_id: 1
                  amount: 10
                  description: Additional Operating Cash Account
                  account_number: 01-1000-00
                  type_code: Debit
                  custom_fields: []
                  distribution_splits:
                  - distribution_split_id: 0
                    ui_project_id: ''
                    transaction_code_values:
                    - name: Jurisdiction
                      value: None
                    - name: Spendable?
                      value: Spendable
                    - name: RE Appeals
                      value: ''
                    - name: Grant
                      value: ''
                    - name: Activities
                      value: ''
                    amount: 10
                    percent: 0
                    account_class: Unrestricted Net Assets
        '403':
          description: Returned when the user does not have permission to view deposits.
          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.
        '404':
          description: Returned when the specified deposit could not be found.
          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:
      - Deposits
  /deposits/{deposit_id}/cashreceipts:
    post:
      operationId: CreateCashReceipt
      summary: Cash receipt (Create)
      description: Adds a new cash receipt.
      parameters:
      - name: deposit_id
        in: path
        required: true
        schema:
          type: integer
        description: The deposit identifier for this cash receipt.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCashReceipt'
            example:
              date: '2017-02-08T00:00:00Z'
              amount: 10
              category: Grants
              description: cash receipt description
              payment_from: Benton
              payment_info:
                payment_method: CreditCard
                card_type: visa
                card_number: '8757'
                expiration_month: 11
                expiration_year: 2019
                authorization_number: '455'
              receipt_status: Do not print
              receipt_address: 123 fake street
              distributions:
              - amount: 10
                account_number: 01-1000-00
                type_code: Debit
                custom_fields: []
                distribution_splits:
                - ui_project_id: '1001'
                  transaction_code_values:
                  - name: Jurisdiction
                    value: None
                  - name: Spendable?
                    value: Spendable
                  - name: RE Appeals
                    value: ''
                  - name: Grant
                    value: ''
                  - name: Activities
                    value: ''
                  amount: 10
                  percent: 100
                  account_class: Unrestricted Net Assets
              custom_fields:
              - field_name: Restitution Recipient
                value: Doug
                comments: Custom field comments
                date: '2017-02-08T00:00:00Z'
        description: The cash receipt to create.
      responses:
        '200':
          description: Returned when the operation is successful. The response body contains the ID of the cash receipt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedResult_Int32'
              example:
                record_id: 843
        '400':
          description: Returned when the request is not in the correct format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainErrorMessage'
              example:
                Error: Invalid Request
                Details:
                - The value 'fake' is not valid for transaction_status.
                ErrorPath: null
        '403':
          description: Returned when the user does not have permission to create cash receipts.
          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.
        '404':
          description: Returned when the specified deposit could not be found.
          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:
      - Deposits
    get:
      operationId: ListCashReceiptsSingleDeposit
      summary: Cash receipts (List)
      description: Returns a list of cash receipts from a given deposit.
      parameters:
      - name: deposit_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier for the deposit to retrieve cash receipts.
      - 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 500."
      responses:
        '200':
          description: Returned when the operation is successful. The response body contains the collection of cash receipts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCollection_CashReceipt'
              example:
                count: 2
                value:
                - cash_receipt_id: 273
                  date: '2015-02-02T00:00:00Z'
                  number: '61'
                  payer: ''
                  description: Def
                  payment_method: Cash
                  amount: 100
                - cash_receipt_id: 274
                  date: '2015-02-02T00:00:00Z'
                  number: '62'
                  payer: ''
                  description: Def
                  payment_method: Cash
                  amount: 100
        '403':
          description: Returned when the user does not have permission to view deposits.
          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.
        '404':
          description: Returned when the specified deposit could not be found.
          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:
      - Deposits
components:
  schemas:
    CreateCustomField:
      description: The create contract for custom fields.
      required:
      - field_name
      - value
      type: object
      properties:
        field_name:
          description: The name of the custom field.
          type: string
          x-ms-summary: Field name
        value:
          description: The value for this custom field.
          type: string
          x-ms-summary: Value
        comments:
          description: The description for this custom field.
          type: string
          x-ms-summary: Comments
        date:
          format: date-time
          description: The date on this custom field.
          type: string
          x-ms-summary: Date
      x-hidden: true
      x-display-name: Create custom field
      x-ms-summary: Create custom field
    ApiCollection_CashReceipt:
      type: object
      properties:
        count:
          format: int32
          type: integer
          x-ms-summary: Count
        value:
          type: array
          items:
            $ref: '#/components/schemas/CashReceipt'
          x-ms-summary: Value
      x-hidden: true
      x-display-name: Api collection `1
      x-ms-summary: Api collection `1
    DomainErrorMessage:
      type: object
      properties:
        Error:
          type: string
          x-ms-summary: Error
        Details:
          type: array
          items:
            type: string
          x-ms-summary: Details
        ErrorPath:
          type: string
          x-ms-summary: Error path
      x-display-name: Domain error message
      x-ms-summary: Domain error message
    CreateDistribution:
      description: Distribution.
      required:
      - distribution_splits
      type: object
      properties:
        distribution_id:
          format: int32
          description: The distribution identifier.
          type: integer
          x-ms-summary: Distribution id
        amount:
          format: double
          description: The distribution amount.
          type: number
          x-ms-summary: Amount
        account_number:
          description: The account number for this distribution
          type: string
          x-ms-summary: Account number
        type_code:
          description: The journal entry transaction type (debit or credit).
          enum:
          - Debit
          - Credit
          type: string
          x-ms-summary: Type code
        distribution_splits:
          description: The distribution splits for this distribution.
          type: array
          items:
            $ref: '#/components/schemas/DistributionSplit'
          x-ms-summary: Distribution splits
        custom_fields:
          description: The custom fields for this distribution.
          type: array
          items:
            $ref: '#/components/schemas/CreateCustomField'
          x-ms-summary: Custom fields
      x-hidden: true
      x-display-name: Create distribution
      x-ms-summary: Create distribution
    DepositDetail:
      description: DepositDetail class.
      type: object
      properties:
        deposit_id:
          format: int32
          description: The identifier for this deposit.
          type: integer
          x-ms-summary: Deposit id
        bank_account_id:
          format: int32
          description: The bank account id for this deposit.
          type: integer
          x-ms-summary: Bank account id
        number:
          description: The number for this deposit.
          type: string
          x-ms-summary: Number
        projected_count:
          format: int32
          description: The projected count for this deposit.
          type: integer
          x-ms-summary: Projected count
        actual_count:
          format: int32
          description: The actual count for this deposit.
          type: integer
          x-ms-summary: Actual count
        projected_amount:
          format: double
          description: The projected amount for this deposit.
          type: number
          x-ms-summary: Projected amount
        actual_amount:
          format: double
          description: The actual amount for this deposit.
          type: number
          x-ms-summary: Actual amount
        date:
          format: date-time
          description: The date for this deposit.
          type: string
          x-ms-summary: Date
        transaction_status:
          description: The transaction status for this deposit.
          enum:
          - Outstanding
          - Cleared
          - Reconciled
          - Voided
          type: string
          x-ms-summary: Transaction status
        status:
          description: The status for this deposit.
          type: string
          x-ms-summary: Status
        post_status:
          description: The post status for this deposit.
          enum:
          - DoNotPost
          - NotYetPosted
          - Posted
          type: string
          x-ms-summary: Post status
        post_date:
          format: date-time
          description: The post date for this deposit.
          type: string
          x-ms-summary: Post date
        distributions:
          description: The distributions for this deposit.
          type: array
          items:
            $ref: '#/components/schemas/Distribution'
          x-ms-summary: Distributions
        ui_deposit_id:
          description: The user defined identifier for this deposit.
          type: string
          x-ms-summary: Ui deposit id
        description:
          description: The description for this deposit.
          type: string
          x-ms-summary: Description
        void_date:
          format: date-time
          description: The void date for this deposit.
          type: string
          x-ms-summary: Void date
        reconciled_date:
          format: date-time
          description: The reconciled date for this deposit.
          type: string
          x-ms-summary: Reconciled date
        cleared_date:
          format: date-time
          description: The cleared date for this deposit.
          type: string
          x-ms-summary: Cleared date
      x-display-name: Deposit detail
      x-ms-summary: Deposit detail
    CashReceipt:
      description: CashReceipt class.
      type: object
      properties:
        cash_receipt_id:
          format: int32
          description: The identifier for this cash receipt.
          type: integer
          x-ms-summary: Cash receipt id
        date:
          format: date-time
          description: The date for this cash receipt.
          type: string
          x-ms-summary: Date
        number:
          description: The number for this cash receipt.
          type: string
          x-ms-summary: Number
        payer:
          description: The payer for this cash receipt.
          type: string
          x-ms-summary: Payer
        description:
          description: The description for this cash receipt.
          type: string
          x-ms-summary: Description
        payment_method:
          description: The payment method for this cash receipt.
          type: string
          x-ms-summary: Payment method
        amount:
          format: double
          description: The amount for this cash receipt.
          type: number
          x-ms-summary: Amount
      x-display-name: Cash receipt
      x-ms-summary: Cash receipt
    CustomField:
      description: Custom field definition.
      type: object
      properties:
        field_name:
          description: The name of the custom field.
          type: string
          x-ms-summary: Field name
        value:
          description: The value for this custom field.
          type: string
          x-ms-summary: Value
        comments:
          description: The description for this custom field.
          type: string
          x-ms-summary: Comments
        type:
          description: The type of this custom field.
          enum:
          - Text
          - Number
          - DateTime
          - Currency
          - Boolean
          - Table
          - FuzzyDate
          type: string
          x-ms-summary: Type
        is_required:
          description: If this custom field is required.
          type: boolean
          x-ms-summary: Is required
        date:
          format: date-time
          description: The date on this custom field.
          type: string
          x-ms-summary: Date
      x-display-name: Custom field
      x-ms-summary: Custom field
    BasicErrorMessage:
      type: object
      properties:
        Error:
          type: string
          x-ms-summary: Error
      x-display-name: Basic error message
      x-ms-summary: Basic error message
    CreateCashReceipt:
      description: CreateCashReceipt class.
      required:
      - date
      - amount
      - receipt_status
      type: object
      properties:
        date:
          format: date-time
          description: The date for this cash receipt.
          type: string
          x-ms-summary: Date
        amount:
          format: double
          description: The amount for this cash receipt.
          type: number
          x-ms-summary: Amount
        category:
          description: The category for this cash receipt.
          type: string
          x-ms-summary: Category
        description:
          description: The description for this cash receipt.
          type: string
          x-ms-summary: Description
        payment_from:
          description: The payment from information for this cash receipt.
          type: string
          x-ms-summary: Payment from
        payment_info:
          $ref: '#/components/schemas/Payment'
          description: The payment information for this cash receipt.
          x-ms-summary: Payment info
        receipt_status:
          description: The receipt status for this cash receipt.
          type: string
          x-ms-summary: Receipt status
        receipt_address:
          description: The receipt address for this cash receipt.
          type: string
          x-ms-summary: Receipt address
        distributions:
          description: The distributions for this cash receipt.
          type: array
          items:
            $ref: '#/components/schemas/CreateDistribution'
          x-ms-summary: Distributions
        custom_fields:
          description: The custom fields for this cash receipt.
          type: array
          items:
            $ref: '#/components/schemas/CreateCustomField'
          x-ms-summary: Custom fields
      example:
        date: '2017-02-08T00:00:00Z'
        amount: 10
        category: Grants
        description: cash receipt description
        payment_from: Benton
        payment_info:
          payment_method: CreditCard
          card_type: visa
          card_number: '8757'
          expiration_month: 11
          expiration_year: 2019
          authorization_number: '455'
        receipt_status: Do not print
        receipt_address: 123 fake street
        distributions:
        - amount: 10
          account_number: 01-1000-00
          type_code: Debit
          custom_fields: []
          distribution_splits:
          - ui_project_id: '1001'
            transaction_code_values:
            - name: Jurisdiction
              value: None
            - name: Spendable?
              value: Spendable
            - name: RE Appeals
              value: ''
            - name: Grant
              value: ''
            - name: Activities
              value: ''
            amount: 10
            percent: 100
            account_class: Unrestricted Net Assets
        custom_fields:
        - field_name: Restitution Recipient
          value: Doug
          comments: Custom field comments
          date: '2017-02-08T00:00:00Z'
      x-hidden: true
      x-display-name: Create cash receipt
      x-ms-summary: Create cash receipt
    DistributionSplit:
      description: Journal Entry Distribution.
      required:
      - transaction_code_values
      type: object
      properties:
        distribution_split_id:
          format: int32
          description: The distribution split identifier.
          type: integer
          x-ms-summary: Distribution split id
        ui_project_id:
          description: The user-visible identifier of the project.
          type: string
          x-ms-summary: Ui project id
        transaction_code_values:
          description: The distribution transaction code values. The values should be in the same order as the codes defined in the database.
          type: array
          items:
            $ref: '#/components/schemas/TransactionCodeValue'
          x-ms-summary: Transaction code values
        amount:
          format: double
          description: The distribution journal entry amount. Only one of amount or percent can be specified.
          type: number
          x-ms-summary: Amount
        percent:
          format: double
          description: The distribution journal entry amount percentage. Only one of amount or percent can be specified.
          type: number
          x-ms-summary: Percent
        account_class:
          description: The account class for this distribution split.
          type: string
          x-ms-summary: Account class
      x-display-name: Distribution split
      x-ms-summary: Distribution split
    Distribution:
      description: Distribution.
      required:
      - distribution_splits
      type: object
      properties:
        distribution_id:
          format: int32
          description: The distribution identifier.
          type: integer
          x-ms-summary: Distribution id
        amount:
          format: double
          description: The distribution amount.
          type: number
          x-ms-summary: Amount
        description:
          description: The description for this distribution.
          type: string
          x-ms-summary: Description
        account_number:
          description: The account number for this distribution.
          type: string
          x-ms-summary: Account number
        type_code:
          description: The journal entry transaction type (debit or credit).
          enum:
          - Debit
          - Credit
          type: string
          x-ms-summary: Type code
        custom_fields:
          description: The custom fields for this distribution.
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
          x-ms-summary: Custom fields
        distribution_splits:
          description: The distribution split.
          type: array
          items:
            $ref: '#/components/schemas/DistributionSplit'
          x-ms-summary: Distribution splits
      x-display-name: Distribution
      x-ms-summary: Distribution
    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
    CreatedResult_Int32:
      type: object
      properties:
        record_id:
          format: int32
          type: integer
          x-ms-summary: Record id
      x-hidden: true
      x-display-name: Created result `1
      x-ms-summary: Created result `1
    Payment:
      description: Payment class.
      required:
      - payment_method
      type: object
      properties:
        payment_method:
          description: The payment method for this payment.
          enum:
          - Cash
          - CashiersCheck
          - Check
          - COD
          - CreditCard
          - ReceivedEFT
          - Other
          type: string
          x-ms-summary: Payment method
        check_number:
          description: The check number for this payment.
          type: string
          x-ms-summary: Check number
        check_date:
          format: date-time
          description: The check date for this payment.
          type: string
          x-ms-summary: Check date
        card_type:
          description: The card type for this payment.
          type: string
          x-ms-summary: Card type
        card_number:
          description: The card number for this payment.
          type: string
          x-ms-summary: Card number
        expiration_month:
          format: int32
          description: The expiration month of the credit card for this payment.
          type: integer
          x-ms-summary: Expiration month
        expiration_year:
          format: int32
          description: The expiration year of the credit card for this payment.
          type: integer
          x-ms-summary: Expiration year
        authorization_number:
          description: The authorization number of the credit card for this payment.
          type: string
          x-ms-summary: Authorization number
        reference_number:
          description: The reference number for this payment.
          type: string
          x-ms-summary: Reference number
        reference_date:
          format: date-time
          description: The reference date for this payment.
          type: string
          x-ms-summary: Reference date
        other_type:
          description: The other type for this payment.
          type: string
          x-ms-summary: Other type
      x-display-name: Payment
      x-ms-summary: Payment
      x-hidden: true
  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: {}