Well

Update supplier payment term

well_update_supplier_payment_term

Update the active payment terms of a supplier in the current workspace.

REQUIRED: supplier_payment_terms_id. OPTIONAL: payment_method, due_date_delay_days, 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 field must be supplied; omitted fields keep their current value.

Terms a connected tool synced in cannot be changed in Well: the next sync would overwrite the change. The call then fails; tell the user to change them in that tool.

Returns { success: true, supplier_payment_term } on success, or { success: false, error } on failure.

A supplier's payment terms.

Input Schema

Name	Required	Description
`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
`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
`supplier_payment_terms_id`	Yes	The id of the supplier payment terms to update.

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"
-  }
-]

addedInput schema / 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."

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

A4.6/5.0

Behavior5/5

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

Annotations only declare the non-read-only, non-destructive, closed-world profile; the description goes well beyond them by documenting partial-update semantics, the sync-overwrite failure mode with the correct user-facing remedy, and the success/error return shape. These are exactly the behaviors an agent needs before committing a mutation.

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/behavior/returns layout is well front-loaded and easy to scan. Minor waste: the enum list duplicates the schema, and the trailing fragment 'A supplier's payment terms.' adds nothing and reads like a truncated field label.

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

Completeness5/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, the description covers the required id, the mutable fields, the partial-update contract, the one hard failure mode, and the response envelope. Workspace/conversation/idempotency parameters are already fully documented in the schema, so nothing an agent needs is missing.

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

Parameters4/5

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

Schema coverage is 67%, and the description adds real meaning beyond the schema: which field is required, which are optional, the 'at least one' constraint, and merge-vs-replace semantics for omitted fields. It repeats the due_date_rule enum verbatim from the schema and says nothing about how due_date_delay_days interacts with due_date_rule or what payment_method accepts, leaving some ambiguity.

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

Purpose5/5

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

Opens with a specific verb and resource ('Update the active payment terms of a supplier') plus the scope ('in the current workspace'), which cleanly separates it from the create/delete supplier-payment-term siblings. An agent can identify the operation without opening the schema.

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

Usage Guidelines4/5

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

Gives a concrete precondition ('At least one field must be supplied; omitted fields keep their current value') and an explicit when-not case with a redirect ('terms a connected tool synced in cannot be changed in Well... tell the user to change them in that tool'). It does not name the create/delete siblings as alternatives, but the update-vs-create distinction is largely self-evident.

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?