Add Zip to your AI agent

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

Create a lookup type in Zip.

Create a lookup option in Zip.

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

Create a main approval queue in Zip.

Record a completed or canceled risk assessment performed outside Zip.

Create an organization role in Zip.

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

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

Create an organization subsidiary in Zip.

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

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

Create a contact for a vendor in Zip.

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.

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

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

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

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

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.

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

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.

Delete a single department from Zip by ID.

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

Delete a company location from Zip by ID.

Delete a Zip lookup type by ID.

Delete a Zip lookup option by ID.

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

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

Delete a single organization role from Zip by ID.

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

Delete a single organization subsidiary from Zip by ID.

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

Delete a single vendor from Zip by vendor ID.

Get metadata for an agent session when Superagents is enabled.

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

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

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

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

Retrieve one Zip department and its organization settings by ID.

Download a Zip document as a PDF file reference.

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

Retrieve a GL account lookup from Zip 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.

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

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

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

Retrieve a Zip lookup type by ID.

Retrieve a Zip lookup option by ID.

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

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

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

Retrieve a single Zip payout by payout ID.

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

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

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

Retrieve a single Zip purchase request by request ID.

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

Retrieve one Zip risk assessment by ID.

List the active custom fields on Zip risk assessments.

Retrieve one organization role from Zip by ID.

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

Retrieve one organization subsidiary from Zip by ID.

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

Retrieve one Zip user and their organization assignments by ID.

Retrieve one Zip user group by ID.

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

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

Retrieve multiple Zip vendor item groups by their IDs.

Retrieve multiple Zip vendor items by their IDs.

Retrieve a single Zip vendor site by site ID.

List messages in an agent session in chronological order.

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

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.

List currencies supported by the connected Zip company.

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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.

Search departments. Multiple search filters can be provided.

Search Zip expense categories using documented filters.

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

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.

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

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

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

Search Zip lookup options and return one page of results.

Search Zip lookup types and return one page of results.

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

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

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

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

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.

Search subsidiaries. Multiple search filters can be provided.

Search Zip tax codes and return one page of results.

Search user groups. Multiple search filters can be provided.

Search users. Multiple search filters can be provided.

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

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

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.

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.

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.

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

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

Update a GL account in Zip by ID.

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.

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

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

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.

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

Update a Zip lookup type by ID.

Update a Zip lookup option by ID.

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

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

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.

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

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

Update the line items of a purchase request. Update the line items of a single purchase request, given the request 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.

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

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

Update an organization subsidiary in Zip by ID.

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

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

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

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

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.

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

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

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

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

Upload a document to Zip using multipart form data.

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

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

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

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

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

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