invoice_links.create

Get the link to an invoice’s page for its customer, creating it if the invoice has none. Anyone holding it can read that invoice without an account until it is revoked.

What it does

Return the invoice’s page link, minting it once if the invoice has no live one: a page at /e/{slug}/invoice/{token} on this server (the kernel is host-agnostic, so the path is what it can promise) that shows the invoice’s figures and lines, the business’s payment instructions for its currency, and its content address, to anyone holding the link, without an account. It names this one invoice, never expires, and stays valid until invoice_links.revoke. It is not a shared view and does not count against the shared-view allowance.

The invoice is a receivable (trade receivable) the business billed; a voided invoice is refused. A second call returns the same link.

Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe invoice_links.create through GET /v1/catalog/commands/{name} before acting.

This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.

Inputs

Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

FieldTypeRequiredMeaning and accepted values
invoiceIdstringYesThe invoice’s claimId, as aging or activity_claims returns it. Minimum length: 1. Example: "claim_01K00000000000000000000000".

After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.

Result fields

Required means required within its containing object; an optional parent can be omitted.

FieldTypeRequiredMeaning and accepted values
linkIdstringYes
invoiceIdstringYes
tokenstringYes
pathstringYes

All commands · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "invoice_links.create"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "invoiceId": {
          "type": "string",
          "minLength": 1,
          "description": "The invoice's claimId, as aging or activity_claims returns it."
        }
      },
      "required": [
        "invoiceId"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "description": "A key you choose, stable for this one command: retrying with it returns the original receipt instead of running again; reusing it for a different command is refused."
    },
    "effective_at": {
      "type": "string",
      "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))$",
      "description": "When the change takes effect in the books, in UTC with Z: the business date it happened, not when you record it."
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}

Accepted command receipt

{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "properties": {
        "linkId": {
          "type": "string"
        },
        "invoiceId": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      },
      "required": [
        "linkId",
        "invoiceId",
        "token",
        "path"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "invoice_links.create",
  "input": {
    "invoiceId": "claim_01K00000000000000000000000"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "invoice_links.create-example-0"
}
Navigate documentation