MCP server for Codat — companies, connections, invoices, bills and financial statements.
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.
MUTATES Codat data — create a new company (a container for a customer's data connections). Provide a name; optionally a description, tags, or other attributes via `fields`. Codat API: POST /companies. Returns the created company (incl. its id).
A human-readable name for the company (usually your customer's business name).
Additional raw Codat fields merged into the request body (escape hatch for any field not typed above).
Optional description / notes for the company.
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.
MUTATES Codat data — create a new company (a container for a customer's data connections). Provide a name; optionally a description, tags, or other attributes via `fields`. Codat API: POST /companies. Returns the created company (incl. its id).
| Argument | Type | Description |
|---|---|---|
| name* | string | A human-readable name for the company (usually your customer's business name). |
| fields | object | Additional raw Codat fields merged into the request body (escape hatch for any field not typed above). |
| description | string | Optional description / notes for the company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A human-readable name for the company (usually your customer's business name)."
},
"fields": {
"type": "object",
"description": "Additional raw Codat fields merged into the request body (escape hatch for any field not typed above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": {
"type": "string",
"description": "Optional description / notes for the company."
}
}
}MUTATES Codat data — create a new data connection on a company for a given source platform. Provide the platformKey (from codat_list_integrations, e.g. "gbol" for QuickBooks Online sandbox). The connection is created in a PendingAuth state; the customer completes authorization via the returned linkUrl. Codat API: POST /companies/{companyId}/connections. Returns the created connection.
| Argument | Type | Description |
|---|---|---|
| fields | object | Additional raw Codat fields merged into the request body (escape hatch for any field not typed above). |
| companyId* | string | The Codat companyId (UUID). |
| platformKey* | string | The integration platformKey to connect (from codat_list_integrations). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"platformKey"
],
"properties": {
"fields": {
"type": "object",
"description": "Additional raw Codat fields merged into the request body (escape hatch for any field not typed above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"platformKey": {
"type": "string",
"description": "The integration platformKey to connect (from codat_list_integrations)."
}
}
}Get a company's balance sheet, broken into periods. periodLength (months per period) and periodsToCompare are BOTH required by Codat. Codat API: GET /companies/{companyId}/data/financials/balanceSheet.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
| startMonth | string | First month of the earliest period (YYYY-MM-DD); defaults to the most recent. |
| periodLength* | integer | Number of months per period (1-12). Required. |
| periodsToCompare* | integer | How many periods to return (1-12). Required. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"periodLength",
"periodsToCompare"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"startMonth": {
"type": "string",
"description": "First month of the earliest period (YYYY-MM-DD); defaults to the most recent."
},
"periodLength": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Number of months per period (1-12). Required."
},
"periodsToCompare": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "How many periods to return (1-12). Required."
}
}
}Get a company's cash flow statement, broken into periods. periodLength and periodsToCompare are BOTH required by Codat. Codat API: GET /companies/{companyId}/data/financials/cashFlowStatement.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
| startMonth | string | First month of the earliest period (YYYY-MM-DD); defaults to the most recent. |
| periodLength* | integer | Number of months per period (1-12). Required. |
| periodsToCompare* | integer | How many periods to return (1-12). Required. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"periodLength",
"periodsToCompare"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"startMonth": {
"type": "string",
"description": "First month of the earliest period (YYYY-MM-DD); defaults to the most recent."
},
"periodLength": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Number of months per period (1-12). Required."
},
"periodsToCompare": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "How many periods to return (1-12). Required."
}
}
}Fetch a single company by id (name, platform, dataConnections, created/lastSync). Codat API: GET /companies/{companyId}.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}Fetch a single data connection by id (platformKey, status, sourceType, lastSync). Codat API: GET /companies/{companyId}/connections/{connectionId}.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
| connectionId* | string | The Codat connectionId (data connection UUID) within the company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"connectionId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"connectionId": {
"type": "string",
"description": "The Codat connectionId (data connection UUID) within the company."
}
}
}Get a company's accounting metadata (base currency, supported data types, etc.). Codat API: GET /companies/{companyId}/data/info.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}Get the freshness/status of each accounting data type for a company (lastSuccessfulSync, currentStatus, dataType). Use this to check whether a dataset has been pulled before reading it. Codat API: GET /companies/{companyId}/dataStatus.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}Fetch a single AR invoice by id (full object incl. lineItems, paymentAllocations). Codat API: GET /companies/{companyId}/data/invoices/{invoiceId}.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
| invoiceId* | string | The invoice id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"invoiceId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"invoiceId": {
"type": "string",
"description": "The invoice id."
}
}
}Fetch the authenticated Codat account's profile (organization name, redirect URLs, features) — a quick way to verify the API key works. Codat API: GET /profile.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get a company's profit and loss (income statement), broken into periods. periodLength and periodsToCompare are BOTH required by Codat. Codat API: GET /companies/{companyId}/data/financials/profitAndLoss.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
| startMonth | string | First month of the earliest period (YYYY-MM-DD); defaults to the most recent. |
| periodLength* | integer | Number of months per period (1-12). Required. |
| periodsToCompare* | integer | How many periods to return (1-12). Required. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"periodLength",
"periodsToCompare"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"startMonth": {
"type": "string",
"description": "First month of the earliest period (YYYY-MM-DD); defaults to the most recent."
},
"periodLength": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Number of months per period (1-12). Required."
},
"periodsToCompare": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "How many periods to return (1-12). Required."
}
}
}List a company's account transactions (bank/GL transactions) for a data connection. NOTE: this endpoint is CONNECTION-scoped. Codat API: GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
| connectionId* | string | The Codat connectionId (data connection UUID) within the company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"connectionId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"connectionId": {
"type": "string",
"description": "The Codat connectionId (data connection UUID) within the company."
}
}
}List a company's chart of accounts (id, name, nominalCode, type, status, currency, currentBalance). Codat API: GET /companies/{companyId}/data/accounts. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's bill payments (money paid out to suppliers) — id, supplierRef, date, currency, totalAmount, lines. Codat API: GET /companies/{companyId}/data/billPayments. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's accounts-payable bills (id, reference, supplierRef, issueDate, dueDate, currency, totalAmount, amountDue, status, lineItems). Codat API: GET /companies/{companyId}/data/bills. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List the companies in your Codat account. A company represents one of your customers' businesses and holds its data connections. Codat API: GET /companies. Returns the paged envelope { results, pageNumber, pageSize, totalResults, _links }.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
}
}
}List a company's data connections (each links the company to one source platform, e.g. QuickBooks, Xero). Codat API: GET /companies/{companyId}/connections. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's credit notes (id, creditNoteNumber, customerRef, issueDate, currency, totalAmount, remainingCredit, status). Codat API: GET /companies/{companyId}/data/creditNotes. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's customers (id, customerName, contactName, emailAddress, addresses, status, defaultCurrency). Codat API: GET /companies/{companyId}/data/customers. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's direct costs (point-of-sale purchases: card/cash spend, refunds) for a data connection. NOTE: this endpoint is CONNECTION-scoped. Codat API: GET /companies/{companyId}/connections/{connectionId}/data/directCosts. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
| connectionId* | string | The Codat connectionId (data connection UUID) within the company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"connectionId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
},
"connectionId": {
"type": "string",
"description": "The Codat connectionId (data connection UUID) within the company."
}
}
}List the accounting/commerce/banking platforms (integrations) Codat supports, with their platformKey. Codat API: GET /integrations. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
}
}
}List a company's accounts-receivable invoices (id, invoiceNumber, customerRef, issueDate, dueDate, currency, totalAmount, amountDue, status, lineItems). Codat API: GET /companies/{companyId}/data/invoices. Returns the paged envelope. Tip: filter with query, e.g. "status=Submitted&&amountDue>0".
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's journal entries (id, postedOn, createdOn, journalLines with accountRef/netAmount/currency). Codat API: GET /companies/{companyId}/data/journalEntries. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's payments received (money in against invoices) — id, customerRef, date, currency, totalAmount, lines/allocations. Codat API: GET /companies/{companyId}/data/payments. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}List a company's suppliers/vendors (id, supplierName, contactName, emailAddress, addresses, status, defaultCurrency). Codat API: GET /companies/{companyId}/data/suppliers. Returns the paged envelope.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number (default 1). |
| query | string | Codat query filter string, e.g. "status=Paid" or "modifiedDate>2026-01-01". See docs.codat.io/using-the-api/querying. |
| orderBy | string | Field to order results by, e.g. "-modifiedDate" (leading "-" for descending). |
| pageSize | integer | Records per page (1-2000, default 100). |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)."
},
"query": {
"type": "string",
"description": "Codat query filter string, e.g. \"status=Paid\" or \"modifiedDate>2026-01-01\". See docs.codat.io/using-the-api/querying."
},
"orderBy": {
"type": "string",
"description": "Field to order results by, e.g. \"-modifiedDate\" (leading \"-\" for descending)."
},
"pageSize": {
"type": "integer",
"maximum": 2000,
"minimum": 1,
"description": "Records per page (1-2000, default 100)."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}MUTATES Codat state — queue a refresh of ALL data types for a company (Codat re-pulls from the connected source platforms). Asynchronous: it enqueues pulls, it does not return the data. Use codat_get_data_status to track progress. Codat API: POST /companies/{companyId}/data/all.
| Argument | Type | Description |
|---|---|---|
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId"
],
"properties": {
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}MUTATES Codat state — queue a refresh of ONE data type for a company (e.g. "invoices", "bills", "chartOfAccounts", "balanceSheet"). Asynchronous: it enqueues a pull, it does not return the data. Codat API: POST /companies/{companyId}/data/queue/{dataType}.
| Argument | Type | Description |
|---|---|---|
| dataType* | string | The Codat data type key to refresh, e.g. "invoices", "bills", "customers", "chartOfAccounts", "balanceSheet". |
| companyId* | string | The Codat companyId (UUID). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"companyId",
"dataType"
],
"properties": {
"dataType": {
"type": "string",
"description": "The Codat data type key to refresh, e.g. \"invoices\", \"bills\", \"customers\", \"chartOfAccounts\", \"balanceSheet\"."
},
"companyId": {
"type": "string",
"description": "The Codat companyId (UUID)."
}
}
}Power-user escape hatch: GET any Codat API path not wrapped by a dedicated tool. READ-ONLY — only GET is allowed. Path starts with a slash (e.g. "/companies/{id}/data/taxRates", "/companies/{id}/reports/agedDebtor"). Codat API: GET {path}.
| Argument | Type | Description |
|---|---|---|
| path* | string | API path starting with a slash, e.g. "/companies/{id}/data/items". |
| query | object | Optional query params object. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"description": "API path starting with a slash, e.g. \"/companies/{id}/data/items\"."
},
"query": {
"type": "object",
"description": "Optional query params object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}