sellsy_search
Search across Sellsy
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.
輸入參數q必填typelimitarchived
sellsy_list_companies
List companies
List companies (customers, prospects, suppliers) with paging. Needs companies.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_companies
Search companies
Search companies by name, email, type (prospect/client/supplier), reference, VAT, SIRET, country, postal code, creation or update date. Needs companies.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_company
Get a company
Get one company by id. Needs companies.read.
輸入參數id必填embedfield
sellsy_list_company_contacts
List a company's contacts
List the contacts linked to one company (GET /companies/{id}/contacts). Needs companies.read and contacts.read.
輸入參數limitoffsetcompany_id必填
sellsy_list_individuals
List individuals
List individuals (private customers, prospects, suppliers) with paging. Needs individuals.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_individuals
Search individuals
Search individuals by name, email, type, reference, country, postal code, creation or update date. Needs individuals.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_individual
Get an individual
Get one individual by id. Needs individuals.read.
輸入參數id必填embedfield
sellsy_list_contacts
List contacts
List contacts (people at companies) with paging. Needs contacts.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_contacts
Search contacts
Search contacts by last name, email, phone, linked company or individual, creation date. Needs contacts.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_contact
Get a contact
Get one contact by id. Needs contacts.read.
輸入參數id必填embedfield
sellsy_list_opportunities
List opportunities
List sales opportunities with paging. Needs opportunities.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_opportunities
Search opportunities
Search opportunities by name, number, pipeline, step, status (open/won/lost/cancelled/closed/late), amount, owner or due date. Needs opportunities.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_opportunity
Get an opportunity
Get one opportunity by id. Needs opportunities.read.
輸入參數id必填embedfield
sellsy_list_opportunity_pipelines
List opportunity pipelines
List the sales pipelines (needed to create an opportunity: pipeline id and step id). Needs opportunities.read.
輸入參數limitoffset
sellsy_list_pipeline_steps
List the steps of a pipeline
List the steps of one opportunity pipeline. Needs opportunities.read.
輸入參數limitoffsetpipeline_id必填
sellsy_list_estimates
List estimates
List estimates (quotes) with paging. Needs estimates.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_estimates
Search estimates
Search estimates by status, number, date, currency, owner, contact or related company/individual/opportunity. Needs estimates.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_estimate
Get an estimate
Get one estimate by id, with its rows and amounts. Needs estimates.read.
輸入參數id必填embedfield
sellsy_list_invoices
List invoices
List invoices with paging. Needs invoices.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_invoices
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.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_invoice
Get an invoice
Get one invoice by id, with its rows, amounts and status. Needs invoices.read.
輸入參數id必填embedfield
sellsy_list_invoice_payments
List an invoice's payments
List the payments linked to one invoice. Needs invoices.read and payments.read.
輸入參數limitoffsetinvoice_id必填
sellsy_list_orders
List orders
List orders with paging. Needs orders.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_orders
Search orders
Search orders by status or delivery status, or related company/individual/opportunity. Needs orders.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_order
Get an order
Get one order by id. Needs orders.read.
輸入參數id必填embedfield
sellsy_list_credit_notes
List credit notes
List credit notes with paging. Needs credit-notes.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_get_credit_note
Get a credit note
Get one credit note by id. Needs credit-notes.read.
輸入參數id必填embedfield
sellsy_list_items
List items
List catalog items (products, services, shipping, packaging) with paging. Needs items.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_items
Search items
Search catalog items by name, reference or type. Needs items.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_item
Get an item
Get one catalog item by id. Needs items.read.
輸入參數id必填embedfield
sellsy_search_payments
Search payments
Search payments by status (pending/confirmed/rejected/failed/refund) or related company/individual. Needs payments.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_list_tasks
List tasks
List tasks with paging. Needs tasks.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_search_tasks
Search tasks
Search tasks by status (todo/done), owner, assignee, label, due date or related record. Needs tasks.read.
輸入參數embedfieldlimitorderoffsetfiltersdirection
sellsy_get_task
Get a task
Get one task by id. Needs tasks.read.
輸入參數id必填embedfield
sellsy_list_task_labels
List task labels
List the task labels (a label id is required to create a task). Needs tasks.read.
輸入參數limitoffset
sellsy_list_staffs
List staff members
List the staff members of the account (the list may hold only yourself, depending on the Sellsy plan). Needs staffs.read.
輸入參數embedfieldlimitorderoffsetdirection
sellsy_create_company
Create a company
WRITE: create a company record in Sellsy (a prospect, client or supplier). Needs companies.write. Nothing is sent to the company.
輸入參數name必填notetype必填emailwebsiteowner_idreferencephone_numbermobile_numbernumber_of_employeesmain_activity_description
sellsy_create_individual
Create an individual
WRITE: create an individual (a private person as prospect, client or supplier) in Sellsy. Needs individuals.write.
輸入參數notetype必填emailwebsitecivilityowner_idlast_name必填referencefirst_namephone_numbermobile_number
sellsy_create_contact
Create a contact
WRITE: create a contact (a person) in Sellsy. It is not linked to a company by this call. Needs contacts.write.
輸入參數noteemailcivilityowner_idpositionlast_name必填first_namephone_numbermobile_number
sellsy_create_opportunity
Create an 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.
輸入參數name必填notestep必填amountrelated必填due_dateowner_idpipeline必填contact_idsprobabilityassigned_staff_ids
sellsy_move_opportunity
Move an opportunity to another step
WRITE: move an existing opportunity to another step of its pipeline, or to a step of another pipeline (then pass that pipeline too). Only the step (and the pipeline) change; the name, amount, status and links stay. Get the ids from sellsy_get_opportunity, sellsy_list_opportunity_pipelines and sellsy_list_pipeline_steps. Needs opportunities.write.
輸入參數id必填step必填pipeline
sellsy_create_task
Create a 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.
輸入參數titledue_date必填label_id必填owner_idpriorityis_privaterelated_iddescriptionrelated_typeassigned_staff_ids