Rutter · Schema
ListBankStatementResponseWithConnection
AccountingB2BCommerceFinancial DataPaymentsUnified APIHRIS
Properties
| Name | Type | Description |
|---|---|---|
| bank_statements | array | |
| next_cursor | stringnull | |
| connection | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/rutter/json-schema/rutter-list-bank-statement-response-with-connection-schema.json",
"title": "ListBankStatementResponseWithConnection",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/rutter-banking-api-openapi.yml#/components/schemas/ListBankStatementResponseWithConnection",
"type": "object",
"properties": {
"bank_statements": {
"type": "array",
"items": {
"$ref": "#/$defs/BankStatement"
}
},
"next_cursor": {
"type": [
"string",
"null"
]
},
"connection": {
"$ref": "#/$defs/Connection"
}
},
"required": [
"bank_statements",
"connection"
],
"$defs": {
"BankStatement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The Rutter generated unique ID of the bank statement.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"platform_id": {
"type": "string",
"description": "The platform specific ID of the bank statement.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"account_id": {
"type": [
"string",
"null"
],
"description": "The Rutter ID of the [Bank Account](/rest/version/bank_accounts) linked to the bank statement. Null when the platform does not identify a single bank account.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"preceding_statement_id": {
"type": [
"string",
"null"
],
"description": "The Rutter ID of the [Bank Statement](/rest/version/bank_statements) linked to the bank statement. The preceding statement in sequence, if resolved.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"start_date": {
"type": [
"string",
"null"
],
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bank statement period starts.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"end_date": {
"type": [
"string",
"null"
],
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bank statement period ends.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"currency_code": {
"type": [
"string",
"null"
],
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UYW",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMW",
"ETH",
"BTC",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank statement totals. Null when there is no single currency for the statement totals.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"ending_balance": {
"type": [
"number",
"null"
],
"description": "The ending balance in major currency units. May be null when the platform omits deprecated totals or the statement spans multiple currencies. Use balance_sections instead.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"opening_balance": {
"type": [
"number",
"null"
],
"description": "The opening balance in major currency units. May be null when the platform omits deprecated totals or the statement spans multiple currencies. Use balance_sections for the per-entity and per-currency balances.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"statement_url": {
"type": [
"string",
"null"
],
"description": "The statement download URL stored during sync. List and detail GETs return the stored URL without on-demand renewal; it may already have expired. A refresh can replace it when Ramp returns a changed URL. Expiry is provider-controlled and exact enforcement is unproven; do not store this as a permanent link.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"total_charges": {
"type": [
"number",
"null"
],
"description": "The total charges in major currency units. May be null when the platform omits deprecated totals or the statement spans multiple currencies. Use balance_sections instead.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"total_credits": {
"type": [
"number",
"null"
],
"description": "The total credits in major currency units. May be null when the platform omits deprecated totals or the statement spans multiple currencies. Use balance_sections instead.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"total_payments": {
"type": [
"number",
"null"
],
"description": "The total payments in major currency units. May be null when the platform omits deprecated totals or the statement spans multiple currencies. Use balance_sections instead.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"lines": {
"type": "array",
"items": {
"$ref": "#/$defs/BankStatementLine"
},
"description": "The typed platform references to financial activity in the statement.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"balance_sections": {
"type": "array",
"items": {
"$ref": "#/$defs/BankStatementBalanceSection"
},
"description": "The statement balances broken down by business entity and currency. Sections and each monetary value's currency are preserved, not combined into statement-wide totals.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"last_synced_at": {
"type": "string",
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank statement was last synced by Rutter.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"platform_data": {
"type": "object",
"additionalProperties": {},
"description": "The raw platform data corresponding to the Rutter object."
}
},
"required": [
"id",
"platform_id",
"account_id",
"start_date",
"end_date",
"currency_code",
"ending_balance",
"opening_balance",
"statement_url",
"total_charges",
"total_credits",
"total_payments",
"lines",
"balance_sections",
"last_synced_at"
]
},
"BankStatementBalanceSection": {
"type": "object",
"properties": {
"platform_id": {
"type": [
"string",
"null"
],
"description": "The platform specific ID of the bank statement balance section.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"entity_id": {
"type": [
"string",
"null"
],
"description": "The platform ID of the business entity for this balance section.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"charges": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": [
"number",
"null"
],
"description": "The amount in major currency units.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"currency_code": {
"type": [
"string",
"null"
],
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UYW",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMW",
"ETH",
"BTC",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the amount.",
"x-rutter-platforms": {
"RAMP": {}
}
}
},
"required": [
"amount",
"currency_code"
],
"additionalProperties": false,
"description": "The charges incurred in this balance section.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"credits": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": [
"number",
"null"
],
"description": "The amount in major currency units.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"currency_code": {
"type": [
"string",
"null"
],
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UYW",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMW",
"ETH",
"BTC",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the amount.",
"x-rutter-platforms": {
"RAMP": {}
}
}
},
"required": [
"amount",
"currency_code"
],
"additionalProperties": false,
"description": "The credits accumulated in this balance section.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"ending_balance": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": [
"number",
"null"
],
"description": "The amount in major currency units.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"currency_code": {
"type": [
"string",
"null"
],
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UYW",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMW",
"ETH",
"BTC",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the amount.",
"x-rutter-platforms": {
"RAMP": {}
}
}
},
"required": [
"amount",
"currency_code"
],
"additionalProperties": false,
"description": "The balance at the end of this section's statement period.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"opening_balance": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": [
"number",
"null"
],
"description": "The amount in major currency units.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"currency_code": {
"type": [
"string",
"null"
],
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UYW",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XFU",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMW",
"ETH",
"BTC",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the amount.",
"x-rutter-platforms": {
"RAMP": {}
}
}
},
"required": [
"amount",
"currency_code"
],
"additionalProperties": false,
"description": "The balance at the beginning of this section's statement period.",
"x-rutter-platforms": {
"RAMP": {}
}
},
"payments": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": [
"number",
"null"
],
"d
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://artifacts.apis.io/rutter/json-schema/rutter-list-bank-statement-response-with-connection-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rutter-list-bank-statement-response-with-connection"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.