# sponsorships.invoice.preview

Preview a sponsorship invoice from its package and optional existing invoice template, using the existing customer's legal/billing identity and project. Choose currency, price, service dates, terms and explicit tax treatment; unknown tax remains unconfirmed, country alone never selects tax. Preview does not create, issue or send an invoice.

`GET | POST /api/v1/accounting/sponsorships.invoice.preview`

Permissions: `accounting:read` · Roles: admin, finance · Send `expectedRevision`

MCP tool: `accounting_sponsorships_invoice_preview`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | string (ID) | Yes | The record's ID. |
| `expectedRevision` | integer | Yes | 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. |
| `additionalInvoiceReason` | string or null |  | Default `null`. |
| `issueDate` | string or null |  | The date the document was issued, as YYYY-MM-DD. |
| `dueDate` | string or null |  | The date payment is due, as YYYY-MM-DD. |
| `taxTreatment` | enum | Yes | One of: `unknown`, `hst`, `gst`, `gst_qst`, `zero_rated`, `exempt`, `none`, `custom`. |
| `taxRateCode` | string or null |  |  |
| `taxReason` | string |  | at most 2000 characters. Default `""`. |
| `terms` | object |  | No other fields. |
| `terms.code` | enum | Yes | One of: `due_on_receipt`, `net_7`, `net_15`, `net_30`, `net_45`, `net_60`, `custom`, `split_50_50`, `monthly`. |
| `terms.days` | integer or null |  |  |
| `priceMinor` | string |  | An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50. Matches ^(?:0\|[1-9]\d{0,18})$. |
| `currency` | string |  | Three-letter currency code, such as CAD or USD. |

## Example request

```bash
curl -G https://app.getoatmilk.com/api/v1/accounting/sponsorships.invoice.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'id=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d' \
  --data-urlencode 'expectedRevision=3' \
  --data-urlencode 'taxTreatment=unknown'
```

Reference page: https://app.getoatmilk.com/docs/api/sponsorships.invoice.preview