Call this server's tools from your browser. Nothing to install.
https://sellsy.usefulapi.io/mcp
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.
sellsy_create_comment
WRITE: add a comment (note) to a company, individual, contact, opportunity or document. Visible to the Sellsy staff, not sent to the customer. Needs comments.write.
Id of that record.
The comment text.
What it is attached to.
Staff to notify.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tools (44)
sellsy_create_comment
WRITE: add a comment (note) to a company, individual, contact, opportunity or document. Visible to the Sellsy staff, not sent to the customer. Needs comments.write.
WRITE: create an individual (a private person as prospect, client or supplier) in Sellsy. Needs individuals.write.
Argument
Type
Description
note
string
type*
string
Relationship type.
email
string
website
string
civility
string
owner_id
integer
Staff id of the owner.
last_name*
string
Last name.
reference
string
first_name
string
phone_number
string
mobile_number
string
Input schema (JSON)
sellsy_create_opportunity
WRITE: create a sales opportunity linked to a company, individual or contact. Needs a pipeline id and one of its step ids (see sellsy_list_opportunity_pipelines and sellsy_list_pipeline_steps). Needs opportunities.write.
Argument
Type
Description
name*
string
Opportunity name.
note
string
step*
integer
Step id inside that pipeline.
amount
string
Potential amount as a decimal string, e.g. "1500.00" (account currency).
related*
array
Who it is for: one company or one individual (required), plus optional contacts.
due_date
string
Due date YYYY-MM-DD.
owner_id
integer
Staff id of the owner (default: the API client's staff).
pipeline*
integer
Pipeline id.
contact_ids
array
sellsy_create_task
WRITE: create a task, optionally attached to a record and assigned to staff. Needs a label id (see sellsy_list_task_labels) and a due date-time. Needs tasks.write.
Argument
Type
Description
title
string
due_date*
string
Due date and time, ISO 8601 with offset, e.g. 2026-11-03T09:00:00+01:00.
label_id*
integer
Task label id.
owner_id
integer
Staff id of the owner.
priority
integer
Priority level, 0 or 1.
is_private
boolean
related_id
integer
Id of that record.
description
string
related_type
string
Record the task is about (give related_id too).
assigned_staff_ids
array
sellsy_get_company
Get one company by id. Needs companies.read.
read-only
Argument
Type
Description
id*
integer
Company id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Company id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_contact
Get one contact by id. Needs contacts.read.
read-only
Argument
Type
Description
id*
integer
Contact id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Contact id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_credit_note
Get one credit note by id. Needs credit-notes.read.
read-only
Argument
Type
Description
id*
integer
Credit note id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Credit note id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_estimate
Get one estimate by id, with its rows and amounts. Needs estimates.read.
read-only
Argument
Type
Description
id*
integer
Estimate id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Estimate id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_individual
Get one individual by id. Needs individuals.read.
read-only
Argument
Type
Description
id*
integer
Individual id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Individual id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_invoice
Get one invoice by id, with its rows, amounts and status. Needs invoices.read.
read-only
Argument
Type
Description
id*
integer
Invoice id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Invoice id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_item
Get one catalog item by id. Needs items.read.
read-only
Argument
Type
Description
id*
integer
Item id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Item id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_opportunity
Get one opportunity by id. Needs opportunities.read.
read-only
Argument
Type
Description
id*
integer
Opportunity id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Opportunity id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_order
Get one order by id. Needs orders.read.
read-only
Argument
Type
Description
id*
integer
Order id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Order id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_get_task
Get one task by id. Needs tasks.read.
read-only
Argument
Type
Description
id*
integer
Task id.
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Task id.",
"exclusiveMinimum": 0
},
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
}
}
}
sellsy_list_companies
List companies (customers, prospects, suppliers) with paging. Needs companies.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: name, id, created_at, updated_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: name, id, created_at, updated_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_company_contacts
List the contacts linked to one company (GET /companies/{id}/contacts). Needs companies.read and contacts.read.
read-only
Argument
Type
Description
limit
integer
Records per page, 1-100 (default 25).
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
company_id*
integer
Company id.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Company id.",
"exclusiveMinimum": 0
}
}
}
sellsy_list_contacts
List contacts (people at companies) with paging. Needs contacts.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, name, created_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, name, created_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_credit_notes
List credit notes with paging. Needs credit-notes.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, number, created, date, amount.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, number, created, date, amount."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_estimates
List estimates (quotes) with paging. Needs estimates.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, numero, created, date, expiry_date, number, amount."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_individuals
List individuals (private customers, prospects, suppliers) with paging. Needs individuals.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: name, id, created_at, updated_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: name, id, created_at, updated_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_invoice_payments
List the payments linked to one invoice. Needs invoices.read and payments.read.
read-only
Argument
Type
Description
limit
integer
Records per page, 1-100 (default 25).
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
invoice_id*
integer
Invoice id.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"invoice_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Invoice id.",
"exclusiveMinimum": 0
}
}
}
sellsy_list_invoices
List invoices with paging. Needs invoices.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, number, created, date, amount, due_date."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_items
List catalog items (products, services, shipping, packaging) with paging. Needs items.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, created_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, created_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_opportunities
List sales opportunities with paging. Needs opportunities.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, created, step_rank, due_date, amount."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_opportunity_pipelines
List the sales pipelines (needed to create an opportunity: pipeline id and step id). Needs opportunities.read.
read-only
Argument
Type
Description
limit
integer
Records per page, 1-100 (default 25).
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
}
}
}
sellsy_list_orders
List orders with paging. Needs orders.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, number, created, date, amount, due_date, order_status."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_pipeline_steps
List the steps of one opportunity pipeline. Needs opportunities.read.
read-only
Argument
Type
Description
limit
integer
Records per page, 1-100 (default 25).
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
pipeline_id*
integer
Pipeline id.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pipeline_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"pipeline_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pipeline id.",
"exclusiveMinimum": 0
}
}
}
sellsy_list_staffs
List the staff members of the account (the list may hold only yourself, depending on the Sellsy plan). Needs staffs.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, name.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, name."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_list_task_labels
List the task labels (a label id is required to create a task). Needs tasks.read.
read-only
Argument
Type
Description
limit
integer
Records per page, 1-100 (default 25).
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
}
}
}
sellsy_list_tasks
List tasks with paging. Needs tasks.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, due_date.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, due_date."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
sellsy_search
Free-text search over companies, individuals, contacts, opportunities, items, documents and staff in one call (GET /search). Use it to find a record by name, email or number when you do not know its type. Needs the search.read scope.
read-only
Argument
Type
Description
q*
string
The text to search for.
type
array
Restrict to these object types or subtypes (e.g. company.client, document.invoice). Omit to search everything.
Search comments and notes by author, date, parent comment or the company/individual/contact they are attached to. Needs comments.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, updated, created.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: owners [staff ids], companies [ids], individuals [ids], contacts [ids], parent_id, related_objects [{type,id}], created {start,end} ISO date-times, updated {start,end} ISO date-times.
direction
string
sellsy_search_companies
Search companies by name, email, type (prospect/client/supplier), reference, VAT, SIRET, country, postal code, creation or update date. Needs companies.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: name, id, created_at, updated_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: name (exact), email (exact), type ("prospect"|"client"|"supplier" or an array), is_archived (bool), siret, vat, reference [..], id [ids], contacts [contact ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times, number_of_employees {min,max}.
sellsy_search_contacts
Search contacts by last name, email, phone, linked company or individual, creation date. Needs contacts.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, name, created_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: last_name, email, phone_number, mobile_number, companies [company ids], individuals [individual ids], id [ids], is_linked (bool), country_code, postal_code [..], created {start,end} ISO date-times, updated {start,end} ISO date-times.
direction
string
sellsy_search_estimates
Search estimates by status, number, date, currency, owner, contact or related company/individual/opportunity. Needs estimates.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: status ["draft"|"sent"|"read"|"accepted"|"refused"|"expired"|"advanced"|"partialinvoiced"|"invoiced"|"cancelled"], number (exact), currency, date {start,end} dates YYYY-MM-DD, created {start,end} ISO date-times, updated {start,end} ISO date-times, owners [staff ids], assigned_staff_ids [..], contacts [contact ids], related_objects [{type,id}] (type company|individual|opportunity).
sellsy_search_individuals
Search individuals by name, email, type, reference, country, postal code, creation or update date. Needs individuals.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: name, id, created_at, updated_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: name (exact), email (exact), type ("prospect"|"client"|"supplier" or an array), is_archived (bool), reference [..], id [ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times.
direction
sellsy_search_invoices
Search invoices by status (draft/due/payinprogress/paid/late/cancelled), number, date, currency, owner, or related company/individual/opportunity. Use it for unpaid or late invoices. Needs invoices.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: status ["draft"|"due"|"payinprogress"|"paid"|"late"|"cancelled"], number (exact), currency, date {start,end} dates YYYY-MM-DD, created {start,end} ISO date-times, updated {start,end} ISO date-times, owners [staff ids], assigned_staff_ids [..], contacts [contact ids], related_objects [{type,id}] (type company|individual|opportunity), is_deposit (bool), is_progress_invoice (bool).
sellsy_search_items
Search catalog items by name, reference or type. Needs items.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, created_at.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: name, reference, type ["product"|"service"|"shipping"|"packaging"], is_archived (bool).
direction
string
Sort direction (default asc).
Input schema (JSON)
sellsy_search_opportunities
Search opportunities by name, number, pipeline, step, status (open/won/lost/cancelled/closed/late), amount, owner or due date. Needs opportunities.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: name, number, pipeline [pipeline ids], step [step ids], statuses ["open"|"won"|"lost"|"cancelled"|"closed"|"late"], amount {min,max}, owners [staff ids], assigned_staffs [staff ids], related_objects [{type:"company"|"individual",id}], created {start,end} ISO date-times, due_date {start,end} ISO date-times.
sellsy_search_orders
Search orders by status or delivery status, or related company/individual/opportunity. Needs orders.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: status ["draft"|"sent"|"read"|"accepted"|"expired"|"advanced"|"invoiced"|"partialinvoiced"|"cancelled"], order_status ["none"|"wait"|"picking"|"sent"|"partialsent"], related_objects [{type,id}], updated {start,end} ISO date-times.
direction
sellsy_search_payments
Search payments by status (pending/confirmed/rejected/failed/refund) or related company/individual. Needs payments.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, paid_date.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: status ["pending"|"confirmed"|"rejected"|"failed"|"refund"], related_objects [{type,id}].
direction
string
Sort direction (default asc).
Input schema (JSON)
sellsy_search_tasks
Search tasks by status (todo/done), owner, assignee, label, due date or related record. Needs tasks.read.
read-only
Argument
Type
Description
embed
array
Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
field
array
Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limit
integer
Records per page, 1-100 (default 25).
order
string
Sort field: id, due_date.
offset
any
Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filters
object
Search filters as an object. Unknown keys are refused by Sellsy. Keys: statuses ["todo"|"done"], owners [staff ids], assigned_staffs [staff ids], labels [label ids], priority {min,max} 0-1, companies [ids], individuals [ids], contacts [ids], related_objects [{type,id}], created {start,end} ISO date-times, due_date {start,end} ISO date-times.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, updated, created."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: owners [staff ids], companies [ids], individuals [ids], contacts [ids], parent_id, related_objects [{type,id}], created {start,end} ISO date-times, updated {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: name, id, created_at, updated_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: name (exact), email (exact), type (\"prospect\"|\"client\"|\"supplier\" or an array), is_archived (bool), siret, vat, reference [..], id [ids], contacts [contact ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times, number_of_employees {min,max}.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, name, created_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: last_name, email, phone_number, mobile_number, companies [company ids], individuals [individual ids], id [ids], is_linked (bool), country_code, postal_code [..], created {start,end} ISO date-times, updated {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, numero, created, date, expiry_date, number, amount."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: status [\"draft\"|\"sent\"|\"read\"|\"accepted\"|\"refused\"|\"expired\"|\"advanced\"|\"partialinvoiced\"|\"invoiced\"|\"cancelled\"], number (exact), currency, date {start,end} dates YYYY-MM-DD, created {start,end} ISO date-times, updated {start,end} ISO date-times, owners [staff ids], assigned_staff_ids [..], contacts [contact ids], related_objects [{type,id}] (type company|individual|opportunity).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: name, id, created_at, updated_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: name (exact), email (exact), type (\"prospect\"|\"client\"|\"supplier\" or an array), is_archived (bool), reference [..], id [ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, number, created, date, amount, due_date."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: status [\"draft\"|\"due\"|\"payinprogress\"|\"paid\"|\"late\"|\"cancelled\"], number (exact), currency, date {start,end} dates YYYY-MM-DD, created {start,end} ISO date-times, updated {start,end} ISO date-times, owners [staff ids], assigned_staff_ids [..], contacts [contact ids], related_objects [{type,id}] (type company|individual|opportunity), is_deposit (bool), is_progress_invoice (bool).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, created_at."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: name, reference, type [\"product\"|\"service\"|\"shipping\"|\"packaging\"], is_archived (bool).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
direction
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, created, step_rank, due_date, amount."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: name, number, pipeline [pipeline ids], step [step ids], statuses [\"open\"|\"won\"|\"lost\"|\"cancelled\"|\"closed\"|\"late\"], amount {min,max}, owners [staff ids], assigned_staffs [staff ids], related_objects [{type:\"company\"|\"individual\",id}], created {start,end} ISO date-times, due_date {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
string
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, number, created, date, amount, due_date, order_status."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: status [\"draft\"|\"sent\"|\"read\"|\"accepted\"|\"expired\"|\"advanced\"|\"invoiced\"|\"partialinvoiced\"|\"cancelled\"], order_status [\"none\"|\"wait\"|\"picking\"|\"sent\"|\"partialsent\"], related_objects [{type,id}], updated {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, paid_date."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: status [\"pending\"|\"confirmed\"|\"rejected\"|\"failed\"|\"refund\"], related_objects [{type,id}].",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
Sort direction (default asc).
Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"embed": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z_]+$|^cf\\.\\d+$",
"maxLength": 60
},
"maxItems": 20,
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"]."
},
"field": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$",
"maxLength": 100
},
"maxItems": 40,
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page, 1-100 (default 25)."
},
"order": {
"type": "string",
"pattern": "^[a-z_]+$",
"maxLength": 40,
"description": "Sort field: id, due_date."
},
"offset": {
"anyOf": [
{
"type": "string",
"maxLength": 500,
"minLength": 1
},
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
],
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit."
},
"filters": {
"type": "object",
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: statuses [\"todo\"|\"done\"], owners [staff ids], assigned_staffs [staff ids], labels [label ids], priority {min,max} 0-1, companies [ids], individuals [ids], contacts [ids], related_objects [{type,id}], created {start,end} ISO date-times, due_date {start,end} ISO date-times.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction (default asc)."
}
}
}
