Ramp: Statement schemas
4 Ramp schemas with complete fields and constraints.
← Statement operations · All schemas
Fetch a statement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance_sections | array | Required within parent | Breakdown of statement balances by entity and currency. |
balance_sections[] | Model | Each item | Expand Fetch a statement — response body — balance sections item |
charges | Model | Required within parent | Expand Hold Bill — response body — amount Total charges incurred during the statement period |
credits | Model | Required within parent | Expand Hold Bill — response body — amount Total credits accumulated during the statement period |
end_date | string | Required within parent | End date of the statement period. Format: date-time |
ending_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the end of the statement period |
id | string | Required within parent | Unique identifier for the statement. Format: uuid |
opening_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the beginning of the statement period |
payments | Model | Required within parent | Expand Hold Bill — response body — amount Total payments made during the statement period |
preceding_statement_id | string | Optional | Identifier of the previous statement in sequence. Format: uuid |
start_date | string | Required within parent | Start date of the statement period. Format: date-time |
statement_lines | array | Required within parent | Financial activities including card transactions, transfers, and cashbacks during the statement period. |
statement_lines[] | Model | Each item | Expand Fetch a statement — response body — statement lines item |
statement_url | string | Optional | Pre-signed URL to download statement PDF, valid for 1 hour after generation. Format: url |
Referenced models: Fetch a statement — response body — statement lines item, Hold Bill — response body — amount, Fetch a statement — response body — balance sections item
Fetch a statement — response body — balance sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charges | Model | Required within parent | Expand Hold Bill — response body — amount Total charges incurred during the statement period. |
credits | Model | Required within parent | Expand Hold Bill — response body — amount Total credits accumulated during the statement period. |
ending_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the end of the statement period. |
entity_id | string | Required within parent | Business entity this balance section belongs to. Format: uuid |
id | string | Required within parent | Unique identifier for the balance section. Format: uuid |
opening_balance | Model | Required within parent | Expand Hold Bill — response body — amount Balance at the beginning of the statement period. |
payments | Model | Required within parent | Expand Hold Bill — response body — amount Total payments made during the statement period. |
Referenced models: Hold Bill — response body — amount
Fetch a statement — response body — statement lines item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cleared_at | JSON | Optional | |
cleared_at (anyOf 1) | string | Alternative | Time when transaction was cleared. Only present for transactions and may be null if not cleared. Format: date-time |
cleared_at (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | For transactions: time when card was swiped. For transfers/cashbacks: creation time. Format: date-time |
id | string | Optional | Unique identifier for the statement line item. Format: uuid |
type | string | Optional | Type of statement line item (CARD_TRANSACTION, TRANSFER_PAYMENT, or CASHBACK). Known values: CARD_TRANSACTION, CASHBACK, TRANSFER_PAYMENT |
List statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a statement — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a statement — response body