Skip to main content

MCP tools reference

search-entity-information​

Search for an entity in Simplicate and return its details, including its recent timeline messages. This is the default lookup tool for projects, sales, organizations, persons, employees and invoices, and needs no employee_id. Pass a Simplicate id as search_term to look the record up by id instead of by name. These six entity types are the only records this tool can reach. If an id carries any other prefix, do not call this tool with a related type; say the record type is not supported.

ParameterTypeRequiredDescription
search_termstringYesName to search for. Each entity searches its own fields: organization and person search the relation name, employee the employee name, sales the subject, project the name, project number, project manager and relation, invoice the invoice number, subject, reference and relation. Pass a Simplicate id to return exactly that one record. The id prefix is the entity_type itself: "organization:...", "person:...", "employee:...", "sales:...", "project:...", "invoice:...". An id with any other prefix, for example "projectservice:...", "document:..." or "hours:...", is a different kind of record. This tool cannot look it up. Do not substitute a related entity_type such as project.
entity_typeenumYesType of the entity to search information for. "sales" is a sale or opportunity (Dutch "salestraject"), never a company; use "organization" for a company. "myorganizationprofile" is your own company's business profile and ignores search_term. One of: project, sales, organization, person, employee, invoice, myorganizationprofile.

create-sale​

Create a new sale (opportunity, 'salestraject') for an organization or a person. Needs one of your own business profiles: find it with search-entity-information, entity_type 'myorganizationprofile'. To change an existing sale use update-sale; to add services, add-sale-services. Show the details and get the user's confirmation first.

ParameterTypeRequiredDescription
subjectstringYesSubject/title of the sale
organization_idstringNoOrganization. Either organization_id or person_id must be provided.
person_idstringNoPerson. Either organization_id or person_id must be provided.
my_organization_profile_idstringYesMy organization profile id - must be one of your own company's business profiles (myorganizationprofile), NOT a regular organization. Search with entity_type 'myorganizationprofile' to find available profiles
responsible_employee_idstringNoEmployee id of the sales responsible for the new sale. Leave this out to make the employee behind the current credentials responsible, which is what the user means unless they say otherwise. Use null only when the user asks for a sale with no responsible employee. Such a sale does not show in list-sales. Never ask the user for this value.
confirmedbooleanYesMust be true to create the sale. Always show the sale details to the user and ask for confirmation BEFORE setting this to true.

update-sale​

Change fields of an existing sale; only the fields you pass change, and null clears divergent_payment_term_id. Get ids from search-sales-options (status, progress, reason, source) and search-payment-terms. Show the changes and get the user's confirmation first.

ParameterTypeRequiredDescription
sale_idstringYesThe ID of the sale to update
subjectstringNoSubject/title of the sale
organization_idstringNoOrganization linked to the sale
person_idstringNoPerson linked to the sale
my_organization_profile_idstringNoMy organization profile id - must be one of your own company's business profiles (myorganizationprofile), NOT a regular organization. Search with entity_type 'myorganizationprofile' to find available profiles
start_datestringNoStart date of the sale (YYYY-MM-DD format)
expected_closing_datestringNoExpected closing date of the sale (YYYY-MM-DD format)
expected_revenuenumberNoExpected revenue from the sale
chance_to_scorenumberNoChance to score/win the sale (0-100 percentage)
progress_idstringNoSales progress/stage ID
reason_idstringNoSales reason/source ID
contact_idstringNoContact person ID linked to the sale
responsible_employee_idstringNoEmployee ID of the person responsible for this sale
source_idstringNoSource ID indicating where the sale/lead originated from
status_idstringNoStatus ID representing the current status of the sale (e.g., open, won, lost)
notestringNoNote or description for the sale
divergent_payment_term_idstring,nullNoDivergent payment term ID. Use null to unset. Search with 'search-payment-terms' to find available payment terms
confirmedbooleanYesMust be true to update the sale. Always show the changes to the user and ask for confirmation BEFORE setting this to true.

search-sales-options​

Search for available sales options from Simplicate. Use this to find IDs for status, progress, reason, or source when updating sales.

ParameterTypeRequiredDescription
option_typeenumYesType of sales option to retrieve: status (sales statuses), progress (sales progress stages), reason (sales reasons), source (sales sources). One of: status, progress, reason, source.

list-sales​

List the sales (opportunities, Dutch "salestrajecten") of one sales responsible, open ones by default, with the signals needed to judge follow-up: the most recent note, e-mail or call note on the timeline, whether the customer's last e-mail is still unanswered, and the earliest open to-do linked to the sale. Sales come sorted by expected revenue, 50 per page; page with offset until metadata.offset + metadata.limit reaches metadata.count. Use search-entity-information to read the timeline of one sale in detail.

ParameterTypeRequiredDescription
responsible_employee_idstringNoEmployee id of the sales responsible whose sales to list. Leave this out to list the sales of the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value.
statusenumNoSales status to list: open (default), won, lost, or all statuses. One of: open, won, lost, all.
offsetintegerNoNumber of sales to skip; use metadata.offset + metadata.limit for the next page

search-payment-terms​

Search all available payment terms from Simplicate. Use this to find payment term IDs when asked to update divergent payment term.

create-draft-invoices​

Start a run that creates concept invoices for an explicit list of projects — the same process as the 'Facturen maken' collective action in Simplicate. Returns a handle immediately without waiting; follow the run with get-draft-invoice-run. Find the project ids with search-entity-information first, and only invoice the projects the user named.

ParameterTypeRequiredDescription
project_idsarrayYesThe projects to invoice, as an explicit list of project ids found with search-entity-information. At most 100. Never guess these ids and never widen the list beyond what the user named.
data_typesarrayNoThe kinds of work to put on the concept invoices. Defaults to hours only. advance_deposits is a mode of its own, the way the screen offers it: submit it alone, never together with another kind, and only when the environment has advance invoicing switched on.
create_typeenumNoalways_new creates a new concept invoice per project; existing_project adds the lines to an existing concept invoice for the same project when there is one; existing_debtor puts the projects of the same debtor together on one concept invoice, which only works when the environment has merging per debtor switched on. One of: always_new, existing_project, existing_debtor.
start_datestringNoOnly invoice work dated on or after this date (YYYY-MM-DD). Leave both dates out to invoice everything that is open, which is what the user means unless they name a period. Never pass one date without the other.
end_datestringNoOnly invoice work dated on or before this date (YYYY-MM-DD). Goes together with start_date: give both or neither.
confirmedbooleanYesMust be true to start the run. First show the user which projects will be invoiced and which options are used, and ask for confirmation. Amounts cannot be shown beforehand: there is no dry run.

get-draft-invoice-run​

Read the status of a draft invoice run started with create-draft-invoices. Waits for the run for a short while before answering. If the run is still going when it answers, call it again with the same handle to keep following it.

ParameterTypeRequiredDescription
request_idstringYesThe run handle returned by create-draft-invoices

identify-current-employee​

Identify the current employee based on the provided credentials. Call this to obtain the employee_id that the other tools require, instead of asking the user for it.

search-registration-project​

Search for a project in Simplicate by name and return its external id. Only returns projects the given employee may register on, so use search-entity-information instead for general project lookups such as finding a project number. At most 5 search terms per call, and the API returns at most 100 projects per term.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
search_termsarrayNoThe names, project_numbers, relation names or relation numbers of the projects to search for, at most 5. Every term is searched separately and the results are merged, if none are provided the first 100 records are returned
registration_datestringNoThe date to register the hour or the mileage for, as YYYY-MM-DD or 'today'. Used to filter registrable projects for that date if defined
for_mileagebooleanNoSet this to true to limit results to projects that support mileage registration

search-project-service-for-registration​

Search a project service in Simplicate for a project by name and return its external id. At most 5 search terms per call. This endpoint returns every project service of the project, however many there are.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
project_idstringYesProject id of a Simplicate project, projects contain project services
search_termsarrayNoThe names or numbers of the project services to search for, at most 5. A project service matching any of them is returned
registration_datestringNoThe date to register the hour for, as YYYY-MM-DD or 'today'. Used to filter registrable project services for that date if defined

search-bookable-hour-type​

Search the Simplicate hour types (in Dutch 'urensoorten') this employee may book on this project service, so the answer to what someone can write hours on, and return their external ids. Use this while preparing an hour registration. Use search-hour-type-catalog to look up an hour type that is not tied to a project service. At most 5 labels per call. Asks the API once and returns at most 100 hour types over all labels together, because the labels filter that one answer.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
project_idstringYesProject id of a Simplicate project, projects contain project services. Look one up with search-registration-project
project_service_idstringYesProject service id of a Simplicate project service, a project service belongs to a project and contains hourtypes. In dutch this is called 'Project dienst'. Look one up with search-project-service-for-registration
hour_type_labelsarrayNoLabels to filter hour types by, at most 5. An hour type matching any of them is returned. If none are provided the first 100 records are returned

search-hour-type-catalog​

Search every Simplicate hour type (in Dutch 'urensoorten') in the administration, bookable or not, with its kind and default tariff, and return their external ids. Use search-bookable-hour-type instead while preparing an hour registration, because this tool also returns hour types the employee may not book. At most 5 labels per call. Asks the API per label and returns at most 100 hour types per label.

ParameterTypeRequiredDescription
hour_type_labelsarrayNoLabels to filter hour types by, at most 5. An hour type matching any of them is returned. If none are provided the first 100 records are returned

register-hour-time-unaware​

Register hours in Simplicate by defining a registration date and a duration in minutes (duration_in_minutes, default 30). The hour is registered as a block of time without a specific start- and end time.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
project_idstringYesProject id of a Simplicate project, projects contain project services
project_service_idstringYesProject service id of a Simplicate project service, a project service belongs to a project and contains hourtypes. In dutch this is called 'Project dienst'
type_idstringYesHourtype id of a Simplicate hourtype, an hourtype belongs to a project service and project. In dutch this is called 'Urensoort'
registrationDatestringYesA date as YYYY-MM-DD, or the word 'today'. Name the day you mean, there is no default
notestringNoNote that can be added to the hour registration, supports max 1000 characters
duration_in_minutesintegerNo

register-hour-time-aware​

Register hours in Simplicate by defining a registration date, a start time and an end time. The hour is registered with a specific start- and end time.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
project_idstringYesProject id of a Simplicate project, projects contain project services
project_service_idstringYesProject service id of a Simplicate project service, a project service belongs to a project and contains hourtypes. In dutch this is called 'Project dienst'
type_idstringYesHourtype id of a Simplicate hourtype, an hourtype belongs to a project service and project. In dutch this is called 'Urensoort'
registrationDatestringYesA date as YYYY-MM-DD, or the word 'today'. Name the day you mean, there is no default
notestringNoNote that can be added to the hour registration, supports max 1000 characters
start_timestringYesStart time of the hour registration in HH:mm format, in the local time of the user
end_timestringYesEnd time of the hour registration in HH:mm format, in the local time of the user
external_calendar_itemobjectNoThe external calendar item this hour is written for. Pass it to keep the hour linked to that item, so the item is not proposed again and no second appointment appears in the external calendar. The link is only made for hours of the employee behind the current credentials, so leave employee_id out when you pass this.

create-timeline-note​

Add a note to the timeline of a project, sale, organization, person or invoice, written as the current employee unless employee_id is given. Find entity_id with search-entity-information. Each call adds a note, and this server cannot edit or remove one afterwards.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
notestringYesContent of the timeline note
entity_idstringYesId of the entity to create the note for
entity_typeenumYesType of the entity to create the note for. One of: project, sales, organization, person, invoice.

list-employees-for-registration​

List employees for which the current employee may register

ParameterTypeRequiredDescription
registrationDatestringYesA date as YYYY-MM-DD, or the word 'today'. Name the day you mean, there is no default

get-hour-registrations​

Get existing hour registrations for an employee over a period. Can be used to view what hours have been registered, or as input for creating new registrations with a similar configuration. The period may cover at most 31 days, and the API returns at most 100 registrations, so ask per project or per shorter period when you need more.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
date_fromstringYesFirst day of the period to get hour registrations for, as YYYY-MM-DD or 'today'
date_tostringYesLast day of the period to get hour registrations for, as YYYY-MM-DD or 'today'. The period may cover at most 31 days
project_idstringNoOptional project ID to filter registrations by project

update-hour​

Correct an existing hour registration in Simplicate. Leave out the fields the user does not want to update, only the fields you pass are changed. Moving a registration to another date keeps its start time. Changing only duration_in_minutes keeps the start time and moves the end time. The project, project service and hour type cannot be changed. To book the time elsewhere, tell the user and, only after they agree, register it again and then delete the old registration with delete-hour.

ParameterTypeRequiredDescription
hour_idstringYesId of the hour registration to update, as returned by get-hour-registrations
registration_datestringNoMove the registration to another date
start_timestringNoNew start time in HH:mm format, in the local time of the user, pass together with end_time
end_timestringNoNew end time in HH:mm format, in the local time of the user, pass together with start_time
duration_in_minutesintegerNoNew duration in minutes. Use this or start_time and end_time, not both
notestringNoNote on the hour registration, supports max 1000 characters

delete-hour​

Delete an existing hour registration in Simplicate. Mileage linked to this hour is deleted with it.

ParameterTypeRequiredDescription
hour_idstringYesId of the hour registration to delete, as returned by get-hour-registrations

search-sale-services​

Search the services already on one sale by name. Returns at most 10 services, each with id and name. To add services use add-sale-services; for service templates use search-default-services.

ParameterTypeRequiredDescription
sale_idstringYesSale id of a Simplicate sale/opportunity. In Dutch this is called 'Salestraject'
search_termstringYesPart of the name of the sale services to search for. Returns at most 10 matches

search-default-services​

Search the catalog of default services (service templates) in Simplicate to find a default_service_id.

ParameterTypeRequiredDescription
search_termstringNoOptional name to filter default services by. Leave out to list the first default services.

list-default-workflows​

List the workflows this customer has configured and that the current employee can start, with what each one requires. Use this before starting a workflow: it is the only way to get a valid workflow id. Workflows that cannot be started are left out.

create-workflow​

Start a workflow for this customer from one of their configured workflows. Call list-default-workflows first: it is the only source of valid workflow ids and it says per workflow whether a subject is required.

ParameterTypeRequiredDescription
default_workflow_idstringYesId of a Simplicate default workflow, the configured template a workflow is started from. Pass this when starting a workflow. In Dutch this is called 'Standaard workflow'
titlestringYesShort subject of the workflow, shown in the overview. Required. Plain text only.
descriptionstringYesWhat has to happen, for the colleague who picks the workflow up. Required. Plain text only: Simplicate shows it exactly as it is given, so markdown, BBCode and HTML land as the literal characters that spell them.
destination_employee_idstringYesThe colleague who gets the first step of the workflow, as the external id list-employees-for-registration returns, so it starts with "employee:". Required: never guess it and never pass an internal number. Ignored when the workflow has a fixed destination configured.
subject_typeenumNoWhat the workflow is about. Pick one of the allowedSubjectTypes that list-default-workflows reports for this workflow; that is also the word you search with in search-entity-information. You have to pass one when isSubjectRequired is true. When it is false you may still pass one if allowedSubjectTypes is not empty, and you leave both subject fields out when it is. One of: project, sales, organization, person, employee, invoice.
subject_idstringNoId of the subject, as returned by search-entity-information. It has to be that external id, not an internal number. Pass it together with subject_type.
deadlinestringNoDate the whole workflow has to be finished, as YYYY-MM-DD. Optional: leave it out when the user names no deadline. Simplicate refuses a date in the past, so ask the user rather than guessing one. A workflow of one step has a single deadline: pass either this or step_deadline and Simplicate copies it to the other, and it refuses two different dates.
step_deadlinestringNoDate the first step has to be finished, as YYYY-MM-DD. Optional, and it has to fall on or before deadline. Pass this when the user names a deadline for the task rather than for the whole workflow.
attachmentsarrayNoDocuments already stored in Simplicate to attach to the workflow, each as the id search-documents returns. Look the document up there first; the argument takes no file name or content. Only allowed when canHaveAttachment is true for this workflow in list-default-workflows, and Simplicate refuses the call otherwise. When the document is not in Simplicate yet, refer the user to the app to upload it there and leave this out.
confirmedbooleanYesMust be true to start the workflow. Starting one puts work on a colleague's plate and can email them, so always show the details to the user and ask for confirmation BEFORE setting this to true.

list-open-workflows​

List the workflows whose current step the current employee holds and may act on, with the actions that step offers and who the next step can go to. Use this before advance-workflow or transfer-workflow: it is the only source of the workflow and action ids they take. These are ids of started workflows, not the defaultworkflow ids of the templates list-default-workflows returns. It covers the current employee only.

ParameterTypeRequiredDescription
pageintegerNoPage to read, starting at 1. Each page holds up to 30 workflows. Leave it out for the first page.

advance-workflow​

Apply an action of the current step of a workflow the current employee holds, such as approving or rejecting it. The workflow moves to the step the action leads to, or completes when it leads to none. Call list-open-workflows first: it is the only source of the workflow and action ids and says per action which destinations it takes.

ParameterTypeRequiredDescription
workflow_idstringYesId of the workflow, as list-open-workflows returns it, so it starts with "workflow:". Not the defaultworkflow id of a template.
action_idstringYesAn action of the current step, as list-open-workflows lists it under currentStep.actions, so it starts with "defaultaction:".
reactionstringNoMessage placed on the workflow with the action, for the colleagues on it. Required when the action has isReactionRequired, and a reaction of only spaces does not count. Plain text only: Simplicate refuses HTML.
destinationsarrayNoWho gets the next step. Follow the destinations hint of the action in list-open-workflows: pass at least one for required, pass some for optional only when the user names who gets it instead of the step's own assignees, and leave this out for fixed and none.
step_deadlinestringNoDate the step the workflow moves to has to be finished, as YYYY-MM-DD. Pass it only when the user names a deadline for that step, and do not ask for one. Without it, the next step is due the processing time configured for it after the workflow reaches it, and the deadline of the current step does not carry over. Leave it out when the action's toStepId in list-open-workflows is null: an action that completes the workflow takes no deadlines. Simplicate refuses a date in the past and a date after the workflow deadline (the new one when you pass deadline), and calls this stepDeadline in its refusals.
deadlinestringNoNew date the whole workflow has to be finished, as YYYY-MM-DD, set with the move. Pass it only when the user names a new deadline for the whole workflow, and do not ask for one. Leave it out to keep the workflow deadline as it is, and when the action's toStepId in list-open-workflows is null. Simplicate refuses a date in the past, and calls this workflowDeadline in its refusals.
confirmedbooleanYesMust be true to apply the action. It moves work on to colleagues, can email them, and cannot be undone, so always show the user the workflow, the action and who gets the next step, and ask for confirmation BEFORE setting this to true. When you leave destinations out, say the next step goes to the assignees it is configured with, rather than naming anyone. Name the deadlines you pass. When the action moves to a next step and you pass no step_deadline, say the next step is due the processing time configured for it after the workflow reaches it, and that the deadline of the current step does not carry over.

transfer-workflow​

Hand the current step of a workflow to one colleague, who replaces everyone holding it now. The workflow stays on the same step. Get the workflow id from list-open-workflows. Some steps do not allow changing who holds them, and Simplicate then refuses.

ParameterTypeRequiredDescription
workflow_idstringYesId of the workflow, as list-open-workflows returns it, so it starts with "workflow:". Not the defaultworkflow id of a template.
employee_idstringYesThe colleague who takes over the current step, as the id list-employees-for-registration returns, so it starts with "employee:". Never guess it.
messagestringNoMessage for the colleague who takes the workflow over, placed on the workflow. Plain text only: Simplicate refuses HTML.
confirmedbooleanYesMust be true to hand the workflow over. It puts the step on a colleague's plate instead of the current holders' and can email them, so always show the user the workflow and the colleague and ask for confirmation BEFORE setting this to true.

search-documents​

Find a document that is already stored in Simplicate, by its title or by the name of what it is filed under. Returns per document the id that create-workflow takes as an attachment, its title, its document type and what it is linked to. A document that is not in Simplicate yet cannot be added here: refer the user to the app to upload it first.

ParameterTypeRequiredDescription
search_termstringYesPart of the document title, or the name of the organization, person, project or sale the document is filed under. Matched case-insensitively.

add-sale-services​

Add one or more services to an existing sale in Simplicate. Each service is created from a default service (template) - find its default_service_id with 'search-default-services' first.

ParameterTypeRequiredDescription
sale_idstringYesThe ID of the sale to add the services to
servicesarrayYesOne or more services to add to the sale
confirmedbooleanYesMust be true to add the services. Always show the services to the user and ask for confirmation BEFORE setting this to true.

register-mileage​

Register mileage in Simplicate on a project for a given date. Mileage is registered on a project only, there is no project service and no mileage type to look up. The project must have mileage registration enabled, so find it with search-registration-project using for_mileage set to true.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
project_idstringYesProject id of a Simplicate project, projects contain project services
registration_datestringYesThe date to register the mileage for, as YYYY-MM-DD or 'today'
mileagenumberYesTotal distance driven, in kilometers. Double it yourself for a return trip ('retour', 'heen en terug')
notestringNoNote that can be added to the mileage registration, supports max 1000 characters
related_hour_idstringNoOptional id of an hour registration to link this mileage to. The hour must be on the same project and cannot be leave or absence

get-mileage-registrations​

Get existing mileage registrations for an employee over a period. Use it to check what has already been registered, or as input for a correction with update-mileage.

ParameterTypeRequiredDescription
employee_idstringNoEmployee id of a Simplicate employee. Leave this out to act as the employee behind the current credentials, which is what the user means unless they say otherwise. Never ask the user for this value. Only pass it when the user explicitly acts on behalf of a colleague, and look that colleague up with list-employees-for-registration first.
date_fromstringYesFirst day of the period to get mileage registrations for, as YYYY-MM-DD or 'today'
date_tostringYesLast day of the period to get mileage registrations for, as YYYY-MM-DD or 'today'
project_idstringNoOptional project id to filter registrations by project

update-mileage​

Correct an existing mileage registration in Simplicate. At least one of mileage, registration_date, note or related_hour_id must be filled. Only the fields you pass are changed, the rest is left alone. The employee and the project cannot be changed after creation, and a registration that has been approved or invoiced can no longer be edited.

ParameterTypeRequiredDescription
mileage_idstringYesId of the mileage registration to update, as returned by get-mileage-registrations
mileagenumberNoThe total distance in kilometers to store, replacing the current value
registration_datestringNoMove the registration to another date
notestringNoNote on the mileage registration, supports max 1000 characters
related_hour_idstringNoId of an hour registration to link this mileage to. The hour must be on the same project

create-crm-relation​

Create a new relation in Simplicate: an organization or a person. A person needs a family name. The gender is optional: leave it out rather than derive one from the first name. Look up every id field with search-crm-options. Accountancy fields need the accountancy branch, and a person's bank_account and bank_bic need the setting for private individuals. Always show the relation details to the user and ask for confirmation BEFORE setting confirmed to true.

ParameterTypeRequiredDescription
relationstringYesThe relation to create, either an organization or a person.
confirmedbooleanYesMust be true to create the relation. Always show the details to the user and ask for confirmation BEFORE setting this to true.

search-crm-options​

Read the CRM lookup values available in this environment: relation type, industry, organization size, gender, customer group, country, team, interest and payment term. Use this to find the ids that create-crm-relation takes; it accepts ids only and never matches on a name. customergroup lists the organizations already used as a customer group, not every organization that could become one. team requires the hrm_options module; if this environment does not have it, this call is refused.

ParameterTypeRequiredDescription
option_typeenumYesWhich lookup values to read: relationtype (relatiesoort), industry (branche), organizationsize (organisatiegrootte), gender (geslacht), customergroup (klantgroep), country (land), team, interest or paymentterm (betalingstermijn). One of: relationtype, industry, organizationsize, gender, customergroup, country, team, interest, paymentterm.