Skip to main content
Ramp logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 111
  • Triggers: 0
  • Slug: RAMP
  • Version: 20261101_00

Tools

Slug: RAMP_ADD_PURCHASE_ORDER_LINE_ITEMSAdd line items to an existing Ramp Plus purchase order.

Input Parameters

array
required
Line items to add; existing purchase order line items are not modified.
string
required
Purchase order ID that will receive the new line items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_ADD_RECEIPT_INTEGRATION_OPT_OUT_EMAILAdd an email to a business’s receipt integrations opt-out list. Requires an email address; business_id is optional for the connected business. Returns the created opt-out object’s email and UUID when present. The provider may return a null UUID; list opt-outs to discover it before removal. Requires receipt_integrations:write.

Input Parameters

string
required
Email address to add to the receipt integrations opt-out list.
integer
Optional integer business ID. Omit to use the connected business.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_ARCHIVE_BILLArchive a bill, cancelling inflight payments or terminating its one-time card where possible. Paid and batch-payment bills cannot be archived.

Input Parameters

string
required
UUID of the bill to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_ARCHIVE_PURCHASE_ORDERArchive a Ramp Plus purchase order. This destructive operation is irreversible.

Input Parameters

string
Optional reason for archiving. Pass null explicitly to record no reason.
string
required
Purchase order ID to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_ARCHIVE_VENDOR_BANK_ACCOUNTArchive a vendor bank account by vendor ID and bank account ID. If the account has associated bills, drafts, or recurring templates, provide replacement_bank_account_id to transfer them to a replacement account. Returns a local success acknowledgement for HTTP 204; does not initiate a payment.

Input Parameters

string
required
Unique identifier (UUID) of the vendor that owns the account.
string
required
Unique identifier (UUID) of the vendor bank account to archive.
string
Replacement bank account ID (UUID). Required when the archived account has associated bills, drafts, or recurring templates; those associations are transferred to this account. May be omitted or null otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_ACCOUNTING_FIELD_OPTION_FILTER_RULESCreate accounting field option filter rules in bulk. Requires Ramp Plus. Rules restrict target options based on trigger field selections: AND within each rule, OR between rules for the same target option. Existing rules count as duplicates without changes. Returns created and duplicate counts.

Input Parameters

array
required
Field option filter rules to create (1–1000).
string
Accounting connection UUID. Required for rules on an inactive connection; otherwise omit or send null to use the active connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_BILLCreate a Ramp bill. Ramp does not support creating batch payments through this API.

Input Parameters

string
Internal bill memo.
string
required
Due date of the bill.
string
required
UUID of the business entity associated with the bill.
string
required
Date the invoice was issued.
string
Client-side bill ID; requires an accounting connection and enable_accounting_sync=true.
string
required
UUID of the bill vendor.
array
Expense line items on the bill.
string
Memo shown to the vendor.
string
For non-card bills, requested payment initiation date; Ramp moves unavailable dates to the next valid date.
string
Date the bill is posted to the accounting system.
string
UUID of a previously uploaded file to attach.
string
required
Invoice number on the bill.
string ("ACH" | "CARD" | "CHECK" | "CRYPTO_WALLET_TRANSFER" | "DOMESTIC_WIRE" | "INTERNATIONAL" | "LOCAL_BANK_TRANSFER" | "ONE_TIME_CARD" | "ONE_TIME_CARD_DELIVERY" | "PAID_MANUALLY" | "SWIFT")
Payment method; required unless use_default_payment_method is true.
string
Payment-method-specific bank account, check, card, or manual payment details.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDSUI" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
required
ISO 4217 currency code of the invoice.
string
Vendor contact UUID; required unless use_default_vendor_contact is true.
array
Purchase order UUIDs to match to the bill.
array
Inventory line items on the bill.
boolean
Whether to sync the bill to the ERP; this must be true when remote_id is provided.
boolean
Use the vendor’s default payment method; when true, omit payment_method and payment_details.
boolean
Use the vendor’s default contact; when true, omit vendor_contact_id.
array
Accounting field options used to code the bill.
string
Target vendor arrival date when using the vendor’s default payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_CARD_EMBED_TOKENCreate an embed initialization token for an activated, currently active card. Use the returned token to initialize Ramp Embedded and exchange it for a session token. Requires Embedded Cards access; this does not activate or issue a card.

Input Parameters

string
required
Identifier of an activated, currently active card.
string
required
HTTP or HTTPS origin URL with hostname for the parent embedding the card (for example https://app.ramp.com/). Localhost origins are restricted in production.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_CARD_VAULTCreate a spend limit and virtual card synchronously, returning sensitive card details. Requires Vault API access (production requires Ramp approval). Uses the separate vault host. PAN and CVV must only be used transiently, never logged or persisted. To terminate this fund-backed card, DELETE /developer/v1/funds/{spend_limit_id} with funds:write; this irreversibly terminates the fund and its attached cards.

Input Parameters

string
required
UUID of the card owner.
string
Cosmetic display name of the limit.
string
Optional client-generated X-Idempotency-Key header. Reuse for retries of the same creation.
array
Accounting rules for the limit and card.
string
Associated spend program UUID. Its restrictions override spending_restrictions when supplied.
object
Spending restrictions; ignored when spend_program_id is supplied.
string
Fund-level overage override from 0 to 100; 10 means 10%. Omitted or null inherits the spend program or business default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_DEPARTMENTTool for creating a new department in your Ramp organization. Perfect for setting up organizational structure and expense categorization.

Input Parameters

string
required
Name of the department

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_DRAFT_BILLBeta: create a Ramp draft bill for a vendor without submitting it.

Input Parameters

string
Internal bill memo. Use the update action’s clear_fields parameter to clear it later.
string
Bill due date in YYYY-MM-DD format.
string
UUID of the associated business entity.
string
Invoice issue date in YYYY-MM-DD format.
string
Client-side bill identifier. Use the update action’s clear_fields parameter to clear it later.
string
required
UUID of the bill vendor.
array
Bill line items. When supplied, replaces all existing line items; use the update action’s clear_fields parameter to clear them later.
string
Memo shown to the vendor. Use the update action’s clear_fields parameter to clear it later.
string
Accounting-system posting date in YYYY-MM-DD format. Use the update action’s clear_fields parameter to clear it later.
string
Invoice number on the bill.
string ("ACH" | "CARD" | "CHECK" | "CRYPTO_WALLET_TRANSFER" | "DOMESTIC_WIRE" | "INTERNATIONAL" | "LOCAL_BANK_TRANSFER" | "ONE_TIME_CARD" | "ONE_TIME_CARD_DELIVERY" | "PAID_MANUALLY" | "SWIFT")
Payment method for the bill.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDSUI" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
ISO 4217 currency code for the invoice.
string
UUID of a contact belonging to the selected vendor.
array
Purchase order UUIDs to match. Ramp accepts these IDs but does not expose the draft-bill relationship in its read API; successful submission cannot independently confirm that the linkage persisted.
array
Inventory line items. When supplied, replaces all existing inventory line items; use the update action’s clear_fields parameter to clear them later.
boolean
Set false to prevent the bill from syncing to the ERP.
boolean
Use the vendor’s default payment method. Do not also provide payment_method when true.
array
Accounting field options used to code the draft bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_DRAFT_SPEND_REQUEST_VIA_OCRCreate a draft spend request by extracting information from an uploaded document. Requires Ramp Plus and a requester and spend program. Returns the draft ID; this operation does not submit the draft for approval. Reuse the idempotency key when retrying the same request.

Input Parameters

object
required
Document to use to create the draft spend request.
string
required
Client-generated unique value identifying retries of the same request. A random UUID is recommended.
string
required
Procurement spend intent (spend program) to associate with the spend request; SpendLimit programs are not supported.
string
required
User to associate with the spend request.
string
Purchase order number, as an integer in string format.
string
Prefix of the purchase order number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_INVENTORY_ITEM_ACCOUNTING_FIELDTool to create a new inventory item accounting field for tracking inventory categories. Use when setting up inventory tracking for an accounting connection. Note: There can only be one active inventory item accounting field per accounting connection.

Input Parameters

string
required
Name of the inventory item tracking category in the remote ERP system
string
The name of the inventory item tracking category as shown on Ramp. If not provided, defaults to the name field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_ITEM_RECEIPTCreate an item receipt for purchase order lines. Requires Ramp Plus. Records goods or services as received; expense lines may be received in full regardless of unit_quantity (see that field). Returns the created receipt and typed line items. This endpoint does not accept files or document uploads.

Input Parameters

string
Receipt memo, or null.
string
required
Date the vendor delivers the goods or services (YYYY-MM-DD).
string
required
UUID of the purchase order to attach this receipt to.
string
required
User-defined item receipt number.
array
required
Purchase order line items to receive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_LOCATIONCreate a named location in the Ramp organization, optionally under a business entity. Returns the location ID, name, and associated entity ID. This creates an organizational location, not a shipping address or payment recipient.

Input Parameters

string
required
Name of the location.
string
UUID of the business entity this location belongs to. Omit if not needed; explicit null is not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_MEMOTool for uploading a new memo for a transaction in Ramp. Use when you need to add notes or context to existing transactions.

Input Parameters

string
required
Text content of the memo to create. Maximum length is 255 characters.
string
required
Unique identifier for the transaction to attach the memo to
boolean
Whether this memo should automatically apply to similar future transactions. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_MILEAGE_REIMBURSEMENTTool to create a mileage reimbursement in Ramp. Use when a user needs to submit a reimbursement for business-related travel distance. Requires distance, reimbursee_id, and trip_date as mandatory fields.

Input Parameters

string
required
Memo or note describing the purpose of the mileage reimbursement. This field is required.
string
required
Distance traveled for the reimbursement. Can be specified as a number or string.
string
required
Date of the trip in ISO 8601 date format (YYYY-MM-DD).
array
List of intermediate stops during the trip.
string
Ending location of the trip.
string
required
Unique identifier (UUID) of the user to be reimbursed.
string ("KILOMETERS" | "MILES")
Distance units for mileage reimbursement.
string
Starting location of the trip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_MOCK_WEBHOOK_EVENTCreate a mock webhook event for active subscriptions matching its event type. Use to exercise webhook delivery with a supplied object UUID and metadata. This sends to every matching active subscription; it does not target a single subscription or create a business object.

Input Parameters

string
required
UUID of the object associated with the event.
string ("applications.status_updated" | "bills.approved" | "bills.archived" | "bills.created" | "bills.paid" | "bills.ready_to_sync" | "bills.rejected" | "bills.updated" | "draft_bills.created" | "entities.created" | "item_receipts.created" | "payments.updated" | "purchase_orders.archived" | "purchase_orders.created" | "purchase_orders.updated" | "reimbursements.batch_payment_reimbursed" | "reimbursements.ready_for_review" | "reimbursements.ready_to_sync" | "reimbursements.sync_requested" | "spend_requests.comment_created" | "spend_requests.created" | "tests.test_event" | "transactions.all_requirements_met_and_approved_changed" | "transactions.authorized" | "transactions.body_coding_updated" | "transactions.cleared" | "transactions.declined" | "transactions.ready_for_review" | "transactions.ready_to_sync" | "transactions.receipt_added" | "transactions.sync_requested" | "transactions.synced" | "unified_requests.created" | "unified_requests.external_approval_request" | "unified_requests.external_approval_request_reset" | "unified_requests.modified" | "unified_requests.node_advanced" | "unified_requests.override_approved" | "unified_requests.updated" | "users.invite_accepted" | "vendor_agreements.archived" | "vendor_agreements.created" | "vendor_agreements.deleted" | "vendor_agreements.document_added" | "vendor_agreements.renewal_milestone" | "vendor_agreements.updated" | "vendors.activated" | "vendors.approved" | "vendors.updated" | "webhooks.verification")
required
Type of the webhook event.
object
required
Additional metadata associated with the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_NEW_CUSTOM_ACCOUNTING_FIELDTool for creating a new custom accounting field. Note: This operation requires elevated permissions not available in the demo API.

Input Parameters

string
required
Remote/external ID of custom accounting field from ERP system.
string
required
Name of the custom accounting field.
string ("SINGLE_CHOICE" | "BOOLEAN" | "FREE_FORM_TEXT")
required
The input type could be SINGLE_CHOICE, BOOLEAN or FREE_FORM_TEXT.
boolean
If set to True, the accounting field can be used to annotate split line items.
array
Types of objects that require this accounting field to be used for coding before they can be marked as ready to sync.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_PROCUREMENT_REQUESTCreate a procurement request for a purchase-order or approval-only spend program. Early access must be enabled for the business, with a business-scoped token and Ramp Plus. By default this submits into the program’s approval flow; set submit=false for a draft. File-upload form fields are unsupported and required unanswered fields are reported in additional_info.fields_to_answer. A new vendor contact is saved even for a draft. Returns request detail.

Input Parameters

string
Request name.
boolean
Submit into the approval flow by default. Set false to create a draft.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MUR" | "MRU" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDG" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
required
Request currency code supported by Ramp.
string
Spend period end, YYYY-MM-DD.
string
Business entity ID; defaults to program or requester entity.
array
Request line items; purchase-order programs only.
string
Spend period start, YYYY-MM-DD.
array
Form answers whose answer_type matches each program form field. File-upload fields are unsupported.
string
Optional client-generated X-Idempotency-Key header to make retries idempotent; 1–255 characters.
string
required
Owner user ID. Approvals route as if this user submitted the request.
string
required
Procurement spend program ID; other program types are rejected.
array
Request-level selections; purchase-order programs only, limited to enabled fields allowed by the ERP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_PURCHASE_ORDERCreate a purchase order. Purchase Orders require a Ramp Plus account.

Input Parameters

string
Purchase order memo.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDSUI" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
required
Ramp-supported purchase order currency code.
string
Owner ID; defaults to the API caller when omitted.
string
required
Associated business entity ID.
string
Associated vendor ID.
array
required
Line items for the purchase order.
string
Unique, immutable client-side purchase order ID.
string
Date the vendor promises delivery.
string
Date when purchase order spending ends.
string
Date when purchase order spending begins.
integer
Invoice payment term in days.
string
Unique purchase order number; Ramp generates one when omitted.
boolean
required
Whether item receipts are required for three-way matching.
string
Default retainage rate as a fraction from 0 (inclusive) to 1 (exclusive).
array
Body-level accounting coding selections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_SPEND_PROGRAMCreate a Ramp spend program with spending limits and optional issuance rules. Automatic issuance can assign limits to matching users; physical-card issuance is disabled by default. This API does not expose a spend-program delete operation.

Input Parameters

string ("AccountingServicesIcon" | "AdvertisingIcon" | "CONTRACTORS_AND_PROFESSIONAL_SERVICES" | "CUSTOM" | "CardIcon" | "EducationStipendIcon" | "EmployeeRewardsIcon" | "GroundTransportationIcon" | "LegalFeesIcon" | "LodgingIcon" | "LunchOrderingIcon" | "OnboardingIcon" | "PerDiemCardIcon" | "SOFTWARE" | "SaasSubscriptionIcon" | "SoftwareTrialIcon" | "SuppliesIcon" | "TeamSocialIcon" | "TravelExpensesIcon" | "VirtualEventIcon" | "WellnessIcon" | "WorkFromHomeIcon" | "advertising" | "airlines" | "bills" | "business" | "car_services" | "contractor" | "education" | "entertainment" | "event_balloons" | "event_virtual" | "food" | "fuel_and_gas" | "general_expense" | "general_merchandise" | "gift" | "government_services" | "internet_and_phone" | "legal" | "lodging" | "lodging_room" | "newspaper" | "office" | "physical_card" | "procurement_checklist" | "procurement_intake" | "professional_services" | "restaurants" | "reward" | "saas_software" | "shipping" | "travel_misc" | "wellness")
required
Ramp template icon.
string
required
Description of the spend program.
string
required
Display name of the spend program.
boolean
Allow sharing among multiple users.
object
Optional automatic issuance and requestability rules.
object
required
Permitted spending methods.
object
required
Restrictions imposed on the spend program.
boolean
Issue a physical card if the user has none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_TAX_CODE_ACCOUNTING_FIELDTool to create a new tax code accounting field in Ramp. There can only be one active tax code accounting field per accounting connection. Use when you need to set up tax code tracking for an accounting integration.

Input Parameters

string
required
Name of the tax code field in the remote ERP system.
string
The name of the tax code field as shown on Ramp. If not provided, the name field will be used as the display name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_USER_INVITETool to create a user invite for onboarding new employees to Ramp. Triggers an async task to send an invite email. Users must accept the invite to be onboarded. Assign users to specific entities using location_id.

Input Parameters

string ("AUDITOR" | "BUSINESS_ADMIN" | "BUSINESS_BOOKKEEPER" | "BUSINESS_OWNER" | "BUSINESS_USER" | "GUEST_USER" | "IT_ADMIN")
required
The employee’s role in the organization. Note that BUSINESS_OWNER is not an invitable role
string
required
The employee’s email address where the invite will be sent
string
required
Last name of the employee (max 255 characters)
string
required
First name of the employee (max 255 characters)
boolean
Whether the employee is a manager
string
Unique identifier of the employee’s location. Use this to assign the user to a specific entity (locations are mapped to entities with many-to-one relationship)
string
Unique identifier of the employee’s department (UUID format)
string
required
A unique value generated by the client which the server uses to recognize subsequent retries of the same request. Use a random generated UUID to avoid collisions
string
Unique identifier of the employee’s direct manager (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_VENDORCreate an approved Ramp vendor, bypassing existing vendor approval policies. Optionally request payment or tax details from a contact. These flags default to false. Admin/owner tokens may choose requesting_user_id for those requests.

Input Parameters

string
New vendor name.
string
Vendor-level two-letter US state; ignored for non-US countries.
object
Vendor address.
string
Vendor country; defaults to US when omitted or null.
string
Deprecated and ignored; use requesting_user_id instead.
string
Owner user UUID; omitted means no owner.
string
Parent vendor UUID.
string
Default entity UUID belonging to this business; omitted means none.
integer
Days until payment due; 0 is due on receipt. Null clears; omission may inherit parent terms.
string
Customer-defined ID independent of accounting remote IDs.
string
Ramp user UUID recorded as payment/tax requestor. Requires an admin/owner token; omission uses existing creation behavior.
boolean
Request tax information; requires a contact email.
boolean
Request bank/wire/check details; requires a contact email.
object
required
Detailed information about the vendor contact.
string
Accounting remote ID; mutually exclusive with vendor_tracking_category_option_id. Must not already be linked to another Ramp vendor.
string
Ramp accounting vendor UUID; mutually exclusive with accounting_vendor_remote_id. Must not already be linked to another vendor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_VENDOR_CONTACTCreate a contact for an existing Ramp vendor. Returns approved with a contact ID when applied immediately, or pending_approval with a proposal ID when vendor approval is required. Use Get Vendor Contact to read the created contact once approved.

Input Parameters

string
required
Contact email address.
string
Contact phone number; may be null.
string
Contact last name; may be null.
string
required
UUID of the vendor receiving the contact.
string
Contact first name; may be null.
boolean
Whether this is the default contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_CREATE_WEBHOOK_SUBSCRIPTIONTool to create a new webhook subscription for receiving event notifications from Ramp. Use when you need to set up real-time notifications for events like transactions, bills, or reimbursements. The newly registered subscription will be in pending verification state and requires endpoint verification with the provided challenge.

Input Parameters

array
required
List of event types to subscribe to. The webhook will receive notifications for these events
string
required
URL where webhook events will be sent. Must be a valid HTTPS URL that can receive POST requests
object
Optional headers to include with webhook requests. Max 5 headers allowed. Header names max 100 chars, values max 1000 chars

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DEACTIVATE_USERTool to deactivate a user in your Ramp organization. Use when you need to prevent a user from logging in, spending on cards, or receiving notifications. Once deactivated, users cannot access their Ramp account or perform any actions.

Input Parameters

string
required
The unique identifier (UUID) of the user to deactivate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_ACCOUNTTool to delete a general ledger account from Ramp. Use when you need to remove a GL account from the accounting system.

Input Parameters

string
required
The unique identifier (UUID) of the general ledger account to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_CONNECTIONTool to disconnect the current active API-based accounting connection. Use when you need to disable the accounting integration. This action will clear associated accounting settings including Custom Fields, GL Accounts, and Vendors. Only API-based connections can be disconnected via this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_FIELD_OPTION_FILTER_RULESBulk delete specific accounting field option filter rules (Ramp Plus required). Identify each rule by its target field and option remote IDs plus its required trigger selections. Missing rules are no-ops, reported in not_found_count. Returns deleted and missing rule counts; does not delete fields or options.

Input Parameters

array
required
Rules to delete, identified by target field, target option, and required selections.
string
Accounting connection UUID. Required for rules belonging to an inactive accounting connection; otherwise omit or send null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_FIELDSTool to delete a custom accounting field from Ramp. Use when you need to remove a custom accounting field from the system. Note: Fields are read-only and cannot be deleted when a direct accounting connection is enabled.

Input Parameters

string
required
The unique identifier (UUID) of the custom accounting field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_INVENTORY_ITEM_OPTIONSTool to delete an accounting inventory item option from Ramp. Use when you need to remove an inventory item option from the accounting system.

Input Parameters

string
required
The unique identifier (UUID) of the inventory item option to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_TAX_CODETool to delete the tax code accounting field from Ramp. Use when you need to remove the tax code field configuration. Note: The tax code field must exist before deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_TAX_CODE_OPTIONSTool to delete a tax code option from Ramp. Use when you need to remove a tax code option from the accounting system.

Input Parameters

string
required
The unique identifier (UUID) of the tax code option to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_TAX_RATESTool to delete an accounting tax rate from Ramp. Use when you need to remove a tax rate from the accounting system.

Input Parameters

string
required
The unique identifier (UUID) of the tax rate to delete
string
required
The accounting connection ID (UUID) associated with the tax rate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ACCOUNTING_VENDORSTool to delete an accounting vendor from Ramp. Use when you need to remove a vendor from the accounting system.

Input Parameters

string
required
The unique identifier (UUID) of the vendor to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_CUSTOM_FIELD_OPTIONTool to delete a custom accounting field option from Ramp. Use when you need to remove a specific option from a custom accounting field.

Input Parameters

string
required
The unique identifier (UUID) of the custom accounting field option to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_INVENTORY_ITEM_FIELDTool to delete the inventory item accounting field from Ramp. Use when you need to remove the inventory item field from the accounting connection. This uses the authenticated connection’s context to identify which inventory item field to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_ITEM_RECEIPTDelete an item receipt by its ID. Requires Ramp Plus. Returns an empty object after successful deletion (HTTP 204).

Input Parameters

string
required
UUID of the item receipt to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_PROCUREMENT_REQUESTDelete a procurement request by its unified request ID. Requires Ramp Plus and a business-scoped token; acts on behalf of the request owner. Shared procurement eligibility and request-owner permissions apply. Approved and rejected requests can be eligible for deletion. A draft can only be deleted when its owner is also its creator.

Input Parameters

string
required
Unified procurement request ID, as returned by List Procurement Requests (not spend_request_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_PURCHASE_ORDER_LINE_ITEMDelete one line item from an approved Ramp Plus purchase order.

Input Parameters

string
required
Line item ID to delete.
string
required
Purchase order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_SPEND_ALLOCATION_DELETE_USERSTool to remove users from a shared spend limit in Ramp. Use when you need to revoke a user’s access to a shared spending allocation.

Input Parameters

array
required
List of user IDs (UUIDs) to remove from the shared limit
string
required
Unique identifier (UUID) of the shared spend limit to remove users from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_VENDORDelete a Ramp vendor by ID. A vendor cannot be deleted if it has associated transactions, bills, contracts, spend requests, or child vendors.

Input Parameters

string
required
The unique identifier (UUID) of the Ramp vendor to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DELETE_WEBHOOKDelete a Ramp webhook subscription by ID. The operation is irreversible and returns a success indicator when the request succeeds.

Input Parameters

string
required
The unique identifier (UUID) of the webhook subscription to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_DOWNLOAD_BILL_REMITTANCE_RECEIPTDownload the remittance receipt PDF for a Ramp bill.

Input Parameters

string
required
Unique identifier of the bill

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_FETCH_ACCOUNTING_ACCOUNTTool to fetch a specific general ledger account by ID from Ramp. Use when you need to retrieve detailed information about a single GL account.

Input Parameters

string
required
UUID of the general ledger account to retrieve
string
UUID of the accounting connection to filter the GL account. Required when fetching accounts associated with a specific accounting connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_FETCH_ACCOUNTING_VENDORTool to fetch a specific accounting vendor by ID from Ramp. Use when you need to retrieve detailed information about a single accounting vendor for coding transactions, reimbursements, bills, or purchase orders.

Input Parameters

string
required
UUID of the accounting vendor to retrieve
string
UUID of the accounting connection to filter the vendor. Used when fetching vendors associated with a specific accounting connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_FETCH_CUSTOM_ACCOUNTING_FIELDTool for fetching a custom accounting field.

Input Parameters

string
required
UUID of the custom accounting field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_ACCOUNTSTool to list general ledger accounts from Ramp. Use when you need to retrieve GL accounts for accounting integration or transaction categorization.

Input Parameters

string
Filter by account code (e.g., ‘6410’)
string
The ID of the last entity of the previous page, used for pagination to get the next page
boolean
Filter by active status. If not provided, returns all accounts. If true, returns only active accounts. If false, returns only inactive accounts.
boolean
Filter by sync status with the accounting system
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
string
Filter by Remote/external ID from the ERP system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_ALL_CONNECTIONSTool to fetch all accounting connections for the current Ramp business. Use when you need to view all accounting integrations, including both active and inactive connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_CONNECTIONTool to fetch the current active accounting connection for a Ramp account. Use when you need to check the status, type, or configuration of the active accounting integration with providers like QuickBooks or NetSuite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_CONNECTION_BY_IDTool to fetch a specific accounting connection by ID from Ramp. Use when you need to retrieve detailed information about a particular accounting integration.

Input Parameters

string
required
UUID of the accounting connection to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_FIELDSTool to list custom accounting fields for coding transactions. Use when you need to retrieve custom accounting fields that can be leveraged to code transactions, reimbursements, and bills.

Input Parameters

string
The ID of the last entity of the previous page, used for pagination to get the next page
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_TAX_CODEFetch the tax code accounting field for the current Ramp accounting connection. To read an inactive connection’s field, supply its accounting_connection_id from List Accounting Connections. Requires accounting:read.

Input Parameters

string
Accounting connection UUID. Required for an inactive connection; otherwise defaults to the current accounting connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ACCOUNTING_VENDORSTool to list accounting vendors from Ramp. Use when you need to retrieve vendor data for transaction coding, reimbursements, bills, or purchase orders in the accounting system.

Input Parameters

string
The ID of the last entity from the previous page, used for pagination to get the next page of results. Ramp uses cursor-based pagination for consistent results.
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ALL_TRANSACTIONSList a page of Ramp transactions, with optional filters and sorting. Pagination information can be used to request subsequent pages.

Input Parameters

string
ID of the last entity of the previous page for pagination
string
Filter by transaction state. If set to ‘ALL’, all transactions including ‘DECLINED’ will be listed
string
Filter by physical card UUID
string
Filter for transactions with user_transaction_time before the given date (ISO 8601 datetime, default: today)
string
Filter for trip UUID
string
Filter by user UUID
string
Filter by limit UUID
string
Filter transactions by business entity UUID
string
Filter for transactions with user_transaction_time after the given date (ISO 8601 datetime)
integer
Number of results per page (2-100, default: 20)
string
Filter for transactions with amount smaller than given amount (USD)
string
Filter for transactions with amount larger than given amount (USD)
boolean
Filter for transactions that are coded with accounting fields and ready to sync to ERP systems
string
Filter by location UUID
string
Filter by merchant UUID
string
Filter for transactions by sync status. Supersedes sync_ready and has_no_sync_commits if set
string
Filter by statement UUID
string
Filter for transactions synced after the given date (ISO 8601 datetime)
string
Filter by department UUID
boolean
Filters for transactions which require a memo but do not have one (can only be set to true)
string
Filter by Ramp category code (integer)
string
Filter by transaction approval status
string
Filter by spend program UUID
boolean
Sort transactions by user_transaction_date in ascending order
boolean
Sort transactions by user_transaction_date in descending order
boolean
Filter for transactions that have not been synced to ERP systems yet
boolean
Sort transactions by amount in ascending order
boolean
Sort transactions by amount in descending order
boolean
Include all purchase data provided by the merchant
string
Filter for transactions awaiting approval by a specific user UUID
string
Filter transactions by accounting field selection UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_BANK_ACCOUNTGet one connected Ramp bank account by UUID. Obtain bank_account_id from List Bank Accounts. Returns account metadata, connection provider, and ACH-detail availability. Requires bank_accounts:read.

Input Parameters

string
required
Bank account UUID; obtain from List Bank Accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_BANKING_BALANCE_HISTORYGet daily available balance history for one Ramp banking account. Obtain account_id from List Banking Accounts. Optionally filter by inclusive start_date and end_date. Returns one page; pass the start query parameter from page.next to continue. Requires treasury:read.

Input Parameters

string
Opaque start cursor from the previous response’s page.next URL.
string
Include balances on or before this ISO 8601 date (YYYY-MM-DD).
integer
Results per page, from 2 to 100 (default 20).
string
required
Banking account ID; obtain from List Banking Accounts.
string
Include balances on or after this ISO 8601 date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_BILLFetch one Ramp bill by ID, including its coding, line items, and payment.

Input Parameters

string
required
UUID of the bill to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_BUSINESSFetch the connected Ramp company’s information, including names, billing address and approved credit limit. Requires business:read; no business ID is needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_BUSINESS_BALANCEFetch the current Ramp business’s balances, available card and flex limits, overall spending limit, and billing dates. No business ID or filters are needed. Amount objects include the currency and minor-unit conversion rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_CARDTool 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.

Input Parameters

string
required
The ID of the card to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_CARD_VAULT_RESOURCETool to fetch a card’s sensitive details from the vault. Requires vault API access. Use when you need to retrieve PAN or CVV for a specific card. This endpoint uses a separate vault base URL.

Input Parameters

string
required
The unique identifier of the card to fetch sensitive details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_CASHBACKFetch one Ramp cashback payment by ID, including its amount and sync status. Obtain cashback_id from List Cashback Payments. Requires cashbacks:read.

Input Parameters

string
required
Cashback payment ID; obtain from List Cashback Payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_CUSTOM_FIELD_OPTIONTool to fetch a custom accounting field option by its ID. Use when you need to retrieve details about a specific custom accounting field option from Ramp’s accounting integration.

Input Parameters

string
required
UUID of the custom accounting field option to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_CUSTOM_FORM_COLLECTION_RESPONSEFetch one custom form collection response by its response ID, including question labels, typed answers, comments, mappings and conditional workflows. Obtain the response ID from procurement, vendor or purchase-order custom-form metadata; a form template ID is not interchangeable. This read does not download attached files.

Input Parameters

string
required
Custom form collection response ID from procurement, vendor or purchase-order custom-form metadata. This is a response ID, not a template or form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_DEPARTMENTRetrieve a specific Ramp department by ID, returning its ID and name.

Input Parameters

string
required
The ID of the department to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_DRAFT_BILLBeta: retrieve one Ramp draft bill by its unique identifier.

Input Parameters

string
required
Unique identifier of the draft bill to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ENTITYGet one Ramp business entity by UUID, including accounts and locations. Obtain entity_id from List Entities. Optionally hide inactive entities or include custom record field values. Requires entities:read.

Input Parameters

string
required
Business entity UUID; obtain from List Entities.
boolean
Hide inactive entities (default false).
boolean
Include custom record field values (default false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_INVENTORY_ITEM_FIELDTool to fetch inventory item accounting field for the current accounting connection. Use when you need to retrieve the inventory item field configuration from the connected ERP system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_ITEM_RECEIPTFetch an item receipt by UUID, including its purchase order, line items and document URLs. Requires Ramp Plus.

Input Parameters

string
required
UUID of the item receipt to fetch; discover IDs with List Item Receipts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_LOCATIONFetch one Ramp location by its UUID, returning its name and business entity ID. Use the locations list endpoint to discover the location ID. Requires locations:read.

Input Parameters

string
required
Unique identifier (UUID) of the location; obtain it by listing locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_MEMOTool to fetch a transaction memo. Use when you need to retrieve the memo text associated with a specific transaction.

Input Parameters

string
required
Unique identifier of the transaction for which to retrieve the memo (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_PROCUREMENT_REQUESTRetrieve one unified procurement or spend request by its unified request ID, including ownership, amounts, status, approval history and memos. Visibility follows the connected user’s permissions. The provider marks this response schema as not finalized.

Input Parameters

string
required
Unified procurement request ID, as returned by List Procurement Requests (not spend_request_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_PURCHASE_ORDERFetch a Ramp Plus purchase order and its detailed line items.

Input Parameters

string
required
Purchase order ID to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_RECEIPTFetch a Ramp receipt by UUID, returning a temporary image URL and optional structured OCR data.

Input Parameters

string
required
UUID of the existing receipt to retrieve; discover IDs with List Receipts.
boolean
Include structured OCR data, including currency code, line items and taxes. Omitted by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_REIMBURSEMENTRetrieve details of a specific reimbursement, including amount, status, user information, accounting details, and receipts, for approval workflows or analysis.

Input Parameters

string
required
ID of the reimbursement to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_SPEND_LIMITTool to fetch detailed information about a specific spend limit. Use when you need to retrieve comprehensive limit details including balance, restrictions, linked cards, and users.

Input Parameters

string
required
The unique identifier (UUID) of the spend limit to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_SPEND_PROGRAMRetrieve one Ramp spend program by ID, including restrictions and request forms.

Input Parameters

string
required
The ID of the spend program to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_STATEMENTRetrieve a statement in JSON or request PDF or CSV format. For PDF and CSV requests, returns the statement ID and a download URL when provided in the response Location header.

Input Parameters

string ("json" | "pdf" | "csv")
Format of the statement: json, pdf, csv
string
required
ID of the statement to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_TRANSACTIONTool for retrieving complete details of a specific transaction. Includes merchant details, receipts, accounting codes, and dispute information.

Input Parameters

string
required
ID of the transaction to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_TRANSFERFetch one Ramp transfer payment by its transfer identifier. Obtain transfer_id from List Transfer Payments. Returns amount, bank account, entity, creation time, payment identifier, and processing/accounting sync status when provided by Ramp. Requires transfers:read. This only reads a transfer.

Input Parameters

string
required
Transfer identifier; obtain from List Transfer Payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_TRIPFetch an existing Ramp trip by UUID, including locations, spend events and totals.

Input Parameters

string
required
UUID of the existing trip to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_USERTool to retrieve detailed information about a specific Ramp user by their ID. Use when you need complete user profile information including role, status, department, and custom fields.

Input Parameters

string
required
The unique identifier (UUID) of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_USERS_DEFERRED_STATUSTool for fetching the status of a deferred user task. Use when you need to check the progress or outcome of asynchronous user operations like user creation.

Input Parameters

string
required
Unique identifier of the deferred task to retrieve status for (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_VENDORTool 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.

Input Parameters

string
required
The ID of the vendor to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_VENDOR_BANK_ACCOUNTFetch one vendor bank account by its vendor ID and bank account ID. Returns currency, payment method, nullable account-number last four digits, and nickname and default status when available. Use List Vendor Bank Accounts to discover account IDs. This read does not initiate a payment.

Input Parameters

string
required
Unique identifier (UUID) of the vendor that owns the account.
string
required
Unique identifier (UUID) of the vendor bank account to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_VENDOR_CONTACTFetch one vendor contact by vendor ID and contact ID. Returns the contact’s email, nullable first and last names and phone number, and whether it is the default contact. Use List Vendor Contacts to find IDs.

Input Parameters

string
required
UUID of the vendor that owns the contact.
string
required
UUID of the vendor contact, obtained from List Vendor Contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_GET_WEBHOOKTool to retrieve detailed information about a specific webhook subscription by ID. Use when you need to check webhook configuration, status, or event types.

Input Parameters

string
required
The unique identifier of the webhook subscription to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_HOLD_BILLBeta: place a Ramp bill on hold, blocking all payment rails and descheduling payments.

Input Parameters

string
Optional reason for placing the bill on hold.
string
required
UUID of the bill to place on hold.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_HOLD_VENDORBlock payments to a vendor by placing a vendor-scoped hold. Removes modifiable open, unpaid bills from scheduled payment flows. An optional reason records why the hold was placed. HTTP 202 means pending approval; only HTTP 204 confirms the vendor was placed on hold. Releasing the hold does not automatically reschedule removed payments.

Input Parameters

string
Optional reason for placing the vendor on hold. May be null.
string
required
Unique identifier of the vendor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_ISSUE_VIRTUAL_CARDRequest asynchronous issuance of a virtual card for a user, with optional spending limits and restrictions. Returns a deferred task identifier and status for tracking the operation.

Input Parameters

string
Memo for the card creation
string
required
User ID to issue the card to
string
Display name for the card
string
Card program ID to use for the card
object
Spending restrictions for the card

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ACCOUNTING_FIELD_OPTION_FILTER_RULESList rules determining which target accounting field options are available based on selected trigger field options. Requires Ramp Plus and accounting:read. Filter by target field or option remote ID. For an inactive accounting connection, supply its accounting_connection_id. Returns one page with a next-page URL.

Input Parameters

string
ID of the last entity of the previous page, used to get the next page.
integer
Results per page, from 2 to 100. Defaults to 20.
string
Filter by target field remote ID.
string
Accounting connection UUID. Required when the filter rules belong to an inactive accounting connection.
string
Filter by target field option remote ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ACCOUNTING_INVENTORY_ITEM_OPTIONSTool to list accounting inventory item options from Ramp. Use when you need to retrieve inventory items for accounting integration or transaction categorization.

Input Parameters

string
Filter by code
string
The ID of the last entity of the previous page, used for pagination to get the next page
boolean
Filter by active status. If not provided, returns all objects. If true, returns only active objects. If false, returns only inactive objects.
boolean
Filter by sync status with the accounting system
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
string
Filter by Remote/external ID from the ERP system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ACCOUNTING_TAX_CODE_OPTIONSList one page of accounting tax code options, including external tax rate IDs and entity availability. Specify accounting_connection_id for an inactive connection. Follow page.next using its start cursor to retrieve subsequent pages.

Input Parameters

string
Filter by code.
string
ID of the last entity on the previous page, used to retrieve the next page.
boolean
Filter by active status; omit to return both active and inactive options.
boolean
Filter by whether the option is synced.
integer
Results per page, between 2 and 100; defaults to 20.
string
Filter by remote/external ID.
string
Accounting connection UUID. Required when querying an inactive accounting connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ACCOUNTING_TAX_RATESTool to list tax rates from Ramp’s accounting integration. Use when you need to retrieve tax rate information for transaction categorization or tax compliance.

Input Parameters

string
The ID of the last entity of the previous page, used for pagination to get the next page
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_AUDIT_LOG_EVENTSList one page of Ramp audit log events (requires Ramp Plus). Filter by users, inclusive dates, actor/event types, agent labels, or a referenced object and resource name together. Returns native page.next; reuse its start query parameter unchanged with the same filters to retrieve the next page.

Input Parameters

string
Opaque last-entity ID from page.next’s start query parameter; pass unchanged with the same filters.
string
Events created at or before this ISO 8601 date-time (inclusive).
array
Filter events attributed to these user UUIDs. Sent comma-separated.
string
Events created at or after this ISO 8601 date-time (inclusive).
string
Referenced object UUID. Also supply resource_name.
integer
Results per page, 2-100 (default 20).
array
Customer-visible agent labels that executed the action. Sent comma-separated.
array
Exact Ramp audit event type labels, for example ‘User login’, ‘Created card’, or ‘Test’. Sent comma-separated; use labels from Ramp’s audit log event catalog.
string ("Accounting rule group" | "Approvals" | "Bill payment" | "Bill template" | "Card" | "Cash Manager recommendation" | "Fixed asset class" | "Fixed asset" | "Forecast custom input" | "Fund request" | "Investment account" | "Legal entity" | "Managed portfolio transfer" | "Payment run" | "Reimbursement" | "SFTP Configurations" | "Separation of duties" | "Spend allocation" | "Spend event" | "Spend program" | "Transaction" | "Travel (Booking request)" | "Travel (Trip)" | "Treasury account" | "User" | "Vendor / Merchant" | "WBX Policy" | "WBX Request" | "Wallet automation policy" | "Wallet transfer" | "Workflow (Base)" | "Workflow")
Referenced resource name. Also supply object_id.
array
Filter by actor types. Sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_BANK_ACCOUNTSList connected Ramp bank accounts, one page at a time. Optionally filter by connection provider. Requires bank_accounts:read. Continue by passing the start query parameter from page.next with the same filter.

Input Parameters

string
ID of the last entity of the previous page; use start from page.next.
integer
Results per page, from 2 to 100 (default 20).
string ("finicity" | "manual" | "plaid" | "ramp_brokerage" | "ramp_wallet" | "teller")
Filter bank accounts by connection provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_BANKING_ACCOUNTSList the business’s Ramp checking, brokerage, and investment accounts. Returns one page of account identifiers, types, and display names. Requires treasury:read. To continue, pass the start query parameter from page.next.

Input Parameters

string
ID of the last entity of the previous page.
integer
Results per page, from 2 to 100 (default 20).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_BILLSList Ramp bills using payment, status, accounting, date, and amount filters.

Input Parameters

string
ID of the last bill from the previous page.
string
Filter by business entity UUID.
integer
Results per page, from 2 through 100.
string
Filter by exact client-side ID.
string
Filter by vendor UUID.
string
Maximum bill amount in major currency units.
string
Minimum bill amount in major currency units.
string
Filter by payment UUID.
boolean
Return only bills ready or not ready to sync to the ERP.
string
Return bills paid on or before this ISO 8601 datetime.
boolean
When true, return archived bills instead of active bills.
string ("BILL_AND_PAYMENT_SYNCED" | "BILL_SYNCED" | "NOT_SYNCED")
Filter by ERP sync status.
string
Return bills due on or before this ISO 8601 datetime.
string
Return bills paid on or after this ISO 8601 datetime.
string
Filter by exact source draft bill UUID.
string
Return bills due on or after this ISO 8601 datetime.
string
Return bills created on or before this ISO 8601 datetime.
string
Filter by exact invoice number.
string ("ACH" | "CARD" | "CHECK" | "CRYPTO_WALLET_TRANSFER" | "DOMESTIC_WIRE" | "INTERNATIONAL" | "LOCAL_BANK_TRANSFER" | "ONE_TIME_CARD" | "ONE_TIME_CARD_DELIVERY" | "PAID_MANUALLY" | "SWIFT")
Filter by payment method.
string ("OPEN" | "PAID")
Filter by bill payment status.
string
Return bills issued on or before this ISO 8601 datetime.
string ("APPROVED" | "INITIALIZED" | "PENDING" | "REJECTED" | "TERMINATED")
Filter by bill approval status.
string
Return bills created on or after this ISO 8601 datetime.
string
Return non-card bills with payment dates on or before this YYYY-MM-DD date.
string
Return bills issued on or after this ISO 8601 datetime.
array
Filter by one or more status summaries; values are sent to Ramp as a comma-separated list.
string
Return non-card bills with payment dates on or after this YYYY-MM-DD date.
string
Filter by matched purchase order UUID.
boolean
Filter by payment accounting export readiness.
boolean
When true, return only bills missing payment details.
boolean
Filter by whether bills are configured to sync to the ERP.
string
Filter by exact customer-facing payment ID.
string
Filter by an accounting field option UUID used to code a bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_CARDSTool 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.

Input Parameters

string
ID of the last entity of the previous page for pagination
string
Filter by card owner UUID
string
Filter by business entity UUID
integer
Number of results per page (2-100, default: 20)
string
Filter by display name
boolean
Filter only for activated cards. Defaults to True if not specified
boolean
Filter only for terminated cards. Defaults to False if not specified
string
Filter by card program UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_CASHBACKSList one page of cashback payments, optionally filtered by entity, statement, dates, or accounting sync status. Requires cashbacks:read. sync_status takes precedence over sync_ready. To continue, pass the start query parameter from page.next; a null page.next means there are no more pages.

Input Parameters

string
Opaque ID/cursor from the previous page’s page.next start query parameter.
string
Cashbacks on or before this ISO8601 datetime.
string
Filter cashbacks by business entity UUID.
string
Cashbacks on or after this ISO8601 datetime.
integer
Results per page, from 2 to 100 (default 20).
boolean
Filter cashbacks ready to sync (no pending syncs and completed).
string ("NOT_SYNC_READY" | "SYNCED" | "SYNC_READY")
Filter by sync status. Supersedes sync_ready if provided.
string
Filter cashbacks included in the specified statement UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_CHILD_VENDORSList child vendors of a parent Ramp vendor. Requires an existing parent vendor ID and vendors:read. Returns one page of vendor resources and a next-page URL; pass its start cursor to continue. An empty data array is valid when the vendor has no children.

Input Parameters

string
ID of the last entity of the previous page.
integer
Results per page, from 2 to 100 (default 20).
string
required
ID of the parent vendor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_DEPARTMENTSList Ramp departments with pagination, returning department IDs and names.

Input Parameters

string
ID of the last entity of the previous page for pagination
integer
Number of results per page (2-100, default: 20)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_DRAFT_BILLSBeta: list Ramp draft bills with filters and cursor pagination.

Input Parameters

string
ID from the previous page’s page.next URL.
string
Filter draft bills by business entity UUID.
integer
Number of results to return, from 2 to 100.
string
Filter by exact client-side remote ID.
string
Filter draft bills by vendor UUID.
string
Return drafts due on or before this ISO 8601 datetime.
string
Return drafts due on or after this ISO 8601 datetime.
string
Return drafts created on or before this ISO 8601 datetime.
string
Filter by exact invoice number.
string
Return drafts issued on or before this ISO 8601 datetime.
string
Return drafts created on or after this ISO 8601 datetime.
string
Return drafts issued on or after this ISO 8601 datetime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ENTITIESList Ramp business entities, one page at a time. Filter by currency, entity name, or primary status. Requires entities:read. To continue, pass the start query parameter from page.next with the same filters.

Input Parameters

string
ID of the last entity of the previous page.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDG" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
Filter by currency of the entity.
integer
Results per page, from 2 to 100 (default 20).
boolean
Filter to include only primary or non-primary entities.
string
Filter entities by name.
boolean
Hide inactive entities. Defaults to false.
boolean
Include deleted accounts. Boolean query flag; omit to use the provider default.
boolean
Include custom record field values. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ITEM_RECEIPTSList one page of item receipts, optionally filtered by entity or purchase order. Requires Ramp Plus. Returns receipt details, line items and native page.next. For the next page, pass the start query value from page.next with the same filters.

Input Parameters

string
Last entity ID from the previous page; use start from page.next unchanged.
string
Associated business entity UUID.
integer
Results per page, between 2 and 100 (default 20).
boolean
Include archived item receipts; defaults to false.
string
Associated purchase order UUID.
string
Associated purchase order line item UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_LOCATIONSList one page of Ramp locations, optionally filtered by business entity. Returns location IDs, names, entity IDs, and the native page.next URL. Use its start query parameter to request the next page.

Input Parameters

string
ID of the last entity of the previous page; pass unchanged to retrieve the next page.
string
Filter by associated business entity UUID.
integer
Number of results per page (2-100; default 20).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_MEMOSTool for listing memos associated with transactions in your Ramp organization. Returns memo details with support for filtering by card, user, department, location, manager, merchant, and date range.

Input Parameters

string
ID of the last entity of the previous page for pagination
string
Filter memos by card UUID
string
Filter memos for transactions before this date (ISO 8601 format)
string
Filter memos by user UUID
string
Filter memos for transactions after this date (ISO 8601 format)
integer
Number of results per page (2-100, default: 20)
string
Filter memos by manager UUID
string
Filter memos by location UUID
string
Filter memos by merchant UUID
string
Filter memos by department UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_MERCHANTSList one page of Ramp merchants, optionally filtered by URL, name, or transaction dates. Returns merchant IDs, names, receipt-exemption flags, nullable categories, and the native page.next URL. Use its start query parameter for the next page.

Input Parameters

string
ID of the last entity of the previous page; use the start query parameter from page.next unchanged.
integer
Number of results per page (2-100; default 20).
string
Filter merchants by URL or domain after normalization.
string
Filter merchants by a case-sensitive display name prefix.
string
Filter by transactions occurring (user_transaction_time) on or before this date-time (ISO 8601).
string
Filter by transactions occurring (user_transaction_time) on or after this date-time (ISO 8601).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_PROCUREMENT_REQUEST_ATTACHMENTSList all non-deleted attachments on a unified procurement request, oldest first, including supporting documents and purchase order PDF attachments. Returns metadata and nullable pre-signed download URLs valid for one hour, without downloading files. Requires Ramp Plus and visibility of the request under the connected user’s permissions.

Input Parameters

string
required
Unified procurement request ID from List Procurement Requests (not spend_request_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_PROCUREMENT_REQUESTSList unified procurement and spend requests visible to the connected user, with filters and cursor pagination. Includes purchase orders, spend allocations, approval-only, fund restoration and travel requests. The provider marks this response schema as not finalized.

Input Parameters

string
Opaque pagination cursor from the previous page.next URL’s start parameter.
integer
Results per page, from 2 to 100 (default 20).
array
Filter by entity IDs.
string
Inclusive maximum amount, as a decimal string or number.
string
Inclusive minimum amount, as a decimal string or number.
array
Filter by location IDs.
string
Return requests created on or before this ISO 8601 datetime.
array
Filter by department IDs.
array
Filter by owner user IDs.
string
Return requests created on or after this ISO 8601 datetime.
boolean
Show deleted requests instead of active requests.
array
Filter by request statuses; PENDING selects pending requests.
array
Filter by spend program IDs.
array
Filter by persisted spend request types.
array
Filter by unified spend request classifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_PURCHASE_ORDERSList and filter Ramp Plus purchase orders using cursor pagination.

Input Parameters

string
Last entity ID from the previous page’s next URL.
string
Filter by associated business entity ID.
integer
Number of results per page, from 2 to 100.
string
Filter by exact accounting provider remote ID.
string
Filter by exact client-side external ID.
string
Return purchase orders created before this ISO 8601 timestamp.
string ("FULLY_RECEIVED" | "NOT_RECEIVED" | "OVER_RECEIVED" | "PARTIALLY_RECEIVED")
Filter by receipt status.
string ("ACCOUNTING_PROVIDER" | "DEVELOPER_API" | "EXTERNAL_IMPORT" | "RAMP")
Filter by purchase order creation source.
string
Return purchase orders created after this ISO 8601 timestamp.
boolean
Whether archived purchase orders should be included.
string
Filter by associated spend request ID.
boolean
Filter by whether three-way matching is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_RECEIPT_INTEGRATION_OPT_OUT_EMAILSList emails opted out of receipt integrations. Uses a bodyless GET and wraps Ramp’s native array in data. Optional email and id query values may be ignored by Ramp: check entries rather than assuming the returned list is filtered. No pagination is exposed. Requires receipt_integrations:read.

Input Parameters

string
Optional opt-out UUID query value. Filtering is not guaranteed; check returned entries.
string
Optional email query value. Ramp may ignore it and return the entire list; check returned entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_RECEIPTSList one page of receipts filtered by creation dates, transaction dates or linked IDs. Optionally include structured OCR. Returns pre-signed receipt URLs (valid for one hour by default) and native page.next. For the next page, pass that URL’s start query parameter with the same filters.

Input Parameters

string
ID of the last entity on the previous page; pass the start query parameter from page.next unchanged.
string
Filter transactions with user_transaction_time before this ISO 8601 date-time.
string
Filter transactions with user_transaction_time after this ISO 8601 date-time.
integer
Results per page, 2-100 (default 20).
string
Filter receipts created after this ISO 8601 date-time.
string
Filter receipts created before this ISO 8601 date-time.
string
Filter receipts for a specific transaction UUID.
boolean
Include structured receipt OCR currency, line items and taxes.
string
Filter receipts for a specific reimbursement UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_REIMBURSEMENTSList reimbursements with filtering options. Returns reimbursement details including amounts, status, and associated entities for expense analysis and approval workflows.

Input Parameters

string
ID of the last entity of the previous page for pagination
string
Filter reimbursements created before this date (ISO 8601 datetime)
string
Filter reimbursements associated with a specific trip UUID
string
Filter by user UUID
string
Filter by direction (BUSINESS_TO_USER default, USER_TO_BUSINESS for repayments)
string
Filter reimbursements by business entity UUID
string
Filter reimbursements created after this date (ISO 8601 datetime)
integer
Number of results per page (2-100, default: 20)
boolean
Filter reimbursements that are ready to sync to ERP systems
string
Filter by sync status. Supersedes has_no_sync_commits and sync_ready
string
Filter reimbursements synced after this date (ISO 8601 datetime)
string
Filter reimbursements updated after this date (ISO 8601 datetime)
string
Filter reimbursements submitted before this date (ISO 8601 datetime)
string
Filter reimbursements submitted after this date (ISO 8601 datetime)
boolean
Filter reimbursements that haven’t been synced to ERP systems
string
Filter by underlying transaction date (before this date, ISO 8601 datetime)
string
Filter by underlying transaction date (after this date, ISO 8601 datetime)
string
Filter for reimbursements awaiting approval by a specific user UUID
string
Filter reimbursements by accounting field selection UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_REPAYMENTSList one page of repayments, newest creation date first. Filter by entity, funding methods, original transaction, repayment dates, accounting sync status, or user. Date filters return only completed repayments. Requires repayments:read. Pass the start query parameter from page.next to continue; null page.next marks the last page.

Input Parameters

string
Opaque start query parameter from the previous page.next URL.
string
Filter repayments by user UUID.
string
Filter repayments by business entity UUID.
integer
Results per page, from 2 to 100 (default 20).
string ("IN_PROGRESS" | "MARKED_CANCELED" | "NOT_STARTED" | "SYNC_FAILURE" | "SYNC_SUCCESS")
Latest repayment accounting sync status; excludes repayments with no sync.
string
Repaid before this ISO8601 datetime; returns only completed repayments.
string
Repaid at or after this ISO8601 datetime; returns only completed repayments.
array
Filter by funding methods; sent as a comma-separated list.
string
Filter by the UUID of the original transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_ROLESList the business’s custom roles and their product capabilities. Returns each role’s ID, name, description, base role, and capability access levels. Takes no filters or pagination parameters. Requires users:read. An empty list means the business has no custom roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_SPEND_PROGRAMSList Ramp spend programs and their spending restrictions, one page at a time. Use page.next’s start query parameter to retrieve the next page.

Input Parameters

string
ID of the last entity of the previous page, used to get the next page.
integer
Number of results per page, between 2 and 100. Defaults to 20.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_SPEND_PROGRAM_WORKFLOW_NODESList External Approval Request nodes for one Ramp spend program. Requires service_identifier and a spend program with a Blank Canvas workflow. Returns only nodes matching that non-secret integration identifier, without pagination.

Input Parameters

string
required
UUID of the spend program whose workflow nodes to list.
string
required
Non-secret external approval integration identifier configured on the program’s workflow nodes (Ramp query name: service_key). This is not an API key or authentication credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_STATEMENTSTool for listing all statements with filtering options. Perfect for financial reporting and reconciliation workflows.

Input Parameters

string
ID of the last entity of the previous page for pagination
string
Filter statements with end_date on or before this date (ISO 8601 datetime). Defaults to current time
string
Filter statements with end_date on or after this date (ISO 8601 datetime)
integer
Number of results per page (2-100, default: 20)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_SYNCABLE_BANKING_TRANSACTIONSList banking transactions available to sync to an accounting provider. Requires an active accounting-provider connection and treasury:read. Filter by date range, business entities, or include already-synced transfers. Returns one page; pass the start query parameter from page.next to continue.

Input Parameters

string
Opaque cursor from the start query parameter in page.next.
string
Filter transactions before this date-time (ISO 8601).
integer
Results per page, from 2 to 100 (default 20).
array
Filter by business entity UUIDs; sent comma-separated.
string
Filter transactions after this date-time (ISO 8601).
boolean
Include transfers already synced to the accounting provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_TRANSFERSList one page of transfer payments filtered by status, entity, statement, dates, or accounting sync status. Requires transfers:read. sync_status takes precedence over has_no_sync_commits. Continue with the start query parameter from page.next; a null page.next means there are no more pages.

Input Parameters

string
Opaque ID from the previous page’s page.next start query parameter.
string ("ACH_CONFIRMED" | "CANCELED" | "COMPLETED" | "ERROR" | "INITIATED" | "NOT_ACKED" | "NOT_ENOUGH_FUNDS" | "PROCESSING_BY_ODFI" | "REJECTED_BY_ODFI" | "RETURNED_BY_RDFI" | "SUBMITTED_TO_FED" | "SUBMITTED_TO_RDFI" | "UNNECESSARY" | "UPLOADED")
Filter by transfer status.
string
Filter transfers that occurred before this ISO8601 datetime.
string
Filter transfers by business entity UUID.
string
Filter transfers that occurred after this ISO8601 datetime.
integer
Results per page, from 2 to 100 (default 20).
string ("NOT_SYNC_READY" | "SYNCED" | "SYNC_READY")
Filter by sync status. Supersedes has_no_sync_commits if both are provided.
string
Filter transfers included in the specified statement UUID.
boolean
Filter transfers that have not been synced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_TRIPSList one page of business trips filtered by travelers, status, dates, amount or name. Returns trip details, locations, spend events and native page.next. For the next page, pass the start query parameter from that URL with the same filters.

Input Parameters

string
ID of the last entity on the previous page; take start from the native page.next URL unchanged.
string ("cancelled" | "completed" | "ongoing" | "upcoming")
Filter by trip status.
string
ISO 8601 date-time: trips starting on or before this date; with from_date, overlapping trips are included.
array
Filter by traveler UUIDs; sent as a comma-separated query value.
string
ISO 8601 date-time: trips starting on or after this date; with to_date, overlapping trips are included.
integer
Results per page, 2-100 (default 20).
string
Filter by this trip name.
string
Inclusive maximum trip amount, as a decimal string or number.
string
Inclusive minimum trip amount, as a decimal string or number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_USERSTool 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.

Input Parameters

string
Filter by user role
string
Filter by email address
string
ID of the last entity of the previous page for pagination
string
Filter by business entity UUID
integer
Number of results per page (2-100, default: 20)
string
Filter by user employee_id
string
Filter by location UUID
string
Filter by department UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_VENDORSTool 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.

Input Parameters

string
Filter vendors by name
string
ID of the last entity of the previous page for pagination
boolean
Filter by vendor active status
integer
Number of results per page (2-100, default: 20)
string
Show only vendors with created_at after this date (ISO 8601 datetime)
string
Show only vendors whose sk_category_id matches a Ramp Category Code in the passed list. Expects a comma-separated list of integers
string
Unique identifier of the user which owns this vendor (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_VENDORS_ACCOUNTSTool for listing bank accounts associated with a specific vendor. Returns account details including currency, payment method, and default status. Use this to retrieve payment account information for vendor transactions.

Input Parameters

string
ID of the last entity of the previous page for pagination
integer
Number of results per page (2-100, default: 20)
string
required
The unique identifier (UUID) of the vendor whose bank accounts to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_VENDORS_CONTACTSTool for listing contacts associated with a specific vendor. Returns contact information including names, emails, and phone numbers. Use this to find vendor contact details for communication or relationship management.

Input Parameters

string
ID of the last entity of the previous page for pagination
integer
Number of results per page (2-100, default: 20)
string
required
Unique identifier (UUID) of the vendor to retrieve contacts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_VENDORS_CREDITSTool to list all vendor credits for all vendors of a business. Use when you need to track vendor credits, analyze credit usage across vendors, or reconcile vendor accounts.

Input Parameters

string
The ID of the last entity of the previous page, used for pagination to get the next page
integer
The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used
boolean
Include vendor credits that are marked as fully used. Defaults to false if not specified
string
Filter by vendor credits with an accounting date up to or on the provided date (ISO 8601 date format: YYYY-MM-DD)
string
Filter by vendor credits with an accounting date on or after the provided date (ISO 8601 date format: YYYY-MM-DD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_LIST_WEBHOOKSList webhook subscriptions for the organization, including endpoint URLs, event types, and status. The result can be empty when the response does not contain the expected nested subscription list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_MARK_ACCOUNTING_CONNECTION_READY_TO_MIGRATEMark an inactive API accounting connection ready for the customer’s ERP migration flow. Requires a different active accounting connection to migrate away from, a target not already marked ready, and no ERP migration already in progress. Returns the connection including is_ready_to_migrate. This makes the target selectable in Ramp’s Switch Providers UI; the customer completes the switch there.

Input Parameters

string
required
UUID of the inactive API-based accounting connection to mark ready to migrate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_MARK_ACCOUNTING_OBJECTS_READY_TO_SYNCMark Ramp transactions or reimbursements reviewed and ready for accounting sync. Flags the specified objects as reviewed and complete so they are included in the next accounting export to the connected ERP. Accepts 1–500 IDs of one supported type, all belonging to the authenticated business. Returns no fields on success (HTTP 204); this does not itself perform or confirm an ERP export.

Input Parameters

array
required
UUIDs of 1–500 objects to mark ready to sync. All must belong to the authenticated business; the request fails if any ID is not found.
string ("REIMBURSEMENT" | "TRANSACTION")
required
Type of all objects in object_ids: Ramp reimbursements or card transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_OPTIONS_FOR_CUSTOM_ACCOUNTING_FIELDTool for listing options for a given accounting field.

Input Parameters

string
required
UUID of the custom accounting field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_PATCH_ACCOUNTING_CONNECTIONTool to update an accounting connection’s settings. Use when you need to modify configuration for API-based accounting connections. This endpoint is restricted to Accounting API based connections only.

Input Parameters

object
Settings for API-based accounting connections.
string
required
The UUID of the accounting connection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_PATCH_CARD_RESOURCETool to update a card’s properties including owner, display name, and spending restrictions. Use when you need to modify card settings or reassign card ownership.

Input Parameters

string
required
UUID of the card to update
string
Specify ID to update associated business entity (UUID format)
string
Specify ID for new card owner (UUID format)
string
Cosmetic display name of the card
object
Spending restrictions to update for the card.
boolean
Flag to enable or disable notifications for this card

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_PATCH_CUSTOM_FIELD_OPTIONTool to update a custom accounting field option. Use when you need to modify display name, code, value, or visibility of an existing field option.

Input Parameters

string
Code of the custom accounting field option. Only available if not using a direct ERP integration. Provide an empty string to reset the code.
string
Name of the custom accounting field option. Only available if not using a direct ERP integration.
boolean
Reactivate a deleted custom field option. Only available if not using a direct ERP integration. Must be true if provided.
string ("HIDDEN" | "VISIBLE")
Visibility status for custom field option.
string
Update the display name of the custom field option. Available to all users.
string
required
UUID of the custom accounting field option to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_PATCH_GL_ACCOUNT_RESOURCETool to update a general ledger account in Ramp. Use when you need to modify the name, code, or reactivate a deleted GL account.

Input Parameters

string
Code of the general ledger account (e.g., ‘1500-UPDATED’, ‘6410’). Provide an empty string to reset the code.
string
Name of the general ledger account (e.g., ‘Updated Equipment Account’, ‘Travel : Travel - Lodging’)
boolean
Reactivate a deleted general ledger account. Set to true to reactivate.
string
required
UUID of the general ledger account to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_PATCH_INVENTORY_ITEM_FIELDTool to update the inventory item accounting field for a Ramp connection. Use when you need to modify the name or display name of the inventory item field.

Input Parameters

string
required
Name of the inventory item field.
string
Display name of the inventory item field on Ramp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_ACCOUNTING_ACCOUNTSTool to batch upload general ledger accounts to Ramp. Supports up to 500 accounts per call with all-or-nothing validation. Use when you need to create GL accounts in Ramp’s accounting system.

Input Parameters

array
required
A list of general ledger accounts to upload. Maximum 500 accounts per API call. All-or-nothing validation: if any account fails validation, the entire batch is rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_ACCOUNTING_CODINGSPost accounting coding selections to an existing Ramp card transaction. Select field options, supply free-form text, or explicitly clear an option by sending null without free_form_text. Returns the coded object and selections. This changes accounting coding; it does not create a transaction or payment.

Input Parameters

string
required
UUID of the Ramp card transaction to code.
string
required
Type of Ramp object to code; only TRANSACTION is supported.
array
required
Accounting field selections to post to the transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_ACCOUNTING_CONNECTIONTool to register a new API-based accounting connection between Ramp and an accounting provider. Use when establishing a new connection to accounting systems like QuickBooks, NetSuite, or Xero. If a Universal CSV connection exists, it will be upgraded to an API-based connection.

Input Parameters

object
Connection settings for API-based accounting connections. Applies only to API-based connections
boolean
Deprecated parameter. Use POST accounting/connection/<connection_id>/reactivate instead
string
required
The name of the accounting provider to connect to (e.g., QUICKBOOKS, NETSUITE, XERO, ACCOUNTING_SEED)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_ACCOUNTING_SYNCSReport successful and failed ERP sync results for Ramp objects. Updates accounting sync status rather than exporting objects to an ERP. Supply object IDs and a unique idempotency key; reuse the key for identical retries. Requires an active API-based ERP accounting connection. Returns the sync job ID.

Input Parameters

string ("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")
required
Type of Ramp objects whose sync results are reported.
array
Objects that failed to sync (1–5000). Omit if unused; null is not supported.
string
required
Client-generated unique retry key. Prefer a random UUID; reuse only for retries of the same request.
string
Nullable sync request UUID from the TRANSACTION_SYNC_REQUESTED, REIMBURSEMENT_SYNC_REQUESTED, or ACCRUAL_SYNC_REQUESTED webhook for Sync Button flows. Omit for other flows.
array
Successfully synced objects (1–5000). Omit if unused; null is not supported.
boolean
Mark successful transactions ready before recording completion, clearing accounting requirements. Only TRANSACTION_SYNC without sync_request_id; failed syncs are unaffected. Defaults to false when omitted; null is not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_ACCOUNTING_VENDORSTool to batch upload vendors to Ramp for coding transactions, bills, and purchase orders. Supports up to 500 vendors per call with all-or-nothing validation. Use when you need to create vendors in Ramp’s accounting system.

Input Parameters

array
required
A list of vendors to upload. Maximum 500 vendors per API call. All-or-nothing validation: if any vendor fails validation, the entire batch is rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_INVENTORY_ITEM_OPTIONSTool to upload inventory item options for an active inventory item accounting field. Use when you need to create inventory items in Ramp’s accounting system.

Input Parameters

array
required
A list of inventory item options to upload. Maximum 500 items per API call. There must be an active inventory item accounting field for the accounting connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_POST_PHYSICAL_CARDTool to create a physical card asynchronously. Returns a task ID which can be used to track the card creation status. Physical cards require fulfillment details with a shipping address. Use when a user needs a physical card for in-person transactions.

Input Parameters

string
required
Unique identifier (UUID) of the card owner. This user will be assigned as the cardholder.
string
Business entity UUID to associate with the card. If not provided, defaults to entity associated with user’s location.
object
Fulfillment details for the physical card.
string
required
Cosmetic display name for the card (e.g., ‘Business Travel Card’, ‘T&E’). Required by the API.
boolean
Set to true to create a temporary card. Defaults to false.
string
Card program ID to use for the card. One of spending_restrictions or card_program_id must be provided.
string
required
Unique value to recognize subsequent retries of the same request. Use a random UUID to avoid collisions.
object
Spending restrictions for the physical card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_REACTIVATE_ACCOUNTING_CONNECTIONTool to reactivate a previously unlinked accounting connection by changing its status back to linked. This preserves all previous accounting field configurations and settings. Use when you need to restore a disconnected accounting integration. The business must not have any other active accounting connections.

Input Parameters

string
required
The UUID of the accounting connection to reactivate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_REACTIVATE_USERTool to reactivate a suspended user in your Ramp organization. Use when you need to restore a user’s access. Upon reactivation, users can log in to Ramp again, spend on their previously issued cards, and resume receiving Ramp notifications.

Input Parameters

string
required
The unique identifier (UUID) of the user to reactivate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_RELEASE_BILL_HOLDBeta: release a Ramp bill hold so payments can be scheduled again.

Input Parameters

string
required
UUID of the bill whose hold to release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_RELEASE_VENDORRelease the active vendor-scoped hold to allow new payments to be scheduled. Payments removed from scheduled payment flows during the hold must be scheduled again after release. A pending-approval result does not confirm release; check the vendor’s status before scheduling payments.

Input Parameters

string
required
Unique identifier of the vendor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_REMOVE_RECEIPT_INTEGRATION_OPT_OUT_EMAILRemove an email from the receipt integration opt-out list by its entry ID. A successful request opts the email back into receipt integrations. Returns an empty object on success. Requires receipt_integrations:write.

Input Parameters

string
required
ID of the receipt integration opt-out entry to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_RESOLVE_EXTERNAL_APPROVALApprove or reject a blank canvas external approval workflow step. Requires blank_canvas:write and the approval trigger instance UUID for the workflow step. This resolves that step and can advance or reject its workflow; it does not create an approval request. Returns the provider’s result message.

Input Parameters

string ("approve" | "reject")
required
Decision to apply to the external approval workflow step.
string
required
Blank canvas approval trigger instance ID, not the procurement request or approval instance ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_SUBMIT_DRAFT_BILLBeta: submit a Ramp draft bill and return the resulting standard bill.

Input Parameters

string
required
Unique identifier of the draft bill to submit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_SUBMIT_PROCUREMENT_REQUESTSubmit a procurement draft for approval and return its request detail. Requires Ramp Plus and unified_requests:write. An incomplete draft fails with DEVELOPER_7195; additional_info.validation_errors and additional_info.fields_to_answer describe the missing information. Submission enters the configured approval workflow and may notify its participants.

Input Parameters

string
required
Unified procurement draft request ID (not spend_request_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_SUBMIT_REIMBURSEMENT_RECEIPTTool to upload a receipt for a reimbursement. Use when submitting receipts for out-of-pocket expenses. If reimbursement_id is provided, attaches the receipt to an existing reimbursement; otherwise creates a new draft reimbursement via OCR.

Input Parameters

object
required
Receipt file to upload. The file name should match the receipt filename (for example, ‘receipt.pdf’ or ‘receipt.jpg’).
string
required
UUID of the user to create the reimbursement for
string
required
Unique value to prevent duplicate uploads. Use a UUID to avoid collisions
string
Optional UUID of existing reimbursement to attach receipt to. If not provided, a new draft reimbursement will be created via OCR

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_SUSPEND_CARDTool to suspend a card by creating an async task that locks the card from use. Use when you need to temporarily disable a card. The suspension is revertable.

Input Parameters

string
required
The unique identifier of the card to suspend
string
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_TERMINATE_CARDTool to permanently terminate a Ramp card. This action creates an async task to terminate the card and is irreversible. Use when you need to permanently deactivate a card. The response contains a task ID that can be used to check the termination status.

Input Parameters

string
required
The unique identifier of the card to terminate permanently
string
required
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, use random generated UUIDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_FIELDTool to update a custom accounting field. Use when you need to modify the display name, name, or splittable setting of an existing custom accounting field.

Input Parameters

string
Name of the custom accounting field.
string
required
UUID of the custom accounting field to update (ramp_id).
string
Update the name of the custom accounting field on Ramp.
boolean
Update the is_splittable of the custom accounting field on Ramp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_INVENTORY_ITEM_OPTIONSUpdate the name of an existing inventory item option in Ramp’s accounting system.

Input Parameters

string
The updated name of the inventory item option
string
required
The Ramp UUID of the inventory item option to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_TAX_CODEUpdate the tax code accounting field’s name and optionally its display name in Ramp’s accounting system.

Input Parameters

string
required
Name of the tax code field.
string
Display name of the tax code field on Ramp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_TAX_CODE_OPTIONSTool to update a tax code option in Ramp. Use when you need to modify the name or associated tax rates of an existing tax code option.

Input Parameters

string
The name of the tax code option.
string
required
The unique identifier (UUID) of the tax code option to update
array
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_TAX_RATETool to update an accounting tax rate in Ramp. Use when you need to modify the name, rate percentage, or associated GL account for an existing tax rate.

Input Parameters

string
Name of the tax rate
string
The tax rate percentage expressed as a decimal (e.g. 0.10 for 10%, 0.15 for 15%)
string
required
The unique Ramp ID (UUID) of the tax rate to update
string
The Ramp ID (UUID) of the GL account to associate with this tax rate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_ACCOUNTING_VENDORTool to update an accounting vendor in Ramp. Use when you need to modify vendor details such as name or code, or reactivate a deleted vendor.

Input Parameters

string
Code of the vendor. Provide an empty string to reset the code.
string
Name of the vendor to update
string
required
The unique identifier (ramp_id UUID) of the vendor to update. This is the Ramp-internal UUID, not the external ERP system ID.
boolean
Set to true to reactivate a deleted vendor. Only the value true is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_BILLUpdate an approved Ramp bill. Ramp rejects updates to bills that are not approved.

Input Parameters

string
Bill memo. Use clear_fields to clear it.
string
New bill due date.
string
required
UUID of the approved bill to update.
string
UUID of the business entity associated with the bill.
string
New invoice issue date.
string
Client-side bill ID. Use clear_fields to clear it.
string
UUID of the bill vendor.
array
Replacement expense line items. Add line_items to clear_fields to replace them with an empty list.
string
Memo shown to the vendor. Use clear_fields to clear it.
array
Fields to clear. Ramp clears line_items and inventory_line_items with an empty list; scalar fields are sent as explicit null. Clear requests override replacement values for the same fields.
string
Scheduled payment initiation date for a non-card payment. Use clear_fields to unschedule payment.
string
Accounting posting date. Use clear_fields to clear it.
string
New invoice number.
string ("ACH" | "CARD" | "CHECK" | "CRYPTO_WALLET_TRANSFER" | "DOMESTIC_WIRE" | "INTERNATIONAL" | "LOCAL_BANK_TRANSFER" | "ONE_TIME_CARD" | "ONE_TIME_CARD_DELIVERY" | "PAID_MANUALLY" | "SWIFT")
New payment method for the bill.
string
UUID of a vendor contact associated with the selected vendor.
array
Replacement list of matched purchase order UUIDs.
array
Replacement inventory line items. Add inventory_line_items to clear_fields to replace them with an empty list.
array
Accounting field options used to code the bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_CARD_LIMITRetrieve a card’s details, including its current spending restrictions, after querying limits for the card. This tool does not update the spending limit.

Input Parameters

integer
required
New spending limit amount in cents
string
required
The ID of the card to update limits for
string
required
Spending limit interval: DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY, or TOTAL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_CUSTOM_ACCOUNTING_FIELD_OPTIONUpdate an existing custom accounting field option by ID. Change display name, visibility, entity availability, or (without a direct ERP integration) code, value, and reactivation. Omitted fields remain unchanged; entity_remote_ids=null resets availability to all connected entities. Returns the updated option. Requires accounting:write.

Input Parameters

string
Option code; send an empty string to reset. Only available without a direct ERP integration.
string
Updated option name. Only available without a direct ERP integration.
boolean
Reactivate a deleted option; only true is accepted. Only available without a direct ERP integration.
string ("HIDDEN" | "VISIBLE")
Hide or show this option, available to all integrations.
string
Updated display name, available to all integrations.
string
required
ID of the custom accounting field option to update.
array
Remote IDs from POST /developer/v1/accounting/entities. Omit to leave entity scoping unchanged; send null to reset availability to all connected entities.
string
Accounting connection UUID. Required for an option on an inactive connection. Verified live on PUT; omitted from the provider PUT OpenAPI parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_DEPARTMENTTool for updating an existing department in your Ramp organization. Useful for reorganizing departmental structure or renaming departments.

Input Parameters

string
New department code/identifier
string
New name for the department
string
required
ID of the department to update
string
New parent department ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_DRAFT_BILLBeta: update only explicitly supplied fields on a Ramp draft bill.

Input Parameters

string
Internal bill memo. Use the update action’s clear_fields parameter to clear it later.
string
Bill due date in YYYY-MM-DD format.
string
UUID of the associated business entity.
string
Invoice issue date in YYYY-MM-DD format.
string
Client-side bill identifier. Use the update action’s clear_fields parameter to clear it later.
string
UUID of the bill vendor.
array
Bill line items. When supplied, replaces all existing line items; use the update action’s clear_fields parameter to clear them later.
string
Memo shown to the vendor. Use the update action’s clear_fields parameter to clear it later.
array
Fields to clear. Each listed field is sent to Ramp as explicit null and overrides a replacement value for the same field.
string
Accounting-system posting date in YYYY-MM-DD format. Use the update action’s clear_fields parameter to clear it later.
string
required
Unique identifier of the draft bill to update.
string
Invoice number on the bill.
string ("ACH" | "CARD" | "CHECK" | "CRYPTO_WALLET_TRANSFER" | "DOMESTIC_WIRE" | "INTERNATIONAL" | "LOCAL_BANK_TRANSFER" | "ONE_TIME_CARD" | "ONE_TIME_CARD_DELIVERY" | "PAID_MANUALLY" | "SWIFT")
Payment method for the bill.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDSUI" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
ISO 4217 currency code for the invoice.
string
UUID of a contact belonging to the selected vendor.
array
Purchase order UUIDs to match. Ramp accepts these IDs but does not expose the draft-bill relationship in its read API; successful submission cannot independently confirm that the linkage persisted.
array
Inventory line items. When supplied, replaces all existing inventory line items; use the update action’s clear_fields parameter to clear them later.
boolean
Set false to prevent the bill from syncing to the ERP.
boolean
Use the vendor’s default payment method. Do not also provide payment_method when true.
array
Accounting field options used to code the draft bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_EXTERNAL_APPROVAL_METADATAUpdate display metadata for a Ramp blank canvas external approval request. Supply an existing approval trigger instance UUID and any recipients, display status, or approval URL to send in the PATCH. Omitted metadata fields are not sent; explicit nulls are preserved. This updates metadata, not the approval decision. Returns the approval trigger instance ID and saved metadata. Requires blank_canvas:write.

Input Parameters

string
URL of the approval request. Omit to exclude from the PATCH; explicit null is sent as JSON null.
string
Display name of the approval request status, usually in sentence case. Omit to exclude from the PATCH; explicit null is sent as JSON null.
array
Recipients of the approval request. Omit to exclude from the PATCH; explicit null and an empty list are sent as supplied.
string
required
UUID of the external approval trigger instance whose metadata to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_LIMITSUpdate a Ramp spending limit, including its display name, spending restrictions, permitted spend types, or user assignment. The tool then fetches the updated limit; that read can fail after the update succeeds.

Input Parameters

string
Change the user of the limit. Must be a valid UUID.
string
Change the display name of the limit.
boolean
Dictates whether the spend limit is shareable among multiple users.
string
required
Unique identifier of the spending limit to update.
array
Set accounting rules for all card transactions and reimbursements (if applicable) for the given spend limit.
string
Specify a spend program to link with. This will override the limit’s spending restrictions and permitted spend types with those of the spend program. Pass None to detach the limit’s current spend program. If the spend_program_id field is specified, no other fields may be passed.
object
Permitted spend types for the limit.
object
Spending restrictions for the limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_LOCATIONUpdate a Ramp location’s name and optionally its business entity. Name is required even when changing the entity. Changing entity_id also moves existing users assigned to this location to the updated entity. Returns the location ID, name, and entity ID. Requires locations:write.

Input Parameters

string
required
Updated name of the location.
string
Updated UUID of the business entity this location belongs to. Existing users assigned to this location will also move to that entity. Omit to leave unchanged; explicit null is not supported.
string
required
UUID of the location to update; obtain it by listing locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_PROCUREMENT_REQUESTEdit an owned native draft or submitted Ramp Plus procurement request. Never submits a draft. Submitted edits undergo normal approval reconciliation. Collections replace the complete saved set: re-send every answer, coding selection and line to retain. Omitted/null line descriptions are cleared. Returns request detail with saved purchase-order coding and lines.

Input Parameters

string
Replacement name; omit to keep.
string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "EURC" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "OPEN_USD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USDB" | "USDC" | "USDG" | "USDT" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAD" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWG" | "ZWL")
Replacement currency; omit to keep.
string
Spend period end, YYYY-MM-DD; omit to keep, null to clear.
string
Replacement business entity ID; omit to keep.
array
Complete line replacement: IDs retain/update, absent IDs create, unlisted saved IDs are deleted. Omit to keep all. [] deletes all lines on drafts only; submitted requests must retain a line. Re-send description to retain it.
string
Spend period start, YYYY-MM-DD; omit to keep, null to clear.
array
Complete API-editable answer replacement. Omit to keep; [] clears all supported answers. Unlisted supported fields are cleared; file uploads are untouched.
string
Optional X-Idempotency-Key. Reuse rejects the request rather than replaying the response.
string
required
Unified request ID, not spend_request_id; must be owned by the connected user.
array
Complete request-level coding replacement. Omit to keep; unlisted enabled fields are cleared; [] clears all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_PURCHASE_ORDERUpdate an approved Ramp Plus purchase order; unapproved orders are rejected by Ramp.

Input Parameters

string
Replacement memo. Add memo to clear_fields to clear it.
array
Fields to clear. Each listed field is sent to Ramp as explicit null and overrides a replacement value for the same field.
string
Replacement spend end date.
string
Replacement spend start date.
string
required
Purchase order ID to update.
string
Replacement retainage rate from 0 (inclusive) to 1 (exclusive); add withholding_default_rate to clear_fields to clear it.
array
Replacement body-level accounting coding selections; the list is updated all at once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_PURCHASE_ORDER_LINE_ITEMUpdate one line item on an approved Ramp Plus purchase order.

Input Parameters

string
Replacement unit price. Ramp accepts a decimal string or JSON number.
string
Replacement description. Add description to clear_fields to clear it.
array
Fields to clear. Each listed field is sent to Ramp as explicit null and overrides a replacement value for the same field.
string
required
Line item ID to update.
integer
Replacement line item quantity.
string
Replacement retainage rate from 0 (inclusive) to 1 (exclusive); add withholding_rate to clear_fields to clear it.
string
required
Purchase order ID.
array
Replacement accounting coding selections; the list is updated all at once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_USERTool to update an existing user in your Ramp organization. Use when modifying user information such as name, department, role, or manager assignments.

Input Parameters

string ("AUDITOR" | "BUSINESS_ADMIN" | "BUSINESS_BOOKKEEPER" | "BUSINESS_OWNER" | "BUSINESS_USER" | "GUEST_USER" | "IT_ADMIN")
User role in the Ramp organization.
string
required
Unique identifier of the user to update (UUID format)
string
Last name of the user
string
First name of the user
boolean
Whether the employee is a manager
string
Unique identifier of the employee’s location (UUID format)
boolean
Whether to automatically promote the user’s manager to manager role
string
Unique identifier of the employee’s department (UUID format)
string
Unique identifier of the employee’s direct manager (UUID format). Set to null to remove manager assignment.
string
The date when the user is scheduled to be deactivated (YYYY-MM-DD format). Set to null to clear the scheduled deactivation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_VENDORUpdate an existing Ramp vendor by UUID. Omitted fields remain unchanged. Explicit null clears nullable fields such as default_entity_id and net_payment_terms; an empty display_name clears it. Payment/tax detail requests require an existing default contact email.

Input Parameters

string
Vendor name.
string
Vendor-level two-letter US state. Required for US vendor country; ignored for non-US countries.
object
Vendor address.
string
Vendor country.
boolean
Whether this vendor is active.
string
required
UUID of the vendor to update.
string
Vendor description.
string
Vendor display name; an empty string clears it.
string
Default entity UUID belonging to this business; null clears it.
integer
Days until payment due; 0 means due on receipt, null clears, omission leaves unchanged.
string
Customer-defined ID independent of accounting remote IDs.
boolean
Request tax information. Requires an existing default vendor contact email; defaults to false.
string
Existing bank account UUID belonging to this vendor to use as its default payment method. Does not change existing bills; omit to leave unchanged.
boolean
Request ACH, wire and check payment details. Requires an existing default vendor contact email; defaults to false.
string
Accounting remote ID; provide at most one of this or vendor_tracking_category_option_id.
string
Ramp accounting vendor UUID; provide at most one of this or accounting_vendor_remote_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPDATE_VENDOR_BANK_ACCOUNTSAdd vendor payment details through Ramp’s approval workflow. Supports US ACH, US wire, and stablecoin wallet details. Returns approved when applied immediately, or pending_approval with a proposal ID when business policies require approval. This adds payment details; it does not send a payment.

Input Parameters

string
required
Unique identifier (UUID) of the vendor.
boolean
Whether this is the default payment method.
object
US ACH payment details.
object
US wire payment details.
object
Crypto wallet (stablecoin) payout details.
string
Optional payment account nickname.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_BILL_ATTACHMENTUpload an invoice or supporting file to an existing Ramp bill.

Input Parameters

object
required
File to attach to the bill
string
required
Unique identifier of the bill
string ("INVOICE" | "FILE")
required
Attachment type. Use INVOICE for the bill’s invoice or FILE for another supporting file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_DRAFT_BILL_ATTACHMENTUpload an invoice or supporting file to an existing Ramp draft bill.

Input Parameters

object
required
File to attach to the draft bill
string
required
Unique identifier of the draft bill
string ("INVOICE" | "FILE")
required
Attachment type. Use INVOICE for the bill’s invoice or FILE for another supporting file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_EXTERNAL_APPROVAL_DOCUMENTUpload a document for a blank canvas external approval workflow step. The unified request must be associated with a spend request. Sends the document and its category as multipart parts. Returns an empty object on success (HTTP 204).

Input Parameters

object
required
Document to upload for the blank canvas workflow step.
string
required
Unique identifier of the unified request to upload the document to. Must be associated with a spend request.
string ("ADDENDUM_OR_RIDER" | "AMENDMENT" | "BANK_LETTER" | "CAIQ_LITE" | "CERTIFICATE_OF_INSURANCE" | "CONTRACT_OTHER" | "DATA_PROTECTION_AGREEMENT" | "ECOVADIS" | "ENGAGEMENT_LETTER" | "FAQ" | "FORM_1099" | "GDPR" | "HIPAA" | "INVOICE" | "ISO_27001" | "ISO_9001" | "MSA" | "NDA" | "NMSDC_CERTIFICATION" | "ORDER_FORM" | "OTHER" | "PAYMENT_INSTRUCTIONS" | "PCI_DSS" | "PEN_TEST_REPORT" | "PRIVACY_POLICY" | "PURCHASE_ORDER" | "QUESTIONNAIRE" | "QUOTE" | "SECURITY_DOCUMENT" | "SECURITY_EXHIBIT" | "SIG" | "SLA" | "SOC_1_TYPE_1" | "SOC_1_TYPE_2" | "SOC_2" | "SOW" | "TAX_DOCUMENT" | "TAX_DOCUMENT_INTL_COR" | "TAX_DOCUMENT_INTL_GOV_FORM" | "TAX_DOCUMENT_INTL_OTHER" | "TAX_DOCUMENT_INTL_STATUTORY_FORM" | "TOS" | "VENDOR_CONTRACT" | "VENDOR_CREDIT" | "VOIDED_CHECK" | "W8" | "W9")
required
Category of document to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_NEW_OPTIONSTool for uploading new options for a given accounting field.

Input Parameters

array
required
A list of field options for a given custom accounting field.
string
required
UUID of the custom accounting field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_PROCUREMENT_REQUEST_ATTACHMENTUpload a supporting document or purchase-order attachment to a procurement request. Requires Ramp Plus. Supporting documents are not shared with the vendor; PURCHASE_ORDER files are appended to the purchase order PDF sent to the vendor. Returns the attachment ID. An idempotency key is required for retries.

Input Parameters

object
required
File to attach to the request.
string ("SPEND_REQUEST" | "PURCHASE_ORDER")
SPEND_REQUEST (default) is a supporting document not shared with the vendor. PURCHASE_ORDER appends the file to the purchase order PDF sent to the vendor.
string
required
Client-generated X-Idempotency-Key header. Reuse the same key when retrying the same upload; 1–255 characters.
string
required
Unique identifier of the procurement request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_RECEIPTUpload a receipt image or PDF for a Ramp user. Optionally attach it to a transaction. When transaction_id is omitted, Ramp attempts automatic transaction matching; omission does not guarantee an unattached receipt. Returns the receipt identifier when supplied by Ramp.

Input Parameters

object
required
Receipt image or PDF to upload.
string
required
User to associate with the receipt; affects transaction matching priority.
string
Transaction to attach to the receipt. If omitted, Ramp attempts to match a transaction automatically.
string
required
Caller-supplied form field that makes upload retries idempotent. Reuse the same key for the same upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_TAX_CODE_OPTIONSTool to upload tax code options to Ramp. Use when you need to create or update tax codes in the accounting system. Requires an active tax code accounting field for the accounting connection.

Input Parameters

array
required
A list of tax code options to upload. Must contain at least 1 option and at most 500 options per API call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_UPLOAD_TAX_RATESTool to batch upload tax rates to Ramp. Supports up to 500 tax rates per call with all-or-nothing validation. Use when you need to create tax rates in Ramp’s accounting system. Ensure data is sanitized and tax rates do not already exist before uploading.

Input Parameters

array
required
A list of tax rates to upload. Maximum 500 tax rates per API call. All-or-nothing validation: if any tax rate fails validation or violates a database constraint, the entire batch is rejected. Ensure tax rates do not already exist on Ramp before uploading.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RAMP_VERIFY_WEBHOOKVerify a pending webhook subscription using its delivered challenge. Use after your HTTPS receiver has received and acknowledged Ramp’s webhooks.verification request. A successful verification activates the subscription so it can receive its subscribed business events. This action submits the challenge; it does not verify signatures of incoming events.

Input Parameters

string
required
Challenge received in Ramp’s webhooks.verification POST to your webhook endpoint. Return 2xx to that delivery, then submit its challenge here unchanged.
string
required
UUID of the webhook subscription to verify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not