Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt

Use this file to discover all available pages before exploring further.

royaltyport statements upload <project_id> [file_path]
Uploads a statement file to a project for processing. You can provide either a local file path or base64-encoded content.

​
Arguments

ArgumentRequiredDescription
project_idYesThe project UUID
file_pathNoPath to the statement file

​
Options

OptionShortDescription
--base64 <string>—Base64-encoded file content (alternative to file_path)
--file-name <name>—File name (required with --base64)

​
Behavior

  • You must provide either file_path or --base64, but not both
  • When using --base64, --file-name is required
  • On success, prints the staging ID and a hint to track progress with royaltyport statements status

​
Output

Prints a table with upload details:
FieldDescription
Staging IDUnique identifier for tracking processing progress
Staging StageCurrent processing stage (queued, processing, completed, failed)
Staging DoneWhether staging (pre-processing) has completed
Processing DoneWhether statement processing has completed
Created AtUpload timestamp

​
Examples

Upload a local file: 
royaltyport statements upload a1b2c3d4-e5f6-7890-abcd-ef1234567890 ./Q1-2025-royalties.xlsx
Upload base64-encoded content: 
royaltyport statements upload a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --base64 "UEsDBBQAAAAI..." \
  --file-name "Q1-2025-royalties.xlsx"