Payments

get_payments

Get list of payments for the authenticated user's organization

get_payments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payments",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "status": "PENDING",
        "paymentMethod": "CREDIT_CARD",
        "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
        "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
        "projectId": "550e8400-e29b-41d4-a716-446655440000",
        "currency": "USD",
        "startDate": "string",
        "endDate": "string",
        "overdue": true
      }
  }
}

const result = await client.callTool({
  "name": "get_payments",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "status": "PENDING",
    "paymentMethod": "CREDIT_CARD",
    "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
    "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "currency": "USD",
    "startDate": "string",
    "endDate": "string",
    "overdue": true
  }
});

result = await session.call_tool("get_payments", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "status": "PENDING",
  "paymentMethod": "CREDIT_CARD",
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "currency": "USD",
  "startDate": "string",
  "endDate": "string",
  "overdue": true
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for payment notes

relationsArray<string>

Relations to include (e.g., ["invoice", "organizationContact", "project", "recordedBy"])

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDED

Filter by payment status

paymentMethodstringCREDIT_CARDDEBIT_CARDBANK_TRANSFERPAYPALSTRIPECASHCHECKOTHER

Filter by payment method

invoiceIdstring<uuid>

Filter by invoice ID

organizationContactIdstring<uuid>

Filter by organization contact ID

projectIdstring<uuid>

Filter by project ID

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

startDatestring

Filter payments from this date (ISO format)

endDatestring

Filter payments until this date (ISO format)

overdueboolean

Filter by overdue status

get_payment_count

Get payment count in the authenticated user's organization

get_payment_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payment_count",
    "arguments": {
        "status": "PENDING",
        "paymentMethod": "CREDIT_CARD",
        "currency": "USD",
        "overdue": true,
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_payment_count",
  "arguments": {
    "status": "PENDING",
    "paymentMethod": "CREDIT_CARD",
    "currency": "USD",
    "overdue": true,
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_payment_count", arguments={
  "status": "PENDING",
  "paymentMethod": "CREDIT_CARD",
  "currency": "USD",
  "overdue": true,
  "startDate": "string",
  "endDate": "string"
})

Parameters

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDED

Filter by payment status

paymentMethodstringCREDIT_CARDDEBIT_CARDBANK_TRANSFERPAYPALSTRIPECASHCHECKOTHER

Filter by payment method

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

overdueboolean

Filter by overdue status

startDatestring

Filter payments from this date (ISO format)

endDatestring

Filter payments until this date (ISO format)

get_payment

Get a specific payment by ID

get_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_payment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_payment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The payment ID

relationsArray<string>

Relations to include (e.g., ["invoice", "organizationContact", "project", "recordedBy"])

create_payment

Create a new payment in the authenticated user's organization

create_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_payment",
    "arguments": {
        "payment_data": {
          "amount": 0,
          "currency": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_payment",
  "arguments": {
    "payment_data": {
      "amount": 0,
      "currency": "string"
    }
  }
});

result = await session.call_tool("create_payment", arguments={
  "payment_data": {
    "amount": 0,
    "currency": "string"
  }
})

Request Body

{
  "payment_data": {
    "amount": 0,
    "currency": "string"
  }
}

Body

application/json

payment_dataobjectrequired

The data for creating the payment

Show child attributes

amountnumberrequired

The amount (required)

currencystringrequired

The currency (required)

[key: string]any

update_payment

Update an existing payment

update_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_payment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "payment_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_payment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "payment_data": {}
  }
});

result = await session.call_tool("update_payment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "payment_data": {}
})

Parameters

idstring<uuid>required

The payment ID

payment_dataobjectrequired

The data for updating the payment

update_payment_status

Update the status of a payment

update_payment_status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_payment_status",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "PENDING"
      }
  }
}

const result = await client.callTool({
  "name": "update_payment_status",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PENDING"
  }
});

result = await session.call_tool("update_payment_status", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING"
})

Parameters

idstring<uuid>required

The payment ID

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDEDrequired

The new status for the payment

delete_payment

Delete a payment

delete_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_payment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_payment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_payment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The payment ID

get_payments_by_invoice

Get payments for a specific invoice

get_payments_by_invoice

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payments_by_invoice",
    "arguments": {
        "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "status": "PENDING",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_payments_by_invoice",
  "arguments": {
    "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "status": "PENDING",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_payments_by_invoice", arguments={
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "status": "PENDING",
  "relations": [
    "string"
  ]
})

Parameters

invoiceIdstring<uuid>required

The invoice ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDED

Filter by payment status

relationsArray<string>

Relations to include

get_payments_by_client

Get payments for a specific client/organization contact

get_payments_by_client

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payments_by_client",
    "arguments": {
        "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "status": "PENDING",
        "currency": "USD",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_payments_by_client",
  "arguments": {
    "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "status": "PENDING",
    "currency": "USD",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_payments_by_client", arguments={
  "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "status": "PENDING",
  "currency": "USD",
  "relations": [
    "string"
  ]
})

Parameters

organizationContactIdstring<uuid>required

The organization contact ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDED

Filter by payment status

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

relationsArray<string>

Relations to include

get_payment_statistics

Get payment statistics for the authenticated user's organization

get_payment_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_payment_statistics",
    "arguments": {
        "startDate": "string",
        "endDate": "string",
        "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
        "projectId": "550e8400-e29b-41d4-a716-446655440000",
        "currency": "USD"
      }
  }
}

const result = await client.callTool({
  "name": "get_payment_statistics",
  "arguments": {
    "startDate": "string",
    "endDate": "string",
    "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "currency": "USD"
  }
});

result = await session.call_tool("get_payment_statistics", arguments={
  "startDate": "string",
  "endDate": "string",
  "organizationContactId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "currency": "USD"
})

Parameters

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

organizationContactIdstring<uuid>

Filter by specific client ID

projectIdstring<uuid>

Filter by specific project ID

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

process_payment

Process a payment (mark as completed)

process_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "process_payment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "paymentDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "process_payment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "paymentDate": "string"
  }
});

result = await session.call_tool("process_payment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "paymentDate": "string"
})

Parameters

idstring<uuid>required

The payment ID

paymentDatestring

The payment date (ISO format)

refund_payment

Refund a payment

refund_payment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "refund_payment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "refundAmount": 0,
        "reason": "string"
      }
  }
}

const result = await client.callTool({
  "name": "refund_payment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "refundAmount": 0,
    "reason": "string"
  }
});

result = await session.call_tool("refund_payment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "refundAmount": 0,
  "reason": "string"
})

Parameters

idstring<uuid>required

The payment ID

refundAmountnumber

The refund amount (if partial refund)

reasonstring

Reason for refund

get_overdue_payments

Get overdue payments for the authenticated user's organization

get_overdue_payments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_overdue_payments",
    "arguments": {
        "page": 1,
        "limit": 10,
        "relations": [
          "string"
        ],
        "currency": "USD"
      }
  }
}

const result = await client.callTool({
  "name": "get_overdue_payments",
  "arguments": {
    "page": 1,
    "limit": 10,
    "relations": [
      "string"
    ],
    "currency": "USD"
  }
});

result = await session.call_tool("get_overdue_payments", arguments={
  "page": 1,
  "limit": 10,
  "relations": [
    "string"
  ],
  "currency": "USD"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>

Relations to include

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

search_payments

Search payments by notes, invoice number, or client name

search_payments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_payments",
    "arguments": {
        "query": "string",
        "limit": 20,
        "status": "PENDING",
        "paymentMethod": "CREDIT_CARD",
        "currency": "USD"
      }
  }
}

const result = await client.callTool({
  "name": "search_payments",
  "arguments": {
    "query": "string",
    "limit": 20,
    "status": "PENDING",
    "paymentMethod": "CREDIT_CARD",
    "currency": "USD"
  }
});

result = await session.call_tool("search_payments", arguments={
  "query": "string",
  "limit": 20,
  "status": "PENDING",
  "paymentMethod": "CREDIT_CARD",
  "currency": "USD"
})

Parameters

querystringrequired

Search query

limitnumber20

Maximum number of results

statusstringPENDINGPROCESSINGCOMPLETEDFAILEDCANCELLEDREFUNDED

Filter by payment status

paymentMethodstringCREDIT_CARDDEBIT_CARDBANK_TRANSFERPAYPALSTRIPECASHCHECKOTHER

Filter by payment method

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

Stack Overflow Website Demo