Ramp: Custom records schemas
78 Ramp schemas with complete fields and constraints.
← Custom records operations · All schemas
Add a result column to an existing Matrix table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Schema for defining a Matrix result column (Developer API). |
cardinality | string | Required within parent | Cardinality enum for Pydantic schemas with lowercase values. This enum uses lowercase values for API consistency while mapping to the internal CardinalityEnum. many_to_one or many_to_many for the result column One of: many_to_many, many_to_one |
label | string | Required within parent | Display name for the result column |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | API name for the column Default: null |
name (anyOf 2) | null | Alternative | |
native_table | Model | Required within parent | Expand Add a result column to an existing Matrix table — request body — body native table The native table this result references (only users, approver_groups, and accounting_field_options supported) |
Referenced models: Add a result column to an existing Matrix table — request body — body native table
Add a result column to an existing Matrix table — request body — body native table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Native table reference for Developer API result columns. Only allows: users, approver_groups, and accounting_field_options. |
accounting_field_ramp_id | JSON | Optional | |
accounting_field_ramp_id (anyOf 1) | string | Alternative | The accounting field's ramp_id (UUID), only set for accounting_field_options Default: null |
accounting_field_ramp_id (anyOf 2) | null | Alternative | |
table_name | string | Required within parent | The native table name for result columns: users, approver_groups, or accounting_field_options only. One of: accounting_field_options, approver_groups, users |
type | string | Optional | Default: native_table One of: native_table |
Add a result column to an existing Matrix table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for adding a result column to a Matrix table. |
column_id | string | Required within parent | ID of the created result column |
Append cells to Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for appending cells to Matrix rows. |
data | array | Required within parent | Rows with cells to append (many-to-many result columns only) |
data[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item |
ignore_duplicates | boolean | Optional | If true, existing duplicate cells and duplicate cells within the request are skipped instead of returning an error. Default: false |
Referenced models: Upsert Matrix table rows — request body — body data item
Append cells to Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for appending cells to Matrix rows. |
metadata | Model | Required within parent | Expand Append cells to Matrix table rows — response body — metadata Append counts |
Referenced models: Append cells to Matrix table rows — response body — metadata
Append cells to Matrix table rows — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells_appended | JSON | Required within parent | |
cells_appended (anyOf 1) | integer | Alternative | Number of cells appended |
cells_appended (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Append cells to a Custom Table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of rows to insert or update. All entries must have the same set of column names, with `null` provided to indicate that a value should not be set. |
data[] | Model | Each item | Expand Append cells to a Custom Table — request body — body data item |
Referenced models: Append cells to a Custom Table — request body — body data item
Append cells to a Custom Table — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The contents of the cells in the row. The column name should be the name of the column, and the contents should be the value to insert into the cell. When setting a cell to reference many rows, each reference must be a separate entry in the list. |
cells[] | Model | Each item | Expand Append cells to a Custom Table — request body — body data item cells item |
external_key | string | Required within parent | The external key of the row. |
Referenced models: Append cells to a Custom Table — request body — body data item cells item
Append cells to a Custom Table — request body — body data item cells item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contents | JSON | Required within parent | |
contents (anyOf 1) | JSON | Alternative | |
contents (anyOf 1) (oneOf 1) | Model | Alternative | Expand Append cells to a Native Ramp table — request body — body data item row |
contents (anyOf 1) (oneOf 2) | string | Alternative | Format: date-time |
contents (anyOf 1) (oneOf 3) | boolean | Alternative | |
contents (anyOf 1) (oneOf 4) | number | Alternative | |
contents (anyOf 1) (oneOf 5) | string | Alternative | |
contents (anyOf 2) | null | Alternative | |
name | string | Required within parent |
Referenced models: Append cells to a Native Ramp table — request body — body data item row
Append cells to a Custom Table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Required within parent | Expand Append cells to a Custom Table — response body — metadata |
Referenced models: Append cells to a Custom Table — response body — metadata
Append cells to a Custom Table — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inserted | JSON | Required within parent | |
inserted (anyOf 1) | integer | Alternative | |
inserted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Append cells to a Native Ramp table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of rows to insert or update. All entries must have the same set of column names, with `null` provided to indicate that a value should not be set. |
data[] | Model | Each item | Expand Append cells to a Native Ramp table — request body — body data item |
Referenced models: Append cells to a Native Ramp table — request body — body data item
Append cells to a Native Ramp table — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The contents of the cells in the row. The column name should be the name of the column, and the contents should be the value to insert into the cell. When setting a cell to reference many rows, each reference must be a separate entry in the list. |
cells[] | Model | Each item | Expand Append cells to a Custom Table — request body — body data item cells item |
row | Model | Required within parent | Expand Append cells to a Native Ramp table — request body — body data item row An identifier for the Ramp object |
Referenced models: Append cells to a Custom Table — request body — body data item cells item, Append cells to a Native Ramp table — request body — body data item row
Append cells to a Native Ramp table — request body — body data item row
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_name | string | Required within parent | |
value | string | Required within parent |
Change the API name of a Matrix table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
new_name | string | Required within parent |
Change the external key of a Custom Table row — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
new_external_key | string | Required within parent | The new external key to set for the row |
Create Custom Table column — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"boolean": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody", "custom_reference": "#/components/schemas/DeveloperApiCreateReferenceColumnRequestBody", "native_reference": "#/components/schemas/DeveloperApiCreateReferenceColumnRequestBody", "number": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody", "text": "#/components/schemas/DeveloperApiCreatePrimitiveColumnRequestBody"}, "propertyName": "column_type_name"} |
$ (oneOf 1) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: boolean, number, text |
$ (oneOf 2) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference |
Referenced models: Create Custom Table column — request body — body / column_type_name: boolean, number, text, Create Custom Table column — request body — body / column_type_name: custom reference, native reference
Create Custom Table column — request body — body / column_type_name: boolean, number, text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_type_name | string | Required within parent | The type of the primitive column. One of: boolean, number, text |
label | string | Required within parent | The display name of the column |
name | string | Required within parent | The API name of the column, to be used when writing to this column |
Create Custom Table column — request body — body / column_type_name: custom reference, native reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_type_name | string | Required within parent | The type of the reference column. One of: custom_reference, native_reference |
label | string | Required within parent | The display name of the column |
name | string | Required within parent | The API name of the column, to be used when writing to this column |
reference_args | Model | Required within parent | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args Arguments for creating a reference column. |
Referenced models: Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args
Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the reference. One of: many_to_many, many_to_one |
corresponding_column_label | JSON | Optional | |
corresponding_column_label (anyOf 1) | string | Alternative | The label of the corresponding column. Providing either corresponding column field opts into creating an archived backref column; omitted fields are generated only when a backref is created. Default: null |
corresponding_column_label (anyOf 2) | null | Alternative | |
corresponding_column_name | JSON | Optional | |
corresponding_column_name (anyOf 1) | string | Alternative | The API name of the corresponding column. Providing either corresponding column field opts into creating an archived backref column; omitted fields are generated only when a backref is created. Default: null |
corresponding_column_name (anyOf 2) | null | Alternative | |
foreign_table | JSON | Required within parent | The table that this column references. |
foreign_table (oneOf 1) | Model | Alternative | Expand Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table |
foreign_table (oneOf 2) | Model | Alternative | Expand Extend Native Ramp table — request body — body |
Referenced models: Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table, Extend Native Ramp table — request body — body
Create Custom Table column — request body — body / column_type_name: custom reference, native reference reference args foreign table type: custom table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_name | string | Required within parent | The name of the custom table |
type | string | Optional | Default: custom_table One of: custom_table |
Create Custom Table column — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_id | string | Required within parent | The id of the created column |
Create Custom Table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_label | string | Required within parent | The custom table's label as displayed in Ramp |
table_name | string | Required within parent | The custom table's API name |
type | string | Optional | Default: custom_table One of: custom_table |
Create a Matrix table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Schema for creating a Matrix table (Developer API). |
input_columns | array | Required within parent | Input columns that define the Matrix dimensions (references or number) |
input_columns[] | Model | Each item | Expand Create a Matrix table — request body — body input columns item |
label | string | Required within parent | Display name for the Matrix table |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | API name for the table Default: null |
name (anyOf 2) | null | Alternative | |
result_columns | array | Required within parent | Result columns that store Matrix outputs |
result_columns[] | Model | Each item | Expand Add a result column to an existing Matrix table — request body — body |
Referenced models: Create a Matrix table — request body — body input columns item, Add a result column to an existing Matrix table — request body — body
Create a Matrix table — request body — body / input_columns / item / column_type / type: native table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Native table reference for Developer API input columns. Allows: users, locations, departments, business_entities, accounting_field_options, vendors, and merchant_categories. |
accounting_field_ramp_id | JSON | Optional | |
accounting_field_ramp_id (anyOf 1) | string | Alternative | The accounting field's ramp_id (UUID), only set for accounting_field_options Default: null |
accounting_field_ramp_id (anyOf 2) | null | Alternative | |
table_name | string | Required within parent | The native table name for input columns: users, locations, departments, business_entities, accounting_field_options, vendors, merchant_categories. One of: accounting_field_options, business_entities, departments, locations, merchant_categories, users, vendors |
type | string | Optional | Default: native_table One of: native_table |
Create a Matrix table — request body — body / input_columns / item / column_type / type: number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number column type for Developer API input columns. |
type | string | Optional | Column type discriminator Default: number One of: number |
Create a Matrix table — request body — body input columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Schema for defining a Matrix input column (Developer API). |
column_type | JSON | Required within parent | Defines the type of input field used by the matrix |
column_type (oneOf 1) | Model | Alternative | Expand Create a Matrix table — request body — body / input_columns / item / column_type / type: native table |
column_type (oneOf 2) | Model | Alternative | Expand Create a Matrix table — request body — body / input_columns / item / column_type / type: number |
label | string | Required within parent | Display name for the input column |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | API name for the column Default: null |
name (anyOf 2) | null | Alternative |
Referenced models: Create a Matrix table — request body — body / input_columns / item / column_type / type: native table, Create a Matrix table — request body — body / input_columns / item / column_type / type: number
Create a Matrix table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for creating a Matrix table. |
table_id | string | Required within parent | ID of the created Matrix table |
Delete rows from a Custom Table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of the external keys of rows to delete. |
data[] | Model | Each item | Expand Delete rows from a Custom Table — request body — body data item |
Referenced models: Delete rows from a Custom Table — request body — body data item
Delete rows from a Custom Table — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_key | string | Required within parent |
Delete rows from a Custom Table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Required within parent | Expand Delete rows from a Custom Table — response body — metadata |
Referenced models: Delete rows from a Custom Table — response body — metadata
Delete rows from a Custom Table — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | JSON | Required within parent | |
deleted (anyOf 1) | integer | Alternative | |
deleted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Extend Native Ramp table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_name | string | Required within parent | The name of the native Ramp table One of: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors |
type | string | Optional | Default: native_table One of: native_table |
List Custom Table columns — 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 List Custom Table columns — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List Custom Table columns — response body — data item
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: custom reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the referencing column Known values: many_to_many, many_to_one, one_to_many, one_to_one |
corresponding_column_id | JSON | Required within parent | |
corresponding_column_id (anyOf 1) | string | Alternative | The column in the referenced table that corresponds to the referencing column. This is null for forward-only reference columns. Default: null |
corresponding_column_id (anyOf 2) | null | Alternative | |
table_display_name | string | Required within parent | The display name of the referenced table |
table_id | string | Required within parent | The unique identifier for the referenced table |
table_name | string | Required within parent | The API name of the custom table that is referenced |
type | string | Required within parent | Known values: custom_reference Default: custom_reference |
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the referencing column Known values: many_to_many, many_to_one, one_to_many, one_to_one |
corresponding_column_id | JSON | Required within parent | |
corresponding_column_id (anyOf 1) | string | Alternative | The column in the referenced table that corresponds to the referencing column. This is null for forward-only reference columns. Default: null |
corresponding_column_id (anyOf 2) | null | Alternative | |
table_id | string | Required within parent | The unique identifier for the referenced table |
table_name | string | Required within parent | The native Ramp table that is referenced Known values: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors |
tracking_category | JSON | Required within parent | |
tracking_category (anyOf 1) | Model | Alternative | Expand List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference tracking category accounting provider is connected, display name, id, is active, uuid Metadata about the tracking category when referencing accounting_field_options Default: null |
tracking_category (anyOf 2) | null | Alternative | |
type | string | Required within parent | Known values: native_reference Default: native_reference |
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference tracking category accounting provider is connected, display name, id, is active, uuid
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_provider_is_connected | boolean | Required within parent | Whether the tracking category's accounting provider is currently connected |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | The display name of the tracking category Default: null |
display_name (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The tracking category integer ID |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_active | boolean | Required within parent | Whether the tracking category is active |
uuid | string | Required within parent | The tracking category UUID (ramp_id) |
List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: currency, number, percentage |
type | string | Required within parent | Known values: number Default: number |
List Custom Table columns — response body — data / item / type / display_type: date, type: datetime
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: date |
type | string | Required within parent | Known values: datetime Default: datetime |
List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: email, numeric_id, paragraph, phone, plain_text, url |
type | string | Required within parent | Known values: text Default: text |
List Custom Table columns — response body — data / item / type / type: boolean
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Known values: boolean Default: boolean |
List Custom Table columns — response body — data item
Referenced models: List Custom Table columns — response body — data / item / type / type: boolean, List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: custom reference, List Custom Table columns — response body — data / item / type / display_type: date, type: datetime, List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference, List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number, List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text
List Custom Table rows — 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 List Custom Table rows — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List Custom Table rows — response body — data item
List Custom Table rows — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The contents of each column for this row. |
cells[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
display_name | string | Required within parent | A display name for the custom row. |
external_key | string | Required within parent | The external key of the custom row. Will be unique within the table. |
id | string | Required within parent | The id of the custom row |
Referenced models: Get a business entity — response body — custom record fields item
List Custom Tables — 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 List Custom Tables — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List Custom Tables — response body — data item
List Custom Tables — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_label | string | Required within parent | The custom table's label as displayed in Ramp |
table_name | string | Required within parent | The custom table's API name |
type | string | Required within parent | Known values: custom_table Default: custom_table |
List Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for listing Matrix rows. |
external_keys | JSON | Optional | |
external_keys (anyOf 1) | array | Alternative | Filter by specific external keys Default: null |
external_keys (anyOf 1)[] | string | Each item | |
external_keys (anyOf 2) | null | Alternative | |
filters | JSON | Optional | |
filters (anyOf 1) | array | Alternative | Filter rows by input column values. Only rows matching ALL filters are returned. Default: null |
filters (anyOf 1)[] | Model | Each item | Expand List Matrix table rows — request body — body filters array item |
filters (anyOf 2) | null | Alternative | |
page_size | integer | Optional | Number of rows per page Default: 100 |
start | JSON | Optional | |
start (anyOf 1) | string | Alternative | Pagination cursor (row ID from page.next) Default: null |
start (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — request body — body filters array item
List Matrix table rows — request body — body filters array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Filter for a specific Matrix input column. |
column_name | string | Required within parent | API name of the input column to filter on |
one_of | array | Required within parent | List of ramp object UUIDs to filter by (matches any) |
one_of[] | string | Each item |
List Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for listing Matrix rows. |
data | array | Required within parent | List of Matrix rows |
data[] | Model | Each item | Expand List Matrix table rows — response body — data item |
page | Model | Required within parent | Expand List Matrix table rows — response body — page Pagination information |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of rows matching filters |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List Matrix table rows — response body — page, List Matrix table rows — response body — data item
List Matrix table rows — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix row for reading (GET/list operations). |
id | string | Required within parent | Unique Identifier for this row of the Matrix |
inputs | array | Required within parent | Input cells (ALL input columns included, even if None) |
inputs[] | Model | Each item | Expand List Matrix table rows — response body — data item inputs item |
results | array | Required within parent | Result cells (only cells that exist) |
results[] | Model | Each item | Expand List Matrix table rows — response body — data item results item |
Referenced models: List Matrix table rows — response body — data item results item, List Matrix table rows — response body — data item inputs item
List Matrix table rows — response body — data item inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix input cell with column name, identifier, and display_name (for responses). |
column_name | string | Required within parent | API name of the input column |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the referenced object or number value (None for missing input) |
display_name (anyOf 2) | null | Alternative | |
identifier | JSON | Optional | |
identifier (anyOf 1) | JSON | Alternative | Identifier for the referenced object or number value (includes type discriminator) Default: null |
identifier (anyOf 1) (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value |
identifier (anyOf 1) (anyOf 2) | Model | Alternative | Expand List Matrix table rows — response body — data item inputs item identifier value value |
identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value, List Matrix table rows — response body — data item inputs item identifier value value
List Matrix table rows — response body — data item inputs item identifier value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier for a number value in Matrix input columns. |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | Numeric value (e.g., amount threshold) |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List Matrix table rows — response body — data item results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix result cell with column name, identifier, and display_name (for responses). |
column_name | string | Required within parent | API name of the result column |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the referenced object (None to clear) |
display_name (anyOf 2) | null | Alternative | |
identifier | JSON | Required within parent | |
identifier (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value Identifier for the referenced object (None to clear) |
identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value
List Matrix table rows — response body — data item results item identifier column name, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier for a native Ramp object (e.g., user, department). |
column_name | string | Required within parent | Column name to identify by (e.g., 'id', 'email') |
value | string | Required within parent | Value for identification |
List Matrix table rows — response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | Cursor for next page (row ID to pass as start parameter) |
next (anyOf 2) | null | Alternative |
List Native Ramp tables — 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 List Native Ramp tables — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List Native Ramp tables — response body — data item
List Native Ramp tables — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
table_name | string | Required within parent | The name of the native Ramp table Known values: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors |
type | string | Required within parent | Known values: native_table Default: native_table |
List all Matrix tables for the business — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for listing Matrix tables. |
data | array | Required within parent | List of Matrix tables |
data[] | Model | Each item | Expand List all Matrix tables for the business — response body — data item |
Referenced models: List all Matrix tables for the business — response body — data item
List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type info for native reference Matrix input columns (Developer API). |
column_type | string | Optional | Column type discriminator Known values: native_reference Default: native_reference |
native_table | Model | Required within parent | Expand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table |
Referenced models: List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table
List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Native table reference for Developer API input columns. Allows: users, locations, departments, business_entities, accounting_field_options, vendors, and merchant_categories. |
accounting_field_ramp_id | JSON | Optional | |
accounting_field_ramp_id (anyOf 1) | string | Alternative | The accounting field's ramp_id (UUID), only set for accounting_field_options Default: null |
accounting_field_ramp_id (anyOf 2) | null | Alternative | |
table_name | string | Required within parent | The native table name for input columns: users, locations, departments, business_entities, accounting_field_options, vendors, merchant_categories. Known values: accounting_field_options, business_entities, departments, locations, merchant_categories, users, vendors |
type | string | Optional | Known values: native_table Default: native_table |
List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type info for number Matrix input columns (Developer API). |
column_type | string | Optional | Column type discriminator Known values: number Default: number |
List all Matrix tables for the business — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about a Matrix table for Developer API (uses UUIDs). |
id | string | Required within parent | Table ID |
input_columns | array | Required within parent | Input columns |
input_columns[] | Model | Each item | Expand List all Matrix tables for the business — response body — data item input columns item |
label | string | Required within parent | Display name |
name | string | Required within parent | API name |
result_columns | array | Required within parent | Result columns |
result_columns[] | Model | Each item | Expand List all Matrix tables for the business — response body — data item result columns item |
Referenced models: List all Matrix tables for the business — response body — data item input columns item, List all Matrix tables for the business — response body — data item result columns item
List all Matrix tables for the business — response body — data item input columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about a Matrix input column for Developer API (uses UUIDs). |
display_name | string | Required within parent | Display name |
id | string | Required within parent | Column ID |
name | string | Required within parent | API name |
type | JSON | Required within parent | Column type details (native_reference or number) |
type (anyOf 1) | Model | Alternative | Expand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference |
type (anyOf 2) | Model | Alternative | Expand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number |
Referenced models: List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference, List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number
List all Matrix tables for the business — response body — data item result columns item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Info about a Matrix result column for Developer API (uses UUIDs). |
display_name | string | Required within parent | Display name |
id | string | Required within parent | Column ID |
name | string | Required within parent | API name |
type | Model | Required within parent | Expand List all Matrix tables for the business — response body — data item result columns item type Column type details (currently only native_reference) |
Referenced models: List all Matrix tables for the business — response body — data item result columns item type
List all Matrix tables for the business — response body — data item result columns item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Type info for native reference Matrix result columns (Developer API). |
cardinality | string | Required within parent | Cardinality enum for Pydantic schemas with lowercase values. This enum uses lowercase values for API consistency while mapping to the internal CardinalityEnum. Known values: many_to_many, many_to_one |
column_type | string | Optional | Column type discriminator Known values: native_reference Default: native_reference |
native_table | Model | Required within parent | Expand List all Matrix tables for the business — response body — data item result columns item type native table |
Referenced models: List all Matrix tables for the business — response body — data item result columns item type native table
List all Matrix tables for the business — response body — data item result columns item type native table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Native table reference for Developer API result columns. Only allows: users, approver_groups, and accounting_field_options. |
accounting_field_ramp_id | JSON | Optional | |
accounting_field_ramp_id (anyOf 1) | string | Alternative | The accounting field's ramp_id (UUID), only set for accounting_field_options Default: null |
accounting_field_ramp_id (anyOf 2) | null | Alternative | |
table_name | string | Required within parent | The native table name for result columns: users, approver_groups, or accounting_field_options only. Known values: accounting_field_options, approver_groups, users |
type | string | Optional | Known values: native_table Default: native_table |
Remove cells from Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for removing cells from Matrix rows. |
data | array | Required within parent | Rows with cells to remove (many-to-many result columns only) |
data[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item |
Referenced models: Upsert Matrix table rows — request body — body data item
Remove cells from Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for removing cells from Matrix rows. |
metadata | Model | Required within parent | Expand Remove cells from Matrix table rows — response body — metadata Remove counts |
Referenced models: Remove cells from Matrix table rows — response body — metadata
Remove cells from Matrix table rows — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells_removed | JSON | Required within parent | |
cells_removed (anyOf 1) | integer | Alternative | Number of cells removed |
cells_removed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Remove cells from a Native Ramp table — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of rows containing cells to remove. |
data[] | Model | Each item | Expand Append cells to a Native Ramp table — request body — body data item |
skip_removing_already_missing | boolean | Optional | Whether to ignore requested cells that do not exist instead of returning an error. Default: false |
Referenced models: Append cells to a Native Ramp table — request body — body data item
Set values for rows of a Custom Table — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Required within parent | Expand Set values for rows of a Custom Table — response body — metadata |
Referenced models: Set values for rows of a Custom Table — response body — metadata
Set values for rows of a Custom Table — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inserted | JSON | Required within parent | |
inserted (anyOf 1) | integer | Alternative | The number of rows inserted. |
inserted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated | JSON | Required within parent | |
updated (anyOf 1) | integer | Alternative | The number of rows updated. |
updated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Upsert Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for upserting Matrix rows. |
data | array | Required within parent | Rows to upsert |
data[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item |
Referenced models: Upsert Matrix table rows — request body — body data item
Upsert Matrix table rows — request body — body data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Input for writing a single Matrix row. |
inputs | array | Required within parent | Input column values (must include ALL input columns) |
inputs[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item inputs item |
results | array | Required within parent | Result column values (can be partial subset) |
results[] | Model | Each item | Expand Upsert Matrix table rows — request body — body data item results item |
Referenced models: Upsert Matrix table rows — request body — body data item inputs item, Upsert Matrix table rows — request body — body data item results item
Upsert Matrix table rows — request body — body data item inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix input cell with column name and identifier. |
column_name | string | Required within parent | API name of the input column |
identifier | JSON | Optional | |
identifier (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value Identifier for the referenced native object (use for native_table columns) Default: null |
identifier (anyOf 2) | null | Alternative | |
number_identifier | JSON | Optional | |
number_identifier (anyOf 1) | JSON | Alternative | Number value identifier (use for number columns) Default: null |
number_identifier (anyOf 1) (oneOf 1) | number | Alternative | |
number_identifier (anyOf 1) (oneOf 2) | string | Alternative | |
number_identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value
Upsert Matrix table rows — request body — body data item results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix result cell with column name and identifier (for input requests). |
column_name | string | Required within parent | API name of the result column |
identifier | JSON | Required within parent | |
identifier (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value Identifier for the referenced object (None to clear) |
identifier (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — response body — data item results item identifier column name, value
Upsert Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for upserting Matrix rows. |
metadata | Model | Required within parent | Expand Upsert Matrix table rows — response body — metadata Insert/update counts |
Referenced models: Upsert Matrix table rows — response body — metadata
Upsert Matrix table rows — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inserted | JSON | Required within parent | |
inserted (anyOf 1) | integer | Alternative | Number of rows inserted |
inserted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated | JSON | Required within parent | |
updated (anyOf 1) | integer | Alternative | Number of rows updated |
updated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |