Well

Create supplier payment term

well_create_supplier_payment_term

Create payment terms for a supplier in the current workspace. A supplier has one active set of terms at a time.

REQUIRED: company_id (the supplier company in this workspace). OPTIONAL: payment_method (e.g. "bank_transfer"), due_date_delay_days (whole days after invoice date), due_date_rule (one of upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month, 45_days, 45_days_end_of_month, 60_days). At least one optional field must be supplied.

Returns { success: true, supplier_payment_term } on success, or { success: false, error } on failure. A duplicate active term for the same supplier is refused.

A supplier's payment terms.

Input Schema

Name	Required	Description
`company_id`	Yes	The supplier company these terms belong to.
`workspaceId`	No
`workspace_id`	No	Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
`due_date_rule`	No	One of upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month, 45_days, 45_days_end_of_month, 60_days, or null.
`payment_method`	No	How the supplier expects to be paid, e.g. 'bank_transfer'.
`conversation_id`	No	The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
`idempotency_key`	No	Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
`workspace_scope`	No	Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.
`due_date_delay_days`	No	Number of days after the invoice date payment is due.

Output Schema

Name	Required	Description
`code`	No
`error`	No
`success`	Yes
`reply_lines`	No
`conversation_id`	No	The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
`near_candidates`	No
`newly_connected`	No	Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
`conversation_id_note`	No	Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.
`supplier_payment_term`	No
`conversation_id_source`	No	Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
`near_candidates_truncated`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 28, 2026

removedInput schema / properties / due_date_rule / anyOf

Removed value: -[
-  {
-    "maxLength": 100,
-    "minLength": 1,
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

changedInput schema / properties / due_date_rule / description

Previous value: -"A free-text rule such as 'end_of_month_plus_15'."New value: +"One of upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month, 45_days, 45_days_end_of_month, 60_days, or null."

addedInput schema / properties / due_date_rule / type
```
Added value: +[
+  "string",
+  "null"
+]
```

addedOutput schema / properties / supplier_payment_term / properties / due_date_rule / description

Added value: +"One of upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month, 45_days, 45_days_end_of_month, 60_days, or null."

Changed10 schema fields changedOct 28, 2026

addedOutput schema / properties / code
```
Added value: +{
+  "type": "string"
+}
```

addedOutput schema / properties / near_candidates

Added value: +{
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "company_id": {
+        "type": "string"
+      },
+      "name": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "company_id",
+      "name"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

addedOutput schema / properties / near_candidates_truncated
```
Added value: +{
+  "type": "boolean"
+}
```

addedOutput schema / properties / reply_lines

Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

changedOutput schema / properties / supplier_payment_term / properties / created_at / pattern

Previous value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"New value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

removedOutput schema / properties / supplier_payment_term / properties / due_date_rule / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
addedOutput schema / properties / supplier_payment_term / properties / due_date_rule / type
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / supplier_payment_term / properties / payment_method / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
addedOutput schema / properties / supplier_payment_term / properties / payment_method / type
```
Added value: +[
+  "string",
+  "null"
+]
```

changedOutput schema / properties / supplier_payment_term / properties / updated_at / anyOf

Previous value: -[
-  {
-    "format": "date-time",
-    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "format": "date-time",
+    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

AddedOct 20, 2026

TDQS

A3.7/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With only readOnly/destructive/openWorld hints from annotations, the description adds real behavioral detail: the refusal of duplicate active terms, the { success, error } failure shape, and the 'one active set at a time' invariant. It stops short of stating what happens to prior terms or how conflicts should be resolved.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The REQUIRED/OPTIONAL layout and return-shape sentence are well organized and front-loaded. The trailing dangling fragment 'A supplier's payment terms.' is stray text that adds nothing and slightly hurts an otherwise tight definition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter mutation with an output schema present, the description covers the business rule, the required/optional split, the enum space, and the failure mode. The remaining plumbing parameters (workspace_id, conversation_id, idempotency_key) are documented in the schema, so omitting them here is acceptable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 89%, so the baseline is 3, and the description largely restates what the schema documents (enum list, payment_method example, due_date_delay_days meaning). It does add one cross-parameter rule not expressible in the schema ('at least one optional field must be supplied'), but says nothing about workspace_id, conversation_id, idempotency_key, or workspace_scope.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence states a specific verb and resource ('Create payment terms for a supplier in the current workspace') and adds a scope rule ('one active set of terms at a time'). It does not, however, name the closely related siblings well_update_supplier_payment_term and well_delete_supplier_payment_term, so the agent must infer that this tool is for new terms only.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description supplies useful call conditions: company_id is required, at least one optional field must be supplied, and a duplicate active term is refused. It does not say when to use this versus update_supplier_payment_term for an existing supplier, which is the main adjacent decision an agent faces.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Well tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?