View as Markdown
UpKeep icon

UpKeep ACTION

Create Purchase Order

Create a Purchase Order, See the docs
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's UpKeep account once, then configure and run Create Purchase Order 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: "upkeep-create-purchase-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upkeep: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    vendorId: "Vendor",
  },
})

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.

Create Purchase Order inputs
Property Type Description
title Title string
Title of the purchase order
Required
vendorId Vendor string
The ID of the vendor
Optional
categoryId Category string
The category of the purchase order.
Optional Dynamic
purchaseOrderNumber Purchase Order Number string
Set a custom purchase order number. If not passed, the default one from settings will be used.
Optional
description Purchase Order Description string
Description of the purchase order
Optional
dueDate Due Date string
Due date, in yyyy-MM-dd format, e.g. 2018-06-30
Optional
poDate Purchase Order Date string
Date of purchase order, in yyyy-MM-dd format, e.g. 2018-06-28
Optional
parts Parts string[]
An array of Part IDs to include with the purchase order
Optional Dynamic
respectivePartQuantityUsed Respective Part Quantities integer[]
The respective quantities of each part included in the parts array
Optional
otherFields Other Fields object
The fields does not exist in this integration. Please see (docs)[https://developers.onupkeep.com/#purchase-orders] for more fields, e.g. {"companyCity":"Los Angeles","companyState":"California","companyZip":"90224"}
Optional
customFieldsPO Custom Fields string[]
A list of custom fields of the purchase order. Its child attributes are name, value, and unit, e.g. {"name": "SAPPONumber","value": "110-235"}
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
upkeep-create-purchase-order
Version
0.0.3
App
UpKeep
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes