Skip to main content
POST
Upload Royalty File
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

The uploaded file is capped at 500 MB. A file exceeding that limit is rejected with a 400 before any processing begins. Authorization:
  • Required role: user or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

multipart/form-data
file
file
required

The royalty file to upload. Maximum size 500 MB.

royaltySource
string
required
accountingPeriod
string<date>
required
salePeriod
string<date>
required
uploadType
enum<string>
required
Available options:
royalty,
invoice,
receipt,
report
originalname
string
required
mimetype
string
required

Response

File uploaded successfully

success
boolean
default:true
message
string
data
object