Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Expenses and cards API

5 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

spend.current

List the connected spend platform and what it may read

POST/api/v1/manage/spend/current

const result = await shuffl.spend.current();
Request fields (none)

This operation takes no input.

Response object
  • catalog object[] required
    • blurb string required
    • docsHref string required
    • fields object[] required
      • help string optional
      • id string required
      • label string required
      • optional true optional
      • options object[] optional
        • label string required
        • value string required
      • secret true optional
    • id "brex" | "ramp" required
    • name string required
    • steps string[] required
  • connections object[] required
    • capabilities "limits" | "programs"[] required
    • createdAt string required
    • id string required
    • label string required
    • lastUsedAt null | string required
    • policyDraftedAt null | string required
    • policySourceId null | string required
    • provider string required
    • providerName string required
    • sandbox boolean required
    • status "connected" | "disconnected" | "needs_attention" required

spend.mine

Read the company’s spend programs and your own cards and limits

POST/api/v1/manage/spend/mine

const result = await shuffl.spend.mine();
Request fields (none)

This operation takes no input.

Response object

The response is object.

spend.programs

Read the spend programs as the spend platform holds them now

POST/api/v1/manage/spend/programs

const result = await shuffl.spend.programs({
  "connectionId": "<connectionId>"
});
Request fields (1)
  • connectionId string required
Response object
  • asOf string required
  • programs object[] required
    • allowedCategories string[] required
    • blockedCategories string[] required
    • card null | false | true required
    • description null | string required
    • id string required
    • interval null | "daily" | "monthly" | "quarterly" | "total" | "weekly" | "yearly" required
    • limit null | object required
      • amount number required
      • currency string required
    • limitLabel null | string required
    • name string required
    • reimbursements null | false | true required
    • transactionLimit null | object required
      • amount number required
      • currency string required
    • transactionLimitLabel null | string required

spend.disconnect

Disconnect the spend platform; Mello stops reading it at once

POST/api/v1/manage/spend/disconnect

  • Write
  • Permission spend.disconnect
  • Needs a requestKey
  • Needs confirm set to spend.disconnect
const result = await shuffl.spend.disconnect({
  "connectionId": "<connectionId>",
  "confirm": "spend.disconnect",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • connectionId string required
  • confirm "spend.disconnect" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • catalog object[] required
      • blurb string required
      • docsHref string required
      • fields object[] required
        • help string optional
        • id string required
        • label string required
        • optional true optional
        • options object[] optional
        • secret true optional
      • id "brex" | "ramp" required
      • name string required
      • steps string[] required
    • connections object[] required
      • capabilities "limits" | "programs"[] required
      • createdAt string required
      • id string required
      • label string required
      • lastUsedAt null | string required
      • policyDraftedAt null | string required
      • policySourceId null | string required
      • provider string required
      • providerName string required
      • sandbox boolean required
      • status "connected" | "disconnected" | "needs_attention" required

spend.draftPolicy

Draft the spending policy page in Knowledge from the spend programs

POST/api/v1/manage/spend/draftPolicy

  • Write
  • Permission spend.draftPolicy
  • Needs a requestKey
  • Needs confirm set to spend.draftPolicy
const result = await shuffl.spend.draftPolicy({
  "connectionId": "<connectionId>",
  "confirm": "spend.draftPolicy",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • connectionId string required
  • confirm "spend.draftPolicy" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • programs number required
    • sourceId string required
    • title string required