`get_finance_clawbacks_voucher`

Read-only

Calls GET /api/finance/clawbacks/voucher as the signed-in person · REST reference

Look a voucher up by code before filing a clawback of it (platform staff)

A voucher by its exact code, with what Pawsitive Future weighs before filing a clawback of it: its state (only a PAID voucher's payout can be clawed back), the service provider that took it and was paid, its credited amount, what is left of it after every clawback of it that was not denied, and the clawback in flight, if any. Reads only; filing is POST /api/finance/clawbacks.

Arguments

Argument	Type		Description
`code`query	string	required

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_finance_clawbacks_voucher",
    "arguments": {
      "code": "string"
    }
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The voucher

json

{
  "clawbackStatus": "REQUESTED",
  "code": "string",
  "creditedAmount": 1,
  "currency": "string",
  "id": "11111111-1111-4111-8111-111111111111",
  "openClawbackId": "11111111-1111-4111-8111-111111111111",
  "orgId": "11111111-1111-4111-8111-111111111111",
  "orgName": "string",
  "paidAt": 1,
  "remainingAmount": 1,
  "state": "string"
}

Fields

Field	Type	Description
`clawbackStatus`	"REQUESTED" \| "APPROVED" \| "EXECUTING" \| "RECOVERED" \| "PARTIALLY_RECOVERED" \| "WRITTEN_OFF" \| … (7 values)	The status of the latest payout clawback against a voucher, resolved ones included — what the voucher's (or its payout's) clawback chip says. Null when there is none. DENIED is never reported, nor a REQUESTED clawback Pawsitive Future filed: until it is approved it is Pawsitive Future's own deliberation.
`code`	string
`creditedAmount`	integer	CENTS its payout credited.
`currency`	string
`id`	string (uuid)
`openClawbackId`	string (uuid) \| null	The clawback of it in flight, if any; a second is refused while it is.
`orgId`	string (uuid) \| null	The service provider that took it — the one a clawback asks; null when no clinic did.
`orgName`	string \| null
`paidAt`	integer \| null	Epoch milliseconds.
`remainingAmount`	integer	CENTS still claimable — creditedAmount less every clawback of it that was not denied.
`state`	string	Its lifecycle state; only a PAID voucher's payout can be clawed back.

When it fails

A failed call returns isError: true with the API's message as text.

400: The request was malformed or failed a guard.
403: Authenticated, but the caller holds none of the required permissions.
404: No live voucher has the code.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json

{
  "name": "get_finance_clawbacks_voucher",
  "description": "GET /api/finance/clawbacks/voucher — A voucher by its exact code, with what Pawsitive Future weighs before filing a clawback of it: its state (only a PAID voucher's payout can be clawed back), the service provider that took it and was paid, its credited amount, what is left of it after every clawback of it that was not denied, and the clawback in flight, if any. Reads only; filing is POST /api/finance/clawbacks.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "code": {
        "type": "string"
      }
    },
    "required": [
      "code"
    ]
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}