BatchPushBankTransactionResponseV2Dto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/fis/main/json-schema/fis-batch-push-bank-transaction-response-v2-dto-schema.json",
  "title": "BatchPushBankTransactionResponseV2Dto",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fis-bankcontrollerv2-api-openapi.yml#/components/schemas/BatchPushBankTransactionResponseV2Dto",
  "type": "object",
  "properties": {
    "connectionUuid": {
      "type": "string",
      "readOnly": true
    },
    "businessName": {
      "type": "string",
      "readOnly": true
    },
    "serviceName": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "freshbooks",
        "quickbooks",
        "quickbooksDesktop",
        "xero",
        "oracleNetsuite",
        "sageBusinessCloud",
        "sageIntacct",
        "dynamicsBusinessCentral",
        "dynamics365Finance",
        "wave",
        "myob",
        "zohoBooks",
        "byod"
      ]
    },
    "batchId": {
      "type": "string",
      "readOnly": true
    },
    "batch": {
      "readOnly": true,
      "type": "array",
      "items": {
        "$ref": "#/$defs/PushBankTransactionIndividualResponseV2Dto"
      }
    }
  },
  "required": [
    "connectionUuid",
    "businessName",
    "serviceName",
    "batchId",
    "batch"
  ],
  "$defs": {
    "AccountRefDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "BankAccountRefDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "BaseTaxRateRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "EntityRefDto": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "customer",
            "vendor"
          ]
        },
        "id": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "PushBankTransactionIndividualResponseV2Dto": {
      "type": "object",
      "properties": {
        "pushCommunicationId": {
          "type": "string",
          "readOnly": true
        },
        "requestedOn": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "status": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "success",
            "failed",
            "pending"
          ]
        },
        "data": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/$defs/PushBankTransactionV2"
            }
          ]
        }
      },
      "required": [
        "pushCommunicationId",
        "requestedOn",
        "status",
        "data"
      ]
    },
    "PushBankTransactionLineV2": {
      "type": "object",
      "properties": {
        "quantity": {
          "type": "number",
          "format": "float"
        },
        "unitAmount": {
          "type": "number",
          "format": "float"
        },
        "description": {
          "type": "string",
          "maxLength": 4000
        },
        "accountRef": {
          "$ref": "#/$defs/AccountRefDto"
        },
        "taxRateRef": {
          "$ref": "#/$defs/BaseTaxRateRef"
        },
        "taxAmount": {
          "type": "number",
          "format": "float"
        },
        "trackingCategoryRefs": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TrackingCategoryRefV2Dto"
          }
        }
      },
      "required": [
        "accountRef"
      ]
    },
    "PushBankTransactionV2": {
      "type": "object",
      "properties": {
        "currencyRate": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        },
        "transactionType": {
          "type": "string",
          "enum": [
            "payment",
            "refund",
            "deposit",
            "expense",
            "transfer",
            "overPayment",
            "unknown",
            "salesReturn",
            "ownerDrawings",
            "salesWithoutInvoices",
            "interestIncome",
            "otherIncome",
            "expenseRefund",
            "depositFromOtherAccounts",
            "ownersContribution"
          ]
        },
        "bankAccountRef": {
          "$ref": "#/$defs/BankAccountRefDto"
        },
        "entityRef": {
          "$ref": "#/$defs/EntityRefDto"
        },
        "lines": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PushBankTransactionLineV2"
          }
        },
        "totalAmount": {
          "type": "number",
          "format": "float"
        },
        "memo": {
          "type": "string",
          "maxLength": 4000
        },
        "postedDate": {
          "format": "date-time",
          "type": "string"
        },
        "transactionDirection": {
          "type": "string",
          "enum": [
            "outgoing",
            "incoming"
          ]
        },
        "passThrough": {
          "type": "object",
          "additionalProperties": true
        }
      },
      "required": [
        "bankAccountRef"
      ]
    },
    "TrackingCategoryRefV2Dto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "class",
            "department",
            "location",
            "unknown"
          ]
        }
      }
    }
  }
}