Query and manage Mercoa AP/AR bill-pay: entities, invoices, transactions and payment methods.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE — adds a comment to an invoice (visible in its activity log). POST /invoice/{invoiceId}/comment.
Comment text.
Invoice ID to comment on.
ID or foreign ID of the user creating the comment.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE — adds a comment to an invoice (visible in its activity log). POST /invoice/{invoiceId}/comment.
| Argument | Type | Description |
|---|---|---|
| text* | string | Comment text. |
| userId | string | ID or foreign ID of the user creating the comment. |
| invoiceId* | string | Invoice ID to comment on. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoiceId",
"text"
],
"properties": {
"text": {
"type": "string",
"description": "Comment text."
},
"userId": {
"type": "string",
"description": "ID or foreign ID of the user creating the comment."
},
"invoiceId": {
"type": "string",
"description": "Invoice ID to comment on."
}
}
}WRITE — creates a real entity (customer/vendor/payor/payee) in Mercoa. Supply role flags, accountType, and a nested `profile` object (business or individual details). POST /entity.
| Argument | Type | Description |
|---|---|---|
| string | Primary email for the entity. | |
| isPayee | boolean | Whether this entity can receive payments (AR / vendor). |
| isPayor | boolean | Whether this entity can pay invoices (AP). |
| profile | object | Nested profile object, e.g. { "business": { "legalBusinessName": "Acme Inc.", "email": "[email protected]", "businessType": "llc" } } or { "individual": { "name": {...}, "email": "..." } }. |
| foreignId | string | Your system's ID for this entity. |
| isCustomer | boolean | Whether this entity has a direct relationship with your organization. |
| accountType | string | business or individual. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"description": "Primary email for the entity."
},
"isPayee": {
"type": "boolean",
"description": "Whether this entity can receive payments (AR / vendor)."
},
"isPayor": {
"type": "boolean",
"description": "Whether this entity can pay invoices (AP)."
},
"profile": {
"type": "object",
"description": "Nested profile object, e.g. { \"business\": { \"legalBusinessName\": \"Acme Inc.\", \"email\": \"[email protected]\", \"businessType\": \"llc\" } } or { \"individual\": { \"name\": {...}, \"email\": \"...\" } }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"foreignId": {
"type": "string",
"description": "Your system's ID for this entity."
},
"isCustomer": {
"type": "boolean",
"description": "Whether this entity has a direct relationship with your organization."
},
"accountType": {
"enum": [
"business",
"individual"
],
"type": "string",
"description": "business or individual."
}
}
}WRITE — creates a real invoice/bill in Mercoa. Set status (DRAFT to stage, NEW to submit), amount, currency, payer/vendor, dates and line items. POST /invoice.
| Argument | Type | Description |
|---|---|---|
| amount | number | Total invoice amount. |
| status | string | Invoice status, e.g. DRAFT, NEW, APPROVED, SCHEDULED. |
| dueDate | string | Due date (ISO 8601). |
| payerId | string | Payer entity ID (who owes). |
| currency | string | Currency code, e.g. USD. |
| metadata | object | Arbitrary key/value metadata. |
| vendorId | string | Vendor entity ID (who is paid). |
| lineItems | array | Line items array, e.g. [{ "amount": 100, "currency": "USD", "description": "Product A", "quantity": 1, "unitPrice": 100 }]. |
| noteToSelf | string | Internal note. |
Find/search entities (buyers, vendors, payors, payees). Use to look up counterparties by name/email/foreignId or list all. GET /entity.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max entities to return (1-100, default 10). |
| search | string | Search by name, email, emailTo, entity ID, or foreign ID (partial matches). |
| status | any | Entity status filter (e.g. verified, pending). |
| isPayee | boolean | Filter entities marked as payees. |
| isPayor | boolean | Filter entities marked as payors. |
| foreignId | any | Your system's ID(s) for the entity. |
| isCustomer | boolean | If true, only entities with a direct relationship to your organization. |
| startingAfter | string | Entity ID cursor for pagination. |
| paymentMethods | boolean | If true, include payment methods in the response. |
Find/search invoices (bills) across payers and vendors. Filter by status, entity, date, approver and more. GET /invoices (plural list endpoint).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max invoices to return (1-100, default 10). |
| search | string | Search by vendor name, invoice number, check number, or amount. |
| status | any | Invoice status filter (e.g. DRAFT, NEW, APPROVED, SCHEDULED, PAID). |
| endDate | string | End date filter (ISO 8601). |
| orderBy | string | Field to order by (e.g. CREATED_AT, AMOUNT, DUE_DATE). |
| payerId | any | Filter by payer ID(s) or foreign ID(s). |
| dateType | string | Date type to filter by (e.g. CREATED_AT, DUE_DATE). |
| entityId | any | Filter by entity (payer or vendor) ID(s) or foreign ID(s). |
| vendorId | any | Filter by vendor ID(s) or foreign ID(s). |
List/search payment transactions. Filter by entity, invoice, status, type and date. GET /transactions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max transactions to return (1-100, default 10). |
| search | string | Search by vendor name, invoice number, check number, or amount. |
| status | any | Transaction status filter. |
| endDate | string | CREATED_AT end date filter (ISO 8601). |
| payerId | any | Filter by payer ID(s). |
| entityId | any | Filter by entity ID(s) or foreign ID(s). |
| vendorId | any | Filter by vendor ID(s). |
| invoiceId | any | Filter by invoice ID(s) or foreign ID(s). |
| startDate | string | CREATED_AT start date filter (ISO 8601). |
| entityGroupId |
Get a single entity by ID (or foreign ID). GET /entity/{entityId}.
| Argument | Type | Description |
|---|---|---|
| entityId* | string | Entity ID (e.g. ent_...) or foreign ID. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId"
],
"properties": {
"entityId": {
"type": "string",
"description": "Entity ID (e.g. ent_...) or foreign ID."
}
}
}Get the event/audit log for an entity. GET /entity/{entityId}/events.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max events to return (1-100). |
| endDate | string | End date filter (ISO 8601). |
| entityId* | string | Entity ID or foreign ID. |
| startDate | string | Start date filter (ISO 8601). |
| startingAfter | string | Event ID cursor for pagination. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Max events to return (1-100).",
"exclusiveMinimum": 0
},
"endDate": {
"type": "string",
"description": "End date filter (ISO 8601)."
},
"entityId": {
"type": "string",
"description": "Entity ID or foreign ID."
},
"startDate": {
"type": "string",
"description": "Start date filter (ISO 8601)."
},
"startingAfter": {
"type": "string",
"description": "Event ID cursor for pagination."
}
}
}Get aggregate invoice metrics (totals/counts, grouped by currency) for an entity's payables/receivables — for AP/AR dashboards and aging. GET /entity/{entityId}/invoice-metrics.
| Argument | Type | Description |
|---|---|---|
| search | string | Search by vendor name, invoice number, check number, or amount. |
| status | any | Invoice status filter (e.g. NEW, SCHEDULED, PAID). |
| endDate | string | End date filter (ISO 8601). |
| groupBy | any | Additional grouping (e.g. by status). |
| payerId | any | Filter by payer ID(s). |
| currency | any | Currency code(s) to filter on, e.g. USD. |
| dateType | string | Date type to filter by (e.g. CREATED_AT, DUE_DATE). |
| entityId* | string | Entity ID or foreign ID. |
| vendorId | any | Filter by vendor ID(s). |
Get a single invoice (bill) by ID. GET /invoice/{invoiceId}.
| Argument | Type | Description |
|---|---|---|
| invoiceId* | string | Invoice ID (e.g. in_...) or foreign ID. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Invoice ID (e.g. in_...) or foreign ID."
}
}
}Get the event/audit log for an invoice (status changes, approvals, payments). GET /invoice/{invoiceId}/events.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max events to return (1-100). |
| endDate | string | End date filter (ISO 8601). |
| invoiceId* | string | Invoice ID or foreign ID. |
| startDate | string | Start date filter (ISO 8601). |
| startingAfter | string | Event ID cursor for pagination. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoiceId"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Max events to return (1-100).",
"exclusiveMinimum": 0
},
"endDate": {
"type": "string",
"description": "End date filter (ISO 8601)."
},
"invoiceId": {
"type": "string",
"description": "Invoice ID or foreign ID."
},
"startDate": {
"type": "string",
"description": "Start date filter (ISO 8601)."
},
"startingAfter": {
"type": "string",
"description": "Event ID cursor for pagination."
}
}
}Get the caller's Mercoa organization configuration (settings, payment methods enabled, etc.). GET /organization.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get a single payment method for an entity. GET /entity/{entityId}/paymentMethod/{paymentMethodId}.
| Argument | Type | Description |
|---|---|---|
| entityId* | string | Entity ID or foreign ID. |
| paymentMethodId* | string | Payment method ID (e.g. pm_...). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId",
"paymentMethodId"
],
"properties": {
"entityId": {
"type": "string",
"description": "Entity ID or foreign ID."
},
"paymentMethodId": {
"type": "string",
"description": "Payment method ID (e.g. pm_...)."
}
}
}Get a single payment transaction by ID. GET /transaction/{transactionId}.
| Argument | Type | Description |
|---|---|---|
| transactionId* | string | Transaction ID. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transactionId"
],
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction ID."
}
}
}List an entity's payment methods (bank accounts, cards, check, etc.). GET /entity/{entityId}/paymentMethods.
| Argument | Type | Description |
|---|---|---|
| type | string | Filter by payment method type (e.g. bankAccount, card, check). |
| entityId* | string | Entity ID or foreign ID. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId"
],
"properties": {
"type": {
"type": "string",
"description": "Filter by payment method type (e.g. bankAccount, card, check)."
},
"entityId": {
"type": "string",
"description": "Entity ID or foreign ID."
}
}
}List the users belonging to an entity (approvers, admins, etc.). GET /entity/{entityId}/users.
| Argument | Type | Description |
|---|---|---|
| entityId* | string | Entity ID or foreign ID. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId"
],
"properties": {
"entityId": {
"type": "string",
"description": "Entity ID or foreign ID."
}
}
}WRITE — updates an existing invoice/bill (all fields optional). Commonly used to advance status (e.g. DRAFT→NEW→SCHEDULED) or change amounts, dates, or payment methods. POST /invoice/{invoiceId}.
| Argument | Type | Description |
|---|---|---|
| amount | number | Total invoice amount. |
| status | string | New invoice status, e.g. NEW, APPROVED, SCHEDULED. |
| dueDate | string | Due date (ISO 8601). |
| payerId | string | Payer entity ID. |
| currency | string | Currency code, e.g. USD. |
| metadata | object | Arbitrary key/value metadata. |
| vendorId | string | Vendor entity ID. |
| invoiceId* | string | Invoice ID to update. |
| lineItems | array | Replacement line items array. |
| noteToSelf |
| invoiceDate |
| string |
| Invoice date (ISO 8601). |
| creatorUserId | string | User ID creating the invoice. |
| deductionDate | string | Scheduled payment/deduction date (ISO 8601). |
| invoiceNumber | string | Human-readable invoice number, e.g. INV-123. |
| creatorEntityId | string | Entity ID on whose behalf the invoice is created. |
| paymentSourceId | string | Payment method ID to pay from (payer's). |
| paymentDestinationId | string | Payment method ID to pay to (vendor's). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"amount": {
"type": "number",
"description": "Total invoice amount."
},
"status": {
"type": "string",
"description": "Invoice status, e.g. DRAFT, NEW, APPROVED, SCHEDULED."
},
"dueDate": {
"type": "string",
"description": "Due date (ISO 8601)."
},
"payerId": {
"type": "string",
"description": "Payer entity ID (who owes)."
},
"currency": {
"type": "string",
"description": "Currency code, e.g. USD."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"vendorId": {
"type": "string",
"description": "Vendor entity ID (who is paid)."
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Line items array, e.g. [{ \"amount\": 100, \"currency\": \"USD\", \"description\": \"Product A\", \"quantity\": 1, \"unitPrice\": 100 }]."
},
"noteToSelf": {
"type": "string",
"description": "Internal note."
},
"invoiceDate": {
"type": "string",
"description": "Invoice date (ISO 8601)."
},
"creatorUserId": {
"type": "string",
"description": "User ID creating the invoice."
},
"deductionDate": {
"type": "string",
"description": "Scheduled payment/deduction date (ISO 8601)."
},
"invoiceNumber": {
"type": "string",
"description": "Human-readable invoice number, e.g. INV-123."
},
"creatorEntityId": {
"type": "string",
"description": "Entity ID on whose behalf the invoice is created."
},
"paymentSourceId": {
"type": "string",
"description": "Payment method ID to pay from (payer's)."
},
"paymentDestinationId": {
"type": "string",
"description": "Payment method ID to pay to (vendor's)."
}
}
}| returnMetadata | any | Metadata key(s) to include in the response. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Max entities to return (1-100, default 10).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"description": "Search by name, email, emailTo, entity ID, or foreign ID (partial matches)."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Entity status filter (e.g. verified, pending)."
},
"isPayee": {
"type": "boolean",
"description": "Filter entities marked as payees."
},
"isPayor": {
"type": "boolean",
"description": "Filter entities marked as payors."
},
"foreignId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Your system's ID(s) for the entity."
},
"isCustomer": {
"type": "boolean",
"description": "If true, only entities with a direct relationship to your organization."
},
"startingAfter": {
"type": "string",
"description": "Entity ID cursor for pagination."
},
"paymentMethods": {
"type": "boolean",
"description": "If true, include payment methods in the response."
},
"returnMetadata": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Metadata key(s) to include in the response."
}
}
}| invoiceId | any | Filter by invoice ID(s) or foreign ID(s). |
| startDate | string | Start date filter (ISO 8601). |
| approverId | any | Filter by assigned approver user ID(s). |
| paymentType | any | Filter by payment type (e.g. recurring). |
| creatorUserId | any | Filter by the user ID(s) that created the invoice. |
| entityGroupId | string | Filter by entity group ID. |
| startingAfter | string | Invoice ID cursor for pagination. |
| approverAction | any | Filter by approver action (use with approverId), e.g. APPROVE. |
| orderDirection | string | asc or desc. |
| invoiceTemplateId | any | Filter by invoice template ID(s). |
| returnPayerMetadata | boolean | Include payer metadata in the response. |
| returnPaymentTiming | boolean | Include payment timing in the response. |
| returnVendorMetadata | boolean | Include vendor metadata in the response. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Max invoices to return (1-100, default 10).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"description": "Search by vendor name, invoice number, check number, or amount."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Invoice status filter (e.g. DRAFT, NEW, APPROVED, SCHEDULED, PAID)."
},
"endDate": {
"type": "string",
"description": "End date filter (ISO 8601)."
},
"orderBy": {
"type": "string",
"description": "Field to order by (e.g. CREATED_AT, AMOUNT, DUE_DATE)."
},
"payerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by payer ID(s) or foreign ID(s)."
},
"dateType": {
"type": "string",
"description": "Date type to filter by (e.g. CREATED_AT, DUE_DATE)."
},
"entityId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by entity (payer or vendor) ID(s) or foreign ID(s)."
},
"vendorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by vendor ID(s) or foreign ID(s)."
},
"invoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by invoice ID(s) or foreign ID(s)."
},
"startDate": {
"type": "string",
"description": "Start date filter (ISO 8601)."
},
"approverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by assigned approver user ID(s)."
},
"paymentType": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by payment type (e.g. recurring)."
},
"creatorUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by the user ID(s) that created the invoice."
},
"entityGroupId": {
"type": "string",
"description": "Filter by entity group ID."
},
"startingAfter": {
"type": "string",
"description": "Invoice ID cursor for pagination."
},
"approverAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by approver action (use with approverId), e.g. APPROVE."
},
"orderDirection": {
"type": "string",
"description": "asc or desc."
},
"invoiceTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by invoice template ID(s)."
},
"returnPayerMetadata": {
"type": "boolean",
"description": "Include payer metadata in the response."
},
"returnPaymentTiming": {
"type": "boolean",
"description": "Include payment timing in the response."
},
"returnVendorMetadata": {
"type": "boolean",
"description": "Include vendor metadata in the response."
}
}
}| string |
| Filter by entity group ID. |
| startingAfter | string | Transaction ID cursor for pagination. |
| transactionId | any | Filter by transaction ID(s). |
| transactionType | any | Filter by transaction type. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Max transactions to return (1-100, default 10).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"description": "Search by vendor name, invoice number, check number, or amount."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Transaction status filter."
},
"endDate": {
"type": "string",
"description": "CREATED_AT end date filter (ISO 8601)."
},
"payerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by payer ID(s)."
},
"entityId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by entity ID(s) or foreign ID(s)."
},
"vendorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by vendor ID(s)."
},
"invoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by invoice ID(s) or foreign ID(s)."
},
"startDate": {
"type": "string",
"description": "CREATED_AT start date filter (ISO 8601)."
},
"entityGroupId": {
"type": "string",
"description": "Filter by entity group ID."
},
"startingAfter": {
"type": "string",
"description": "Transaction ID cursor for pagination."
},
"transactionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by transaction ID(s)."
},
"transactionType": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by transaction type."
}
}
}| invoiceId | any | Filter by invoice ID(s) or foreign ID(s). |
| startDate | string | Start date filter (ISO 8601). |
| approverId | any | Filter by assigned approver user ID(s). |
| returnByDate | string | Group metrics by date, e.g. CREATION_DATE or DUE_DATE. |
| excludePayables | boolean | Only return receivables (exclude payables). |
| excludeReceivables | boolean | Only return payables (exclude receivables). |
| returnByDateFrequency | string | Frequency for date grouping (e.g. DAILY, MONTHLY). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entityId"
],
"properties": {
"search": {
"type": "string",
"description": "Search by vendor name, invoice number, check number, or amount."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Invoice status filter (e.g. NEW, SCHEDULED, PAID)."
},
"endDate": {
"type": "string",
"description": "End date filter (ISO 8601)."
},
"groupBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Additional grouping (e.g. by status)."
},
"payerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by payer ID(s)."
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Currency code(s) to filter on, e.g. USD."
},
"dateType": {
"type": "string",
"description": "Date type to filter by (e.g. CREATED_AT, DUE_DATE)."
},
"entityId": {
"type": "string",
"description": "Entity ID or foreign ID."
},
"vendorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by vendor ID(s)."
},
"invoiceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by invoice ID(s) or foreign ID(s)."
},
"startDate": {
"type": "string",
"description": "Start date filter (ISO 8601)."
},
"approverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Filter by assigned approver user ID(s)."
},
"returnByDate": {
"type": "string",
"description": "Group metrics by date, e.g. CREATION_DATE or DUE_DATE."
},
"excludePayables": {
"type": "boolean",
"description": "Only return receivables (exclude payables)."
},
"excludeReceivables": {
"type": "boolean",
"description": "Only return payables (exclude receivables)."
},
"returnByDateFrequency": {
"type": "string",
"description": "Frequency for date grouping (e.g. DAILY, MONTHLY)."
}
}
}| string |
| Internal note. |
| invoiceDate | string | Invoice date (ISO 8601). |
| deductionDate | string | Scheduled payment/deduction date (ISO 8601). |
| invoiceNumber | string | Human-readable invoice number. |
| paymentSourceId | string | Payment method ID to pay from. |
| paymentDestinationId | string | Payment method ID to pay to. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoiceId"
],
"properties": {
"amount": {
"type": "number",
"description": "Total invoice amount."
},
"status": {
"type": "string",
"description": "New invoice status, e.g. NEW, APPROVED, SCHEDULED."
},
"dueDate": {
"type": "string",
"description": "Due date (ISO 8601)."
},
"payerId": {
"type": "string",
"description": "Payer entity ID."
},
"currency": {
"type": "string",
"description": "Currency code, e.g. USD."
},
"metadata": {
"type": "object",
"description": "Arbitrary key/value metadata.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"vendorId": {
"type": "string",
"description": "Vendor entity ID."
},
"invoiceId": {
"type": "string",
"description": "Invoice ID to update."
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Replacement line items array."
},
"noteToSelf": {
"type": "string",
"description": "Internal note."
},
"invoiceDate": {
"type": "string",
"description": "Invoice date (ISO 8601)."
},
"deductionDate": {
"type": "string",
"description": "Scheduled payment/deduction date (ISO 8601)."
},
"invoiceNumber": {
"type": "string",
"description": "Human-readable invoice number."
},
"paymentSourceId": {
"type": "string",
"description": "Payment method ID to pay from."
},
"paymentDestinationId": {
"type": "string",
"description": "Payment method ID to pay to."
}
}
}