Skip to content

Ramp: Accounting schemas

81 Ramp schemas with complete fields and constraints.

← Accounting operations · All schemas

Bulk create field option filter rules — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf these filter rules belong to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
accounting_connection_id (anyOf 2)nullAlternative
rulesarrayRequired within parentA list of field option filter rules to create.
Maximum items: 1000
Minimum items: 1
rules[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
required_selectionsarrayRequired within parentThe 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[]ModelEach itemExpand Bulk create field option filter rules — request body — body rules item required selections item
target_field_option_remote_idstringRequired within parentThe remote ID of the target field option that is conditionally available.
Minimum length: 1
target_field_remote_idstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
trigger_field_option_remote_idstringRequired within parentThe remote ID of the required field option.
Minimum length: 1
trigger_field_remote_idstringRequired within parentThe remote ID of the required accounting field.
Minimum length: 1

Bulk create field option filter rules — response body

FieldTypePresenceDescription and constraints
$objectRoot
created_countJSONRequired within parent
created_count (anyOf 1)integerAlternativeThe number of filter rules that were newly created.
created_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
duplicate_countJSONRequired within parent
duplicate_count (anyOf 1)integerAlternativeThe number of filter rules that already existed (no change made).
duplicate_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Bulk delete field option filter rules — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf these filter rules belong to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
accounting_connection_id (anyOf 2)nullAlternative
rulesarrayRequired within parentA list of field option filter rules to delete, identified by their target and required selections.
Maximum items: 1000
Minimum items: 1
rules[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
deleted_countJSONRequired within parent
deleted_count (anyOf 1)integerAlternativeThe number of filter rules that were deleted.
deleted_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
not_found_countJSONRequired within parent
not_found_count (anyOf 1)integerAlternativeThe number of filter rules that were not found (already deleted or never existed).
not_found_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Ramp-only accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeThe name of the custom accounting field as shown on Ramp.
display_name (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of custom accounting field from ERP system.
input_typestringRequired within parentThe input type for the custom accounting field.
One of: BOOLEAN, FREE_FORM_TEXT, SINGLE_CHOICE
is_required_forarrayOptionalTypes of objects that require this accounting field to be used for coding before they can be marked as ready to sync.
is_required_for[]stringEach itemOne of: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT
is_splittablebooleanOptionalIf set to True, the accounting field can be used to annotate split line items. If not specified, the default value will be False.
namestringRequired within parentname of the custom accounting field.

Create a new inventory item accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeThe name of the inventory item tracking category as shown on Ramp.
display_name (anyOf 2)nullAlternative
namestringRequired within parentName of the inventory item tracking category.

Create a new tax code accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeThe name of the tax code field as shown on Ramp.
display_name (anyOf 2)nullAlternative
namestringRequired within parentName of the tax code field.

Delete a Ramp-only field option — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the direct ERP accounting connection this Ramp-only field option request should target.
Format: uuid

Delete a tax rate — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf this resource belongs to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
accounting_connection_id (anyOf 2)nullAlternative

Fetch a custom accounting field — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the custom accounting fields are uploaded to.
Format: uuid
created_atstringOptionalFormat: date-time
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeName of the custom accounting field on Ramp.
display_name (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of custom accounting field from ERP system.
input_typestringRequired within parentThe input type for the custom accounting field.
Known values: BOOLEAN, DATE, FREE_FORM_TEXT, SINGLE_CHOICE
is_activebooleanOptional
is_required_forarrayRequired within parentTypes 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[]stringEach itemKnown values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT
is_splittablebooleanOptional
namestringOptionalName of the custom accounting field in the remote ERP system.
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the custom accounting field is uploaded to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringOptionalid to uniquely identify a custom accounting field within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time

Fetch a general ledger account — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the GL account is uploaded to.
Format: uuid
classificationJSONOptional
classification (anyOf 1)stringAlternativeKnown values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
Read only: true
classification (anyOf 2)nullAlternative
codestringOptionale.g. 400-100.
created_atstringRequired within parentFormat: date-time
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
gl_account_category_infoModelOptionalExpand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Category info of the general ledger account.
idstringOptionalRemote/external ID of GL account in ERP system.
is_activebooleanRequired within parent
namestringRequired within parente.g. Travel : Travel - Lodging.
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the GL account is uploaded to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringRequired within parentid to uniquely identify a general ledger account within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time
visibilitystringOptionalVisibility 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the vendor is uploaded to.
Format: uuid
codestringOptionale.g. 19566
created_atstringRequired within parentDate time at which the vendor account was created on Ramp.
Format: date-time
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of accounting vendor in ERP system.
is_activebooleanRequired within parentWhether this vendor account is active on Ramp
is_syncedbooleanRequired within parentWhether this vendor has been synced to remote ERP.
namestringRequired within parentName of the vendor.
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the vendor is uploaded to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringRequired within parentid to uniquely identify a vendor account within Ramp system
Format: uuid
updated_atstringRequired within parentDate time at which the vendor account was most recently updated.
Format: date-time
vendor_category_infoModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalRemote/external ID of the accounting category from ERP system.
namestringOptionalName of the accounting category in the remote ERP system.
ramp_idstringOptionalid to uniquely identify the accounting category within Ramp system
Format: uuid

Fetch all accounting connections for the current business — response body

FieldTypePresenceDescription and constraints
$objectRoot
connectionsarrayRequired within parentA list of accounting connections for the current business.
connections[]ModelEach itemExpand Update an accounting connection — response body

Referenced models: Update an accounting connection — response body

Fetch inventory item accounting field — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the inventory item field is associated with.
Format: uuid
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the inventory item field on Ramp.
display_name (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of inventory item field from ERP system.
namestringRequired within parentName of the inventory item field in the remote ERP system.
ramp_idstringRequired within parentUnique identifier for the inventory item field within Ramp system.
Format: uuid

Fetch tax code accounting field — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the tax code field is associated with.
Format: uuid
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the tax code field on Ramp.
display_name (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of tax code field from ERP system.
namestringRequired within parentName of the tax code field in the remote ERP system.
ramp_idstringRequired within parentUnique identifier for the tax code field within Ramp system.
Format: uuid

Fetch the current active accounting connection — response body — message

FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptional

List custom accounting fields — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a custom accounting field — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List field option filter rules — 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 field option filter rules — response body — data item

List field option filter rules — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
required_selectionsarrayRequired within parentThe set of trigger field option selections required for the target option to be available.
Read only: true
required_selections[]objectEach item
target_field_option_remote_idstringRequired within parentThe remote ID of the target field option that is conditionally available.
Read only: true
target_field_remote_idstringRequired within parentThe remote ID of the target accounting field whose options are filtered.
Read only: true

List general ledger accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a general ledger account — response body
pageModelRequired within parentExpand 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

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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Update a Ramp-only field option — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Update a tax code option — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Update a tax rate — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a vendor — accounting get Accounting Vendor Resource — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
object_idsarrayRequired within parentIDs 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[]stringEach itemFormat: uuid
object_typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_coding_selectionsarrayRequired within parent
accounting_coding_selections[]ModelEach itemExpand Post accounting coding selections to an object — response body — accounting coding selections item
object_idstringRequired within parentThe ID of the Ramp object to code.
Format: uuid
object_typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_coding_selectionsarrayRequired within parent
accounting_coding_selections[]ModelEach itemExpand Post accounting coding selections to an object — response body — accounting coding selections item
object_idstringRequired within parentThe ID of the Ramp object to code.
Format: uuid
object_typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_idstringRequired within parentThe ID of the custom accounting field. This is the ramp_id returned from the custom field endpoints.
Format: uuid
accounting_field_option_idJSONOptional
accounting_field_option_id (anyOf 1)stringAlternativeThe 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)nullAlternative
free_form_textstringOptional

Post sync status — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
failed_syncsarrayOptionalA list of objects that failed to be synced.
Maximum items: 5000
Minimum items: 1
failed_syncs[]ModelEach itemExpand Post sync status — request body — body failed syncs item
idempotency_keystringRequired within parentAn 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_syncbooleanOptionalMark 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_syncsarrayOptionalA list of successfully synced objects.
Maximum items: 5000
Minimum items: 1
successful_syncs[]ModelEach itemExpand Post sync status — request body — body successful syncs item
sync_request_idJSONOptional
sync_request_id (anyOf 1)stringAlternativeFor 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)nullAlternative
sync_typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
errorModelRequired within parentExpand Post sync status — request body — body failed syncs item error
describes the reason why the sync object failed to sync.
idstringRequired within parentID 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

FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired within parentan error message that explains the reason of the sync failure.

Post sync status — request body — body successful syncs item

FieldTypePresenceDescription and constraints
$objectRoot
deep_link_urlstringOptionalURL 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
idstringRequired within parentID that uniquely identifies the object to sync in Ramp systems.
Format: uuid
reference_idstringRequired within parentID that uniquely identifies the object to sync in remote ERP systems.

Post sync status — response body

FieldTypePresenceDescription and constraints
$objectRoot
sync_idstringRequired within parentUnique identifier of the sync job.
Format: uuid

Register a new API based accounting connection — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
clear_chart_of_accountsbooleanOptionalWhether to clear the existing chart of accounts when upgrading a Universal CSV connection to an API based connection. Defaults to True.
Default: true
reactivatebooleanOptionalDeprecated, use POST accounting/connection/<connection_id>/reactivate.
Default: false
remote_provider_namestringRequired within parentThe name of the accounting connection.
settingsJSONOptional
settings (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

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

FieldTypePresenceDescription and constraints
$objectRoot
entity_selection_enabledbooleanOptionalWhether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections. Defaults to false.
Default: false
reimbursement_sync_button_enabledbooleanOptionalWhether 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_enabledbooleanOptionalWhether 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_enabledbooleanOptionalWhether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections. Defaults to false.
Default: false
vendor_credits_enabledbooleanOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the direct ERP accounting connection this Ramp-only field option request should target.
Format: uuid
codestringOptionalOnly 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_namestringOptionalAvailable to all: Update the display name of the custom field option.
reactivatebooleanOptionalOnly available if not using a direct ERP integration: reactivate a deleted custom field option
One of: true
valuestringOptionalOnly available if not using a direct ERP integration: Name of the custom accounting field option.
visibilitystringOptionalAvailable to all: Hide or Show option
One of: HIDDEN, VISIBLE

Update a Ramp-only field option — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the custom accounting field option belongs to.
Format: uuid
codestringOptionalCode of the custom field option; Usually it is a unique identifier for the custom field option in the remote ERP system.
created_atstringOptionalFormat: date-time
display_namestringOptionalDisplay name of the custom field option.
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of custom accounting field option from ERP system.
is_activebooleanOptional
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the custom accounting field option belongs to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringOptionalid to uniquely identify a custom field option within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time
valuestringOptionalA vendor is a person or business that provides goods or services
visibilitystringOptionalVisibility of the custom field option.
Known values: HIDDEN, VISIBLE

Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalOnly 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_namestringOptionalAvailable to all: Update the display name of the custom field option.
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
reactivatebooleanOptionalOnly available if not using a direct ERP integration: reactivate a deleted custom field option
One of: true
valuestringOptionalOnly available if not using a direct ERP integration: Name of the custom accounting field option.
visibilitystringOptionalAvailable to all: Hide or Show option
One of: HIDDEN, VISIBLE

Update a custom accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalIf this custom field belongs to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeUpdate the name of the custom accounting field on Ramp.
display_name (anyOf 2)nullAlternative
is_splittablebooleanOptionalUpdate the is_splittable of the custom accounting field on Ramp.
namestringOptionalName of the custom accounting field.

Update a general ledger account — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalIf this GL account belongs to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
codestringOptionalcode of the general ledger account; you could provide an empty string if you want to reset the code.
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
namestringOptionalname of the general ledger account
reactivatebooleanOptionalreactivate a deleted general ledger account
One of: true
visibilitystringOptionalHide or show the general ledger account.
One of: HIDDEN, VISIBLE

Update a tax code option — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf 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)nullAlternative
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
namestringOptionalThe name of the tax code option.
tax_rate_idsarrayOptionalA 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[]stringEach item

Update a tax code option — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the tax code option belongs to.
Format: uuid
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
idstringRequired within parentThe external ID of the tax code option. This is the ID in your ERP system.
is_activebooleanRequired within parentWhether the tax code option is active.
namestringRequired within parentThe name of the tax code option.
ramp_idstringRequired within parentUnique identifier for the tax code option within Ramp system.
Format: uuid
tax_rate_idsarrayRequired within parentA list of external tax rate IDs (remote_id values) associated with this tax code option.
Read only: true
tax_rate_ids[]stringEach item

Update a tax rate — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalIf this tax rate belongs to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
accounting_gl_account_idstringOptionalThe Ramp ID of the GL account to associate with this tax rate.
Format: uuid
namestringOptionalName of the tax rate.
rateJSONOptionalThe tax rate percentage expressed as a decimal (e.g. 0.10 for 10%).
rate (oneOf 1)stringAlternativeFormat: decimal
rate (oneOf 2)numberAlternative

Update a tax rate — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the tax rate belongs to.
Format: uuid
accounting_gl_account_idJSONRequired within parent
accounting_gl_account_id (anyOf 1)stringAlternativeThe Ramp ID of the GL account associated with this tax rate.
Format: uuid
accounting_gl_account_id (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of the tax rate from your ERP system.
namestringRequired within parentName of the tax rate.
ramp_idstringRequired within parentUnique identifier for the tax rate within Ramp system.
Format: uuid
ratestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalIf this vendor belongs to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
codestringOptionalCode of the vendor; you could provide an empty string to reset the code.
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
namestringOptionalName of a vendor
reactivatebooleanOptionalreactivate a deleted vendor
One of: true

Update an accounting connection — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
settingsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
entity_selection_enabledbooleanOptionalWhether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections.
reimbursement_sync_button_enabledbooleanOptionalWhether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections.
transaction_accounting_vendor_creation_on_sync_enabledbooleanOptionalWhether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections.
transaction_sync_button_enabledbooleanOptionalWhether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections.
vendor_credits_enabledbooleanOptionalWhether vendor credits are enabled for this accounting connection. Only applies to API-based connections.

Update an accounting connection — response body

FieldTypePresenceDescription and constraints
$objectRoot
connection_typestringRequired within parentThe type of the accounting connection.
Known values: API, CSV, DIRECT
Read only: true
created_atstringRequired within parentThe date and time the accounting connection was created.
Format: date-time
idstringRequired within parentFormat: uuid
is_activebooleanRequired within parentWhether the accounting connection is active.
Read only: true
is_ready_to_migratebooleanRequired within parentWhether 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_atJSONRequired within parent
last_linked_at (anyOf 1)stringAlternativeThe date and time the accounting connection was last connected.
Format: date-time
last_linked_at (anyOf 2)nullAlternative
remote_provider_nameJSONRequired within parent
remote_provider_name (anyOf 1)stringAlternativeThe name of the accounting connection.
Read only: true
remote_provider_name (anyOf 2)nullAlternative
settingsJSONRequired within parent
settings (anyOf 1)ModelAlternativeExpand 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)nullAlternative
statusstringRequired within parentThe current status of the accounting connection.
Known values: failed_to_auth, linked, revoked, unlinked

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

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

FieldTypePresenceDescription and constraints
$objectRoot
entity_selection_enabledbooleanRequired within parentWhether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections.
reimbursement_sync_button_enabledbooleanRequired within parentWhether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections.
transaction_accounting_vendor_creation_on_sync_enabledbooleanRequired within parentWhether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections.
transaction_sync_button_enabledbooleanRequired within parentWhether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections.
vendor_credits_enabledbooleanRequired within parentWhether vendor credits are enabled for this accounting connection. Only applies to API-based connections.

Update an inventory item option — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf 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)nullAlternative
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
gl_account_idstringOptionalThe 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
namestringOptionalThe name of the inventory item option.
reactivatebooleanOptionalReactivate 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the inventory item option belongs to.
Format: uuid
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
gl_account_idJSONRequired within parent
gl_account_id (anyOf 1)stringAlternativeThe 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)nullAlternative
idstringRequired within parentThe external ID of the inventory item option. This is the ID in your ERP system.
is_activebooleanRequired within parentWhether the inventory item option is active.
namestringRequired within parentThe name of the inventory item option.
ramp_idstringRequired within parentUnique identifier for the inventory item option within Ramp system.
Format: uuid

Update inventory item accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf 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)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeDisplay name of the inventory item field on Ramp.
display_name (anyOf 2)nullAlternative
namestringOptionalName of the inventory item field.

Update tax code accounting field — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf 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)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeDisplay name of the tax code field on Ramp.
display_name (anyOf 2)nullAlternative
namestringOptionalName of the tax code field.

Upload entities — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
entitiesarrayRequired within parentA list of subsidiaries/entities to create inside the business's Subsidiary tracking category.
Maximum items: 500
Minimum items: 1
entities[]ModelEach itemExpand Upload entities — request body — body entities item

Referenced models: Upload entities — request body — body entities item

Upload entities — request body — body entities item

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeOptional ISO 3166 alpha-2 country code (e.g., "US").
Default: null
country (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)stringAlternativeOptional ISO 4217 currency code (e.g., "USD").
Default: null
currency (anyOf 2)nullAlternative
federal_id_numberJSONOptional
federal_id_number (anyOf 1)stringAlternativeOptional tax identification number.
Default: null
federal_id_number (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of the subsidiary in the ERP.
namestringRequired within parentName of the subsidiary/entity.

Upload entities — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalID of the accounting connection that the subsidiaries/entities are uploaded to.
Format: uuid
entitiesarrayRequired within parentA list of subsidiaries/entities that were successfully uploaded.
entities[]ModelEach itemExpand Upload entities — response body — entities item

Referenced models: Upload entities — response body — entities item

Upload entities — response body — entities item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the subsidiary/entity is uploaded to.
Format: uuid
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166 alpha-2 country code, if provided on upload.
Read only: true
country (anyOf 2)nullAlternative
currencyJSONRequired within parent
currency (anyOf 1)stringAlternativeISO 4217 currency code, if provided on upload.
Read only: true
currency (anyOf 2)nullAlternative
federal_id_numberJSONRequired within parent
federal_id_number (anyOf 1)stringAlternativeTax identification number, if provided on upload.
Read only: true
federal_id_number (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of the subsidiary in the ERP.
is_activebooleanRequired within parentWhether the subsidiary/entity is active.
namestringRequired within parentName of the subsidiary/entity.
ramp_idstringRequired within parentid to uniquely identify a subsidiary/entity within Ramp system
Format: uuid

Upload general ledger accounts — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
gl_accountsarrayRequired within parentA list of general ledger accounts that you want to use to classify your Ramp transactions.
Maximum items: 500
Minimum items: 1
gl_accounts[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
classificationstringRequired within parentOne of: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
codestringOptionale.g. 400-100.
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
idstringRequired within parentRemote/external ID of GL account in ERP system.
namestringRequired within parente.g. Travel : Travel - Lodging.

Upload general ledger accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalID of the accounting connection that the general ledger accounts are uploaded to.
Format: uuid
gl_accountsarrayOptionalA list of general ledger accounts that are successfully uploaded.
gl_accounts[]ModelEach itemExpand Fetch a general ledger account — response body
uploadedarrayOptionalA list of uuids from the uploaded vendors, gl accounts or custom accounting field options.
uploaded[]stringEach itemFormat: uuid

Referenced models: Fetch a general ledger account — response body

Upload inventory item options — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
optionsarrayRequired within parentA list of inventory item options to upload.
Maximum items: 500
Minimum items: 1
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
gl_account_idJSONOptional
gl_account_id (anyOf 1)stringAlternativeThe 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)nullAlternative
idstringRequired within parentThe external ID of the inventory item option. This is the ID in your ERP system.
namestringRequired within parentThe name of the inventory item option.

Upload inventory item options — response body

FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayRequired within parentA list of inventory item options that were successfully uploaded.
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the direct ERP accounting connection this Ramp-only field option request should target.
Format: uuid
field_idstringRequired within parentThe 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
optionsarrayRequired within parentA list of field options for a given Ramp-only custom accounting field.
Maximum items: 500
Minimum items: 1
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalCode of the custom accounting field option; e.g. 400-100.
display_namestringOptionalSet an optional user-facing display name of the custom field option.
idstringRequired within parentRemote/external ID of custom accounting field option from ERP system.
valuestringRequired within parente.g. Employees:Salaries & Wages

Upload new options — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
field_idstringRequired within parentThe 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
optionsarrayRequired within parentA list of field options for a given custom accounting field.
Maximum items: 500
Minimum items: 1
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalCode of the custom accounting field option; e.g. 400-100.
display_namestringOptionalSet an optional user-facing display name of the custom field option.
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
idstringRequired within parentRemote/external ID of custom accounting field option from ERP system.
valuestringRequired within parente.g. Employees:Salaries & Wages

Upload new options — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the custom accounting field options are uploaded to.
Format: uuid
optionsarrayOptionalA list of custom accounting field options that are successfully uploaded.
options[]ModelEach itemExpand Update a Ramp-only field option — response body
uploadedarrayOptionalA list of uuids from the uploaded vendors, gl accounts or custom accounting field options.
uploaded[]stringEach itemFormat: uuid

Referenced models: Update a Ramp-only field option — response body

Upload tax code options — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
optionsarrayRequired within parentA list of tax code options to upload.
Maximum items: 500
Minimum items: 1
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
idstringRequired within parentThe external ID of the tax code option. This is the ID in your ERP system.
namestringRequired within parentThe name of the tax code option.
tax_rate_idsarrayOptionalA list of external tax rate IDs (remote_id values) to associate with this tax code option.
tax_rate_ids[]stringEach item

Upload tax code options — response body

FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayRequired within parentA list of tax code options that were successfully uploaded.
options[]ModelEach itemExpand Update a tax code option — response body

Referenced models: Update a tax code option — response body

Upload tax rates — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
tax_ratesarrayRequired within parentA list of tax rates to upload.
Maximum items: 500
Minimum items: 1
tax_rates[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_gl_account_idJSONOptional
accounting_gl_account_id (anyOf 1)stringAlternativeThe 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)nullAlternative
idstringRequired within parentRemote/external ID of the tax rate from your ERP system.
namestringRequired within parentName of the tax rate.
rateJSONRequired within parentThe tax rate percentage expressed as a decimal (e.g. 0.10 for 10%).
rate (oneOf 1)stringAlternativeFormat: decimal
rate (oneOf 2)numberAlternative

Upload tax rates — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalID of the accounting connection that the tax rates are uploaded to.
Format: uuid
tax_ratesarrayRequired within parentA list of tax rates that were successfully uploaded.
tax_rates[]ModelEach itemExpand Update a tax rate — response body

Referenced models: Update a tax rate — response body

Upload vendors — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
vendorsarrayRequired within parentA list of vendors that you want to use to classify your Ramp transactions.
Maximum items: 500
Minimum items: 1
vendors[]ModelEach itemExpand Upload vendors — request body — body vendors item

Referenced models: Upload vendors — request body — body vendors item

Upload vendors — request body — body vendors item

FieldTypePresenceDescription and constraints
$objectRoot
codeJSONOptional
code (anyOf 1)stringAlternativeCode of the vendor.
Default: null
code (anyOf 2)nullAlternative
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
idstringRequired within parentRemote/external ID of accounting vendor in ERP system.
namestringRequired within parentname of the vendor

Upload vendors — response body

FieldTypePresenceDescription and constraints
$objectRoot
uploadedarrayOptionalA list of uuids from the uploaded vendors, gl accounts or custom accounting field options.
uploaded[]stringEach itemFormat: uuid
vendorsarrayOptionalA list of vendors that are successfully uploaded.
vendors[]ModelEach itemExpand Fetch a vendor — accounting get Accounting Vendor Resource — response body

Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body

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.