View as Markdown
Business Edge icon

Business Edge ACTION

Get Customers

Retrieve customers from Business Edge via POST /masterfiles/customerV3/export.json. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Business Edge account once, then configure and run Get Customers from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "business_edge-get-customers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    business_edge: { authProvisionId: "apn_xxxxxxx" },
    entity: "Entity",
    dateFormatOpt: "Date Format (DateFormatOpt)",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Customers inputs
Property Type Description
entity Entity string
Entity for this request. Options load from customer V3 args.json when available; otherwise numeric codes 1–20 are shown (configurable fallback).
Required Dynamic
dateFormatOpt Date Format (DateFormatOpt) string
A=mm-dd-yy; B=yy-mm-dd; C=yyyy-mm-dd; D=mmddyy; E=yymmdd; F=yyyymmdd; G=dd-mm-yy; H=ddmmyy
Optional
dateDelim Date Delimiter (DateDelim) string
Optional delimiter used with formatted dates in the API request
Optional
savedSchemaId Saved Schema ID (SavedSchemaID) string
Optional saved API schema ID for returned data (use with or instead of schema code)
Optional
savedSchemaCode Saved Schema Code (SavedSchemaCode) string
Optional saved API schema code for returned data (use with or instead of schema ID)
Optional
availBom Include Bill of Materials in Available (AvailBOM) boolean
When true, include bill of materials in availability-related export output
Optional
chooseOne Choose One (ChooseOne) object
Send Search, List, and/or Range per API rules (Range overrides search and list). Example: { "Search": "ACME" } or { "Range": { "CustBeg": "", "CustEnd": "", "CustSeq": "B" } }
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
business_edge-get-customers
Version
0.0.3
App
Business Edge
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes