---
canonical_url: "https://docs.composio.dev/toolkits/zip"
markdown_url: "https://docs.composio.dev/toolkits/zip.md"
product: "platform"
version: null
last_updated: null
---

# Zip

Zip is an AI procurement orchestration platform for managing purchasing, approvals, suppliers, contracts, invoices, and spend from intake to payment.

- **Category:** accounting
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 161
- **Triggers:** 0
- **Slug:** `ZIP`
- **Version:** 00000000_00

## Tools

### Archive an item receipt

**Slug:** `ZIP_ARCHIVE_ITEM_RECEIPT`

Archive an item receipt. Archives a submitted receipt or return, the same way archiving works in Zip. An archived receipt no longer counts toward three-way match, and allocation to matched bills runs again without it. Fails if the receipt backs a bill that has already been paid. This is a status change, not a delete. On success, the archived item receipt is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `item_receipt_id` | string | Yes | Identifier for `itemReceiptId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create address

**Slug:** `ZIP_CREATE_ADDRESS`

Create a vendor or company address in Zip from structured address fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a comment

**Slug:** `ZIP_CREATE_COMMENT`

Create a comment or reply to an existing comment on Zip's request details page (RDP).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a delegation

**Slug:** `ZIP_CREATE_DELEGATION`

Create a delegation. Create an out-of-office delegation. The delegator's approval responsibilities will be transferred to the delegate for the specified date range. Only one active (unexpired) delegation is allowed per delegator. Circular delegations (A delegates to B who delegates back to A) are not allowed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delegation` | object | Yes | Out-of-office delegation fields: delegator ID, delegate ID, start date, end date, timezone, and optional note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a department

**Slug:** `ZIP_CREATE_DEPARTMENT`

Create a department in Zip with its name, display name, active status, and visibility settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department` | object | No | Department fields to create: name, display name, active status, and Zip visibility. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an invoice from e-invoice XML

**Slug:** `ZIP_CREATE_E_INVOICE`

Create an invoice from an e-invoice payload. Send XML with `application/xml` or `text/xml`, or send the documented JSON form with `application/json` when supplying an optional PDF. Set `provider` only for invoices processed through Zip's billable provider agreement, and set `jurisdiction=FR` only with explicit France routing context; neither value is inferred from the payload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | No | Optional Zip partner provider. Set only for invoices processed through Zip's billable provider agreement. Leave blank for bring-your-own-provider integrations. |
| `content_type` | string ("application/xml" | "text/xml" | "application/json") | No | Media type used for the request body. Defaults to the documented JSON media type; set an XML media type when sending XML. |
| `jurisdiction` | string | No | Optional trusted routing jurisdiction, independent of `provider`. The only currently supported value is `FR`, including when `provider` is omitted. |
| `request_body` | string | No | Request payload matching the schema selected by `content_type`. |
| `inbound_provider_document_id` | string | No | Original inbound provider document ID, preserved exactly. Must be nonblank, contain no null characters, and match the JSON body value if both are supplied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an expense category

**Slug:** `ZIP_CREATE_EXPENSE_CATEGORY`

Create an expense category in Zip with its accounting and active-status fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expense_category` | object | No | Expense category fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create GL code

**Slug:** `ZIP_CREATE_GL_CODE`

Create a GL account in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | GL account fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an invoice

**Slug:** `ZIP_CREATE_INVOICE`

Create an invoice. Creates a new draft bill invoice with the specified details and initializes its approval workflow. The invoice can optionally be matched to one or more purchase orders by providing either purchase_order_ids or purchase_order_numbers. On success, the created invoice is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add invoice line items

**Slug:** `ZIP_CREATE_INVOICE_LINE_ITEMS`

Add multiple line items to an existing bill invoice by invoice ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | No | Request body field `data` as documented by Zip. |
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create item account

**Slug:** `ZIP_CREATE_ITEM_ACCOUNT`

Create an item-account lookup record in Zip from the supplied account fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Item account fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an item receipt

**Slug:** `ZIP_CREATE_ITEM_RECEIPT`

Create an item receipt. Creates a receipt or a return against one purchase order, already submitted. Each line must name a line on that purchase order that requires receiving, at most once, with quantity for a quantity line or total_amount for an amount line. Allocation to matched bills runs after the receipt is saved, as it does for receipts submitted in Zip. Purchase orders that receive in an ERP are rejected. On success, the created item receipt is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create location

**Slug:** `ZIP_CREATE_LOCATION`

Create a company location in Zip with a name and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location` | object | No | Location fields to create: name and status (0 INITIAL, 1 ACTIVE, or 3 DELETED). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create look up type

**Slug:** `ZIP_CREATE_LOOKUP`

Create a lookup type in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Lookup type fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a lookup option

**Slug:** `ZIP_CREATE_LOOKUP_OPTION`

Create a lookup option in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Lookup option fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a product

**Slug:** `ZIP_CREATE_PRODUCT`

Create a product in Zip with its required name and optional product metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product` | object | Yes | Product fields to create; product name is required when this object is supplied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create main queue

**Slug:** `ZIP_CREATE_QUEUE`

Create a main approval queue in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a risk assessment

**Slug:** `ZIP_CREATE_RISK_ASSESSMENT`

Record a completed or canceled risk assessment performed outside Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Completed or canceled risk assessment to record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a role

**Slug:** `ZIP_CREATE_ROLE`

Create an organization role in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | object | No | Role fields to create, including the role name and description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a saving line item

**Slug:** `ZIP_CREATE_SAVING_LINE_ITEM`

Add a saving line item to an existing Zip purchase request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body for creating a saving line item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create subqueue

**Slug:** `ZIP_CREATE_SUBQUEUE_BY_MAIN_QUEUE_ID`

Create subqueue. Creates a subqueue on a main queue by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |
| `queue_id` | string | Yes | Identifier for `queueId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a subsidiary

**Slug:** `ZIP_CREATE_SUBSIDIARY`

Create an organization subsidiary in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subsidiary` | object | No | Subsidiary fields to create, including name, active status, and external identifiers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a tax code

**Slug:** `ZIP_CREATE_TAX_CODE`

Create a tax code in Zip with its name, type, active status, and accounting fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_code` | object | No | Tax code fields to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a user

**Slug:** `ZIP_CREATE_USER`

Create a user in Zip; this API operation requires a Zip Premier subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | User fields to create, including email, first name, last name, and organization assignments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create vendor contact

**Slug:** `ZIP_CREATE_VENDOR_CONTACT`

Create a contact for a vendor in Zip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a vendor credit

**Slug:** `ZIP_CREATE_VENDOR_CREDIT`

Create a vendor credit. Creates a new uncoded vendor credit with the specified details and initializes its approval workflow. On success, the created vendor credit is returned. This endpoint must be enabled for your organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add vendor credit line items

**Slug:** `ZIP_CREATE_VENDOR_CREDIT_LINE_ITEMS`

Add multiple line items to an existing Zip vendor credit; this endpoint must be enabled for the organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | No | Request body field `data` as documented by Zip. |
| `vendor_credit_id` | string | Yes | Identifier for `vendorCreditId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a vendor item

**Slug:** `ZIP_CREATE_VENDOR_ITEM`

Create a vendor item in Zip from the supplied item fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a vendor item group

**Slug:** `ZIP_CREATE_VENDOR_ITEM_GROUP`

Create a vendor item group in Zip from the supplied group fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a vendor site

**Slug:** `ZIP_CREATE_VENDOR_SITE`

Create a vendor site in Zip with the supplied site attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivates user by ID

**Slug:** `ZIP_DEACTIVATE_USER`

Destructive, high-impact operation that deactivates a Zip user's access and may require reassignment of their work; it does not delete the user record. Verify the user ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Identifier for `userId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a comment

**Slug:** `ZIP_DELETE_COMMENT`

Delete a Zip comment by its GUID on behalf of the specified user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_user` | string | Yes | The GUID of the user who is deleting the comment. |
| `comment_id` | string | Yes | The GUID of the comment to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a delegation

**Slug:** `ZIP_DELETE_DELEGATION`

Delete a delegation. Soft-delete a delegation by setting its end date to yesterday. This is the same operation as the "End Now" and "Delete" actions in the Zip UI. The delegation's status will become EXPIRED and any currently delegated approvals will be reassigned back to the original delegator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delegation_id` | string | Yes | ID of the delegation to end. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete department by ID

**Slug:** `ZIP_DELETE_DEPARTMENT_BY_ID`

Delete a single department from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department_id` | string | Yes | Identifier for `departmentId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete expense category by ID

**Slug:** `ZIP_DELETE_EXPENSE_CATEGORY_BY_ID`

Delete an expense category from Zip so it can no longer be used for expense classification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expense_category_id` | string | Yes | ID of the expense category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete location by ID

**Slug:** `ZIP_DELETE_LOCATION_BY_ID`

Delete a company location from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | string | Yes | Identifier for `locationId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete lookup by ID

**Slug:** `ZIP_DELETE_LOOKUP_BY_ID`

Delete a Zip lookup type by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_id` | string | Yes | ID of the lookup type to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete lookup option by ID

**Slug:** `ZIP_DELETE_LOOKUP_OPTION_BY_ID`

Delete a Zip lookup option by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_option_id` | string | Yes | ID of the lookup option to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an option filter rule by rule ID

**Slug:** `ZIP_DELETE_OPTION_FILTER_RULE`

Delete a Zip option filter rule by its client-provided rule ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | Unique client-provided rule ID; it cannot be blank or whitespace-only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete queue by Id

**Slug:** `ZIP_DELETE_QUEUE_BY_ID`

Delete a main queue or subqueue from Zip by queue ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queue_id` | string | Yes | Identifier for `queueId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete role by ID

**Slug:** `ZIP_DELETE_ROLE_BY_ID`

Delete a single organization role from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Identifier for `roleId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a saving line item

**Slug:** `ZIP_DELETE_SAVING_LINE_ITEM`

Delete the purchase-request saving line item identified by `saving_line_item_id`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `saving_line_item_id` | string | Yes | Identifier for the saving line item as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete subsidiary by ID

**Slug:** `ZIP_DELETE_SUBSIDIARY_BY_ID`

Delete a single organization subsidiary from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subsidiary_id` | string | Yes | Identifier for `subsidiaryId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete tax code by ID

**Slug:** `ZIP_DELETE_TAX_CODE_BY_ID`

Delete a tax code from Zip by ID so it is no longer available for tax classification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_code_id` | string | Yes | ID of the tax code to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete vendor by ID

**Slug:** `ZIP_DELETE_VENDOR_BY_ID`

Delete a single vendor from Zip by vendor ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_id` | string | Yes | Identifier for `vendorId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get agent session by ID

**Slug:** `ZIP_GET_AGENT_SESSION_BY_ID`

Get metadata for an agent session when Superagents is enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Agent session identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get agreement by ID

**Slug:** `ZIP_GET_AGREEMENT_BY_ID`

Retrieve one Zip agreement when its `agreement_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agreement_id` | string | Yes | Identifier for the agreement as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get amortization schedule by ID

**Slug:** `ZIP_GET_AMORTIZATION_SCHEDULE_BY_ID`

Retrieve one Zip amortization schedule when its `amortization_schedule_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amortization_schedule_id` | string | Yes | Identifier for the amortization schedule as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a change order by ID

**Slug:** `ZIP_GET_CHANGE_ORDER_BY_ID`

Get a change order by ID. Returns the changed header fields and created, deleted, and updated purchase order lines for a change order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `change_order_id` | string | Yes | Identifier for `changeOrderId` as documented by Zip. |
| `field_type_options` | array | Yes | Selects which groups of changed fields to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a delegation by ID

**Slug:** `ZIP_GET_DELEGATION`

Retrieve one out-of-office approval delegation from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delegation_id` | string | Yes | ID of the delegation to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get department by ID

**Slug:** `ZIP_GET_DEPARTMENT_BY_ID`

Retrieve one Zip department and its organization settings by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department_id` | string | Yes | Identifier for `departmentId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get document by ID

**Slug:** `ZIP_GET_DOCUMENT_BY_ID`

Download a Zip document as a PDF file reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get expense category by ID

**Slug:** `ZIP_GET_EXPENSE_CATEGORY_BY_ID`

Retrieve one Zip expense category and its accounting settings by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expense_category_id` | string | Yes | ID of the expense category to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GL code by ID

**Slug:** `ZIP_GET_GL_CODE_BY_ID`

Retrieve a GL account lookup from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gl_code_id` | string | Yes | ID of the GL account to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get invoice by ID

**Slug:** `ZIP_GET_INVOICE_BY_ID`

Get invoice by ID. Retrieves a single bill invoice by its ID, including its custom attributes and line items with their attributes. Use the line_items_count_only parameter to return just the line item count instead of the full line items array for better performance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |
| `line_items_count_only` | boolean | No | If true, returns only the count of line items instead of the full line items array. This can improve performance for invoices with many line items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get invoice cXML

**Slug:** `ZIP_GET_INVOICE_CXML`

Get invoice cXML. Retrieves the raw cXML payload for a punchout invoice. Returns the most recent cXML message associated with the invoice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | The GUID of the invoice to retrieve cXML for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get item account by ID

**Slug:** `ZIP_GET_ITEM_ACCOUNT_BY_ID`

Retrieve one Zip item-account lookup record when its `item_account_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_account_id` | string | Yes | ID of the item account to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an item receipt by ID

**Slug:** `ZIP_GET_ITEM_RECEIPT_BY_ID`

Retrieve one Zip item receipt when its `item_receipt_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_receipt_id` | string | Yes | Identifier for `itemReceiptId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lookup by ID

**Slug:** `ZIP_GET_LOOKUP_BY_ID`

Retrieve a Zip lookup type by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_id` | string | Yes | ID of the lookup type to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lookup option by ID

**Slug:** `ZIP_GET_LOOKUP_OPTION_BY_ID`

Retrieve a Zip lookup option by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_option_id` | string | Yes | ID of the lookup option to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an option filter rule by rule ID

**Slug:** `ZIP_GET_OPTION_FILTER_RULE`

Retrieve a Zip option filter rule by its client-provided rule ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | Unique client-provided rule ID; it cannot be blank or whitespace-only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get payment method by ID

**Slug:** `ZIP_GET_PAYMENT_METHOD_BY_ID`

Retrieve a Zip payment method by ID, optionally including sensitive or deleted data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_deleted` | boolean | No | Whether to include a soft-deleted payment method. |
| `payment_method_id` | string | Yes | ID of the payment method to retrieve. |
| `show_sensitive_data` | boolean | No | Whether to include sensitive payment method fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get payment terms by ID

**Slug:** `ZIP_GET_PAYMENT_TERMS_BY_ID`

Retrieve one Zip payment-terms record when its `payment_terms_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_terms_id` | string | Yes | ID of the payment terms to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get payout by ID

**Slug:** `ZIP_GET_PAYOUT_BY_ID`

Retrieve a single Zip payout by payout ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payout_id` | string | Yes | Identifier for `payoutId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get products by IDs

**Slug:** `ZIP_GET_PRODUCTS_BY_IDS`

Retrieve multiple Zip product records in one call from a list of product IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_ids` | array | Yes | IDs of the products to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a purchase order by ID

**Slug:** `ZIP_GET_PURCHASE_ORDER_BY_ID`

Retrieve one Zip purchase order when its `purchase_order_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `purchase_order_id` | string | Yes | Identifier for `purchaseOrderId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get queue by ID

**Slug:** `ZIP_GET_QUEUE_BY_ID`

Retrieve a main queue or subqueue from Zip by queue ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queue_id` | string | Yes | Identifier for `queueId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single purchase request

**Slug:** `ZIP_GET_REQUEST_BY_ID`

Retrieve a single Zip purchase request by request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Identifier for `requestId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a request' questionnaire responses

**Slug:** `ZIP_GET_REQUEST_QUESTIONNAIRE_RESPONSES`

Retrieve questionnaire responses for a Zip purchase request by request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Identifier for `requestId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get risk assessment by ID

**Slug:** `ZIP_GET_RISK_ASSESSMENT_BY_ID`

Retrieve one Zip risk assessment by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `risk_assessment_id` | string | Yes | ID of the risk assessment to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get risk assessment fields schema

**Slug:** `ZIP_GET_RISK_ASSESSMENT_SCHEMA`

List the active custom fields on Zip risk assessments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get role by ID

**Slug:** `ZIP_GET_ROLE_BY_ID`

Retrieve one organization role from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Identifier for `roleId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get saving line item by ID

**Slug:** `ZIP_GET_SAVING_LINE_ITEM_BY_ID`

Retrieve one purchase-request saving line item when its `saving_line_item_id` is already known.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `saving_line_item_id` | string | Yes | Identifier for the saving line item as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get subsidiary by ID

**Slug:** `ZIP_GET_SUBSIDIARY_BY_ID`

Retrieve one organization subsidiary from Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subsidiary_id` | string | Yes | Identifier for `subsidiaryId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a tax code

**Slug:** `ZIP_GET_TAX_CODE`

Retrieve one Zip tax code and its tax-classification settings by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_code_id` | string | Yes | ID of the tax code to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user by ID

**Slug:** `ZIP_GET_USER_BY_ID`

Retrieve one Zip user and their organization assignments by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Identifier for `userId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user group by ID

**Slug:** `ZIP_GET_USER_GROUP_BY_ID`

Retrieve one Zip user group by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_group_id` | string | Yes | Identifier for `userGroupId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor by ID

**Slug:** `ZIP_GET_VENDOR_BY_ID`

Retrieve a single Zip vendor by vendor ID, optionally including risk tiers, assessments, and findings when Risk Orchestration is enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_id` | string | Yes | Identifier for `vendorId` as documented by Zip. |
| `request_id` | string | No | Value for `request_id` as documented by Zip. |
| `include_risk_data` | boolean | No | Include inherent and residual risk tiers, associated risk assessments, and risk findings. These fields are returned only when Risk Orchestration is enabled for the company and the caller can read risk assessments. Otherwise they are omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor credit by ID

**Slug:** `ZIP_GET_VENDOR_CREDIT_BY_ID`

Retrieve a single Zip vendor credit by vendor-credit ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_credit_id` | string | Yes | Identifier for `vendorCreditId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor item groups by IDs

**Slug:** `ZIP_GET_VENDOR_ITEM_GROUPS_BY_IDS`

Retrieve multiple Zip vendor item groups by their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `guids` | array | Yes | The IDs of the vendor item groups to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor items by IDs

**Slug:** `ZIP_GET_VENDOR_ITEMS_BY_IDS`

Retrieve multiple Zip vendor items by their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `guids` | array | Yes | The IDs of the vendor items to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor site by ID

**Slug:** `ZIP_GET_VENDOR_SITE_BY_ID`

Retrieve a single Zip vendor site by site ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | string | Yes | Identifier for `siteId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List messages in an agent session

**Slug:** `ZIP_LIST_AGENT_SESSION_MESSAGES`

List messages in an agent session in chronological order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Agent session identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List agent sessions

**Slug:** `ZIP_LIST_AGENT_SESSIONS`

List one page of agent sessions for a company with Superagents enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "last_active") | No | Field to sort by. |
| `page_size` | string | No | Results per page, maximum 100. Omit or pass an empty string for the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; an empty string uses the server default. |
| `created_after` | integer | No | Filter for sessions created after this epoch timestamp. |
| `created_before` | integer | No | Filter for sessions created before this epoch timestamp. |
| `last_active_after` | integer | No | Filter for sessions active after this epoch timestamp. |
| `last_active_before` | integer | No | Filter for sessions active before this epoch timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List change orders

**Slug:** `ZIP_LIST_CHANGE_ORDERS`

List change orders. Returns submitted change orders with their changed header fields and created, deleted, and updated purchase order lines. A change order is included even when the selected field groups contain no changes. Results are returned in pages of up to 50.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Omit for the first page. For later pages, pass the previous response's `next_page_token`. |
| `field_type_options` | array | Yes | Selects which groups of changed fields to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List currencies

**Slug:** `ZIP_LIST_CURRENCIES`

List currencies supported by the connected Zip company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List engagements

**Slug:** `ZIP_LIST_ENGAGEMENTS`

List one page of the company's active and inactive Zip engagements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | string | No | Results per page, maximum 100. Omit or pass an empty string for the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `include_attributes` | boolean | No | Include each engagement's attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get line items

**Slug:** `ZIP_LIST_LINE_ITEMS`

Get line items. Query an invoice's line items with filters and pagination. Results are ordered by created_at in ascending order (oldest first).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | No | Filter line items by invoice GUID. |
| `page_limit` | integer | No | Maximum number of items to return per page. |
| `page_offset` | integer | No | Number of items to skip for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all available purchase categories

**Slug:** `ZIP_LIST_PURCHASE_CATEGORIES`

List all purchase categories defined in the company's Zip settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List risk assessments

**Slug:** `ZIP_LIST_RISK_ASSESSMENTS`

List the company's risk assessments, optionally filtered by vendor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | string | No | Results per page, up to 100; empty uses the server default. |
| `vendor_id` | string | No | Only return risk assessments for this vendor ID. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `include_attributes` | boolean | No | Include custom fields for each risk assessment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List risk levels

**Slug:** `ZIP_LIST_RISK_LEVELS`

List the company's risk tiers from highest to lowest risk.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List vendor payment methods

**Slug:** `ZIP_LIST_VENDOR_PAYMENT_METHODS`

Retrieve a vendor's payment methods, optionally including sensitive or deleted records and filtering by status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | Filter by status. Can be specified multiple times to filter by multiple statuses. When omitted, payment methods of all statuses are returned. |
| `vendor_id` | string | Yes | Identifier for `vendorId` as documented by Zip. |
| `include_deleted` | string | No | When true, deleted payment methods are included. Omitted or empty defaults to false. |
| `show_sensitive_data` | string | No | When true, sensitive payment method fields are included. Omitted or empty defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get vendor roles

**Slug:** `ZIP_LIST_VENDOR_ROLES`

List one page of vendor roles configured for the authenticated organization. This beta feature requires vendor-role listing to be enabled; use returned role IDs when assigning or removing vendor owners.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow Attributes

**Slug:** `ZIP_LIST_WORKFLOW_ATTRIBUTES`

Get Workflow Attributes. Get a schema of configurable attributes given a Zip workflow ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Identifier for `workflowId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflows

**Slug:** `ZIP_LIST_WORKFLOWS`

Get Workflows. Fetch a list of request workflows configured for the company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search agreements

**Slug:** `ZIP_SEARCH_AGREEMENTS`

Search one page of Zip agreements using vendor, subsidiary, or department filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `page_size` | string | No | Results per page, maximum 100. Omit or pass an empty string for the server default. |
| `vendor_id` | string | No | The vendor ID in Zip. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |
| `department_id` | string | No | The department ID in Zip. |
| `subsidiary_id` | string | No | The subsidiary ID in Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search amortization schedules

**Slug:** `ZIP_SEARCH_AMORTIZATION_SCHEDULES`

Search one page of Zip amortization schedules by active status or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The amortization schedule name. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `is_active` | boolean | No | The active status of the amortization schedule. |
| `page_size` | string | No | Results per page, maximum 100. Omit or pass an empty string for the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search approvals

**Slug:** `ZIP_SEARCH_APPROVALS`

Search one page of approvals by request, approval status, node type, date range, or request type; optionally include neighboring approval nodes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8") | No | The status of the approval node: * `0` - "Upcoming", * `1` - "Ready to start", * `2` - "Rejected", * `3` - "Approved", * `4` - "Approved automatically", * `5` - "Canceled", * `6` - "Custom node status with SLA on", * `7` - "Custom node status with SLA off", * `8` - "Custom node status with SLA off" (soon to be deprecated),. |
| `sort_by` | string ("start_time" | "complete_time" | "due_date" | "request_create_time" | "request_number") | No | Sort the approvals by a certain property. |
| `due_after` | integer | No | Query approvals due after a certain epoch timestamp (seconds). |
| `node_type` | string ("NODE" | "GROUP" | "MILESTONE") | No | Query process node with a certain node type. |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `due_before` | integer | No | Query approvals due before a certain epoch timestamp (seconds). |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `config_type` | string ("APPROVAL" | "SEND_EMAIL_ALERT" | "ON_RESOURCE_COMPLETED" | "FINALIZE_VENDOR" | "FINALIZE_PAYMENT" | "FINALIZE_RENEWAL" | "FINALIZE_CONTRACT" | "FINALIZE_DETAILS" | "ON_FORM_COMPLETED" | "ACTION" | "COMPLETE_TASK" | "ON_VENDOR_PORTAL_COMPLETE" | "COLLECT_RESPONSE" | "FINALIZE_AWARD" | "FILL_SURVEY_SCORECARD" | "FILL_PRESENTATION_SCORECARD" | "RSVP" | "PUSH_CHANGE_ORDER_TO_ERP" | "COLLECT_QUESTIONS" | "PUBLISH_ANSWERS" | "REVIEW_CONTRACT_DOCUMENTS" | "REVIEW_RISK" | "SHORTLIST_VENDORS" | "REVIEW_RISK_VENDOR_DEPRECATED" | "EXCEPTION_ACTION") | No | Query process node with a certain config type. |
| `request_type` | array | No | Filter approvals by one or more request types. |
| `started_after` | integer | No | Query approvals started after a certain epoch timestamp (seconds). |
| `updated_after` | integer | No | Query approvals updated after a certain epoch timestamp (seconds). |
| `node_status_id` | string | No | The ID of the custom approval status of the approval node. This only applies to approvals set to a custom status (ie not "Upcoming", "Ready to start" or one of the finalized states). To view your company's custom approval statuses and their ids, visit <your company's subdomain>.ziphq.com/manage/node-status. |
| `request_number` | string | No | The request number which contains the approval node. |
| `started_before` | integer | No | Query approvals started before a certain epoch timestamp (seconds). |
| `completed_after` | integer | No | Query approvals completed after a certain epoch timestamp (seconds). |
| `completed_before` | integer | No | Query approvals completed before a certain epoch timestamp (seconds). |
| `include_neighbors` | boolean | No | When true, includes the predecessors and successors fields on each approval, giving the guid/name/status of its direct predecessor and successor approval nodes in the review chain. Off by default. Requires the organization to have this feature enabled. |
| `request_created_after` | integer | No | Query approvals whose request was submitted after a certain epoch timestamp (seconds). |
| `request_created_before` | integer | No | Query approvals whose request was submitted before a certain epoch timestamp (seconds). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search audit trail logs

**Slug:** `ZIP_SEARCH_AUDIT_LOGS`

Search one page of Zip audit trail events; export requires Zip Premier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `page_size` | string | No | Results per page, maximum 100. Omit or pass an empty string for the server default. |
| `actor_type` | string ("USER" | "MCP" | "SUPER_AGENT" | "API_KEY" | "SYSTEM") | No | Kind of actor behind the event. |
| `creator_id` | string | No | User ID of the event creator. |
| `event_type` | string | No | Event type to query. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |
| `created_after` | integer | No | Filter for events created after this epoch timestamp. |
| `creator_email` | string | No | Creator email; omit or pass an empty string for no filter. |
| `created_before` | integer | No | Filter for events created before this epoch timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search catalog

**Slug:** `ZIP_SEARCH_CATALOG`

Search for vendor items and vendor item groups in the Zip catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed) |
| `sort` | string | No | Field to sort by. |
| `order` | string ("asc" | "desc") | No | Sort order. |
| `statuses` | array | No | Vendor item statuses to match. |
| `page_size` | integer | No | Number of results per page. |
| `search_text` | string | No | Text to search for in the catalog. |
| `object_types` | array | No | Catalog object types to return. |
| `vendor_guids` | array | No | Vendor IDs to match. |
| `category_guids` | array | No | Category IDs to match. |
| `aggregation_only` | boolean | No | Return metadata counts without catalog objects when true. |
| `subsidiary_guids` | array | No | Subsidiary IDs to match. |
| `subcategory_guids` | array | No | Subcategory IDs to match. |
| `vendor_item_group_purchasing_methods` | array | No | Vendor item group purchasing methods to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search comments

**Slug:** `ZIP_SEARCH_COMMENTS`

Search comments belonging to a purchase requisition, optionally filtered by request GUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_guid` | string | No | The guid of the purchase requisition to search comments for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search delegations

**Slug:** `ZIP_SEARCH_DELEGATIONS`

Search delegations. Search delegations with optional filters. Returns delegations for the authenticated organization. Use delegator_email or delegate_email to find delegations for a specific user. Use is_active to filter current vs expired delegations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `is_active` | boolean | No | Filter by delegation state. true returns current delegations (active + upcoming). false returns expired delegations only. |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `delegate_email` | string | No | Filter by the email of the user receiving the delegation. |
| `delegator_email` | string | No | Filter by the email of the user who created the delegation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search departments

**Slug:** `ZIP_SEARCH_DEPARTMENTS`

Search departments. Multiple search filters can be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Department name as configured in Zip. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `is_active` | boolean | No | The active status of the department. |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `hide_in_zip` | boolean | No | Whether the department is currently hidden in Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search expense categories

**Slug:** `ZIP_SEARCH_EXPENSE_CATEGORIES`

Search Zip expense categories using documented filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | array | No | Expense category names to match. |
| `active` | boolean | No | Filter by active status. |
| `external_ids` | array | No | External IDs to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search GL codes

**Slug:** `ZIP_SEARCH_GL_CODES`

Search GL accounts in Zip and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter GL accounts by name. |
| `active` | boolean | No | Filter by active status. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `page_size` | string | No | Results per page; empty uses the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search invoices

**Slug:** `ZIP_SEARCH_INVOICES`

Search one page of invoices by creation, update, approval, amount, invoice number, status, vendor, or upload source; optionally return IDs or line-item counts only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | Query invoices with a certain status. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 50. Larger values are clamped to 50. Omitted or empty uses the endpoint default page size. |
| `vendor_id` | string | No | Query invoices from a specific vendor by their vendor GUID. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `created_after` | integer | No | Query invoices orders created after a certain epoch timestamp (in seconds). |
| `updated_after` | integer | No | Query invoices updated after a certain epoch timestamp (in seconds). |
| `upload_source` | array | No | Query invoices with a certain upload source. |
| `approved_after` | integer | No | Query invoices approved after a certain epoch timestamp (in seconds). |
| `created_before` | integer | No | Query invoices created before a certain epoch timestamp (in seconds). |
| `invoice_number` | string | No | Query invoices by invoice number. |
| `updated_before` | integer | No | Query invoices updated before a certain epoch timestamp (in seconds). |
| `approved_before` | integer | No | Query invoices approved before a certain epoch timestamp (in seconds). |
| `return_ids_only` | boolean | No | If true, returns a list of invoice IDs. This can improve performance of large search queries. |
| `include_attributes` | boolean | No | Include custom fields in the response. This increase the latency of the API request. |
| `invoice_amount_max` | number | No | Filter invoices by a maximum amount. |
| `invoice_amount_min` | number | No | Filter invoices by a minimum amount. |
| `line_items_count_only` | boolean | No | If true, returns only the count of line items instead of the full line items array for each invoice. This can improve performance for invoices with many line items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search item accounts

**Slug:** `ZIP_SEARCH_ITEM_ACCOUNTS`

Search item accounts in Zip by name, active status, or external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | array | No | Item account names to match. |
| `active` | boolean | No | Filter by active status. |
| `external_ids` | array | No | External item account IDs to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search item receipts

**Slug:** `ZIP_SEARCH_ITEM_RECEIPTS`

Search one page of Zip item receipts by created time, updated time, or receipt status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | Filter by status. Can be specified multiple times to filter by multiple statuses. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `created_after` | integer | No | Query item receipts created after a certain epoch timestamp (in seconds). |
| `updated_after` | integer | No | Query item receipts updated after a certain epoch timestamp (in seconds). |
| `created_before` | integer | No | Query item receipts created before a certain epoch timestamp (in seconds). |
| `updated_before` | integer | No | Query item receipts updated before a certain epoch timestamp (in seconds). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search locations

**Slug:** `ZIP_SEARCH_LOCATIONS`

Search Zip company locations by name or status and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Value for `name` as documented by Zip. |
| `status` | integer ("0" | "1" | "3") | No | The status of the location object: * `0` - INITIAL, * `1` - ACTIVE, * `3` - DELETED,. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results. |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search lookup options

**Slug:** `ZIP_SEARCH_LOOKUP_OPTIONS`

Search Zip lookup options and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | No | Filter by option key. |
| `name` | string | No | Filter by option name. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `lookup_id` | string | No | Filter by associated lookup ID. |
| `page_size` | string | No | Results per page; empty uses the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |
| `show_in_zip` | boolean | No | Filter by whether the option is displayed in Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search look up types

**Slug:** `ZIP_SEARCH_LOOKUPS`

Search Zip lookup types and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `page_size` | string | No | Results per page; empty uses the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |
| `show_in_zip` | boolean | No | Filter by whether the lookup is displayed in Zip. |
| `integration_key` | string | No | Filter by integration lookup key. |
| `integration_name` | string | No | Filter by ERP integration name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search payment terms

**Slug:** `ZIP_SEARCH_PAYMENT_TERMS`

Search payment terms in Zip and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter payment terms by name. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `is_active` | boolean | No | Filter by active status. |
| `page_size` | string | No | Results per page; empty uses the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search purchase orders

**Slug:** `ZIP_SEARCH_PURCHASE_ORDERS`

Search one page of Zip purchase orders by PO or request number, status, requester, department, dates, open amount, or vendor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | Requires additional PO search filters to be enabled for your organization. Repeat this parameter to supply multiple statuses. Query purchase orders whose status matches any provided value. Possible values are: * `0` - OPEN * `1` - CLOSED * `2` - CANCELED * `3` - SOFT_CLOSED * `4` - PENDING_APPROVAL * `5` - REJECTED * `6` - UNKNOWN * `7` - DRAFT. |
| `sort_by` | string ("create_time" | "last_updated_time" | "request_number" | "status" | "created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty uses created_at. The updated_at and last_updated_time options sort by last_activity_at. The create_time, last_updated_time, request_number, and status options require additional PO search filters to be enabled for your organization. |
| `page_size` | string | No | The number of results to return per page, maximum is 50. Larger values are clamped to 50. Omitted or empty uses the endpoint default page size. |
| `po_number` | string | No | Query purchase orders by their PO number. Requires additional PO search filters to be enabled for your organization. |
| `vendor_id` | string | No | Query purchase orders from a specific vendor by their vendor GUID. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `vendor_name` | string | No | Query purchase orders by vendor name. Requires additional PO search filters to be enabled for your organization. |
| `requester_id` | string | No | Query purchase orders by requester ID. Requires additional PO search filters to be enabled for your organization. |
| `created_after` | integer | No | Query purchase orders created after a certain epoch timestamp (in seconds). |
| `department_id` | array | No | Query purchase orders whose department ID matches any provided value. Repeat this parameter to supply multiple department IDs. Requires additional PO search filters to be enabled for your organization. |
| `created_before` | integer | No | Query purchase orders created before a certain epoch timestamp (in seconds). |
| `request_number` | integer | No | Query purchase orders by their originating request number. Requires additional PO search filters to be enabled for your organization. |
| `requester_name` | string | No | Query purchase orders by requester name. Requires additional PO search filters to be enabled for your organization. |
| `department_name` | string | No | Query purchase orders by department name. Requires additional PO search filters to be enabled for your organization. |
| `include_attributes` | boolean | No | Include custom fields in the response. This increases the latency of the API request. |
| `last_updated_after` | integer | No | Return POs whose last_activity_at is greater than or equal to this UTC epoch timestamp in seconds. |
| `last_updated_before` | integer | No | Return POs whose last_activity_at is less than or equal to this UTC epoch timestamp in seconds. |
| `open_amount_less_than` | number | No | Query purchase orders with an open amount less than a certain amount. |
| `open_amount_greater_than` | number | No | Query purchase orders with an open amount greater than a certain amount. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search requests

**Slug:** `ZIP_SEARCH_REQUESTS`

Search one page of Zip requests by request details, requester, department, vendor, status, type, priority, or date range, with optional sorting and custom attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | integer ("1" | "2" | "3" | "4" | "5" | "6") | No | The status of the request. Possible values are: * `1` - AWAITING_APPROVAL, * `2` - REJECTED, * `3` - APPROVED, * `4` - CANCELED, * `5` - CLOSED, * `6` - PAUSED. |
| `sort_by` | string ("create_time" | "complete_time" | "last_updated_time" | "request_number" | "status") | No | Sort the requests by a certain property. |
| `priority` | integer ("0" | "1") | No | The priority of the request. Possible values are: * `0` - Urgent, * `1` - Normal. |
| `page_size` | string | No | The number of results to return per page, maximum is 30. Larger values are clamped to 30. Omitted or empty uses the endpoint default page size. |
| `vendor_id` | string | No | ID of the vendor attached to the request. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `vendor_name` | string | No | Name of the vendor attached to the request. |
| `request_type` | string ("PURCHASE_REQUEST" | "SOURCING_PROJECT" | "SOURCING_INSTANCE" | "BILL" | "PAYOUT_GROUP" | "INVOICE_ASSIGNMENT" | "PO_CHANGE_ORDER" | "SECURITY_REVIEW" | "VENDOR_ONBOARDING" | "SOURCING_REQUEST" | "GOODS_RECEIVING" | "DISBURSEMENT_REQUEST" | "VENDOR_UPDATE" | "VENDOR_MANAGEMENT_ONBOARDING" | "VENDOR_MANAGEMENT_UPDATE" | "CHANGE_ORDER" | "CONTRACT_AMENDMENT") | No | Request type. |
| `requester_id` | string | No | User ID of the requester. |
| `created_after` | integer | No | Query requests created after a certain epoch timestamp (in seconds). |
| `department_id` | array | No | ID of the department attached to the request. A request is returned if its department ID matches one of these. |
| `created_before` | integer | No | Query requests created before a certain epoch timestamp (in seconds). |
| `request_number` | string | No | The request number in Zip. |
| `requester_name` | string | No | Requester name. |
| `completed_after` | integer | No | Query requests completed after a certain epoch timestamp (in seconds). |
| `department_name` | string | No | Name of the department attached to the request. |
| `completed_before` | integer | No | Query requests completed before a certain epoch timestamp (in seconds). |
| `include_attributes` | boolean | No | Include custom fields in the response. This increase the latency of the API request. |
| `last_updated_after` | integer | No | Query requests updated after a certain epoch timestamp (in seconds). |
| `last_updated_before` | integer | No | Query requests updated before a certain epoch timestamp (in seconds). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search roles

**Slug:** `ZIP_SEARCH_ROLES`

Search Zip organization roles by name and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Value for `name` as documented by Zip. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search saving line items by field filters

**Slug:** `ZIP_SEARCH_SAVING_LINE_ITEMS`

Search one page of purchase-request saving line items. Filter by custom field GUID or by saving_line_item_type, recognition_frequency, recognition_start_date, or recognition_end_date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Field filters and page settings for the search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search subsidiaries

**Slug:** `ZIP_SEARCH_SUBSIDIARIES`

Search subsidiaries. Multiple search filters can be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Value for `name` as documented by Zip. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `is_active` | boolean | No | Value for `is_active` as documented by Zip. |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search tax codes

**Slug:** `ZIP_SEARCH_TAX_CODES`

Search Zip tax codes and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Exact tax code name to match. |
| `active` | boolean | No | Filter by active status. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by; empty uses the server default. |
| `page_size` | string | No | Results per page; empty uses the server default. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction; empty uses the server default. |
| `tax_code_type` | integer | No | Tax code type to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search user groups

**Slug:** `ZIP_SEARCH_USER_GROUPS`

Search user groups. Multiple search filters can be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Value for `name` as documented by Zip. |
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search users

**Slug:** `ZIP_SEARCH_USERS`

Search users. Multiple search filters can be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Filter by user email. Omitted or empty means no email filter. |
| `sort_by` | string ("email" | "created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated the same as omitted and sorts by created_at (descending). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `deactivated` | boolean | No | Value for `deactivated` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search vendor credits

**Slug:** `ZIP_SEARCH_VENDOR_CREDITS`

Search one page of Zip vendor credits by credit invoice number, with optional creation/update sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "") | No | Field to sort by. Omitted or empty is treated as created_at (server default). |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `credit_invoice_number` | string | No | The invoice number of the credit invoice (not the invoices that the credit was applied to). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search vendors

**Slug:** `ZIP_SEARCH_VENDORS`

Search one page of vendors by name, status, update time, subsidiary, or department; optionally include custom attributes and risk data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Value for `name` as documented by Zip. |
| `status` | array | No | Value for `status` as documented by Zip. |
| `sort_by` | string ("name" | "last_updated" | "created_at" | "updated_at") | No | Both updated_at and last_updated sort by the latest vendor update or audit activity, matching the updated_at timestamp returned in the response. |
| `page_size` | string | No | The number of results to return per page, maximum is 100. Omitted or empty uses the endpoint default page size. |
| `page_token` | string | No | The continuation token returned from a previous page results |
| `sort_order` | string ("asc" | "desc" | "") | No | Sort direction. Omitted or empty is treated as desc when sort_by is set (server default). Ignored when sort_by is omitted or empty. |
| `department_id` | string | No | Value for `department_id` as documented by Zip. |
| `subsidiary_id` | string | No | Value for `subsidiary_id` as documented by Zip. |
| `include_risk_data` | boolean | No | Include inherent and residual risk tiers, associated risk assessments, and risk findings. These fields are returned only when Risk Orchestration is enabled for the company and the caller can read risk assessments. Otherwise they are omitted. |
| `include_attributes` | boolean | No | Include custom fields in the response. This increase the latency of the API request. |
| `last_updated_after` | integer | No | UTC timestamp in seconds. |
| `last_updated_before` | integer | No | UTC timestamp in seconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send a bill invoice for approval

**Slug:** `ZIP_SEND_BILL_INVOICE_FOR_APPROVAL`

Send a bill invoice for approval. Validates a draft bill invoice and submits it for approval. The invoice is validated for completeness, then transitioned into the approval workflow. On success, the updated invoice is returned with its new status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send a vendor credit for approval

**Slug:** `ZIP_SEND_VENDOR_CREDIT_FOR_APPROVAL`

Send a vendor credit for approval. Validates an uncoded vendor credit and submits it for approval. The credit is validated for completeness, then transitioned into the approval workflow (or logged as available when approvals are not configured). On success, the updated vendor credit is returned with its new status. This endpoint must be enabled for your organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_credit_id` | string | Yes | Identifier for `vendorCreditId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a delegation

**Slug:** `ZIP_UPDATE_DELEGATION`

Update a delegation. Update an existing delegation. All fields are optional but at least one must be provided. Changing the delegate triggers a circular delegation check. Changing dates or timezone recalculates the start/end timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Delegation fields to change: delegate ID, start date, end date, timezone, or note; provide at least one. |
| `delegation_id` | string | Yes | ID of the delegation to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update department by ID

**Slug:** `ZIP_UPDATE_DEPARTMENT_BY_ID`

Update a Zip department's name, display name, active status, or visibility by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Department fields to change: name, display name, active status, or Zip visibility. |
| `department_id` | string | Yes | Identifier for `departmentId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update expense category by ID

**Slug:** `ZIP_UPDATE_EXPENSE_CATEGORY_BY_ID`

Update a Zip expense category's accounting or active-status fields by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Expense category fields to update. |
| `expense_category_id` | string | Yes | ID of the expense category to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update GL code by ID

**Slug:** `ZIP_UPDATE_GL_CODE_BY_ID`

Update a GL account in Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | GL account fields to update. |
| `gl_code_id` | string | Yes | ID of the GL account to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update invoice header information

**Slug:** `ZIP_UPDATE_INVOICE_HEADER`

Update invoice header information. Updates header-level fields on a bill invoice such as vendor, subsidiary, currency, dates, amounts, description, and custom attributes. The invoice can also be matched to purchase orders by providing purchase_order_ids or purchase_order_numbers. On success, the updated invoice is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update invoice line item

**Slug:** `ZIP_UPDATE_INVOICE_LINE_ITEM`

Update the supplied fields on one invoice line item by invoice and line-item IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |
| `line_item_id` | string | Yes | Identifier for `lineItemId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an invoice's paid status.

**Slug:** `ZIP_UPDATE_INVOICE_PAID_STATUS`

High-impact, irreversible operation that marks a bill invoice paid and creates its payout. Verify the invoice ID and payment state before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Request body field `data` as documented by Zip. |
| `invoice_id` | string | Yes | Identifier for `invoiceId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an item receipt

**Slug:** `ZIP_UPDATE_ITEM_RECEIPT`

Update an item receipt. Edits a submitted receipt or return. Fields left out keep their values. line_items, when sent, replaces the receipt's lines under the same rules as create: a line already on the receipt is updated in place, a new PO line is added, and a line left out is removed. Allocation to matched bills runs again after the edit is saved. The receipt type, number and purchase order don't change. On success, the updated item receipt is returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `item_receipt_id` | string | Yes | Identifier for `itemReceiptId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a location.

**Slug:** `ZIP_UPDATE_LOCATION`

Update a Zip company location's name or status by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Location fields to change: name or status (0 INITIAL, 1 ACTIVE, or 3 DELETED). |
| `location_id` | string | Yes | Identifier for `locationId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update lookup by ID

**Slug:** `ZIP_UPDATE_LOOKUP_BY_ID`

Update a Zip lookup type by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Lookup fields to update. |
| `lookup_id` | string | Yes | ID of the lookup type to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a lookup option

**Slug:** `ZIP_UPDATE_LOOKUP_OPTION`

Update a Zip lookup option by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Lookup option fields to update. |
| `lookup_option_id` | string | Yes | ID of the lookup option to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update payment method by ID

**Slug:** `ZIP_UPDATE_PAYMENT_METHOD_BY_ID`

Update external identifiers or custom fields on a Zip payment method.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Payment method fields to update. |
| `payment_method_id` | string | Yes | ID of the payment method to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update product by ID

**Slug:** `ZIP_UPDATE_PRODUCT_BY_ID`

Update a Zip product's name or metadata by product ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Product fields to update. |
| `product_id` | string | Yes | ID of the product to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update purchase order statuses

**Slug:** `ZIP_UPDATE_PURCHASE_ORDER_STATUSES`

High-impact, irreversible bulk operation that cancels, closes, or soft-closes up to 50 purchase orders. Verify every purchase order ID and target status before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update queue by ID

**Slug:** `ZIP_UPDATE_QUEUE_BY_ID`

Update queue by ID. Updates a main queue or a subqueue by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `queue_id` | string | Yes | Identifier for `queueId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a single purchase request

**Slug:** `ZIP_UPDATE_REQUEST_BY_ID`

Update the supplied fields on a single Zip purchase request by request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `request_id` | string | Yes | Identifier for `requestId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update the line items of a purchase request

**Slug:** `ZIP_UPDATE_REQUEST_LINE_ITEMS_BY_ID`

Update the line items of a purchase request. Update the line items of a single purchase request, given the request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `request_id` | string | Yes | Identifier for `requestId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a request's status (reject or cancel).

**Slug:** `ZIP_UPDATE_REQUEST_STATUS_BY_ID`

Update a request's status (reject or cancel). Reject or cancel a request. The transition is terminal and closes the approval chain. Bills and payout groups have their own cancel flows and are not supported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Request body field `data` as documented by Zip. |
| `request_id` | string | Yes | The GUID of the request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update role by ID

**Slug:** `ZIP_UPDATE_ROLE_BY_ID`

Destructive, high-impact operation that changes an organization role and can alter users' access. Verify the role ID and permission impact before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Role fields to change, including name or description. |
| `role_id` | string | Yes | Identifier for `roleId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a saving line item

**Slug:** `ZIP_UPDATE_SAVING_LINE_ITEM`

Partially update a Zip saving line item; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Fields to update. Omitted fields remain unchanged. |
| `saving_line_item_id` | string | Yes | Identifier for the saving line item as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update subsidiary by ID

**Slug:** `ZIP_UPDATE_SUBSIDIARY_BY_ID`

Update an organization subsidiary in Zip by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Subsidiary fields to change, including name, active status, or external identifiers. |
| `subsidiary_id` | string | Yes | Identifier for `subsidiaryId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a tax code

**Slug:** `ZIP_UPDATE_TAX_CODE`

Partially update a Zip tax code's name, type, active status, or accounting fields by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | Tax code fields to update. |
| `tax_code_id` | string | Yes | ID of the tax code to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update user by ID

**Slug:** `ZIP_UPDATE_USER_BY_ID`

Update a single Zip user by ID; this API operation requires a Zip Premier subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | User fields to change, including name, email, manager, department, location, role, or active state. |
| `user_id` | string | Yes | Identifier for `userId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update user group by ID

**Slug:** `ZIP_UPDATE_USER_GROUP_BY_ID`

Update user group by ID. Update the description of a single user group by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | No | User-group fields to change; currently supports the group description. |
| `user_group_id` | string | Yes | Identifier for `userGroupId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update vendor by ID

**Slug:** `ZIP_UPDATE_VENDOR_BY_ID`

Update the supplied fields on a single Zip vendor by vendor ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `vendor_id` | string | Yes | Identifier for `vendorId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update vendor credit header information

**Slug:** `ZIP_UPDATE_VENDOR_CREDIT_HEADER`

Update vendor credit header information. Updates header-level fields on a vendor credit such as vendor, subsidiary, currency, dates, amounts, description, and custom attributes. On success, the updated vendor credit is returned. This endpoint must be enabled for your organization. When the credit is already coded, only a limited set of header fields can be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `vendor_credit_id` | string | Yes | Identifier for `vendorCreditId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a vendor credit line item

**Slug:** `ZIP_UPDATE_VENDOR_CREDIT_LINE_ITEM`

Update a line item on a Zip vendor credit; this endpoint must be enabled, and coded credits allow only a limited field set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `line_item_id` | string | Yes | Identifier for `lineItemId` as documented by Zip. |
| `vendor_credit_id` | string | Yes | Identifier for `vendorCreditId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update vendor item by ID

**Slug:** `ZIP_UPDATE_VENDOR_ITEM_BY_ID`

Update the supplied fields on a Zip vendor item by item ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `vendor_item_id` | string | Yes | Identifier for `vendorItemId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update vendor item group by ID

**Slug:** `ZIP_UPDATE_VENDOR_ITEM_GROUP_BY_ID`

Update the supplied fields on a Zip vendor item group by group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `vendor_item_group_id` | string | Yes | Identifier for `vendorItemGroupId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update vendor site by ID

**Slug:** `ZIP_UPDATE_VENDOR_SITE_BY_ID`

Update the supplied fields on a Zip vendor site by site ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |
| `site_id` | string | Yes | Identifier for `siteId` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload a document

**Slug:** `ZIP_UPLOAD_DOCUMENT`

Upload a document to Zip using multipart form data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | File to upload. |
| `invoice_id` | string | No | ID of the invoice or vendor credit to attach the document to. |
| `request_id` | string | No | ID of the purchase request to attach the document to. |
| `idempotency_key` | string | No | Optional key that prevents processing a duplicate upload request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert budget

**Slug:** `ZIP_UPSERT_BUDGET`

Create or update a Zip budget using its period and dimensions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Budget fields to create or update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert budget actual

**Slug:** `ZIP_UPSERT_BUDGET_ACTUAL`

Create or update a Zip budget actual using its date and dimensions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Budget actual fields to create or update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert currencies

**Slug:** `ZIP_UPSERT_CURRENCIES`

Add currencies to the connected Zip company's supported list; existing currencies not included in the request remain supported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Supported currency configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or update an option filter rule

**Slug:** `ZIP_UPSERT_OPTION_FILTER_RULE`

Create or update a Zip option filter rule by client-provided rule ID. Option values are matched by their raw, untranslated names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Option filter rule fields to create or update. |
| `rule_id` | string | Yes | Unique client-provided rule ID; it cannot be blank or whitespace-only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or update option filter rules in a batch

**Slug:** `ZIP_UPSERT_OPTION_FILTER_RULES_BATCH`

Atomically create or update 1 to 100 Zip option filter rules. The entire batch is rejected if any item fails validation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Atomic batch of option filter rules to create or update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert vendor keyed by external id

**Slug:** `ZIP_UPSERT_VENDOR`

Upsert vendor keyed by external id. Create or update a vendor given an external ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Request body field `data` as documented by Zip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |