Invoices

get_invoices

Get list of invoices for the authenticated user's organization

get_invoices

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_invoices",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "status": "DRAFT",
        "invoiceType": "BY_EMPLOYEE_HOURS",
        "paid": true,
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_invoices",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "status": "DRAFT",
    "invoiceType": "BY_EMPLOYEE_HOURS",
    "paid": true,
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_invoices", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "status": "DRAFT",
  "invoiceType": "BY_EMPLOYEE_HOURS",
  "paid": true,
  "startDate": "string",
  "endDate": "string"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for invoice number or client name

relationsArray<string>

Relations to include (e.g., ["organizationContact", "invoiceItems", "tags"])

statusstringDRAFTSENTVIEWEDACCEPTEDACTIVEFULLY_PAIDCANCELLED

Filter by invoice status

invoiceTypestringBY_EMPLOYEE_HOURSBY_PROJECT_HOURSBY_TASK_HOURSBY_PRODUCTSBY_FLAT_FEEDETAILS_INVOICE_ITEMS

Filter by invoice type

paidboolean

Filter by payment status

startDatestring

Filter invoices from this date (ISO format)

endDatestring

Filter invoices until this date (ISO format)

get_invoice_count

Get invoice count in the authenticated user's organization

get_invoice_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_invoice_count",
    "arguments": {
        "status": "DRAFT",
        "paid": true,
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_invoice_count",
  "arguments": {
    "status": "DRAFT",
    "paid": true,
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_invoice_count", arguments={
  "status": "DRAFT",
  "paid": true,
  "startDate": "string",
  "endDate": "string"
})

Parameters

statusstringDRAFTSENTVIEWEDACCEPTEDACTIVEFULLY_PAIDCANCELLED

Filter by invoice status

paidboolean

Filter by payment status

startDatestring

Filter invoices from this date (ISO format)

endDatestring

Filter invoices until this date (ISO format)

get_invoice

Get a specific invoice by ID

get_invoice

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

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

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

Parameters

idstring<uuid>required

The invoice ID

relationsArray<string>

Relations to include (e.g., ["organizationContact", "invoiceItems", "tags"])

create_invoice

Create a new invoice in the authenticated user's organization

create_invoice

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_invoice",
    "arguments": {
        "invoice_data": {
          "invoiceNumber": "string",
          "invoiceDate": "string",
          "dueDate": "string",
          "currency": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_invoice",
  "arguments": {
    "invoice_data": {
      "invoiceNumber": "string",
      "invoiceDate": "string",
      "dueDate": "string",
      "currency": "string"
    }
  }
});

result = await session.call_tool("create_invoice", arguments={
  "invoice_data": {
    "invoiceNumber": "string",
    "invoiceDate": "string",
    "dueDate": "string",
    "currency": "string"
  }
})

Request Body

{
  "invoice_data": {
    "invoiceNumber": "string",
    "invoiceDate": "string",
    "dueDate": "string",
    "currency": "string"
  }
}

Body

application/json

invoice_dataobjectrequired

The data for creating the invoice

Show child attributes

invoiceNumberstringrequired

The invoice number (required)

invoiceDatestringrequired

The invoice date (required)

dueDatestringrequired

The due date (required)

currencystringrequired

The currency (required)

[key: string]any

update_invoice

Update an existing invoice

update_invoice

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

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

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

Parameters

idstring<uuid>required

The invoice ID

invoice_dataobjectrequired

The data for updating the invoice

update_invoice_action

Update the action/status of an invoice

update_invoice_action

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

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

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

Parameters

idstring<uuid>required

The invoice ID

statusstringDRAFTSENTVIEWEDACCEPTEDACTIVEFULLY_PAIDCANCELLED

The new status for the invoice

isEstimateboolean

Whether this is an estimate

update_estimate_status

Update estimate status of an invoice

update_estimate_status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_estimate_status",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "data": {
          "isEstimate": true,
          "status": "DRAFT",
          "paid": true
        }
      }
  }
}

const result = await client.callTool({
  "name": "update_estimate_status",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "data": {
      "isEstimate": true,
      "status": "DRAFT",
      "paid": true
    }
  }
});

result = await session.call_tool("update_estimate_status", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "isEstimate": true,
    "status": "DRAFT",
    "paid": true
  }
})

Request Body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "isEstimate": true,
    "status": "DRAFT",
    "paid": true
  }
}

Body

application/json

idstring<uuid>required

The invoice ID

dataobjectrequired

Data to update for the estimate

Show child attributes

isEstimateboolean

statusstringDRAFTSENTVIEWEDACCEPTEDACTIVEFULLY_PAIDCANCELLED

paidboolean

delete_invoice

Delete an invoice

delete_invoice

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

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

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

Parameters

idstring<uuid>required

The invoice ID

get_invoice_items

Get items for a specific invoice

get_invoice_items

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

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

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

Parameters

invoiceIdstring<uuid>required

The invoice ID

relationsArray<string>

Relations to include (e.g., ["product", "project", "task"])

send_invoice_email

Send an invoice via email

send_invoice_email

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "send_invoice_email",
    "arguments": {
        "email": "user@example.com",
        "params": {
          "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
          "organizationId": "550e8400-e29b-41d4-a716-446655440000",
          "tenantId": "550e8400-e29b-41d4-a716-446655440000"
        }
      }
  }
}

const result = await client.callTool({
  "name": "send_invoice_email",
  "arguments": {
    "email": "user@example.com",
    "params": {
      "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "tenantId": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
});

result = await session.call_tool("send_invoice_email", arguments={
  "email": "user@example.com",
  "params": {
    "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "tenantId": "550e8400-e29b-41d4-a716-446655440000"
  }
})

Request Body

{
  "email": "user@example.com",
  "params": {
    "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "tenantId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Body

application/json

emailstring<email>required

Email address to send the invoice to

paramsobjectrequired

Email parameters including invoice ID

Show child attributes

invoiceIdstring<uuid>required

organizationIdstring<uuid>

tenantIdstring<uuid>

download_invoice_pdf

Download PDF for an invoice as binary data

download_invoice_pdf

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

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

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

Parameters

idstring<uuid>required

The invoice ID

get_highest_invoice_number

Get the highest invoice number in the organization

get_highest_invoice_number

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_highest_invoice_number",
    "arguments": {}
  }
}

const result = await client.callTool({
  "name": "get_highest_invoice_number",
  "arguments": {}
});

result = await session.call_tool("get_highest_invoice_number", arguments={})

generate_invoice_link

Generate a public link for an invoice

generate_invoice_link

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

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

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

Parameters

idstring<uuid>required

The invoice ID

download_invoice_payment_pdf

Download payment PDF for an invoice

download_invoice_payment_pdf

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

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

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

Parameters

idstring<uuid>required

The invoice ID

Stack Overflow Website Demo