Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootSchema for defining a Matrix result column (Developer API).
cardinalitystringRequired within parentCardinality 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
labelstringRequired within parentDisplay name for the result column
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the column
Default: null
name (anyOf 2)nullAlternative
native_tableModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API result columns.

Only allows: users, approver_groups, and accounting_field_options.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for result columns: users, approver_groups, or accounting_field_options only.
One of: accounting_field_options, approver_groups, users
typestringOptionalDefault: native_table
One of: native_table

Add a result column to an existing Matrix table — response body

FieldTypePresenceDescription and constraints
$objectRootResponse for adding a result column to a Matrix table.
column_idstringRequired within parentID of the created result column

Append cells to Matrix table rows — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest for appending cells to Matrix rows.
dataarrayRequired within parentRows with cells to append (many-to-many result columns only)
data[]ModelEach itemExpand Upsert Matrix table rows — request body — body data item
ignore_duplicatesbooleanOptionalIf 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

FieldTypePresenceDescription and constraints
$objectRootResponse for appending cells to Matrix rows.
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cells_appendedJSONRequired within parent
cells_appended (anyOf 1)integerAlternativeNumber of cells appended
cells_appended (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Append cells to a Custom Table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe 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[]ModelEach itemExpand Append cells to a Custom Table — request body — body data item cells item
external_keystringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
contentsJSONRequired within parent
contents (anyOf 1)JSONAlternative
contents (anyOf 1) (oneOf 1)ModelAlternativeExpand Append cells to a Native Ramp table — request body — body data item row
contents (anyOf 1) (oneOf 2)stringAlternativeFormat: date-time
contents (anyOf 1) (oneOf 3)booleanAlternative
contents (anyOf 1) (oneOf 4)numberAlternative
contents (anyOf 1) (oneOf 5)stringAlternative
contents (anyOf 2)nullAlternative
namestringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
insertedJSONRequired within parent
inserted (anyOf 1)integerAlternative
inserted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Append cells to a Native Ramp table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe 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[]ModelEach itemExpand Append cells to a Custom Table — request body — body data item cells item
rowModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
column_namestringRequired within parent
valuestringRequired within parent

Change the API name of a Matrix table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
new_namestringRequired within parent

Change the external key of a Custom Table row — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
new_external_keystringRequired within parentThe new external key to set for the row

Create Custom Table column — request body — body

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"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)ModelAlternativeExpand Create Custom Table column — request body — body / column_type_name: boolean, number, text
$ (oneOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
column_type_namestringRequired within parentThe type of the primitive column.
One of: boolean, number, text
labelstringRequired within parentThe display name of the column
namestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
column_type_namestringRequired within parentThe type of the reference column.
One of: custom_reference, native_reference
labelstringRequired within parentThe display name of the column
namestringRequired within parentThe API name of the column, to be used when writing to this column
reference_argsModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cardinalitystringRequired within parentThe cardinality of the reference.
One of: many_to_many, many_to_one
corresponding_column_labelJSONOptional
corresponding_column_label (anyOf 1)stringAlternativeThe 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)nullAlternative
corresponding_column_nameJSONOptional
corresponding_column_name (anyOf 1)stringAlternativeThe 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)nullAlternative
foreign_tableJSONRequired within parentThe table that this column references.
foreign_table (oneOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
table_namestringRequired within parentThe name of the custom table
typestringOptionalDefault: custom_table
One of: custom_table

Create Custom Table column — response body

FieldTypePresenceDescription and constraints
$objectRoot
column_idstringRequired within parentThe id of the created column

Create Custom Table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
table_labelstringRequired within parentThe custom table's label as displayed in Ramp
table_namestringRequired within parentThe custom table's API name
typestringOptionalDefault: custom_table
One of: custom_table

Create a Matrix table — request body — body

FieldTypePresenceDescription and constraints
$objectRootSchema for creating a Matrix table (Developer API).
input_columnsarrayRequired within parentInput columns that define the Matrix dimensions (references or number)
input_columns[]ModelEach itemExpand Create a Matrix table — request body — body input columns item
labelstringRequired within parentDisplay name for the Matrix table
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the table
Default: null
name (anyOf 2)nullAlternative
result_columnsarrayRequired within parentResult columns that store Matrix outputs
result_columns[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API input columns.

Allows: users, locations, departments, business_entities, accounting_field_options, vendors,
and merchant_categories.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe 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
typestringOptionalDefault: native_table
One of: native_table

Create a Matrix table — request body — body / input_columns / item / column_type / type: number

FieldTypePresenceDescription and constraints
$objectRootNumber column type for Developer API input columns.
typestringOptionalColumn type discriminator
Default: number
One of: number

Create a Matrix table — request body — body input columns item

FieldTypePresenceDescription and constraints
$objectRootSchema for defining a Matrix input column (Developer API).
column_typeJSONRequired within parentDefines the type of input field used by the matrix
column_type (oneOf 1)ModelAlternativeExpand Create a Matrix table — request body — body / input_columns / item / column_type / type: native table
column_type (oneOf 2)ModelAlternativeExpand Create a Matrix table — request body — body / input_columns / item / column_type / type: number
labelstringRequired within parentDisplay name for the input column
nameJSONOptional
name (anyOf 1)stringAlternativeAPI name for the column
Default: null
name (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootResponse for creating a Matrix table.
table_idstringRequired within parentID of the created Matrix table

Delete rows from a Custom Table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of the external keys of rows to delete.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
external_keystringRequired within parent

Delete rows from a Custom Table — response body

FieldTypePresenceDescription and constraints
$objectRoot
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
deletedJSONRequired within parent
deleted (anyOf 1)integerAlternative
deleted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Extend Native Ramp table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
table_namestringRequired within parentThe 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
typestringOptionalDefault: native_table
One of: native_table

List Custom Table columns — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Custom Table columns — response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cardinalitystringRequired within parentThe cardinality of the referencing column
Known values: many_to_many, many_to_one, one_to_many, one_to_one
corresponding_column_idJSONRequired within parent
corresponding_column_id (anyOf 1)stringAlternativeThe 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)nullAlternative
table_display_namestringRequired within parentThe display name of the referenced table
table_idstringRequired within parentThe unique identifier for the referenced table
table_namestringRequired within parentThe API name of the custom table that is referenced
typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
cardinalitystringRequired within parentThe cardinality of the referencing column
Known values: many_to_many, many_to_one, one_to_many, one_to_one
corresponding_column_idJSONRequired within parent
corresponding_column_id (anyOf 1)stringAlternativeThe 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)nullAlternative
table_idstringRequired within parentThe unique identifier for the referenced table
table_namestringRequired within parentThe 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_categoryJSONRequired within parent
tracking_category (anyOf 1)ModelAlternativeExpand 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)nullAlternative
typestringRequired within parentKnown values: native_reference
Default: native_reference

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_provider_is_connectedbooleanRequired within parentWhether the tracking category's accounting provider is currently connected
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeThe display name of the tracking category
Default: null
display_name (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)integerAlternativeThe tracking category integer ID
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_activebooleanRequired within parentWhether the tracking category is active
uuidstringRequired within parentThe tracking category UUID (ramp_id)

List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number

FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: currency, number, percentage
typestringRequired within parentKnown values: number
Default: number

List Custom Table columns — response body — data / item / type / display_type: date, type: datetime

FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: date
typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: email, numeric_id, paragraph, phone, plain_text, url
typestringRequired within parentKnown values: text
Default: text

List Custom Table columns — response body — data / item / type / type: boolean

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentKnown values: boolean
Default: boolean

List Custom Table columns — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
allows_writesbooleanRequired within parentWhether the column can be directly written to. Columns not directly written to have values derived from columns that reference them.
display_namestringRequired within parentThe display name of the column
idstringRequired within parentThe unique identifier for the column
namestringRequired within parentThe name of the column, to be used when writing to this column
typeJSONRequired within parentThe type of the column
type (anyOf 1)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / type: boolean
type (anyOf 2)ModelAlternativeExpand 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
type (anyOf 3)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: date, type: datetime
type (anyOf 4)ModelAlternativeExpand 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
type (anyOf 5)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number
type (anyOf 6)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text

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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Custom Table rows — response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe contents of each column for this row.
cells[]ModelEach itemExpand Get a business entity — response body — custom record fields item
display_namestringRequired within parentA display name for the custom row.
external_keystringRequired within parentThe external key of the custom row. Will be unique within the table.
idstringRequired within parentThe id of the custom row

Referenced models: Get a business entity — response body — custom record fields item

List Custom Tables — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Custom Tables — response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
table_labelstringRequired within parentThe custom table's label as displayed in Ramp
table_namestringRequired within parentThe custom table's API name
typestringRequired within parentKnown values: custom_table
Default: custom_table

List Matrix table rows — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest for listing Matrix rows.
external_keysJSONOptional
external_keys (anyOf 1)arrayAlternativeFilter by specific external keys
Default: null
external_keys (anyOf 1)[]stringEach item
external_keys (anyOf 2)nullAlternative
filtersJSONOptional
filters (anyOf 1)arrayAlternativeFilter rows by input column values. Only rows matching ALL filters are returned.
Default: null
filters (anyOf 1)[]ModelEach itemExpand List Matrix table rows — request body — body filters array item
filters (anyOf 2)nullAlternative
page_sizeintegerOptionalNumber of rows per page
Default: 100
startJSONOptional
start (anyOf 1)stringAlternativePagination cursor (row ID from page.next)
Default: null
start (anyOf 2)nullAlternative

Referenced models: List Matrix table rows — request body — body filters array item

List Matrix table rows — request body — body filters array item

FieldTypePresenceDescription and constraints
$objectRootFilter for a specific Matrix input column.
column_namestringRequired within parentAPI name of the input column to filter on
one_ofarrayRequired within parentList of ramp object UUIDs to filter by (matches any)
one_of[]stringEach item

List Matrix table rows — response body

FieldTypePresenceDescription and constraints
$objectRootResponse for listing Matrix rows.
dataarrayRequired within parentList of Matrix rows
data[]ModelEach itemExpand List Matrix table rows — response body — data item
pageModelRequired within parentExpand List Matrix table rows — response body — page
Pagination information
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of rows matching filters
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootA Matrix row for reading (GET/list operations).
idstringRequired within parentUnique Identifier for this row of the Matrix
inputsarrayRequired within parentInput cells (ALL input columns included, even if None)
inputs[]ModelEach itemExpand List Matrix table rows — response body — data item inputs item
resultsarrayRequired within parentResult cells (only cells that exist)
results[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootA Matrix input cell with column name, identifier, and display_name (for responses).
column_namestringRequired within parentAPI name of the input column
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the referenced object or number value (None for missing input)
display_name (anyOf 2)nullAlternative
identifierJSONOptional
identifier (anyOf 1)JSONAlternativeIdentifier for the referenced object or number value (includes type discriminator)
Default: null
identifier (anyOf 1) (anyOf 1)ModelAlternativeExpand List Matrix table rows — response body — data item results item identifier column name, value
identifier (anyOf 1) (anyOf 2)ModelAlternativeExpand List Matrix table rows — response body — data item inputs item identifier value value
identifier (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootIdentifier for a number value in Matrix input columns.
valueJSONRequired within parent
value (anyOf 1)numberAlternativeNumeric value (e.g., amount threshold)
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Matrix table rows — response body — data item results item

FieldTypePresenceDescription and constraints
$objectRootA Matrix result cell with column name, identifier, and display_name (for responses).
column_namestringRequired within parentAPI name of the result column
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the referenced object (None to clear)
display_name (anyOf 2)nullAlternative
identifierJSONRequired within parent
identifier (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootIdentifier for a native Ramp object (e.g., user, department).
column_namestringRequired within parentColumn name to identify by (e.g., 'id', 'email')
valuestringRequired within parentValue for identification

List Matrix table rows — response body — page

FieldTypePresenceDescription and constraints
$objectRoot
nextJSONRequired within parent
next (anyOf 1)stringAlternativeCursor for next page (row ID to pass as start parameter)
next (anyOf 2)nullAlternative

List Native Ramp tables — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Native Ramp tables — response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
table_namestringRequired within parentThe 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
typestringRequired within parentKnown values: native_table
Default: native_table

List all Matrix tables for the business — response body

FieldTypePresenceDescription and constraints
$objectRootResponse for listing Matrix tables.
dataarrayRequired within parentList of Matrix tables
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootType info for native reference Matrix input columns (Developer API).
column_typestringOptionalColumn type discriminator
Known values: native_reference
Default: native_reference
native_tableModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API input columns.

Allows: users, locations, departments, business_entities, accounting_field_options, vendors,
and merchant_categories.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe 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
typestringOptionalKnown values: native_table
Default: native_table

List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number

FieldTypePresenceDescription and constraints
$objectRootType info for number Matrix input columns (Developer API).
column_typestringOptionalColumn type discriminator
Known values: number
Default: number

List all Matrix tables for the business — response body — data item

FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix table for Developer API (uses UUIDs).
idstringRequired within parentTable ID
input_columnsarrayRequired within parentInput columns
input_columns[]ModelEach itemExpand List all Matrix tables for the business — response body — data item input columns item
labelstringRequired within parentDisplay name
namestringRequired within parentAPI name
result_columnsarrayRequired within parentResult columns
result_columns[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix input column for Developer API (uses UUIDs).
display_namestringRequired within parentDisplay name
idstringRequired within parentColumn ID
namestringRequired within parentAPI name
typeJSONRequired within parentColumn type details (native_reference or number)
type (anyOf 1)ModelAlternativeExpand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference
type (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix result column for Developer API (uses UUIDs).
display_namestringRequired within parentDisplay name
idstringRequired within parentColumn ID
namestringRequired within parentAPI name
typeModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootType info for native reference Matrix result columns (Developer API).
cardinalitystringRequired within parentCardinality 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_typestringOptionalColumn type discriminator
Known values: native_reference
Default: native_reference
native_tableModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API result columns.

Only allows: users, approver_groups, and accounting_field_options.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for result columns: users, approver_groups, or accounting_field_options only.
Known values: accounting_field_options, approver_groups, users
typestringOptionalKnown values: native_table
Default: native_table

Remove cells from Matrix table rows — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest for removing cells from Matrix rows.
dataarrayRequired within parentRows with cells to remove (many-to-many result columns only)
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootResponse for removing cells from Matrix rows.
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cells_removedJSONRequired within parent
cells_removed (anyOf 1)integerAlternativeNumber of cells removed
cells_removed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Remove cells from a Native Ramp table — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of rows containing cells to remove.
data[]ModelEach itemExpand Append cells to a Native Ramp table — request body — body data item
skip_removing_already_missingbooleanOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
insertedJSONRequired within parent
inserted (anyOf 1)integerAlternativeThe number of rows inserted.
inserted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedJSONRequired within parent
updated (anyOf 1)integerAlternativeThe number of rows updated.
updated (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Upsert Matrix table rows — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest for upserting Matrix rows.
dataarrayRequired within parentRows to upsert
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootInput for writing a single Matrix row.
inputsarrayRequired within parentInput column values (must include ALL input columns)
inputs[]ModelEach itemExpand Upsert Matrix table rows — request body — body data item inputs item
resultsarrayRequired within parentResult column values (can be partial subset)
results[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootA Matrix input cell with column name and identifier.
column_namestringRequired within parentAPI name of the input column
identifierJSONOptional
identifier (anyOf 1)ModelAlternativeExpand 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)nullAlternative
number_identifierJSONOptional
number_identifier (anyOf 1)JSONAlternativeNumber value identifier (use for number columns)
Default: null
number_identifier (anyOf 1) (oneOf 1)numberAlternative
number_identifier (anyOf 1) (oneOf 2)stringAlternative
number_identifier (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootA Matrix result cell with column name and identifier (for input requests).
column_namestringRequired within parentAPI name of the result column
identifierJSONRequired within parent
identifier (anyOf 1)ModelAlternativeExpand 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)nullAlternative

Referenced models: List Matrix table rows — response body — data item results item identifier column name, value

Upsert Matrix table rows — response body

FieldTypePresenceDescription and constraints
$objectRootResponse for upserting Matrix rows.
metadataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
insertedJSONRequired within parent
inserted (anyOf 1)integerAlternativeNumber of rows inserted
inserted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedJSONRequired within parent
updated (anyOf 1)integerAlternativeNumber of rows updated
updated (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.