CreateCreditImportBatchMessage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-create-credit-import-batch-message-schema.json",
  "title": "CreateCreditImportBatchMessage",
  "description": "A request containing all the information needed to create a batch of credits",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-billing-management-api-openapi.yml#/components/schemas/CreateCreditImportBatchMessage",
  "required": [
    "batch_id",
    "credits"
  ],
  "type": "object",
  "properties": {
    "batch_id": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "Your unique identifier for the batch. Character limit: 100"
    },
    "credits": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "$ref": "#/$defs/CreateCreditDataMessage"
      },
      "description": "The credits to be created in the batch. Batch size limit: 100"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "CreateCreditDataMessage": {
      "required": [
        "amount",
        "batch_transaction_id",
        "credit_date",
        "fee_type_id",
        "student_user_id"
      ],
      "type": "object",
      "properties": {
        "fee_type_id": {
          "type": "integer",
          "description": "The fee type ID of the credit to be created",
          "format": "int32"
        },
        "amount": {
          "type": "number",
          "description": "The credit amount",
          "format": "double"
        },
        "student_user_id": {
          "type": "integer",
          "description": "The student's user ID to create the credit for",
          "format": "int32"
        },
        "credit_date": {
          "type": "string",
          "description": "The date of the credit",
          "format": "date"
        },
        "credit_comments": {
          "maxLength": 1000,
          "minLength": 0,
          "type": [
            "string",
            "null"
          ],
          "description": "The comments for the credit."
        },
        "batch_transaction_id": {
          "maxLength": 100,
          "minLength": 0,
          "type": "string",
          "description": "Your unique identifier for the credit. Character limit: 100"
        }
      },
      "additionalProperties": false,
      "description": "A message containing all the information needed to create a credit"
    }
  }
}