The ramp connector reads a company's spend from Ramp. It runs Airbyte's Ramp connector definition inside the SDK.
| Connector name | ramp |
| Products | Records |
| Credentials | The portal's Connect button, or a Ramp developer app's client id and secret |
| Definition | Airbyte's source-ramp manifest, version 1.0.1 (Elastic License 2.0) |
| Status | Preview: tested against Ramp's documented responses, not yet on a live account |
What it pulls
By default: transaction, reimbursement, bill, receipt, purchase_order, user, department, location, entity and vendor. Add card, merchant, spend_program, fund, vendor_contact, vendor_agreement or business with objects.
Cardholder and employee names are replaced by tokens on your machine before anything is sent.
Credentials
In Ramp, open Company → Developer → Create new app, choose the Client Credentials grant, and grant the read scopes for what you want to send: transactions:read, reimbursements:read, bills:read, receipts:read, purchase_orders:read, cards:read, users:read, departments:read, locations:read, entities:read, vendors:read. If a scope is missing, the run stops with a message naming it: add the scope, or leave that type out of objects.
Or skip the tokens: click Connect next to Ramp in the portal (Settings → Connected systems), then run datayield connect ramp --broker.
Connect
datayield connect ramp -o clientId=<client id> -o clientSecret=env:RAMP_SECRETOptions
| Option | Required | Meaning |
|---|---|---|
clientId, clientSecret |
yes | The app's credentials. The secret is stored as a secret. |
environment |
no | production (default) or sandbox |
apiUrl |
no | Another API address, such as a proxy |
startDate |
no | Where the first run starts |
objects |
no | Record types to pull |
New records on each run
Transactions and reimbursements are read by their updated time, and receipts by created time, between the last successful run and now. Bills and purchase orders are kept when created inside the window; a bill edited later is not sent again. People, departments, locations, entities and vendors are sent whole each run.