OatmilkDevelopers

Invoicing

sponsorships.save

Save proposed sponsorship context linked to an existing project and customer, keeping a payer distinct. Record package, promised benefits, performance dates, cited country/residency facts and proposed accounting/tax treatment. No customer is silently created and no financial record or classification changes. Editing invalidates the previous review.

POST/api/v1/accounting/sponsorships.save

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_sponsorships_save

Fields

  • idstring (ID)

    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

  • projectIdstring (ID)Required

    The ID of the related record.

  • partyIdstring (ID) or nullRequired

    The ID of a customer or vendor account, from parties.list.

  • packageIdstring (ID) or nullRequired
  • titlestringRequired

    A short title.

    1–200 characters

  • payerNamestring or nullRequired
  • currencystringRequired

    Three-letter currency code, such as CAD or USD.

  • agreedMinorstring or nullRequired

    An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.

  • closedOnstring or nullRequired
  • performanceFromstring or nullRequired
  • performanceTostring or nullRequired
  • benefitsarray of objectsRequired

    at most 50 items

  • factsarray of objectsRequired

    at most 30 items

  • treatmentobjectRequired

    No other fields

  • archivedboolean

    Whether the record is archived.

    Default false

  • 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

Example

curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expectedRevision": 3,
  "projectId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "partyId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "packageId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "title": "Synthetic services agreement",
  "payerName": "Synthetic Ventures Inc.",
  "currency": "CAD",
  "agreedMinor": "1",
  "closedOn": "2026-09-30",
  "performanceFrom": "2026-09-30",
  "performanceTo": "2026-09-30",
  "benefits": [
    {
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "description": "Synthetic example from the docs",
      "performanceFrom": "2026-09-30",
      "performanceTo": "2026-09-30",
      "state": "unknown",
      "sources": [
        {
          "kind": "receipt_original",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
          "quote": "USD"
        }
      ]
    }
  ],
  "facts": [
    {
      "key": "customer",
      "value": "example",
      "confidence": "unknown",
      "sources": [
        {
          "kind": "receipt_original",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
          "quote": "USD"
        }
      ]
    }
  ],
  "treatment": {
    "tax": "example",
    "recognitionDate": "2026-09-30",
    "taxPointDate": "2026-09-30",
    "reason": "Synthetic example from the docs"
  }
}'
Response
{
  "data": { … }
}

Try it

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.

POST/api/v1/accounting/sponsorships.save
curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expectedRevision": 3,
  "projectId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "partyId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "packageId": "7f0f6c1e-1c1f-4b5e-9c8d-2f5e8e3c1a10",
  "title": "Synthetic services agreement",
  "payerName": "Synthetic Ventures Inc.",
  "currency": "CAD",
  "agreedMinor": "1",
  "closedOn": "2026-09-30",
  "performanceFrom": "2026-09-30",
  "performanceTo": "2026-09-30",
  "benefits": [
    {
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "description": "Synthetic example from the docs",
      "performanceFrom": "2026-09-30",
      "performanceTo": "2026-09-30",
      "state": "unknown",
      "sources": [
        {
          "kind": "receipt_original",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
          "quote": "USD"
        }
      ]
    }
  ],
  "facts": [
    {
      "key": "customer",
      "value": "example",
      "confidence": "unknown",
      "sources": [
        {
          "kind": "receipt_original",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
          "quote": "USD"
        }
      ]
    }
  ],
  "treatment": {
    "tax": "example",
    "recognitionDate": "2026-09-30",
    "taxPointDate": "2026-09-30",
    "reason": "Synthetic example from the docs"
  }
}'

More in Invoicing.