KosmoKrator

data

Ramp Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Ramp KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.ramp.*. Use lua_read_doc("integrations.ramp") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Ramp workflow without starting an interactive agent session.

Inline Lua call
kosmo integrations:lua --eval 'dump(app.integrations.ramp.list_general_ledger_accounts({}))' --json
Read Lua docs headlessly
kosmo integrations:lua --eval 'print(docs.read("ramp"))' --json
kosmo integrations:lua --eval 'print(docs.read("ramp.list_general_ledger_accounts"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua
local ramp = app.integrations.ramp
local result = ramp.list_general_ledger_accounts({})

dump(result)
Run the workflow
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.ramp, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.ramp.default.* or app.integrations.ramp.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Ramp, use the narrower mcp:lua command.

MCP Lua command
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Ramp Lua Docs

Ramp tools are exposed under app.integrations.ramp. This package is generated from Ramp’s official Developer API OpenAPI document and exposes all 228 operations found in that spec.

Configure access_token and optionally url. The default URL is https://api.ramp.com.

Pass path and query parameters as top-level snake_case arguments. Pass JSON request bodies under body.

local cards = app.integrations.ramp.ramp_get_card_list_resource({ limit = 25 })
local account = app.integrations.ramp.ramp_get_gl_account_resource({ gl_account_id = "acct_123" })

Coverage Notes

The manifest ramp-openapi-manifest.json records source URL, operation IDs, methods, paths, tool slugs, and classes.

Representative Tools

  • ramp_get_gl_account_list_resource - GET /developer/v1/accounting/accounts
  • ramp_post_gl_account_list_resource - POST /developer/v1/accounting/accounts
  • ramp_delete_gl_account_resource - DELETE /developer/v1/accounting/accounts/{gl_account_id}
  • ramp_get_gl_account_resource - GET /developer/v1/accounting/accounts/{gl_account_id}
  • ramp_patch_gl_account_resource - PATCH /developer/v1/accounting/accounts/{gl_account_id}
  • ramp_get_accounting_all_connections_resource - GET /developer/v1/accounting/all-connections
  • ramp_delete_accounting_connection_resource - DELETE /developer/v1/accounting/connection
  • ramp_get_accounting_current_connection_resource_deprecated - GET /developer/v1/accounting/connection
  • ramp_post_accounting_connection_resource - POST /developer/v1/accounting/connection
  • ramp_get_accounting_connection_detail_resource - GET /developer/v1/accounting/connection/{connection_id}
  • ramp_patch_accounting_connection_detail_resource - PATCH /developer/v1/accounting/connection/{connection_id}
  • ramp_post_reactivate_connection_resource - POST /developer/v1/accounting/connection/{connection_id}/reactivate
  • ramp_get_custom_field_option_list_resource - GET /developer/v1/accounting/field-options
  • ramp_post_custom_field_option_list_resource - POST /developer/v1/accounting/field-options
  • ramp_delete_custom_field_option_resource - DELETE /developer/v1/accounting/field-options/{field_option_id}
  • ramp_get_custom_field_option_resource - GET /developer/v1/accounting/field-options/{field_option_id}
  • ramp_patch_custom_field_option_resource - PATCH /developer/v1/accounting/field-options/{field_option_id}
  • ramp_put_custom_field_option_resource - PUT /developer/v1/accounting/field-options/{field_option_id}
Raw agent markdown
# Ramp Lua Docs

Ramp tools are exposed under `app.integrations.ramp`. This package is generated from Ramp's official Developer API OpenAPI document and exposes all 228 operations found in that spec.

Configure `access_token` and optionally `url`. The default URL is `https://api.ramp.com`.

Pass path and query parameters as top-level snake_case arguments. Pass JSON request bodies under `body`.

```lua
local cards = app.integrations.ramp.ramp_get_card_list_resource({ limit = 25 })
local account = app.integrations.ramp.ramp_get_gl_account_resource({ gl_account_id = "acct_123" })
```

## Coverage Notes

The manifest `ramp-openapi-manifest.json` records source URL, operation IDs, methods, paths, tool slugs, and classes.

## Representative Tools

- `ramp_get_gl_account_list_resource` - GET `/developer/v1/accounting/accounts`
- `ramp_post_gl_account_list_resource` - POST `/developer/v1/accounting/accounts`
- `ramp_delete_gl_account_resource` - DELETE `/developer/v1/accounting/accounts/{gl_account_id}`
- `ramp_get_gl_account_resource` - GET `/developer/v1/accounting/accounts/{gl_account_id}`
- `ramp_patch_gl_account_resource` - PATCH `/developer/v1/accounting/accounts/{gl_account_id}`
- `ramp_get_accounting_all_connections_resource` - GET `/developer/v1/accounting/all-connections`
- `ramp_delete_accounting_connection_resource` - DELETE `/developer/v1/accounting/connection`
- `ramp_get_accounting_current_connection_resource_deprecated` - GET `/developer/v1/accounting/connection`
- `ramp_post_accounting_connection_resource` - POST `/developer/v1/accounting/connection`
- `ramp_get_accounting_connection_detail_resource` - GET `/developer/v1/accounting/connection/{connection_id}`
- `ramp_patch_accounting_connection_detail_resource` - PATCH `/developer/v1/accounting/connection/{connection_id}`
- `ramp_post_reactivate_connection_resource` - POST `/developer/v1/accounting/connection/{connection_id}/reactivate`
- `ramp_get_custom_field_option_list_resource` - GET `/developer/v1/accounting/field-options`
- `ramp_post_custom_field_option_list_resource` - POST `/developer/v1/accounting/field-options`
- `ramp_delete_custom_field_option_resource` - DELETE `/developer/v1/accounting/field-options/{field_option_id}`
- `ramp_get_custom_field_option_resource` - GET `/developer/v1/accounting/field-options/{field_option_id}`
- `ramp_patch_custom_field_option_resource` - PATCH `/developer/v1/accounting/field-options/{field_option_id}`
- `ramp_put_custom_field_option_resource` - PUT `/developer/v1/accounting/field-options/{field_option_id}`
Metadata-derived Lua example
local result = app.integrations.ramp.list_general_ledger_accounts({})
print(result)

Functions

list_general_ledger_accounts Read

List general ledger accounts

Lua path
app.integrations.ramp.list_general_ledger_accounts
Full name
ramp.ramp_get_gl_account_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_general_ledger_accounts Write

You can upload up to 500 general ledger accounts in an all-or-nothing fashion. If a general ledger accounts within a batch is malformed or violates a database constraint, the en...

Lua path
app.integrations.ramp.upload_general_ledger_accounts
Full name
ramp.ramp_post_gl_account_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_general_ledger_account Write

Delete a general ledger account

Lua path
app.integrations.ramp.delete_general_ledger_account
Full name
ramp.ramp_delete_gl_account_resource
ParameterTypeRequiredDescription
No parameters.
fetch_general_ledger_account Read

Fetch a general ledger account

Lua path
app.integrations.ramp.fetch_general_ledger_account
Full name
ramp.ramp_get_gl_account_resource
ParameterTypeRequiredDescription
No parameters.
update_general_ledger_account Write

This endpoint can be used to update the name or code of a GL account;

Lua path
app.integrations.ramp.update_general_ledger_account
Full name
ramp.ramp_patch_gl_account_resource
ParameterTypeRequiredDescription
No parameters.
fetch_all_accounting_connections_current_business Read

Fetch all accounting connections for the current business

Lua path
app.integrations.ramp.fetch_all_accounting_connections_current_business
Full name
ramp.ramp_get_accounting_all_connections_resource
ParameterTypeRequiredDescription
No parameters.
disconnect_accounting_connection Write

This endpoint only allows disconnecting API based connections.

Lua path
app.integrations.ramp.disconnect_accounting_connection
Full name
ramp.ramp_delete_accounting_connection_resource
ParameterTypeRequiredDescription
No parameters.
fetch_current_active_accounting_connection Read

This endpoint is now deprecated. Please use the `/all-connections` endpoint instead here.

Lua path
app.integrations.ramp.fetch_current_active_accounting_connection
Full name
ramp.ramp_get_accounting_current_connection_resource_deprecated
ParameterTypeRequiredDescription
No parameters.
register_new_api_based_accounting_connection Write

A connection is required in order to use our accounting API functionality. If a Universal CSV connection already exists, it will be upgraded to an API based connection.

Lua path
app.integrations.ramp.register_new_api_based_accounting_connection
Full name
ramp.ramp_post_accounting_connection_resource
ParameterTypeRequiredDescription
No parameters.
fetch_accounting_connection_by_id Read

Fetch an accounting connection by ID

Lua path
app.integrations.ramp.fetch_accounting_connection_by_id
Full name
ramp.ramp_get_accounting_connection_detail_resource
ParameterTypeRequiredDescription
No parameters.
update_accounting_connection Write

This endpoint is restricted to Accounting API based connections.

Lua path
app.integrations.ramp.update_accounting_connection
Full name
ramp.ramp_patch_accounting_connection_detail_resource
ParameterTypeRequiredDescription
No parameters.
reactivate_previously_unlinked_accounting_connection Write

This endpoint allows reactivating a previously disconnected accounting connection by changing its status back to linked. This preserves all previous accounting field configurati...

Lua path
app.integrations.ramp.reactivate_previously_unlinked_accounting_connection
Full name
ramp.ramp_post_reactivate_connection_resource
ParameterTypeRequiredDescription
No parameters.
list_options_given_custom_accounting_field Read

List options for a given custom accounting field

Lua path
app.integrations.ramp.list_options_given_custom_accounting_field
Full name
ramp.ramp_get_custom_field_option_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_new_options Write

You can upload up to 500 new field options for a given custom accounting field in an all-or-nothing fashion. If a field option within a batch is malformed or violates a database...

Lua path
app.integrations.ramp.upload_new_options
Full name
ramp.ramp_post_custom_field_option_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_custom_accounting_field_option Write

Delete a custom accounting field option

Lua path
app.integrations.ramp.delete_custom_accounting_field_option
Full name
ramp.ramp_delete_custom_field_option_resource
ParameterTypeRequiredDescription
No parameters.
fetch_custom_accounting_field_option Read

Fetch a custom accounting field option

Lua path
app.integrations.ramp.fetch_custom_accounting_field_option
Full name
ramp.ramp_get_custom_field_option_resource
ParameterTypeRequiredDescription
No parameters.
update_custom_accounting_field_option Write

Update a custom accounting field option

Lua path
app.integrations.ramp.update_custom_accounting_field_option
Full name
ramp.ramp_patch_custom_field_option_resource
ParameterTypeRequiredDescription
No parameters.
update_custom_accounting_field_option Write

Update a custom accounting field option

Lua path
app.integrations.ramp.update_custom_accounting_field_option
Full name
ramp.ramp_put_custom_field_option_resource
ParameterTypeRequiredDescription
No parameters.
list_custom_accounting_fields Read

List custom accounting fields

Lua path
app.integrations.ramp.list_custom_accounting_fields
Full name
ramp.ramp_get_custom_field_list_resource
ParameterTypeRequiredDescription
No parameters.
create_new_custom_accounting_field Write

If a custom field with the same id already exists on Ramp, then that existing one will be returned instead of creating a new one; If the existing custom field is inactive, it wi...

Lua path
app.integrations.ramp.create_new_custom_accounting_field
Full name
ramp.ramp_post_custom_field_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_custom_accounting_field Write

Delete a custom accounting field

Lua path
app.integrations.ramp.delete_custom_accounting_field
Full name
ramp.ramp_delete_custom_field_resource
ParameterTypeRequiredDescription
No parameters.
fetch_custom_accounting_field Read

Fetch a custom accounting field

Lua path
app.integrations.ramp.fetch_custom_accounting_field
Full name
ramp.ramp_get_custom_field_resource
ParameterTypeRequiredDescription
No parameters.
update_custom_accounting_field Write

Update a custom accounting field

Lua path
app.integrations.ramp.update_custom_accounting_field
Full name
ramp.ramp_patch_custom_field_resource
ParameterTypeRequiredDescription
No parameters.
delete_inventory_item_accounting_field Write

Delete inventory item accounting field

Lua path
app.integrations.ramp.delete_inventory_item_accounting_field
Full name
ramp.ramp_delete_inventory_item_field_list_resource
ParameterTypeRequiredDescription
No parameters.
fetch_inventory_item_accounting_field Read

Returns the inventory item accounting field for the current accounting connection.

Lua path
app.integrations.ramp.fetch_inventory_item_accounting_field
Full name
ramp.ramp_get_inventory_item_field_list_resource
ParameterTypeRequiredDescription
No parameters.
update_inventory_item_accounting_field Write

Update inventory item accounting field

Lua path
app.integrations.ramp.update_inventory_item_accounting_field
Full name
ramp.ramp_patch_inventory_item_field_list_resource
ParameterTypeRequiredDescription
No parameters.
create_new_inventory_item_accounting_field Write

There can only be one active inventory item accounting field per accounting connection.

Lua path
app.integrations.ramp.create_new_inventory_item_accounting_field
Full name
ramp.ramp_post_inventory_item_field_list_resource
ParameterTypeRequiredDescription
No parameters.
list_inventory_item_options Read

List inventory item options

Lua path
app.integrations.ramp.list_inventory_item_options
Full name
ramp.ramp_get_inventory_item_field_options_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_inventory_item_options Write

There must be an active inventory item accounting field for the accounting connection.

Lua path
app.integrations.ramp.upload_inventory_item_options
Full name
ramp.ramp_post_inventory_item_field_options_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_inventory_item_option Write

Delete an inventory item option

Lua path
app.integrations.ramp.delete_inventory_item_option
Full name
ramp.ramp_delete_inventory_item_field_option_resource
ParameterTypeRequiredDescription
No parameters.
update_inventory_item_option Write

Update an inventory item option

Lua path
app.integrations.ramp.update_inventory_item_option
Full name
ramp.ramp_patch_inventory_item_field_option_resource
ParameterTypeRequiredDescription
No parameters.
upload_new_options_only_field Write

Upload new options for a Ramp-only field

Lua path
app.integrations.ramp.upload_new_options_only_field
Full name
ramp.ramp_post_ramp_field_option_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_only_field_option Write

Delete a Ramp-only field option

Lua path
app.integrations.ramp.delete_only_field_option
Full name
ramp.ramp_delete_ramp_field_option_resource
ParameterTypeRequiredDescription
No parameters.
update_only_field_option Write

Update a Ramp-only field option

Lua path
app.integrations.ramp.update_only_field_option
Full name
ramp.ramp_patch_ramp_field_option_resource
ParameterTypeRequiredDescription
No parameters.
list_only_accounting_fields Read

List Ramp-only accounting fields

Lua path
app.integrations.ramp.list_only_accounting_fields
Full name
ramp.ramp_get_ramp_field_list_resource
ParameterTypeRequiredDescription
No parameters.
create_only_accounting_field Write

Create a Ramp-only accounting field

Lua path
app.integrations.ramp.create_only_accounting_field
Full name
ramp.ramp_post_ramp_field_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_only_accounting_field Write

Delete a Ramp-only accounting field

Lua path
app.integrations.ramp.delete_only_accounting_field
Full name
ramp.ramp_delete_ramp_field_resource
ParameterTypeRequiredDescription
No parameters.
fetch_only_accounting_field Read

Fetch a Ramp-only accounting field

Lua path
app.integrations.ramp.fetch_only_accounting_field
Full name
ramp.ramp_get_ramp_field_resource
ParameterTypeRequiredDescription
No parameters.
update_only_accounting_field Write

Update a Ramp-only accounting field

Lua path
app.integrations.ramp.update_only_accounting_field
Full name
ramp.ramp_patch_ramp_field_resource
ParameterTypeRequiredDescription
No parameters.
post_ready_sync_status Write

This endpoint allows customers to mark a list of objects as ready to sync by their object IDs.

Lua path
app.integrations.ramp.post_ready_sync_status
Full name
ramp.ramp_post_ready_to_sync_resource
ParameterTypeRequiredDescription
No parameters.
post_sync_status Write

This endpoint allows customers to notify Ramp of a list of sync results. An idempotency key is required to ensure that subsequent requests are properly handled.

Lua path
app.integrations.ramp.post_sync_status
Full name
ramp.ramp_post_sync_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_tax_code_accounting_field Write

Delete tax code accounting field

Lua path
app.integrations.ramp.delete_tax_code_accounting_field
Full name
ramp.ramp_delete_tax_code_field_resource
ParameterTypeRequiredDescription
No parameters.
fetch_tax_code_accounting_field Read

Returns the tax code accounting field for the current accounting connection.

Lua path
app.integrations.ramp.fetch_tax_code_accounting_field
Full name
ramp.ramp_get_tax_code_field_resource
ParameterTypeRequiredDescription
No parameters.
update_tax_code_accounting_field Write

Update tax code accounting field

Lua path
app.integrations.ramp.update_tax_code_accounting_field
Full name
ramp.ramp_patch_tax_code_field_resource
ParameterTypeRequiredDescription
No parameters.
create_new_tax_code_accounting_field Write

There can only be one active tax code accounting field per accounting connection.

Lua path
app.integrations.ramp.create_new_tax_code_accounting_field
Full name
ramp.ramp_post_tax_code_field_resource
ParameterTypeRequiredDescription
No parameters.
list_tax_code_options Read

List tax code options

Lua path
app.integrations.ramp.list_tax_code_options
Full name
ramp.ramp_get_tax_code_field_options_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_tax_code_options Write

There must be an active tax code accounting field for the accounting connection.

Lua path
app.integrations.ramp.upload_tax_code_options
Full name
ramp.ramp_post_tax_code_field_options_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_tax_code_option Write

Delete a tax code option

Lua path
app.integrations.ramp.delete_tax_code_option
Full name
ramp.ramp_delete_tax_code_field_option_resource
ParameterTypeRequiredDescription
No parameters.
update_tax_code_option Write

Update a tax code option

Lua path
app.integrations.ramp.update_tax_code_option
Full name
ramp.ramp_patch_tax_code_field_option_resource
ParameterTypeRequiredDescription
No parameters.
list_tax_rates Read

List tax rates

Lua path
app.integrations.ramp.list_tax_rates
Full name
ramp.ramp_get_tax_code_rates_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_tax_rates Write

You can upload up to 500 tax rates in an all-or-nothing fashion. If a tax rate within a batch is malformed or violates a database constraint, the entire batch will be disregarde...

Lua path
app.integrations.ramp.upload_tax_rates
Full name
ramp.ramp_post_tax_code_rates_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_tax_rate Write

Delete a tax rate

Lua path
app.integrations.ramp.delete_tax_rate
Full name
ramp.ramp_delete_tax_rate_detail_resource
ParameterTypeRequiredDescription
No parameters.
update_tax_rate Write

Update a tax rate

Lua path
app.integrations.ramp.update_tax_rate
Full name
ramp.ramp_patch_tax_rate_detail_resource
ParameterTypeRequiredDescription
No parameters.
list_vendors Read

List vendors

Lua path
app.integrations.ramp.list_vendors
Full name
ramp.ramp_get_accounting_vendor_list_resource
ParameterTypeRequiredDescription
No parameters.
upload_vendors Write

You can upload up to 500 vendors in an all-or-nothing fashion. If a vendors within a batch is malformed or violates a database constraint, the entire batch containing that vendo...

Lua path
app.integrations.ramp.upload_vendors
Full name
ramp.ramp_post_accounting_vendor_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_vendor Write

Delete a vendor

Lua path
app.integrations.ramp.delete_vendor
Full name
ramp.ramp_delete_accounting_vendor_resource
ParameterTypeRequiredDescription
No parameters.
fetch_vendor Read

Fetch a vendor

Lua path
app.integrations.ramp.fetch_vendor
Full name
ramp.ramp_get_accounting_vendor_resource
ParameterTypeRequiredDescription
No parameters.
update_vendor Write

Update a vendor

Lua path
app.integrations.ramp.update_vendor
Full name
ramp.ramp_patch_accounting_vendor_resource
ParameterTypeRequiredDescription
No parameters.
fetch_financing_application Read

Since each business can only have one active financing application, this endpoint will only ever return a single application.

Lua path
app.integrations.ramp.fetch_financing_application
Full name
ramp.ramp_get_application_resource
ParameterTypeRequiredDescription
No parameters.
create_financing_application Write

This endpoint will create a new business for the applicant and email them with instructions to sign up and continue the application. If the applicant email already exists in Ram...

Lua path
app.integrations.ramp.create_financing_application
Full name
ramp.ramp_post_application_resource
ParameterTypeRequiredDescription
No parameters.
get_audit_log_events Read

Get audit log events

Lua path
app.integrations.ramp.get_audit_log_events
Full name
ramp.ramp_get_audit_log_events_list_resource
ParameterTypeRequiredDescription
No parameters.
list_bank_accounts Read

List bank accounts

Lua path
app.integrations.ramp.list_bank_accounts
Full name
ramp.ramp_get_bank_account_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
get_bank_account_details Read

Get bank account details

Lua path
app.integrations.ramp.get_bank_account_details
Full name
ramp.ramp_get_bank_account_resource
ParameterTypeRequiredDescription
No parameters.
list_bills Read

List bills

Lua path
app.integrations.ramp.list_bills
Full name
ramp.ramp_get_bill_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_bill Write

Batch payments cannot be created in the API.

Lua path
app.integrations.ramp.create_bill
Full name
ramp.ramp_post_bill_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
list_draft_bills Read

List draft bills

Lua path
app.integrations.ramp.list_draft_bills
Full name
ramp.ramp_get_draft_bill_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_draft_bill Write

Create a draft bill

Lua path
app.integrations.ramp.create_draft_bill
Full name
ramp.ramp_post_draft_bill_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_draft_bill Read

Fetch a draft bill

Lua path
app.integrations.ramp.fetch_draft_bill
Full name
ramp.ramp_get_draft_bill_resource
ParameterTypeRequiredDescription
No parameters.
update_draft_bill Write

Update a draft bill

Lua path
app.integrations.ramp.update_draft_bill
Full name
ramp.ramp_patch_draft_bill_resource
ParameterTypeRequiredDescription
No parameters.
upload_file_attachment_existing_draft_bill Write

Upload a file as an attachment to a draft bill. INVOICE type attachments cannot be uploaded if one already exists on the draft bill. This endpoint accepts the [multipart/form-da...

Lua path
app.integrations.ramp.upload_file_attachment_existing_draft_bill
Full name
ramp.ramp_post_draft_bill_attachment_upload_resource
ParameterTypeRequiredDescription
No parameters.
archive_bill Write

This is a destructive action. Associated inflight payments will be cancelled if possible or any attached one-time-card will be terminated. Paid bills and bills belonging to a ba...

Lua path
app.integrations.ramp.archive_bill
Full name
ramp.ramp_delete_bill_resource
ParameterTypeRequiredDescription
No parameters.
fetch_bill Read

Fetch a bill

Lua path
app.integrations.ramp.fetch_bill
Full name
ramp.ramp_get_bill_resource
ParameterTypeRequiredDescription
No parameters.
update_bill Write

Only approved bills can be updated.

Lua path
app.integrations.ramp.update_bill
Full name
ramp.ramp_patch_bill_resource
ParameterTypeRequiredDescription
No parameters.
upload_file_attachment_existing_bill Write

Upload a file as an attachment to a bill. INVOICE type attachments cannot be uploaded if one already exists on the bill. This endpoint accepts the [multipart/form-data](https://...

Lua path
app.integrations.ramp.upload_file_attachment_existing_bill
Full name
ramp.ramp_post_bill_attachment_upload_resource
ParameterTypeRequiredDescription
No parameters.
upload_document_blank_canvas_workflow_step Write

This endpoint accepts the [multipart/form-data](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) format. Include the document as a part with `Content-Disposition:...

Lua path
app.integrations.ramp.upload_document_blank_canvas_workflow_step
Full name
ramp.ramp_post_blank_canvas_approval_document_resource
ParameterTypeRequiredDescription
No parameters.
approve_or_reject_blank_canvas_workflow_step Write

Approve or reject a blank canvas workflow step

Lua path
app.integrations.ramp.approve_or_reject_blank_canvas_workflow_step
Full name
ramp.ramp_post_blank_canvas_approval_resource
ParameterTypeRequiredDescription
No parameters.
update_metadata_blank_canvas_external_approval_request Write

Update metadata for a blank canvas external approval request

Lua path
app.integrations.ramp.update_metadata_blank_canvas_external_approval_request
Full name
ramp.ramp_patch_blank_canvas_approval_external_approval_metadata_resource
ParameterTypeRequiredDescription
No parameters.
fetch_company_information Read

Fetch the company information

Lua path
app.integrations.ramp.fetch_company_information
Full name
ramp.ramp_get_business_resource
ParameterTypeRequiredDescription
No parameters.
fetch_company_balance_information Read

Fetch the company balance information

Lua path
app.integrations.ramp.fetch_company_balance_information
Full name
ramp.ramp_get_business_balance_resource
ParameterTypeRequiredDescription
No parameters.
list_cards Read

List cards

Lua path
app.integrations.ramp.list_cards
Full name
ramp.ramp_get_card_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_physical_card Write

Call this endpoint to create an async task to request for new physical card.

Lua path
app.integrations.ramp.create_physical_card
Full name
ramp.ramp_post_physical_card
ParameterTypeRequiredDescription
No parameters.
fetch_deferred_task_status Read

Fetch deferred task status

Lua path
app.integrations.ramp.fetch_deferred_task_status
Full name
ramp.ramp_get_card_deferred_task_resource
ParameterTypeRequiredDescription
No parameters.
create_virtual_card Write

Call this endpoint to create an async task to request for new virtual card.

Lua path
app.integrations.ramp.create_virtual_card
Full name
ramp.ramp_post_virtual_card
ParameterTypeRequiredDescription
No parameters.
fetch_card Read

Fetch a card

Lua path
app.integrations.ramp.fetch_card
Full name
ramp.ramp_get_card_resource
ParameterTypeRequiredDescription
No parameters.
update_card Write

This endpoint allow you update the owner, display name, and spend restrictions of a card.

Lua path
app.integrations.ramp.update_card
Full name
ramp.ramp_patch_card_resource
ParameterTypeRequiredDescription
No parameters.
suspend_card Write

Call this endpoint to create an async task to suspend a card so that it is locked from use. The suspension is revertable.

Lua path
app.integrations.ramp.suspend_card
Full name
ramp.ramp_post_card_suspension_resource
ParameterTypeRequiredDescription
No parameters.
terminate_card Write

Call this endpoint to create an async task to terminate a card permanently. Please note that this action is irreversible.

Lua path
app.integrations.ramp.terminate_card
Full name
ramp.ramp_post_card_termination_resource
ParameterTypeRequiredDescription
No parameters.
unlock_card Write

Call this endpoint to create an async task to remove a card's suspension so that it may be used again.

Lua path
app.integrations.ramp.unlock_card
Full name
ramp.ramp_post_card_unsuspension_resource
ParameterTypeRequiredDescription
No parameters.
list_cashback_payments Read

List cashback payments

Lua path
app.integrations.ramp.list_cashback_payments
Full name
ramp.ramp_get_cashback_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_cashback_payment Read

Fetch a cashback payment

Lua path
app.integrations.ramp.fetch_cashback_payment
Full name
ramp.ramp_get_cashback_resource
ParameterTypeRequiredDescription
No parameters.
list_comments_object_discussion_thread Read

Requires `{resource_name}:read` scope and may require additional access. See `object_type` description for more information.

Lua path
app.integrations.ramp.list_comments_object_discussion_thread
Full name
ramp.ramp_get_comments_resource
ParameterTypeRequiredDescription
No parameters.
create_comment_object_discussion_thread Write

Requires `{resource_name}:write` scope and may require additional access. See `object_type` description for more information.

Lua path
app.integrations.ramp.create_comment_object_discussion_thread
Full name
ramp.ramp_post_comments_resource
ParameterTypeRequiredDescription
No parameters.
fetch_custom_form_collection_response_by_id Read

Fetch a custom form collection response by ID

Lua path
app.integrations.ramp.fetch_custom_form_collection_response_by_id
Full name
ramp.ramp_get_custom_form_collection_response_resource
ParameterTypeRequiredDescription
No parameters.
create_custom_table Write

Create Custom Table

Lua path
app.integrations.ramp.create_custom_table
Full name
ramp.ramp_post_dev_api_configure_custom_tables
ParameterTypeRequiredDescription
No parameters.
create_custom_table_column Write

Create Custom Table column

Lua path
app.integrations.ramp.create_custom_table_column
Full name
ramp.ramp_post_dev_api_configure_custom_table_columns
ParameterTypeRequiredDescription
No parameters.
change_api_name_custom_table_column Write

Change the API name of a Custom Table's Column

Lua path
app.integrations.ramp.change_api_name_custom_table_column
Full name
ramp.ramp_patch_dev_api_rename_custom_table_column
ParameterTypeRequiredDescription
No parameters.
extend_native_table Write

Extend Native Ramp table

Lua path
app.integrations.ramp.extend_native_table
Full name
ramp.ramp_post_dev_api_configure_native_tables
ParameterTypeRequiredDescription
No parameters.
create_native_table_field Write

Create Native Ramp table field

Lua path
app.integrations.ramp.create_native_table_field
Full name
ramp.ramp_post_dev_api_configure_native_table_columns
ParameterTypeRequiredDescription
No parameters.
change_api_name_native_table_custom_record_column Write

Change the API name of a Native Table's Custom Record Column

Lua path
app.integrations.ramp.change_api_name_native_table_custom_record_column
Full name
ramp.ramp_patch_dev_api_rename_native_table_column
ParameterTypeRequiredDescription
No parameters.
list_custom_tables Read

List Custom Tables

Lua path
app.integrations.ramp.list_custom_tables
Full name
ramp.ramp_get_dev_api_custom_table
ParameterTypeRequiredDescription
No parameters.
list_custom_table_columns Read

List Custom Table columns

Lua path
app.integrations.ramp.list_custom_table_columns
Full name
ramp.ramp_get_dev_api_custom_table_column
ParameterTypeRequiredDescription
No parameters.
delete_rows_from_custom_table Write

Delete rows from a Custom Table

Lua path
app.integrations.ramp.delete_rows_from_custom_table
Full name
ramp.ramp_delete_dev_api_custom_row
ParameterTypeRequiredDescription
No parameters.
list_custom_table_rows Read

List Custom Table rows

Lua path
app.integrations.ramp.list_custom_table_rows
Full name
ramp.ramp_get_dev_api_custom_row
ParameterTypeRequiredDescription
No parameters.
set_values_rows_custom_table Write

Set values for rows of a Custom Table

Lua path
app.integrations.ramp.set_values_rows_custom_table
Full name
ramp.ramp_put_dev_api_custom_row
ParameterTypeRequiredDescription
No parameters.
change_external_key_custom_table_row Write

Change the external key of a Custom Table row

Lua path
app.integrations.ramp.change_external_key_custom_table_row
Full name
ramp.ramp_patch_dev_api_change_custom_row_external_key
ParameterTypeRequiredDescription
No parameters.
append_cells_custom_table Write

Append cells to a Custom Table

Lua path
app.integrations.ramp.append_cells_custom_table
Full name
ramp.ramp_post_dev_api_append_custom_row_cells
ParameterTypeRequiredDescription
No parameters.
remove_cells_from_custom_table Write

Remove cells from a Custom Table

Lua path
app.integrations.ramp.remove_cells_from_custom_table
Full name
ramp.ramp_post_dev_api_remove_custom_row_cells
ParameterTypeRequiredDescription
No parameters.
list_all_matrix_tables_business Read

List all Matrix tables for the business

Lua path
app.integrations.ramp.list_all_matrix_tables_business
Full name
ramp.ramp_get_dev_api_matrix_tables
ParameterTypeRequiredDescription
No parameters.
create_matrix_table Write

Matrix tables are special-purpose lookup tables where unique combinations of input values map to result values.

Lua path
app.integrations.ramp.create_matrix_table
Full name
ramp.ramp_post_dev_api_matrix_tables
ParameterTypeRequiredDescription
No parameters.
add_result_column_existing_matrix_table Write

Allows adding result columns to already-created matrix tables without modifying the input columns. Only result columns (users and accounting_field_options) can be added. Input c...

Lua path
app.integrations.ramp.add_result_column_existing_matrix_table
Full name
ramp.ramp_post_dev_api_add_matrix_result_column
ParameterTypeRequiredDescription
No parameters.
change_api_name_matrix_table_column_input_or_result Write

This changes the internal name used in API calls while preserving the human-readable label. Both input and result columns can be renamed.

Lua path
app.integrations.ramp.change_api_name_matrix_table_column_input_or_result
Full name
ramp.ramp_patch_dev_api_rename_matrix_column
ParameterTypeRequiredDescription
No parameters.
list_matrix_table_rows Write

Returns rows with inputs and results separated. Inputs are always complete (all input columns), results are sparse (only set values).

Lua path
app.integrations.ramp.list_matrix_table_rows
Full name
ramp.ramp_post_dev_api_matrix_list_rows
ParameterTypeRequiredDescription
No parameters.
change_api_name_matrix_table Write

Change the API name of a Matrix table

Lua path
app.integrations.ramp.change_api_name_matrix_table
Full name
ramp.ramp_post_dev_api_rename_matrix_table
ParameterTypeRequiredDescription
No parameters.
upsert_matrix_table_rows Write

Creates new rows or updates existing rows based on input values. Input values define row identity (via external_key). Result values are mutable and can be partially updated.

Lua path
app.integrations.ramp.upsert_matrix_table_rows
Full name
ramp.ramp_put_dev_api_matrix_put_rows
ParameterTypeRequiredDescription
No parameters.
append_cells_matrix_table_rows Write

Adds values to many-to-many result columns without replacing existing values. Only works on many-to-many result columns. Set ignore_duplicates=true to skip existing duplicate ce...

Lua path
app.integrations.ramp.append_cells_matrix_table_rows
Full name
ramp.ramp_post_dev_api_matrix_append_cells
ParameterTypeRequiredDescription
No parameters.
remove_cells_from_matrix_table_rows Write

Removes specific values from many-to-many result columns without affecting other values.

Lua path
app.integrations.ramp.remove_cells_from_matrix_table_rows
Full name
ramp.ramp_post_dev_api_matrix_remove_cells
ParameterTypeRequiredDescription
No parameters.
delete_single_matrix_table_row_by_id Write

Deletes the matrix row with the specified ID from the matrix table.

Lua path
app.integrations.ramp.delete_single_matrix_table_row_by_id
Full name
ramp.ramp_delete_dev_api_delete_matrix_row
ParameterTypeRequiredDescription
No parameters.
list_native_tables Read

List Native Ramp tables

Lua path
app.integrations.ramp.list_native_tables
Full name
ramp.ramp_get_dev_api_native_table
ParameterTypeRequiredDescription
No parameters.
list_custom_columns_native_table Read

List Custom Columns for a Native Ramp table

Lua path
app.integrations.ramp.list_custom_columns_native_table
Full name
ramp.ramp_get_dev_api_native_table_column
ParameterTypeRequiredDescription
No parameters.
list_custom_column_values_rows_native_table Read

List Custom Column values for rows of a Native Ramp table

Lua path
app.integrations.ramp.list_custom_column_values_rows_native_table
Full name
ramp.ramp_get_dev_api_native_row
ParameterTypeRequiredDescription
No parameters.
set_values_rows_native_table Write

Set values for rows of a Native Ramp table

Lua path
app.integrations.ramp.set_values_rows_native_table
Full name
ramp.ramp_put_dev_api_native_row
ParameterTypeRequiredDescription
No parameters.
append_cells_native_table Write

Append cells to a Native Ramp table

Lua path
app.integrations.ramp.append_cells_native_table
Full name
ramp.ramp_post_dev_api_append_native_row_cells
ParameterTypeRequiredDescription
No parameters.
remove_cells_from_native_table Write

Remove cells from a Native Ramp table

Lua path
app.integrations.ramp.remove_cells_from_native_table
Full name
ramp.ramp_post_dev_api_remove_native_row_cells
ParameterTypeRequiredDescription
No parameters.
list_departments Read

List departments

Lua path
app.integrations.ramp.list_departments
Full name
ramp.ramp_get_department_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_department Write

Create a department

Lua path
app.integrations.ramp.create_department
Full name
ramp.ramp_post_department_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_department Read

Fetch a department

Lua path
app.integrations.ramp.fetch_department
Full name
ramp.ramp_get_department_resource
ParameterTypeRequiredDescription
No parameters.
update_department Write

Update a department

Lua path
app.integrations.ramp.update_department
Full name
ramp.ramp_patch_department_resource
ParameterTypeRequiredDescription
No parameters.
create_embed_init_token_card Write

The specified card must be activated and currently active

Lua path
app.integrations.ramp.create_embed_init_token_card
Full name
ramp.ramp_post_ramp_embedded_card_resource
ParameterTypeRequiredDescription
No parameters.
list_business_entities Read

List business entities

Lua path
app.integrations.ramp.list_business_entities
Full name
ramp.ramp_get_entity_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
get_business_entity Read

Get a business entity

Lua path
app.integrations.ramp.get_business_entity
Full name
ramp.ramp_get_entity_resource
ParameterTypeRequiredDescription
No parameters.
list_item_receipts Read

List item receipts

Lua path
app.integrations.ramp.list_item_receipts
Full name
ramp.ramp_get_item_receipts_resource
ParameterTypeRequiredDescription
No parameters.
create_item_receipt Write

Create an item receipt

Lua path
app.integrations.ramp.create_item_receipt
Full name
ramp.ramp_post_item_receipts_resource
ParameterTypeRequiredDescription
No parameters.
delete_item_receipt Write

Delete an item receipt

Lua path
app.integrations.ramp.delete_item_receipt
Full name
ramp.ramp_delete_item_receipt_single_resource
ParameterTypeRequiredDescription
No parameters.
fetch_item_receipt Read

Fetch an item receipt

Lua path
app.integrations.ramp.fetch_item_receipt
Full name
ramp.ramp_get_item_receipt_single_resource
ParameterTypeRequiredDescription
No parameters.
list_limits Read

List limits

Lua path
app.integrations.ramp.list_limits
Full name
ramp.ramp_get_spend_limit_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_limit Write

Limit may either be created with spend program id (can provide display name and spending restrictions, cannot permitted spend types) or without (must provide display name, spend...

Lua path
app.integrations.ramp.create_limit
Full name
ramp.ramp_post_spend_limit_creation
ParameterTypeRequiredDescription
No parameters.
fetch_deferred_task_status Read

Fetch deferred task status

Lua path
app.integrations.ramp.fetch_deferred_task_status
Full name
ramp.ramp_get_spend_limit_deferred_task_status
ParameterTypeRequiredDescription
No parameters.
fetch_limit Read

Fetch a limit

Lua path
app.integrations.ramp.fetch_limit
Full name
ramp.ramp_get_spend_limit_resource
ParameterTypeRequiredDescription
No parameters.
update_limit Write

Update a limit

Lua path
app.integrations.ramp.update_limit
Full name
ramp.ramp_patch_spend_limit_resource
ParameterTypeRequiredDescription
No parameters.
update_limit Write

Update a limit

Lua path
app.integrations.ramp.update_limit
Full name
ramp.ramp_put_spend_limit_resource
ParameterTypeRequiredDescription
No parameters.
add_new_users_into_shared_limit Write

Add new users into a shared limit

Lua path
app.integrations.ramp.add_new_users_into_shared_limit
Full name
ramp.ramp_put_spend_allocation_add_users
ParameterTypeRequiredDescription
No parameters.
terminate_limit Write

This endpoint creates an async task to terminate a limit permanently.

Lua path
app.integrations.ramp.terminate_limit
Full name
ramp.ramp_post_spend_limit_termination_resource
ParameterTypeRequiredDescription
No parameters.
remove_users_from_shared_limit Write

Remove users from a shared limit

Lua path
app.integrations.ramp.remove_users_from_shared_limit
Full name
ramp.ramp_delete_spend_allocation_delete_users
ParameterTypeRequiredDescription
No parameters.
suspend_limit Write

Suspend a limit

Lua path
app.integrations.ramp.suspend_limit
Full name
ramp.ramp_post_spend_limit_suspension_resource
ParameterTypeRequiredDescription
No parameters.
unsuspend_limit Write

Unsuspend a limit

Lua path
app.integrations.ramp.unsuspend_limit
Full name
ramp.ramp_post_spend_limit_unsuspension_resource
ParameterTypeRequiredDescription
No parameters.
list_locations Read

List locations

Lua path
app.integrations.ramp.list_locations
Full name
ramp.ramp_get_location_list_resource
ParameterTypeRequiredDescription
No parameters.
create_location Write

Create a location

Lua path
app.integrations.ramp.create_location
Full name
ramp.ramp_post_location_list_resource
ParameterTypeRequiredDescription
No parameters.
fetch_location Read

Fetch a location

Lua path
app.integrations.ramp.fetch_location
Full name
ramp.ramp_get_location_single_resource
ParameterTypeRequiredDescription
No parameters.
update_location Write

Update a location

Lua path
app.integrations.ramp.update_location
Full name
ramp.ramp_patch_location_single_resource
ParameterTypeRequiredDescription
No parameters.
list_memos Read

List memos

Lua path
app.integrations.ramp.list_memos
Full name
ramp.ramp_get_memo_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_transaction_memo Read

Fetch a transaction memo

Lua path
app.integrations.ramp.fetch_transaction_memo
Full name
ramp.ramp_get_memo_single_resource
ParameterTypeRequiredDescription
No parameters.
upload_new_memo_transaction Write

Upload a new memo for a transaction

Lua path
app.integrations.ramp.upload_new_memo_transaction
Full name
ramp.ramp_post_memo_create_single_resource
ParameterTypeRequiredDescription
No parameters.
list_merchants Read

List merchants

Lua path
app.integrations.ramp.list_merchants
Full name
ramp.ramp_get_merchant_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
list_purchase_orders Read

List purchase orders

Lua path
app.integrations.ramp.list_purchase_orders
Full name
ramp.ramp_get_purchase_orders_resource
ParameterTypeRequiredDescription
No parameters.
create_purchase_order Write

Create a purchase order

Lua path
app.integrations.ramp.create_purchase_order
Full name
ramp.ramp_post_purchase_orders_resource
ParameterTypeRequiredDescription
No parameters.
fetch_purchase_order Read

Fetch a purchase order

Lua path
app.integrations.ramp.fetch_purchase_order
Full name
ramp.ramp_get_purchase_order_single_resource
ParameterTypeRequiredDescription
No parameters.
update_purchase_order Write

Purchase order must be approved.

Lua path
app.integrations.ramp.update_purchase_order
Full name
ramp.ramp_patch_purchase_order_single_resource
ParameterTypeRequiredDescription
No parameters.
archive_purchase_order Write

Archive a purchase order

Lua path
app.integrations.ramp.archive_purchase_order
Full name
ramp.ramp_post_purchase_order_archive_resource
ParameterTypeRequiredDescription
No parameters.
add_line_items_existing_purchase_order Write

Add line items to an existing purchase order

Lua path
app.integrations.ramp.add_line_items_existing_purchase_order
Full name
ramp.ramp_post_purchase_order_line_items_resource
ParameterTypeRequiredDescription
No parameters.
delete_single_line_item_from_existing_purchase_order Write

Purchase order must be approved.

Lua path
app.integrations.ramp.delete_single_line_item_from_existing_purchase_order
Full name
ramp.ramp_delete_purchase_order_line_item_single_resource
ParameterTypeRequiredDescription
No parameters.
update_single_line_item_existing_purchase_order Write

Purchase order must be approved.

Lua path
app.integrations.ramp.update_single_line_item_existing_purchase_order
Full name
ramp.ramp_patch_purchase_order_line_item_single_resource
ParameterTypeRequiredDescription
No parameters.
list_emails_opted_out_receipt_integrations Read

List emails opted out of receipt integrations

Lua path
app.integrations.ramp.list_emails_opted_out_receipt_integrations
Full name
ramp.ramp_get_receipt_integration_opted_out_emails_list_resource
ParameterTypeRequiredDescription
No parameters.
add_new_email_receipt_integrations_opt_out_list Write

Add a new email to receipt integrations opt-out list

Lua path
app.integrations.ramp.add_new_email_receipt_integrations_opt_out_list
Full name
ramp.ramp_post_receipt_integration_opted_out_emails_list_resource
ParameterTypeRequiredDescription
No parameters.
remove_email_from_receipt_integration_opt_out_list Write

Successful request will opt-in email to receipt integrations.

Lua path
app.integrations.ramp.remove_email_from_receipt_integration_opt_out_list
Full name
ramp.ramp_delete_receipt_integration_opted_out_emails_delete_resource
ParameterTypeRequiredDescription
No parameters.
list_receipts Read

List receipts

Lua path
app.integrations.ramp.list_receipts
Full name
ramp.ramp_get_receipt_list
ParameterTypeRequiredDescription
No parameters.
upload_receipt Write

image and optionally associate it with a transaction. If a `transaction_id` is provided, the receipt will be linked directly to that transaction. If not, Ramp will attempt to au...

Lua path
app.integrations.ramp.upload_receipt
Full name
ramp.ramp_post_receipt_upload
ParameterTypeRequiredDescription
No parameters.
fetch_receipt Read

Fetch a receipt

Lua path
app.integrations.ramp.fetch_receipt
Full name
ramp.ramp_get_receipt_single_resource
ParameterTypeRequiredDescription
No parameters.
list_reimbursements Read

List reimbursements

Lua path
app.integrations.ramp.list_reimbursements
Full name
ramp.ramp_get_reimbursement_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_mileage_reimbursement Write

Create a mileage reimbursement

Lua path
app.integrations.ramp.create_mileage_reimbursement
Full name
ramp.ramp_post_mileage_reimbursement_resource
ParameterTypeRequiredDescription
No parameters.
upload_receipt_reimbursement Write

If a `reimbursement_id` is provided, the receipt will be linked directly to that reimbursement. If not, Ramp will attempt to automatically create a draft reimbursement via OCR. ...

Lua path
app.integrations.ramp.upload_receipt_reimbursement
Full name
ramp.ramp_post_reimbursement_receipt_upload
ParameterTypeRequiredDescription
No parameters.
fetch_reimbursement Read

Fetch a reimbursement

Lua path
app.integrations.ramp.fetch_reimbursement
Full name
ramp.ramp_get_reimbursement_resource
ParameterTypeRequiredDescription
No parameters.
list_repayments Read

This endpoint supports filtering. Results are sorted by creation date in descending order. Note that entity_id filtering is not supported yet.

Lua path
app.integrations.ramp.list_repayments
Full name
ramp.ramp_get_repayment_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
list_spend_programs Read

List spend programs

Lua path
app.integrations.ramp.list_spend_programs
Full name
ramp.ramp_get_spend_program_resource
ParameterTypeRequiredDescription
No parameters.
create_spend_program Write

Create a spend program

Lua path
app.integrations.ramp.create_spend_program
Full name
ramp.ramp_post_spend_program_resource
ParameterTypeRequiredDescription
No parameters.
fetch_spend_program Read

Fetch a spend program

Lua path
app.integrations.ramp.fetch_spend_program
Full name
ramp.ramp_get_spend_program_single_resource
ParameterTypeRequiredDescription
No parameters.
fetch_blank_canvas_workflow_nodes_spend_program Read

Fetch blank canvas workflow nodes for a spend program

Lua path
app.integrations.ramp.fetch_blank_canvas_workflow_nodes_spend_program
Full name
ramp.ramp_get_spend_program_workflow_nodes_resource
ParameterTypeRequiredDescription
No parameters.
create_draft_spend_request_via_ocr Write

Requests should be made with `multipart/form-data` content type.

Lua path
app.integrations.ramp.create_draft_spend_request_via_ocr
Full name
ramp.ramp_post_spend_request_draft_via_ocr
ParameterTypeRequiredDescription
No parameters.
list_statements Read

List statements

Lua path
app.integrations.ramp.list_statements
Full name
ramp.ramp_get_statement_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_statement Read

Fetch a statement

Lua path
app.integrations.ramp.fetch_statement
Full name
ramp.ramp_get_statement_resource
ParameterTypeRequiredDescription
No parameters.
create_token Write

Expects two headers: - Authorization header formed from base-64 encoded client credentials as `Authorization: Basic ` - `Content-Type: application/x-www-form-urlencoded` Require...

Lua path
app.integrations.ramp.create_token
Full name
ramp.ramp_post_token
ParameterTypeRequiredDescription
No parameters.
revoke_access_or_refresh_token Write

Expects an authorization header formed from base-64 encoded client credentials as `Authorization: Basic `. Content body must be form-encoded. Example: ``` curl \ -X POST \ -H "A...

Lua path
app.integrations.ramp.revoke_access_or_refresh_token
Full name
ramp.ramp_post_revoke_token
ParameterTypeRequiredDescription
No parameters.
list_transactions Read

This endpoint supports filtering and ordering. If state is not set, all transactions except declined transactions will be returned. Note that setting multiple ordering parameter...

Lua path
app.integrations.ramp.list_transactions
Full name
ramp.ramp_get_transactions_canonical_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_transaction Read

Fetch a transaction

Lua path
app.integrations.ramp.fetch_transaction
Full name
ramp.ramp_get_transaction_canonical_resource
ParameterTypeRequiredDescription
No parameters.
list_transfer_payments Write

For information on how to use this endpoint, refer to the [Transfers Guide](/developer-api/v1/guides/transfers).

Lua path
app.integrations.ramp.list_transfer_payments
Full name
ramp.ramp_get_transfer_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
fetch_transfer_payment Write

For information on how to use this endpoint, refer to the [Transfers Guide](/developer-api/v1/guides/transfers).

Lua path
app.integrations.ramp.fetch_transfer_payment
Full name
ramp.ramp_get_transfer_resource
ParameterTypeRequiredDescription
No parameters.
list_all_trips_business Read

List all trips for the business

Lua path
app.integrations.ramp.list_all_trips_business
Full name
ramp.ramp_get_trip_list_resource
ParameterTypeRequiredDescription
No parameters.
fetch_trip Read

Fetch a trip

Lua path
app.integrations.ramp.fetch_trip
Full name
ramp.ramp_get_trip_single_resource
ParameterTypeRequiredDescription
No parameters.
list_unified_requests_with_pagination Read

NOTE: - Response schema is not finalized and will have breaking changes prior to release - This endpoint _is_ user aware, meaning perm-based filtering is applied to the query

Lua path
app.integrations.ramp.list_unified_requests_with_pagination
Full name
ramp.ramp_get_unified_request_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
get_details_specific_unifiedrequest Read

NOTE: - Response schema is not finalized and will have breaking changes prior to release - This endpoint _is_ user aware, meaning perm-based filtering is applied to the query

Lua path
app.integrations.ramp.get_details_specific_unifiedrequest
Full name
ramp.ramp_get_unified_request_detail_resource
ParameterTypeRequiredDescription
No parameters.
list_users Read

List users

Lua path
app.integrations.ramp.list_users
Full name
ramp.ramp_get_user_list_with_pagination
ParameterTypeRequiredDescription
No parameters.
create_user_invite Write

Call this endpoint to trigger an async task to send out a user invite via email. Users will need to accept the invite in order to be onboarded. Assign a user to a specific entit...

Lua path
app.integrations.ramp.create_user_invite
Full name
ramp.ramp_post_user_creation_deferred_task
ParameterTypeRequiredDescription
No parameters.
fetch_deferred_task_status Read

Fetch deferred task status

Lua path
app.integrations.ramp.fetch_deferred_task_status
Full name
ramp.ramp_get_user_deferred_task_resource
ParameterTypeRequiredDescription
No parameters.
fetch_user Read

Fetch a user

Lua path
app.integrations.ramp.fetch_user
Full name
ramp.ramp_get_user_resource
ParameterTypeRequiredDescription
No parameters.
update_user Write

Update a user

Lua path
app.integrations.ramp.update_user
Full name
ramp.ramp_patch_user_resource
ParameterTypeRequiredDescription
No parameters.
deactivate_user Write

When users are deactivated, they will no longer be able to log in, spend on cards, or receive any notifications from Ramp.

Lua path
app.integrations.ramp.deactivate_user
Full name
ramp.ramp_patch_user_deactivation_resource
ParameterTypeRequiredDescription
No parameters.
manage_user_invite_lifecycle Write

Performs one of three actions against a draft user, delegating to the Identity-owned invite / scheduled-invitation services: - `SCHEDULE`: Create or update a scheduled invitatio...

Lua path
app.integrations.ramp.manage_user_invite_lifecycle
Full name
ramp.ramp_post_user_invite_action_resource
ParameterTypeRequiredDescription
No parameters.
reactivate_user Write

Upon reactivation, users can log in to Ramp again, spend on their previously issued cards and resume receiving Ramp notifications.

Lua path
app.integrations.ramp.reactivate_user
Full name
ramp.ramp_patch_user_reactivation_resource
ParameterTypeRequiredDescription
No parameters.
create_spend_limit_and_retrieve_sensitive_card_details Write

Vault API access is required to use this endpoint.

Lua path
app.integrations.ramp.create_spend_limit_and_retrieve_sensitive_card_details
Full name
ramp.ramp_post_card_vault_creation
ParameterTypeRequiredDescription
No parameters.
fetch_card_sensitive_details Read

Accepts a card's ID and returns its sensitive details. Vault API access is required to use this endpoint.

Lua path
app.integrations.ramp.fetch_card_sensitive_details
Full name
ramp.ramp_get_card_vault_resource
ParameterTypeRequiredDescription
No parameters.
list_vendors Read

List vendors

Lua path
app.integrations.ramp.list_vendors
Full name
ramp.ramp_get_vendor_list_resource
ParameterTypeRequiredDescription
No parameters.
create_new_vendor Write

Vendors created in the API are approved by default, and are not subject to existing approval policies.

Lua path
app.integrations.ramp.create_new_vendor
Full name
ramp.ramp_post_vendor_list_resource
ParameterTypeRequiredDescription
No parameters.
list_vendor_agreements Write

List vendor agreements

Lua path
app.integrations.ramp.list_vendor_agreements
Full name
ramp.ramp_post_vendor_agreement_list_resource
ParameterTypeRequiredDescription
No parameters.
delete_vendor_agreement Write

Delete a vendor agreement

Lua path
app.integrations.ramp.delete_vendor_agreement
Full name
ramp.ramp_delete_vendor_agreement_resource
ParameterTypeRequiredDescription
No parameters.
fetch_vendor_agreement Read

Fetch a vendor agreement

Lua path
app.integrations.ramp.fetch_vendor_agreement
Full name
ramp.ramp_get_vendor_agreement_resource
ParameterTypeRequiredDescription
No parameters.
update_vendor_agreement Write

Update a vendor agreement

Lua path
app.integrations.ramp.update_vendor_agreement
Full name
ramp.ramp_patch_vendor_agreement_resource
ParameterTypeRequiredDescription
No parameters.
upload_documents_vendor_agreement Write

This endpoint accepts the [multipart/form-data](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) format. Include each agreement file as a repeated `documents` par...

Lua path
app.integrations.ramp.upload_documents_vendor_agreement
Full name
ramp.ramp_post_vendor_agreement_document_upload_resource
ParameterTypeRequiredDescription
No parameters.
list_all_vendor_credits_all_vendors_business Read

List all vendor credits for all vendors of a business

Lua path
app.integrations.ramp.list_all_vendor_credits_all_vendors_business
Full name
ramp.ramp_get_all_vendor_credits_list
ParameterTypeRequiredDescription
No parameters.
fetch_vendor_credit Read

Fetch a vendor credit

Lua path
app.integrations.ramp.fetch_vendor_credit
Full name
ramp.ramp_get_vendor_credit_detail
ParameterTypeRequiredDescription
No parameters.
delete_vendor Write

A vendor cannot be deleted if it has associated transactions, bills, contracts, or spend requests.

Lua path
app.integrations.ramp.delete_vendor
Full name
ramp.ramp_delete_vendor_resource
ParameterTypeRequiredDescription
No parameters.
fetch_vendor Read

Fetch a vendor

Lua path
app.integrations.ramp.fetch_vendor
Full name
ramp.ramp_get_vendor_resource
ParameterTypeRequiredDescription
No parameters.
update_vendor Write

Update a vendor

Lua path
app.integrations.ramp.update_vendor
Full name
ramp.ramp_patch_vendor_resource
ParameterTypeRequiredDescription
No parameters.
list_vendor_bank_accounts Read

List vendor bank accounts

Lua path
app.integrations.ramp.list_vendor_bank_accounts
Full name
ramp.ramp_get_vendor_bank_account_list_resource
ParameterTypeRequiredDescription
No parameters.
fetch_vendor_bank_account Read

Fetch a vendor bank account

Lua path
app.integrations.ramp.fetch_vendor_bank_account
Full name
ramp.ramp_get_vendor_bank_account_resource
ParameterTypeRequiredDescription
No parameters.
archive_vendor_bank_account Write

If the bank account has associated bills, drafts, or recurring templates, a replacement_bank_account_id must be provided in the request body.

Lua path
app.integrations.ramp.archive_vendor_bank_account
Full name
ramp.ramp_post_vendor_bank_account_archive_resource
ParameterTypeRequiredDescription
No parameters.
create_vendor_agreement Write

Create a vendor agreement

Lua path
app.integrations.ramp.create_vendor_agreement
Full name
ramp.ramp_post_vendor_agreement_create_resource
ParameterTypeRequiredDescription
No parameters.
list_vendor_contacts_vendor Read

List vendor contacts for vendor

Lua path
app.integrations.ramp.list_vendor_contacts_vendor
Full name
ramp.ramp_get_vendor_contact_list_resource
ParameterTypeRequiredDescription
No parameters.
fetch_vendor_contact Read

Fetch a vendor contact

Lua path
app.integrations.ramp.fetch_vendor_contact
Full name
ramp.ramp_get_vendor_contact_resource
ParameterTypeRequiredDescription
No parameters.
list_vendor_credits_by_vendor Read

List vendor credits by vendor

Lua path
app.integrations.ramp.list_vendor_credits_by_vendor
Full name
ramp.ramp_get_vendor_credits_list
ParameterTypeRequiredDescription
No parameters.
add_vendor_bank_account_details Write

Adds payment details for the vendor through the approval workflow. The proposal may require approval depending on the business's approval policies. Supported payment methods: - ...

Lua path
app.integrations.ramp.add_vendor_bank_account_details
Full name
ramp.ramp_post_vendor_bank_account_update_resource
ParameterTypeRequiredDescription
No parameters.
get_all_webhook_subscriptions Read

Get all webhook subscriptions

Lua path
app.integrations.ramp.get_all_webhook_subscriptions
Full name
ramp.ramp_get_outbound_webhook_subscription_resource
ParameterTypeRequiredDescription
No parameters.
creates_new_webhook_subscription Write

The newly registered subscription will be in the pending verficiation state. You will need to verify your endpoint with the provided challenge.

Lua path
app.integrations.ramp.creates_new_webhook_subscription
Full name
ramp.ramp_post_outbound_webhook_subscription_resource
ParameterTypeRequiredDescription
No parameters.
create_mock_webhook_event_active_subscriptions_matching_event_type Write

Create a mock webhook event for active subscriptions matching the event type

Lua path
app.integrations.ramp.create_mock_webhook_event_active_subscriptions_matching_event_type
Full name
ramp.ramp_post_mock_outbound_webhook_event_resource
ParameterTypeRequiredDescription
No parameters.
delete_webhook_subscription_by_id Write

Delete a webhook subscription by id

Lua path
app.integrations.ramp.delete_webhook_subscription_by_id
Full name
ramp.ramp_delete_outbound_webhook_subscription_detail_resource
ParameterTypeRequiredDescription
No parameters.
get_webhook_subscription_by_id Read

Get a webhook subscription by id

Lua path
app.integrations.ramp.get_webhook_subscription_by_id
Full name
ramp.ramp_get_outbound_webhook_subscription_detail_resource
ParameterTypeRequiredDescription
No parameters.
verify_webhook_subscription Write

Verify a webhook subscription

Lua path
app.integrations.ramp.verify_webhook_subscription
Full name
ramp.ramp_post_outbound_webhook_subscription_verify_resource
ParameterTypeRequiredDescription
No parameters.