Ramp: Accounting schemas
81 Ramp schemas with complete fields and constraints.
← Accounting operations · All schemas
Bulk create field option filter rules — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If these filter rules belong to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
rules | array | Required within parent | A list of field option filter rules to create. Maximum items: 1000 Minimum items: 1 |
rules[] | Model | Each item | Expand Bulk create field option filter rules — request body — body rules item |
Referenced models: Bulk create field option filter rules — request body — body rules item
Bulk create field option filter rules — request body — body rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
required_selections | array | Required within parent | The set of trigger field option selections that must all be met (AND logic) for the target option to be available. Multiple rules for the same target option use OR logic between them. Minimum items: 1 |
required_selections[] | Model | Each item | Expand Bulk create field option filter rules — request body — body rules item required selections item |
target_field_option_remote_id | string | Required within parent | The remote ID of the target field option that is conditionally available. Minimum length: 1 |
target_field_remote_id | string | Required within parent | The remote ID of the target accounting field whose options are filtered. Minimum length: 1 |
Referenced models: Bulk create field option filter rules — request body — body rules item required selections item
Bulk create field option filter rules — request body — body rules item required selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
trigger_field_option_remote_id | string | Required within parent | The remote ID of the required field option. Minimum length: 1 |
trigger_field_remote_id | string | Required within parent | The remote ID of the required accounting field. Minimum length: 1 |
Bulk create field option filter rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_count | JSON | Required within parent | |
created_count (anyOf 1) | integer | Alternative | The number of filter rules that were newly created. |
created_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
duplicate_count | JSON | Required within parent | |
duplicate_count (anyOf 1) | integer | Alternative | The number of filter rules that already existed (no change made). |
duplicate_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Bulk delete field option filter rules — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If these filter rules belong to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
rules | array | Required within parent | A list of field option filter rules to delete, identified by their target and required selections. Maximum items: 1000 Minimum items: 1 |
rules[] | Model | Each item | Expand Bulk create field option filter rules — request body — body rules item |
Referenced models: Bulk create field option filter rules — request body — body rules item
Bulk delete field option filter rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted_count | JSON | Required within parent | |
deleted_count (anyOf 1) | integer | Alternative | The number of filter rules that were deleted. |
deleted_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
not_found_count | JSON | Required within parent | |
not_found_count (anyOf 1) | integer | Alternative | The number of filter rules that were not found (already deleted or never existed). |
not_found_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a Ramp-only accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | The name of the custom accounting field as shown on Ramp. |
display_name (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of custom accounting field from ERP system. |
input_type | string | Required within parent | The input type for the custom accounting field. One of: BOOLEAN, FREE_FORM_TEXT, SINGLE_CHOICE |
is_required_for | array | Optional | Types of objects that require this accounting field to be used for coding before they can be marked as ready to sync. |
is_required_for[] | string | Each item | One of: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT |
is_splittable | boolean | Optional | If set to True, the accounting field can be used to annotate split line items. If not specified, the default value will be False. |
name | string | Required within parent | name of the custom accounting field. |
Create a new inventory item accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | The name of the inventory item tracking category as shown on Ramp. |
display_name (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the inventory item tracking category. |
Create a new tax code accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | The name of the tax code field as shown on Ramp. |
display_name (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the tax code field. |
Delete a Ramp-only field option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the direct ERP accounting connection this Ramp-only field option request should target. Format: uuid |
Delete a tax rate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If this resource belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative |
Fetch a custom accounting field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the custom accounting fields are uploaded to. Format: uuid |
created_at | string | Optional | Format: date-time |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Name of the custom accounting field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of custom accounting field from ERP system. |
input_type | string | Required within parent | The input type for the custom accounting field. Known values: BOOLEAN, DATE, FREE_FORM_TEXT, SINGLE_CHOICE |
is_active | boolean | Optional | |
is_required_for | array | Required within parent | Types of objects that require this accounting field to be used for coding before they can be marked as ready to sync. Read only: true |
is_required_for[] | string | Each item | Known values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT |
is_splittable | boolean | Optional | |
name | string | Optional | Name of the custom accounting field in the remote ERP system. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the custom accounting field is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Optional | id to uniquely identify a custom accounting field within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |
Fetch a general ledger account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the GL account is uploaded to. Format: uuid |
classification | JSON | Optional | |
classification (anyOf 1) | string | Alternative | Known values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN Read only: true |
classification (anyOf 2) | null | Alternative | |
code | string | Optional | e.g. 400-100. |
created_at | string | Required within parent | Format: date-time |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this GL account is available for. Null means the GL account is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
gl_account_category_info | Model | Optional | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info Category info of the general ledger account. |
id | string | Optional | Remote/external ID of GL account in ERP system. |
is_active | boolean | Required within parent | |
name | string | Required within parent | e.g. Travel : Travel - Lodging. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the GL account is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Required within parent | id to uniquely identify a general ledger account within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |
visibility | string | Optional | Visibility of the general ledger account. Known values: HIDDEN, VISIBLE |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Fetch a vendor — accounting get Accounting Vendor Resource — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the vendor is uploaded to. Format: uuid |
code | string | Optional | e.g. 19566 |
created_at | string | Required within parent | Date time at which the vendor account was created on Ramp. Format: date-time |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this vendor is available for. Null means the vendor is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of accounting vendor in ERP system. |
is_active | boolean | Required within parent | Whether this vendor account is active on Ramp |
is_synced | boolean | Required within parent | Whether this vendor has been synced to remote ERP. |
name | string | Required within parent | Name of the vendor. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the vendor is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Required within parent | id to uniquely identify a vendor account within Ramp system Format: uuid |
updated_at | string | Required within parent | Date time at which the vendor account was most recently updated. Format: date-time |
vendor_category_info | Model | Optional | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info Category info of the general ledger account. |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Remote/external ID of the accounting category from ERP system. |
name | string | Optional | Name of the accounting category in the remote ERP system. |
ramp_id | string | Optional | id to uniquely identify the accounting category within Ramp system Format: uuid |
Fetch all accounting connections for the current business — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connections | array | Required within parent | A list of accounting connections for the current business. |
connections[] | Model | Each item | Expand Update an accounting connection — response body |
Referenced models: Update an accounting connection — response body
Fetch inventory item accounting field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the inventory item field is associated with. Format: uuid |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the inventory item field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of inventory item field from ERP system. |
name | string | Required within parent | Name of the inventory item field in the remote ERP system. |
ramp_id | string | Required within parent | Unique identifier for the inventory item field within Ramp system. Format: uuid |
Fetch tax code accounting field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the tax code field is associated with. Format: uuid |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the tax code field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of tax code field from ERP system. |
name | string | Required within parent | Name of the tax code field in the remote ERP system. |
ramp_id | string | Required within parent | Unique identifier for the tax code field within Ramp system. Format: uuid |
Fetch the current active accounting connection — response body — message
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional |
List custom accounting fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a custom accounting field — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a custom accounting field — response body
List field option filter rules — 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 field option filter rules — 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 field option filter rules — response body — data item
List field option filter rules — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
required_selections | array | Required within parent | The set of trigger field option selections required for the target option to be available. Read only: true |
required_selections[] | object | Each item | |
target_field_option_remote_id | string | Required within parent | The remote ID of the target field option that is conditionally available. Read only: true |
target_field_remote_id | string | Required within parent | The remote ID of the target accounting field whose options are filtered. Read only: true |
List general ledger accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a general ledger account — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a general ledger account — response body
List inventory item options — 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 Update an inventory item option — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: Update an inventory item option — response body, List bills — response body — page
List options for a given custom accounting field — 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 Update a Ramp-only field option — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Update a Ramp-only field option — response body
List tax code options — 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 Update a tax code option — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: Update a tax code option — response body, List bills — response body — page
List tax rates — 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 Update a tax rate — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: Update a tax rate — response body, List bills — response body — page
List vendors — accounting get Accounting Vendor List Resource — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a vendor — accounting get Accounting Vendor Resource — response body
Mark objects as ready to sync to your accounting provider — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
object_ids | array | Required within parent | IDs of the objects to mark as ready to sync. All IDs must belong to the authenticated business; the request fails if any ID is not found. Maximum items: 500 Minimum items: 1 |
object_ids[] | string | Each item | Format: uuid |
object_type | string | Required within parent | The type of object to mark ready to sync. Supported values are TRANSACTION and REIMBURSEMENT. One of: REIMBURSEMENT, TRANSACTION |
Post accounting coding selections to an object — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_coding_selections | array | Required within parent | |
accounting_coding_selections[] | Model | Each item | Expand Post accounting coding selections to an object — response body — accounting coding selections item |
object_id | string | Required within parent | The ID of the Ramp object to code. Format: uuid |
object_type | string | Required within parent | The type of Ramp object to code. One of: TRANSACTION |
Referenced models: Post accounting coding selections to an object — response body — accounting coding selections item
Post accounting coding selections to an object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_coding_selections | array | Required within parent | |
accounting_coding_selections[] | Model | Each item | Expand Post accounting coding selections to an object — response body — accounting coding selections item |
object_id | string | Required within parent | The ID of the Ramp object to code. Format: uuid |
object_type | string | Required within parent | The type of Ramp object to code. Known values: TRANSACTION |
Referenced models: Post accounting coding selections to an object — response body — accounting coding selections item
Post accounting coding selections to an object — response body — accounting coding selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_id | string | Required within parent | The ID of the custom accounting field. This is the ramp_id returned from the custom field endpoints. Format: uuid |
accounting_field_option_id | JSON | Optional | |
accounting_field_option_id (anyOf 1) | string | Alternative | The accounting field option ID returned by the custom field options endpoints. When posting accounting codings, set this to null without free_form_text to clear the field. Existing accounting permissions and policy validation apply. Format: uuid |
accounting_field_option_id (anyOf 2) | null | Alternative | |
free_form_text | string | Optional |
Post sync status — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failed_syncs | array | Optional | A list of objects that failed to be synced. Maximum items: 5000 Minimum items: 1 |
failed_syncs[] | Model | Each item | Expand Post sync status — request body — body failed syncs item |
idempotency_key | string | Required within parent | An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs. |
mark_ready_to_sync | boolean | Optional | Mark successful transaction syncs ready before recording completion, clearing their accounting requirements. Only supported for TRANSACTION_SYNC without sync_request_id; failed_syncs are not marked ready. Defaults to false. |
successful_syncs | array | Optional | A list of successfully synced objects. Maximum items: 5000 Minimum items: 1 |
successful_syncs[] | Model | Each item | Expand Post sync status — request body — body successful syncs item |
sync_request_id | JSON | Optional | |
sync_request_id (anyOf 1) | string | Alternative | For Sync Button flows, provide the sync request ID received from the TRANSACTION_SYNC_REQUESTED, REIMBURSEMENT_SYNC_REQUESTED, or ACCRUAL_SYNC_REQUESTED outbound webhook. Do not provide this value for non-Sync Button flows. Default: null Format: uuid |
sync_request_id (anyOf 2) | null | Alternative | |
sync_type | string | Required within parent | The type of object to sync. One of: ACCRUAL_SYNC, BILL_PAYMENT_SYNC, BILL_SYNC, BROKERAGE_ORDER_SYNC, RECOGNITION_SCHEDULE_ENTRY_SYNC, REIMBURSEMENT_SYNC, REPAYMENT_SYNC, STATEMENT_CREDIT_SYNC, TRANSACTION_SYNC, TRANSFER_SYNC, WALLET_TRANSFER_SYNC |
Referenced models: Post sync status — request body — body failed syncs item, Post sync status — request body — body successful syncs item
Post sync status — request body — body failed syncs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Required within parent | Expand Post sync status — request body — body failed syncs item error describes the reason why the sync object failed to sync. |
id | string | Required within parent | ID that uniquely identifies the object to sync in Ramp systems. Format: uuid |
Referenced models: Post sync status — request body — body failed syncs item error
Post sync status — request body — body failed syncs item error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent | an error message that explains the reason of the sync failure. |
Post sync status — request body — body successful syncs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deep_link_url | string | Optional | URL that links to the object in the remote ERP system. Applicable for transactions, reimbursements, bills, and bill payments. Bill payment syncs update the bill's URL. Omitting this field preserves the existing URL. Format: url |
id | string | Required within parent | ID that uniquely identifies the object to sync in Ramp systems. Format: uuid |
reference_id | string | Required within parent | ID that uniquely identifies the object to sync in remote ERP systems. |
Post sync status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sync_id | string | Required within parent | Unique identifier of the sync job. Format: uuid |
Register a new API based accounting connection — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
clear_chart_of_accounts | boolean | Optional | Whether to clear the existing chart of accounts when upgrading a Universal CSV connection to an API based connection. Defaults to True. Default: true |
reactivate | boolean | Optional | Deprecated, use POST accounting/connection/<connection_id>/reactivate. Default: false |
remote_provider_name | string | Required within parent | The name of the accounting connection. |
settings | JSON | Optional | |
settings (anyOf 1) | Model | Alternative | Expand Register a new API based accounting connection — request body — body settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled Optional settings for the accounting connection. Only applies to API-based connections. Default: null |
settings (anyOf 2) | null | Alternative |
Register a new API based accounting connection — request body — body settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_selection_enabled | boolean | Optional | Whether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections. Defaults to false. Default: false |
reimbursement_sync_button_enabled | boolean | Optional | Whether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections. Defaults to false. Default: false |
transaction_accounting_vendor_creation_on_sync_enabled | boolean | Optional | Whether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections. Defaults to false. Default: false |
transaction_sync_button_enabled | boolean | Optional | Whether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections. Defaults to false. Default: false |
vendor_credits_enabled | boolean | Optional | Whether vendor credits are enabled for this accounting connection. Only applies to API-based connections. Defaults to false. Default: false |
Update a Ramp-only field option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the direct ERP accounting connection this Ramp-only field option request should target. Format: uuid |
code | string | Optional | Only available if not using a direct ERP integration: Code of the custom accounting field option; you could provide an empty string to reset the code. |
display_name | string | Optional | Available to all: Update the display name of the custom field option. |
reactivate | boolean | Optional | Only available if not using a direct ERP integration: reactivate a deleted custom field option One of: true |
value | string | Optional | Only available if not using a direct ERP integration: Name of the custom accounting field option. |
visibility | string | Optional | Available to all: Hide or Show option One of: HIDDEN, VISIBLE |
Update a Ramp-only field option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the custom accounting field option belongs to. Format: uuid |
code | string | Optional | Code of the custom field option; Usually it is a unique identifier for the custom field option in the remote ERP system. |
created_at | string | Optional | Format: date-time |
display_name | string | Optional | Display name of the custom field option. |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this custom field option is available for. Null means the custom field option is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of custom accounting field option from ERP system. |
is_active | boolean | Optional | |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the custom accounting field option belongs to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Optional | id to uniquely identify a custom field option within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |
value | string | Optional | A vendor is a person or business that provides goods or services |
visibility | string | Optional | Visibility of the custom field option. Known values: HIDDEN, VISIBLE |
Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Only available if not using a direct ERP integration: Code of the custom accounting field option; you could provide an empty string to reset the code. |
display_name | string | Optional | Available to all: Update the display name of the custom field option. |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this custom field option should be available for. Pass null to reset the custom field option to all connected entities. Omit this field to leave entity scoping unchanged. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
reactivate | boolean | Optional | Only available if not using a direct ERP integration: reactivate a deleted custom field option One of: true |
value | string | Optional | Only available if not using a direct ERP integration: Name of the custom accounting field option. |
visibility | string | Optional | Available to all: Hide or Show option One of: HIDDEN, VISIBLE |
Update a custom accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | If this custom field belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Update the name of the custom accounting field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
is_splittable | boolean | Optional | Update the is_splittable of the custom accounting field on Ramp. |
name | string | Optional | Name of the custom accounting field. |
Update a general ledger account — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | If this GL account belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
code | string | Optional | code of the general ledger account; you could provide an empty string if you want to reset the code. |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this GL account should be available for. Pass null to reset the GL account to all connected entities. Omit this field to leave entity scoping unchanged. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
name | string | Optional | name of the general ledger account |
reactivate | boolean | Optional | reactivate a deleted general ledger account One of: true |
visibility | string | Optional | Hide or show the general ledger account. One of: HIDDEN, VISIBLE |
Update a tax code option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If this tax code option belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this tax code option should be available for. Null means the option is available for all connected entities. If provided, this value replaces the existing entity remote IDs. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
name | string | Optional | The name of the tax code option. |
tax_rate_ids | array | Optional | A list of external tax rate IDs (remote_id values) to associate with this tax code option. If this value is provided, it will replace all existing tax rate IDs. |
tax_rate_ids[] | string | Each item |
Update a tax code option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the tax code option belongs to. Format: uuid |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this tax code option is available for. Null means the option is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
id | string | Required within parent | The external ID of the tax code option. This is the ID in your ERP system. |
is_active | boolean | Required within parent | Whether the tax code option is active. |
name | string | Required within parent | The name of the tax code option. |
ramp_id | string | Required within parent | Unique identifier for the tax code option within Ramp system. Format: uuid |
tax_rate_ids | array | Required within parent | A list of external tax rate IDs (remote_id values) associated with this tax code option. Read only: true |
tax_rate_ids[] | string | Each item |
Update a tax rate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | If this tax rate belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_gl_account_id | string | Optional | The Ramp ID of the GL account to associate with this tax rate. Format: uuid |
name | string | Optional | Name of the tax rate. |
rate | JSON | Optional | The tax rate percentage expressed as a decimal (e.g. 0.10 for 10%). |
rate (oneOf 1) | string | Alternative | Format: decimal |
rate (oneOf 2) | number | Alternative |
Update a tax rate — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the tax rate belongs to. Format: uuid |
accounting_gl_account_id | JSON | Required within parent | |
accounting_gl_account_id (anyOf 1) | string | Alternative | The Ramp ID of the GL account associated with this tax rate. Format: uuid |
accounting_gl_account_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of the tax rate from your ERP system. |
name | string | Required within parent | Name of the tax rate. |
ramp_id | string | Required within parent | Unique identifier for the tax rate within Ramp system. Format: uuid |
rate | string | Required within parent | The tax rate percentage expressed as a decimal (e.g. 0.10 for 10%). Format: decimal |
Update a vendor — accounting patch Accounting Vendor Resource — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | If this vendor belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
code | string | Optional | Code of the vendor; you could provide an empty string to reset the code. |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this vendor should be available for. Pass null to reset the vendor to all connected entities. Omit this field to leave entity scoping unchanged. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
name | string | Optional | Name of a vendor |
reactivate | boolean | Optional | reactivate a deleted vendor One of: true |
Update an accounting connection — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
settings | Model | Optional | Expand Update an accounting connection — request body — body settings Settings for the accounting connection. Only applies to API-based connections. |
Referenced models: Update an accounting connection — request body — body settings
Update an accounting connection — request body — body settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_selection_enabled | boolean | Optional | Whether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections. |
reimbursement_sync_button_enabled | boolean | Optional | Whether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections. |
transaction_accounting_vendor_creation_on_sync_enabled | boolean | Optional | Whether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections. |
transaction_sync_button_enabled | boolean | Optional | Whether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections. |
vendor_credits_enabled | boolean | Optional | Whether vendor credits are enabled for this accounting connection. Only applies to API-based connections. |
Update an accounting connection — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connection_type | string | Required within parent | The type of the accounting connection. Known values: API, CSV, DIRECT Read only: true |
created_at | string | Required within parent | The date and time the accounting connection was created. Format: date-time |
id | string | Required within parent | Format: uuid |
is_active | boolean | Required within parent | Whether the accounting connection is active. Read only: true |
is_ready_to_migrate | boolean | Required within parent | Whether an Accounting Connection is marked as ready to migrate. For use by the ERP migration flow. Only one Accounting Connection will be marked as ready to migrate per business at a given time. Once a customer begins an ERP migration, a ready to migrate Accounting Connection will no longer be considered ready to migrate. Read only: true |
last_linked_at | JSON | Required within parent | |
last_linked_at (anyOf 1) | string | Alternative | The date and time the accounting connection was last connected. Format: date-time |
last_linked_at (anyOf 2) | null | Alternative | |
remote_provider_name | JSON | Required within parent | |
remote_provider_name (anyOf 1) | string | Alternative | The name of the accounting connection. Read only: true |
remote_provider_name (anyOf 2) | null | Alternative | |
settings | JSON | Required within parent | |
settings (anyOf 1) | Model | Alternative | Expand Update an accounting connection — response body — settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled The connection settings for this accounting connection. Only applies to API-based accounting connections. This field will be empty for non-API based accounting connections. Read only: true |
settings (anyOf 2) | null | Alternative | |
status | string | Required within parent | The current status of the accounting connection. Known values: failed_to_auth, linked, revoked, unlinked |
Update an accounting connection — response body — settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_selection_enabled | boolean | Required within parent | Whether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections. |
reimbursement_sync_button_enabled | boolean | Required within parent | Whether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections. |
transaction_accounting_vendor_creation_on_sync_enabled | boolean | Required within parent | Whether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections. |
transaction_sync_button_enabled | boolean | Required within parent | Whether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections. |
vendor_credits_enabled | boolean | Required within parent | Whether vendor credits are enabled for this accounting connection. Only applies to API-based connections. |
Update an inventory item option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If this inventory item option belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this inventory item option should be available for. Pass null to reset the inventory item option to all connected entities. Omit this field to leave entity scoping unchanged. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
gl_account_id | string | Optional | The Ramp ID (ramp_id) of the GL account to associate with this inventory item option. The GL account must already exist in Ramp. Use POST /developer/v1/accounting/accounts to upload GL accounts. Format: uuid |
name | string | Optional | The name of the inventory item option. |
reactivate | boolean | Optional | Reactivate a deleted inventory item option. If provided, this must be true; false is not allowed. One of: true |
Update an inventory item option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the inventory item option belongs to. Format: uuid |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this inventory item option is available for. Null means the inventory item option is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
gl_account_id | JSON | Required within parent | |
gl_account_id (anyOf 1) | string | Alternative | The Ramp ID of the GL account associated with this inventory item option, or null if no GL account is linked. Format: uuid Read only: true |
gl_account_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | The external ID of the inventory item option. This is the ID in your ERP system. |
is_active | boolean | Required within parent | Whether the inventory item option is active. |
name | string | Required within parent | The name of the inventory item option. |
ramp_id | string | Required within parent | Unique identifier for the inventory item option within Ramp system. Format: uuid |
Update inventory item accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If the inventory item field belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Display name of the inventory item field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the inventory item field. |
Update tax code accounting field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If the tax code field belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Display name of the tax code field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the tax code field. |
Upload entities — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
entities | array | Required within parent | A list of subsidiaries/entities to create inside the business's Subsidiary tracking category. Maximum items: 500 Minimum items: 1 |
entities[] | Model | Each item | Expand Upload entities — request body — body entities item |
Referenced models: Upload entities — request body — body entities item
Upload entities — request body — body entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Optional ISO 3166 alpha-2 country code (e.g., "US"). Default: null |
country (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Optional ISO 4217 currency code (e.g., "USD"). Default: null |
currency (anyOf 2) | null | Alternative | |
federal_id_number | JSON | Optional | |
federal_id_number (anyOf 1) | string | Alternative | Optional tax identification number. Default: null |
federal_id_number (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of the subsidiary in the ERP. |
name | string | Required within parent | Name of the subsidiary/entity. |
Upload entities — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | ID of the accounting connection that the subsidiaries/entities are uploaded to. Format: uuid |
entities | array | Required within parent | A list of subsidiaries/entities that were successfully uploaded. |
entities[] | Model | Each item | Expand Upload entities — response body — entities item |
Referenced models: Upload entities — response body — entities item
Upload entities — response body — entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the subsidiary/entity is uploaded to. Format: uuid |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | ISO 3166 alpha-2 country code, if provided on upload. Read only: true |
country (anyOf 2) | null | Alternative | |
currency | JSON | Required within parent | |
currency (anyOf 1) | string | Alternative | ISO 4217 currency code, if provided on upload. Read only: true |
currency (anyOf 2) | null | Alternative | |
federal_id_number | JSON | Required within parent | |
federal_id_number (anyOf 1) | string | Alternative | Tax identification number, if provided on upload. Read only: true |
federal_id_number (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of the subsidiary in the ERP. |
is_active | boolean | Required within parent | Whether the subsidiary/entity is active. |
name | string | Required within parent | Name of the subsidiary/entity. |
ramp_id | string | Required within parent | id to uniquely identify a subsidiary/entity within Ramp system Format: uuid |
Upload general ledger accounts — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
gl_accounts | array | Required within parent | A list of general ledger accounts that you want to use to classify your Ramp transactions. Maximum items: 500 Minimum items: 1 |
gl_accounts[] | Model | Each item | Expand Upload general ledger accounts — request body — body gl accounts item |
Referenced models: Upload general ledger accounts — request body — body gl accounts item
Upload general ledger accounts — request body — body gl accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
classification | string | Required within parent | One of: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN |
code | string | Optional | e.g. 400-100. |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this GL account should be available for. Omit this field to make the GL account available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | Remote/external ID of GL account in ERP system. |
name | string | Required within parent | e.g. Travel : Travel - Lodging. |
Upload general ledger accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | ID of the accounting connection that the general ledger accounts are uploaded to. Format: uuid |
gl_accounts | array | Optional | A list of general ledger accounts that are successfully uploaded. |
gl_accounts[] | Model | Each item | Expand Fetch a general ledger account — response body |
uploaded | array | Optional | A list of uuids from the uploaded vendors, gl accounts or custom accounting field options. |
uploaded[] | string | Each item | Format: uuid |
Referenced models: Fetch a general ledger account — response body
Upload inventory item options — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
options | array | Required within parent | A list of inventory item options to upload. Maximum items: 500 Minimum items: 1 |
options[] | Model | Each item | Expand Upload inventory item options — request body — body options item |
Referenced models: Upload inventory item options — request body — body options item
Upload inventory item options — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this inventory item option should be available for. Omit this field to make the inventory item option available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
gl_account_id | JSON | Optional | |
gl_account_id (anyOf 1) | string | Alternative | The Ramp ID (ramp_id) of the GL account to associate with this inventory item option. The GL account must already exist in Ramp. Use POST /developer/v1/accounting/accounts to upload GL accounts. Format: uuid |
gl_account_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | The external ID of the inventory item option. This is the ID in your ERP system. |
name | string | Required within parent | The name of the inventory item option. |
Upload inventory item options — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Required within parent | A list of inventory item options that were successfully uploaded. |
options[] | Model | Each item | Expand Update an inventory item option — response body |
Referenced models: Update an inventory item option — response body
Upload new options for a Ramp-only field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the direct ERP accounting connection this Ramp-only field option request should target. Format: uuid |
field_id | string | Required within parent | The ID of the custom accounting field that this custom accounting field option belongs to. This is the ramp_id returned from custom field endpoints. Format: uuid |
options | array | Required within parent | A list of field options for a given Ramp-only custom accounting field. Maximum items: 500 Minimum items: 1 |
options[] | Model | Each item | Expand Upload new options for a Ramp-only field — request body — body options item |
Referenced models: Upload new options for a Ramp-only field — request body — body options item
Upload new options for a Ramp-only field — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Code of the custom accounting field option; e.g. 400-100. |
display_name | string | Optional | Set an optional user-facing display name of the custom field option. |
id | string | Required within parent | Remote/external ID of custom accounting field option from ERP system. |
value | string | Required within parent | e.g. Employees:Salaries & Wages |
Upload new options — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
field_id | string | Required within parent | The ID of the custom accounting field that this custom accounting field option belongs to. This is the ramp_id returned from custom field endpoints. Format: uuid |
options | array | Required within parent | A list of field options for a given custom accounting field. Maximum items: 500 Minimum items: 1 |
options[] | Model | Each item | Expand Upload new options — request body — body options item |
Referenced models: Upload new options — request body — body options item
Upload new options — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Code of the custom accounting field option; e.g. 400-100. |
display_name | string | Optional | Set an optional user-facing display name of the custom field option. |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this custom field option should be available for. Omit this field to make the custom field option available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | Remote/external ID of custom accounting field option from ERP system. |
value | string | Required within parent | e.g. Employees:Salaries & Wages |
Upload new options — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the custom accounting field options are uploaded to. Format: uuid |
options | array | Optional | A list of custom accounting field options that are successfully uploaded. |
options[] | Model | Each item | Expand Update a Ramp-only field option — response body |
uploaded | array | Optional | A list of uuids from the uploaded vendors, gl accounts or custom accounting field options. |
uploaded[] | string | Each item | Format: uuid |
Referenced models: Update a Ramp-only field option — response body
Upload tax code options — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
options | array | Required within parent | A list of tax code options to upload. Maximum items: 500 Minimum items: 1 |
options[] | Model | Each item | Expand Upload tax code options — request body — body options item |
Referenced models: Upload tax code options — request body — body options item
Upload tax code options — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this tax code option should be available for. Omit this field to make the option available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | The external ID of the tax code option. This is the ID in your ERP system. |
name | string | Required within parent | The name of the tax code option. |
tax_rate_ids | array | Optional | A list of external tax rate IDs (remote_id values) to associate with this tax code option. |
tax_rate_ids[] | string | Each item |
Upload tax code options — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Required within parent | A list of tax code options that were successfully uploaded. |
options[] | Model | Each item | Expand Update a tax code option — response body |
Referenced models: Update a tax code option — response body
Upload tax rates — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
tax_rates | array | Required within parent | A list of tax rates to upload. Maximum items: 500 Minimum items: 1 |
tax_rates[] | Model | Each item | Expand Upload tax rates — request body — body tax rates item |
Referenced models: Upload tax rates — request body — body tax rates item
Upload tax rates — request body — body tax rates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_gl_account_id | JSON | Optional | |
accounting_gl_account_id (anyOf 1) | string | Alternative | The Ramp ID (ramp_id) of the GL account associated with this tax rate. This is required if the accounting connection is API-based. Format: uuid |
accounting_gl_account_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of the tax rate from your ERP system. |
name | string | Required within parent | Name of the tax rate. |
rate | JSON | Required within parent | The tax rate percentage expressed as a decimal (e.g. 0.10 for 10%). |
rate (oneOf 1) | string | Alternative | Format: decimal |
rate (oneOf 2) | number | Alternative |
Upload tax rates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | ID of the accounting connection that the tax rates are uploaded to. Format: uuid |
tax_rates | array | Required within parent | A list of tax rates that were successfully uploaded. |
tax_rates[] | Model | Each item | Expand Update a tax rate — response body |
Referenced models: Update a tax rate — response body
Upload vendors — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
vendors | array | Required within parent | A list of vendors that you want to use to classify your Ramp transactions. Maximum items: 500 Minimum items: 1 |
vendors[] | Model | Each item | Expand Upload vendors — request body — body vendors item |
Referenced models: Upload vendors — request body — body vendors item
Upload vendors — request body — body vendors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | Code of the vendor. Default: null |
code (anyOf 2) | null | Alternative | |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this vendor should be available for. Omit this field to make the vendor available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | Remote/external ID of accounting vendor in ERP system. |
name | string | Required within parent | name of the vendor |
Upload vendors — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
uploaded | array | Optional | A list of uuids from the uploaded vendors, gl accounts or custom accounting field options. |
uploaded[] | string | Each item | Format: uuid |
vendors | array | Optional | A list of vendors that are successfully uploaded. |
vendors[] | Model | Each item | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body