`sponsorships.links.set`

Replace a sponsorship's references and partial associations to existing income/refund/fee entries, invoices and invoice payments. Source revisions, currencies, current access and total cross-sponsorship allocation are checked. Does not change bank reconciliation, amounts, categories or tax.

POST/api/v1/accounting/sponsorships.links.set

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_sponsorships_links_set

Fields

idstring (ID)Required
The record's ID.
expectedRevisionintegerRequired
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
0 to 9007199254740991
linksarray of objectsRequired
at most 100 items
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters

curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3,
  "links": [
    {
      "kind": "entry",
      "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "sourceRevision": 3,
      "amountMinor": "1",
      "currency": "CAD",
      "reason": "Synthetic example from the docs"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3,
    "links": [
      {
        "kind": "entry",
        "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "sourceRevision": 3,
        "amountMinor": "1",
        "currency": "CAD",
        "reason": "Synthetic example from the docs"
      }
    ]
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
        "links": [
            {
                "kind": "entry",
                "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
                "sourceRevision": 3,
                "amountMinor": "1",
                "currency": "CAD",
                "reason": "Synthetic example from the docs",
            },
        ],
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/sponsorships.links.set

curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3,
  "links": [
    {
      "kind": "entry",
      "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "sourceRevision": 3,
      "amountMinor": "1",
      "currency": "CAD",
      "reason": "Synthetic example from the docs"
    }
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3,
    "links": [
      {
        "kind": "entry",
        "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "sourceRevision": 3,
        "amountMinor": "1",
        "currency": "CAD",
        "reason": "Synthetic example from the docs"
      }
    ]
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/sponsorships.links.set",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
        "links": [
            {
                "kind": "entry",
                "sourceId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
                "sourceRevision": 3,
                "amountMinor": "1",
                "currency": "CAD",
                "reason": "Synthetic example from the docs",
            },
        ],
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside links

Example

Try it