apideck-mcp-pay-bill
Pay a vendor bill (Apideck MCP)
When the user wants to pay a known vendor bill, prefer apideck-pay-bill over stitching accounting-bills-get + accounting-bill-payments-create manually. The workflow tool fetches the bill, reads its outstanding balance, builds the right allocation, picks the correct AP endpoint, and surfaces structured errors with failingStep so you know which leg broke.
When this is the right tool
| User intent | Tool |
|---|---|
| "Pay bill 6", "Settle the LinkedIn invoice", "Close out bill from RocketReach" | apideck-pay-bill ✓ |
| "Record that customer paid invoice 4" | apideck-receive-customer-payment (AR mirror — different unified endpoint) |
| "Create a prepayment / unallocated transfer" | accounting-payments-create directly (no allocation) |
| "Show me unpaid bills" | accounting-bills-list with filter[status]=open |
IMPORTANT RULES
- CONFIRM before calling. Pay-bill is mutating and not idempotent — calling twice creates two payments on the connected service. Always show the user the bill total, currency, payment account, and supplier, and wait for explicit confirmation before invoking the tool.
- PASS
payment_methodas a capitalized value when targeting QuickBooks:"Check","CreditCard","Cash". Lower-case"check"triggers a generic JSON-parse rejection from QuickBooks before any meaningful validation runs. Other connectors accept lower-case ("check","ach","wire","credit_card"). - DON'T pass
amountto pay the full balance — omit it and the workflow defaults to the bill's outstanding balance (which is the correct amount even on partially-settled bills). Only passamountwhen the user explicitly wants a partial payment. - SET
x-apideck-service-idwhen the consumer has multiple accounting connections (e.g. both Xero and QuickBooks). Otherwise the call routes to whichever connection Apideck picks first. - DON'T confuse with
apideck-receive-customer-payment. Bills are accounts payable (you owe money). Invoices are accounts receivable (someone owes you). They route to different unified endpoints under the hood.
Argument map
| Arg | Required | Default | Notes |
|---|---|---|---|
bill_id |
yes | — | From accounting-bills-list. The numeric or UUID id Apideck returns. |
account_id |
yes | — | The bank/cash account the payment is drawn from. From accounting-ledger-accounts-list filtered to type=bank. |
amount |
no | bill's outstanding balance | In bill's currency. Pass smaller for a partial payment. |
transaction_date |
no | today (YYYY-MM-DD) | Some connectors reject future dates. |
payment_method |
no | — | QB requires capitalized: "Check" etc. Other connectors flexible. |
reference |
no | — | Memo / external reference shown on the payment record. |
x-apideck-service-id |
no | first accounting connection | E.g. "xero", "quickbooks". |
Result shape
Success
{
"bill_id": "4",
"payment_id": "pay-77",
"amount": 742.45,
"currency": "USD",
"transaction_date": "2026-04-26",
"bill_total": 742.45,
"partial": false,
"service_id": "quickbooks"
}
partial: true means the agent paid less than the bill's outstanding balance. Use this to confirm with the user that a follow-up payment will be needed.
Failure (with isError: true)
{
"bill_id": "4",
"amount": 1,
"currency": "USD",
"error": "accounting-bill-payments-create failed: ...",
"failingStep": "accounting-bill-payments-create",
"upstream": { "status_code": 400, "type_name": "ConnectorExecutionError", ... }
}
failingStep tells you which leg failed:
accounting-bills-get— the bill ID is wrong or the connector lost the recordvalidate-amount— the bill has no positive outstanding balance (already paid, or zero-total)accounting-bill-payments-create— the payment write itself failed; inspectupstreamfor connector-specific reason
Worked example
User: "Pay the bill from LinkedIn for $742.45 from Business Checking."
accounting-bills-listwithfilter: { supplier_id: ... }to find the bill ID — say"4".accounting-ledger-accounts-listwithfilter: { type: "bank" }to find Business Checking — say"8".- Confirm with the user: "Paying bill 4 (LinkedIn, $742.45 USD) from Business Checking via QuickBooks. Confirm?"
- On confirmation, call:
{ "name": "apideck-pay-bill", "arguments": { "bill_id": "4", "account_id": "8", "payment_method": "Check", "x-apideck-service-id": "quickbooks" } } - Surface the resulting
payment_idto the user.
Common failure modes
| Symptom | Cause | Fix |
|---|---|---|
failingStep: validate-amount |
Bill has zero outstanding balance | Either it's already paid, or pass an explicit amount to override |
QuickBooks rejects with Property Name:failed to parse json object |
payment_method lower-case |
Pass "Check" (capitalized) for QB |
QuickBooks rejects with CustomerRef missing |
Wrong unified endpoint chosen — workflow protects against this | Should not happen via apideck-pay-bill; if it does, file a bug |
failingStep: accounting-bill-payments-create with Subscription period has ended |
QB sandbox/account billing issue, not a workflow bug | Renew connector subscription |
UrlElicitationRequiredError thrown |
Connection expired or never authorized | Surface the consent URL to user, retry after OAuth |
Related
apideck-mcp— front-door skill for the MCP server itselfapideck-mcp-receive-payment— AR mirror (customer paying you)- Workflow source: src/gen/workflows/payBill.ts
More from apideck-libraries/api-skills
apideck-connector-coverage
Check Apideck connector API coverage before building integrations. Use when determining which operations a connector supports, comparing connector capabilities, or diagnosing why an API call fails with a specific connector. Teaches agents to query the Connector API for real-time coverage data.
18apideck-best-practices
Best practices for building Apideck integrations. Covers authentication patterns, pagination, error handling, connection management with Vault, webhook setup, and common pitfalls. Use when designing or reviewing any Apideck integration regardless of language.
18apideck-rest
Apideck Unified REST API reference for any language. Use when building integrations with accounting software (QuickBooks, Xero, NetSuite), CRMs (Salesforce, HubSpot, Pipedrive), HRIS platforms (Workday, BambooHR), file storage (Google Drive, Dropbox, Box), ATS systems (Greenhouse, Lever), e-commerce, or any of Apideck's 200+ connectors using direct HTTP calls. Covers authentication headers, CRUD operations, cursor-based pagination, filtering, sorting, error handling, rate limiting, pass-through parameters, and webhooks. Language-agnostic — works with curl, fetch, axios, httpx, or any HTTP client.
17apideck-node
Apideck Unified API integration patterns for TypeScript and Node.js. Use when building integrations with accounting software (QuickBooks, Xero, NetSuite), CRMs (Salesforce, HubSpot, Pipedrive), HRIS platforms (Workday, BambooHR), file storage (Google Drive, Dropbox, Box), ATS systems (Greenhouse, Lever), e-commerce, or any of Apideck's 200+ connectors. Covers the @apideck/unify SDK, authentication, CRUD operations, pagination, filtering, webhooks, and Vault connection management.
15apideck-portman
API contract testing with Portman by Apideck. Use when generating Postman collections from OpenAPI specs, writing contract tests, variation tests, integration tests, fuzz testing, or setting up CI/CD API test pipelines. Portman converts OpenAPI 3.x specs into Postman collections with auto-generated test suites.
14apideck-codegen
Generate typed API clients from Apideck OpenAPI specs using code generators. Use when the user wants to generate custom SDK clients, typed models, API stubs, or server scaffolding from Apideck's published OpenAPI specifications. Covers openapi-generator, Speakeasy, and Postman import workflows.
14