Ramp
rampRamp is a platform that helps you manage your finances, track your income and expenses, and get insights into your business
Acciones disponibles (22)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create DepartmentRAMP_CREATE_DEPARTMENTAcciónTool for creating a new department in your ramp organization. perfect for setting up organizational structure and expense categorization.
RAMP_CREATE_DEPARTMENTAcciónTool for creating a new department in your ramp organization. perfect for setting up organizational structure and expense categorization.
Parámetros de entrada
namestringObligatorioName of the department
parent_department_idstringParent department ID for hierarchy
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create New Custom Accounting FieldRAMP_CREATE_NEW_CUSTOM_ACCOUNTING_FIELDAcciónTool for creating a new custom accounting field. note: this operation requires elevated permissions not available in the demo api.
RAMP_CREATE_NEW_CUSTOM_ACCOUNTING_FIELDAcciónTool for creating a new custom accounting field. note: this operation requires elevated permissions not available in the demo api.
Parámetros de entrada
idstringObligatorioRemote/external ID of custom accounting field from ERP system.
namestringObligatorioName of the custom accounting field.
input_typestringObligatorioenumThe input type could be SINGLE_CHOICE, BOOLEAN or FREE_FORM_TEXT.
SINGLE_CHOICEBOOLEANFREE_FORM_TEXTis_splittablebooleanIf set to True, the accounting field can be used to annotate split line items.
is_required_forstring[]Types of objects that require this accounting field to be used for coding before they can be marked as ready to sync.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch Custom Accounting FieldRAMP_FETCH_CUSTOM_ACCOUNTING_FIELDAcciónTool for fetching a custom accounting field.
RAMP_FETCH_CUSTOM_ACCOUNTING_FIELDAcciónTool for fetching a custom accounting field.
Parámetros de entrada
field_idstringObligatorioUUID of the custom accounting field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All TransactionsRAMP_GET_ALL_TRANSACTIONSAcciónGet all the transactions.
RAMP_GET_ALL_TRANSACTIONSAcciónGet all the transactions.
Parámetros de entrada
startstringID of the last entity of the previous page for pagination
statestringFilter by transaction state. If set to 'ALL', all transactions including 'DECLINED' will be listed
card_idstringFilter by physical card UUID
to_datestringFilter for transactions with user_transaction_time before the given date (ISO 8601 datetime, default: today)
trip_idstringFilter for trip UUID
user_idstringFilter by user UUID
limit_idstringFilter by limit UUID
entity_idstringFilter transactions by business entity UUID
from_datestringFilter for transactions with user_transaction_time after the given date (ISO 8601 datetime)
page_sizeintegerNumber of results per page (2-100, default: 20)
max_amountstringFilter for transactions with amount smaller than given amount (USD)
min_amountstringFilter for transactions with amount larger than given amount (USD)
sync_readybooleanFilter for transactions that are coded with accounting fields and ready to sync to ERP systems
location_idstringFilter by location UUID
merchant_idstringFilter by merchant UUID
sync_statusstringFilter for transactions by sync status. Supersedes sync_ready and has_no_sync_commits if set
statement_idstringFilter by statement UUID
synced_afterstringFilter for transactions synced after the given date (ISO 8601 datetime)
department_idstringFilter by department UUID
requires_memobooleanFilters for transactions which require a memo but do not have one (can only be set to true)
sk_category_idstringFilter by Ramp category code (integer)
approval_statusstringFilter by transaction approval status
spend_program_idstringFilter by spend program UUID
order_by_date_ascbooleanSort transactions by user_transaction_date in ascending order
order_by_date_descbooleanSort transactions by user_transaction_date in descending order
has_no_sync_commitsbooleanFilter for transactions that have not been synced to ERP systems yet
order_by_amount_ascbooleanSort transactions by amount in ascending order
order_by_amount_descbooleanSort transactions by amount in descending order
include_merchant_databooleanInclude all purchase data provided by the merchant
awaiting_approval_by_user_idstringFilter for transactions awaiting approval by a specific user UUID
accounting_field_selection_idstringFilter transactions by accounting field selection UUID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CardRAMP_GET_CARDAcciónTool for retrieving detailed information about a specific card. returns comprehensive card details including spending limits, cardholder info, and fulfillment status. use this to get complete card profile for analysis or troubleshooting.
RAMP_GET_CARDAcciónTool for retrieving detailed information about a specific card. returns comprehensive card details including spending limits, cardholder info, and fulfillment status. use this to get complete card profile for analysis or troubleshooting.
Parámetros de entrada
card_idstringObligatorioThe ID of the card to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DepartmentRAMP_GET_DEPARTMENTAcciónTool for retrieving detailed information about a specific department. returns comprehensive department details including hierarchy information. use this to get complete department profile for organizational analysis.
RAMP_GET_DEPARTMENTAcciónTool for retrieving detailed information about a specific department. returns comprehensive department details including hierarchy information. use this to get complete department profile for organizational analysis.
Parámetros de entrada
department_idstringObligatorioThe ID of the department to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get My CardsRAMP_GET_MY_CARDSAcciónTool for fetching cards assigned to you, including physical and virtual cards. useful for checking card status, limits, and managing your payment methods.
RAMP_GET_MY_CARDSAcciónTool for fetching cards assigned to you, including physical and virtual cards. useful for checking card status, limits, and managing your payment methods.
Parámetros de entrada
statestringFilter by card state: ACTIVE, SUSPENDED, TERMINATED
card_typestringFilter by card type: PHYSICAL, VIRTUAL
page_sizeintegerMaximum number of cards to return (default: 50, max: 100)
page_tokenstringToken for pagination - use 'page.cursor' from previous response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get My TransactionsRAMP_GET_MY_TRANSACTIONSAcciónGet my transactions.
RAMP_GET_MY_TRANSACTIONSAcciónGet my transactions.
Parámetros de entrada
startstringID of the last entity of the previous page for pagination
statestringFilter by transaction state. If set to 'ALL', all transactions including 'DECLINED' will be listed
card_idstringFilter by physical card UUID
to_datestringFilter for transactions with user_transaction_time before the given date (ISO 8601 datetime)
trip_idstringFilter for trip UUID
user_idstringFilter by user UUID
limit_idstringFilter by limit UUID
entity_idstringFilter transactions by business entity UUID
from_datestringFilter for transactions with user_transaction_time after the given date (ISO 8601 datetime)
page_sizeintegerNumber of results per page (2-100, default: 20)
max_amountstringFilter for transactions with amount smaller than given amount (USD)
min_amountstringFilter for transactions with amount larger than given amount (USD)
sync_readybooleanFilter for transactions that are coded with accounting fields and ready to sync to ERP systems
location_idstringFilter by location UUID
merchant_idstringFilter by merchant UUID
sync_statusstringFilter for transactions by sync status. Supersedes sync_ready and has_no_sync_commits if set
statement_idstringFilter by statement UUID
synced_afterstringFilter for transactions synced after the given date (ISO 8601 datetime)
department_idstringFilter by department UUID
requires_memobooleanFilters for transactions which require a memo but do not have one (can only be set to true)
sk_category_idstringFilter by Ramp category code (integer)
approval_statusstringFilter by transaction approval status
spend_program_idstringFilter by spend program UUID
order_by_date_ascbooleanSort transactions by user_transaction_date in ascending order
order_by_date_descbooleanSort transactions by user_transaction_date in descending order
has_no_sync_commitsbooleanFilter for transactions that have not been synced to ERP systems yet
order_by_amount_ascbooleanSort transactions by amount in ascending order
order_by_amount_descbooleanSort transactions by amount in descending order
include_merchant_databooleanInclude all purchase data provided by the merchant
awaiting_approval_by_user_idstringFilter for transactions awaiting approval by a specific user UUID
accounting_field_selection_idstringFilter transactions by accounting field selection UUID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get StatementRAMP_GET_STATEMENTAcciónTool for retrieving statement details or downloading statements. supports json, pdf, and csv formats for financial reporting.
RAMP_GET_STATEMENTAcciónTool for retrieving statement details or downloading statements. supports json, pdf, and csv formats for financial reporting.
Parámetros de entrada
formatstringFormat of the statement: json, pdf, csv
statement_idstringObligatorioID of the statement to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Transaction DetailsRAMP_GET_TRANSACTIONAcciónTool for retrieving complete details of a specific transaction. includes merchant details, receipts, accounting codes, and dispute information.
RAMP_GET_TRANSACTIONAcciónTool for retrieving complete details of a specific transaction. includes merchant details, receipts, accounting codes, and dispute information.
Parámetros de entrada
transaction_idstringObligatorioID of the transaction to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Vendor DetailsRAMP_GET_VENDORAcciónTool for retrieving detailed information about a specific vendor. returns comprehensive vendor details including spending totals, category, and contact information. use this to get complete vendor profile for analysis or updates.
RAMP_GET_VENDORAcciónTool for retrieving detailed information about a specific vendor. returns comprehensive vendor details including spending totals, category, and contact information. use this to get complete vendor profile for analysis or updates.
Parámetros de entrada
vendor_idstringObligatorioThe ID of the vendor to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Issue Virtual CardRAMP_ISSUE_VIRTUAL_CARDAcciónTool for issuing virtual cards to users instantly. creates cards with customizable spending limits and restrictions. returns full card details including card number and cvv.
RAMP_ISSUE_VIRTUAL_CARDAcciónTool for issuing virtual cards to users instantly. creates cards with customizable spending limits and restrictions. returns full card details including card number and cvv.
Parámetros de entrada
memostringMemo for the card creation
user_idstringObligatorioUser ID to issue the card to
display_namestringDisplay name for the card
card_program_idstringCard program ID to use for the card
spending_restrictionsobjectSpending restrictions for the card
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All CardsRAMP_LIST_CARDSAcciónTool for listing all cards across the organization with optional filters. returns card details including spending limits, cardholder info, and state. use this to analyze card distribution, monitor card states, or find specific cards.
RAMP_LIST_CARDSAcciónTool for listing all cards across the organization with optional filters. returns card details including spending limits, cardholder info, and state. use this to analyze card distribution, monitor card states, or find specific cards.
Parámetros de entrada
startstringID of the last entity of the previous page for pagination
user_idstringFilter by card owner UUID
entity_idstringFilter by business entity UUID
page_sizeintegerNumber of results per page (2-100, default: 20)
display_namestringFilter by display name
is_activatedbooleanFilter only for activated cards. Defaults to True if not specified
is_terminatedbooleanFilter only for terminated cards. Defaults to False if not specified
card_program_idstringFilter by card program UUID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DepartmentsRAMP_LIST_DEPARTMENTSAcciónTool for listing all departments in the organization. returns department details including names, codes, and hierarchy information. use this to analyze organizational structure and department relationships.
RAMP_LIST_DEPARTMENTSAcciónTool for listing all departments in the organization. returns department details including names, codes, and hierarchy information. use this to analyze organizational structure and department relationships.
Parámetros de entrada
startstringID of the last entity of the previous page for pagination
page_sizeintegerNumber of results per page (2-100, default: 20)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List StatementsRAMP_LIST_STATEMENTSAcciónTool for listing all statements with filtering options. perfect for financial reporting and reconciliation workflows.
RAMP_LIST_STATEMENTSAcciónTool for listing all statements with filtering options. perfect for financial reporting and reconciliation workflows.
Parámetros de entrada
startstringID of the last entity of the previous page for pagination
to_datestringFilter statements with end_date on or before this date (ISO 8601 datetime). Defaults to current time
from_datestringFilter statements with end_date on or after this date (ISO 8601 datetime)
page_sizeintegerNumber of results per page (2-100, default: 20)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List UsersRAMP_LIST_USERSAcciónTool for listing users in your ramp organization with flexible filtering. perfect for user audits, access management, and organizational analysis. helps identify inactive users, role distribution, and departmental structures.
RAMP_LIST_USERSAcciónTool for listing users in your ramp organization with flexible filtering. perfect for user audits, access management, and organizational analysis. helps identify inactive users, role distribution, and departmental structures.
Parámetros de entrada
rolestringFilter by user role
emailstringFilter by email address
startstringID of the last entity of the previous page for pagination
entity_idstringFilter by business entity UUID
page_sizeintegerNumber of results per page (2-100, default: 20)
employee_idstringFilter by user employee_id
location_idstringFilter by location UUID
department_idstringFilter by department UUID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List VendorsRAMP_LIST_VENDORSAcciónTool for listing vendors with their spending information. returns vendor details including spending totals, categories, and activity status. use this to analyze vendor relationships and procurement patterns.
RAMP_LIST_VENDORSAcciónTool for listing vendors with their spending information. returns vendor details including spending totals, categories, and activity status. use this to analyze vendor relationships and procurement patterns.
Parámetros de entrada
namestringFilter vendors by name
startstringID of the last entity of the previous page for pagination
is_activebooleanFilter by vendor active status
page_sizeintegerNumber of results per page (2-100, default: 20)
from_created_atstringShow only vendors with created_at after this date (ISO 8601 datetime)
sk_category_idsstringShow only vendors whose sk_category_id matches a Ramp Category Code in the passed list. Expects a comma-separated list of integers
vendor_owner_idstringUnique identifier of the user which owns this vendor (UUID)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Options for Custom Accounting FieldRAMP_OPTIONS_FOR_CUSTOM_ACCOUNTING_FIELDAcciónTool for listing options for a given accounting field.
RAMP_OPTIONS_FOR_CUSTOM_ACCOUNTING_FIELDAcciónTool for listing options for a given accounting field.
Parámetros de entrada
field_idstringObligatorioUUID of the custom accounting field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search TransactionsRAMP_SEARCH_TRANSACTIONSAcciónSearch transactions with filters.
RAMP_SEARCH_TRANSACTIONSAcciónSearch transactions with filters.
Parámetros de entrada
querystringObligatorioSearch query for merchant name, memo, or other transaction details
startstringID of the last entity of the previous page for pagination
statestringFilter by transaction state. If set to 'ALL', all transactions including 'DECLINED' will be listed
card_idstringFilter by physical card UUID
to_datestringFilter for transactions with user_transaction_time before the given date (ISO 8601 datetime)
trip_idstringFilter for trip UUID
user_idstringFilter by user UUID
limit_idstringFilter by limit UUID
entity_idstringFilter transactions by business entity UUID
from_datestringFilter for transactions with user_transaction_time after the given date (ISO 8601 datetime)
page_sizeintegerNumber of results per page (2-100, default: 20)
max_amountstringFilter for transactions with amount smaller than given amount (USD)
min_amountstringFilter for transactions with amount larger than given amount (USD)
sync_readybooleanFilter for transactions that are coded with accounting fields and ready to sync to ERP systems
location_idstringFilter by location UUID
merchant_idstringFilter by merchant UUID
sync_statusstringFilter for transactions by sync status. Supersedes sync_ready and has_no_sync_commits if set
statement_idstringFilter by statement UUID
synced_afterstringFilter for transactions synced after the given date (ISO 8601 datetime)
department_idstringFilter by department UUID
requires_memobooleanFilters for transactions which require a memo but do not have one (can only be set to true)
sk_category_idstringFilter by Ramp category code (integer)
approval_statusstringFilter by transaction approval status
spend_program_idstringFilter by spend program UUID
order_by_date_ascbooleanSort transactions by user_transaction_date in ascending order
order_by_date_descbooleanSort transactions by user_transaction_date in descending order
has_no_sync_commitsbooleanFilter for transactions that have not been synced to ERP systems yet
order_by_amount_ascbooleanSort transactions by amount in ascending order
order_by_amount_descbooleanSort transactions by amount in descending order
include_merchant_databooleanInclude all purchase data provided by the merchant
awaiting_approval_by_user_idstringFilter for transactions awaiting approval by a specific user UUID
accounting_field_selection_idstringFilter transactions by accounting field selection UUID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Card Spending LimitRAMP_UPDATE_CARD_LIMITAcciónTool for updating spending limits on a card. note: this returns the limits associated with the card. the actual update might require using the limit id directly via patch /limits/{limit id}.
RAMP_UPDATE_CARD_LIMITAcciónTool for updating spending limits on a card. note: this returns the limits associated with the card. the actual update might require using the limit id directly via patch /limits/{limit id}.
Parámetros de entrada
amountintegerObligatorioNew spending limit amount in cents
card_idstringObligatorioThe ID of the card to update limits for
intervalstringObligatorioSpending limit interval: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY, or TOTAL
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update DepartmentRAMP_UPDATE_DEPARTMENTAcciónTool for updating an existing department in your ramp organization. useful for reorganizing departmental structure or renaming departments.
RAMP_UPDATE_DEPARTMENTAcciónTool for updating an existing department in your ramp organization. useful for reorganizing departmental structure or renaming departments.
Parámetros de entrada
codestringNew department code/identifier
namestringNew name for the department
department_idstringObligatorioID of the department to update
parent_department_idstringNew parent department ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload New Options for Custom Accounting FieldRAMP_UPLOAD_NEW_OPTIONSAcciónTool for uploading new options for a given accounting field.
RAMP_UPLOAD_NEW_OPTIONSAcciónTool for uploading new options for a given accounting field.
Parámetros de entrada
optionsobject[]ObligatorioA list of field options for a given custom accounting field.
field_idstringObligatorioUUID of the custom accounting field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not