---
title: "POST /api/royalty"
method: POST
path: "/api/royalty"
tags: ["Royalty"]
---

# POST /api/royalty

`POST /api/royalty`

## Request

- Base URL: `https://data.deluxe.com` (the document declares no server; this is the origin it was published from)
- URL: `https://data.deluxe.com/api/royalty`
- Auth: API key in header `X-Deluxe-Auth`
- TypeScript: <https://skmtc.dev/deluxe/apis/append-api/docs/api/royalty/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- RoyaltyRequest
  - `supplierPartyId` integer
  - `month` integer
  - `year` integer

## Response `200`

Success

- RoyaltyRecord[]
  - `id` integer
  - `transactionDate` string, date-time
  - `marketerId` integer
  - `subCode` string, nullable
  - `dataDictionaryIds` integer[], nullable
  - `billingReferenceCode` string, nullable
  - `searchTypeId` integer

---

[API](https://skmtc.dev/deluxe/apis/append-api.md) - [All operations](https://skmtc.dev/deluxe/apis/append-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deluxe/apis/append-api/revisions/e7cde4e5a902?raw)