Track Portal API

openapi: 3.2.0
info:
  title: Track Portal API
  version: 1.0.0
  description: Track API schema
tags:
- name: Portal
paths:
  /api/portal/royalty-statements:
    get:
      operationId: api_portal_royalty_statements_list
      parameters:
      - in: query
        name: contract
        schema:
          type: string
          format: uuid
      - in: query
        name: currency
        schema:
          type: string
      - in: query
        name: ids
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: label_id
        schema:
          type: string
          format: uuid
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: payees
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: period_end_before
        schema:
          type: string
          format: date
      - in: query
        name: period_start_after
        schema:
          type: string
          format: date
      - in: query
        name: status
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      tags:
      - Portal
      security:
      - jwtAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPortalRoyaltyStatementList'
          description: ''
      summary: Api portal royalty statements list
      x-summary-source: derived
  /api/portal/royalty-statements/{id}:
    get:
      operationId: api_portal_royalty_statements_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - Portal
      security:
      - jwtAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalRoyaltyStatement'
          description: ''
      summary: Api portal royalty statements retrieve
      x-summary-source: derived
  /api/portal/royalty-statements/{id}/html:
    get:
      operationId: api_portal_royalty_statements_html_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - Portal
      security:
      - jwtAuth: []
      - cookieAuth: []
      responses:
        '200':
          description: No response body
      summary: Api portal royalty statements html retrieve
      x-summary-source: derived
components:
  schemas:
    ContractTypeEnum:
      enum:
      - recording
      - distribution
      - licensing
      - producer
      - featured_artist
      - exclusive_license
      - '360'
      type: string
      description: '* `recording` - Recording

        * `distribution` - Distribution

        * `licensing` - Licensing

        * `producer` - Producer

        * `featured_artist` - Featured Artist

        * `exclusive_license` - Exclusive License

        * `360` - 360 Deal'
    Status65cEnum:
      enum:
      - draft
      - active
      - ended
      type: string
      description: '* `draft` - Draft

        * `active` - Active

        * `ended` - Ended'
    RoyaltyBasisEnum:
      enum:
      - net_receipts
      - gross
      type: string
      description: '* `net_receipts` - Net Receipts

        * `gross` - Gross'
    PayeeDetails:
      type: object
      description: Shared helpers to serialize release and recording information.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        label:
          type: string
          format: uuid
        label_name:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 255
        legal_name:
          type:
          - string
          - 'null'
          maxLength: 255
        tax_number:
          type:
          - string
          - 'null'
          maxLength: 20
        preferred_currency:
          type: string
          maxLength: 3
        country:
          oneOf:
          - $ref: '#/components/schemas/CountryEnum'
          - $ref: '#/components/schemas/NullEnum'
        city:
          type:
          - string
          - 'null'
          maxLength: 100
        state:
          type:
          - string
          - 'null'
          maxLength: 100
        zip_code:
          type:
          - string
          - 'null'
          maxLength: 20
        address:
          type:
          - string
          - 'null'
        address_line_2:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
          maxLength: 255
        contact_email:
          oneOf:
          - type: string
            format: email
            maxLength: 254
          - type: string
            maxLength: 0
        phone:
          type:
          - string
          - 'null'
          maxLength: 20
        is_active:
          type: boolean
        can_delete:
          type: boolean
          readOnly: true
        parties:
          type: array
          items:
            type: string
            format: uuid
        parties_details:
          type: string
          readOnly: true
        contracts:
          type: string
          readOnly: true
        releases:
          type: string
          readOnly: true
        recordings:
          type: string
          readOnly: true
      required:
      - can_delete
      - contracts
      - created_at
      - id
      - label
      - label_name
      - name
      - parties_details
      - recordings
      - releases
      - updated_at
    BlankEnum:
      enum:
      - ''
    Status4deEnum:
      enum:
      - pending
      - generating
      - draft
      - sent
      - paid
      - failed
      type: string
      description: '* `pending` - Pending

        * `generating` - Generating

        * `draft` - Draft

        * `sent` - Sent

        * `paid` - Paid

        * `failed` - Failed'
    StatementPeriodEnum:
      enum:
      - monthly
      - quarterly
      - half_yearly
      - annually
      type: string
      description: '* `monthly` - Monthly

        * `quarterly` - Quarterly

        * `half_yearly` - Half-Yearly

        * `annually` - Annually'
    PortalRoyaltyStatement:
      type: object
      description: The label-side serializer minus who created the statement; a payee has no use for it.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        statement_no:
          type: string
          readOnly: true
        payee:
          type: string
          format: uuid
          readOnly: true
        payee_details:
          allOf:
          - $ref: '#/components/schemas/PayeeDetails'
          readOnly: true
        contract:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        contract_details:
          allOf:
          - $ref: '#/components/schemas/ContractDetails'
          readOnly: true
        period_start:
          type:
          - string
          - 'null'
          format: date
          readOnly: true
        period_end:
          type:
          - string
          - 'null'
          format: date
          readOnly: true
        total_revenue_share:
          type: string
          format: decimal
          pattern: ^-?\d{0,19}(?:\.\d{0,2})?$
          readOnly: true
        statement_value:
          type: string
          format: decimal
          pattern: ^-?\d{0,19}(?:\.\d{0,2})?$
          readOnly: true
        previous_balance:
          type: string
          format: decimal
          pattern: ^-?\d{0,19}(?:\.\d{0,2})?$
          readOnly: true
        recoupment_applied:
          type: string
          format: decimal
          pattern: ^-?\d{0,19}(?:\.\d{0,2})?$
          readOnly: true
        statement_balance:
          type: string
          format: decimal
          pattern: ^-?\d{0,19}(?:\.\d{0,2})?$
          readOnly: true
        meets_payment_threshold:
          type: boolean
          readOnly: true
        payment_threshold:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          readOnly: true
        currency:
          type:
          - string
          - 'null'
          readOnly: true
        file:
          type:
          - string
          - 'null'
          format: uri
          readOnly: true
        file_url:
          type: string
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/Status4deEnum'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - contract
      - contract_details
      - created_at
      - currency
      - file
      - file_url
      - id
      - meets_payment_threshold
      - payee
      - payee_details
      - payment_threshold
      - period_end
      - period_start
      - previous_balance
      - recoupment_applied
      - statement_balance
      - statement_no
      - statement_value
      - status
      - total_revenue_share
      - updated_at
    PaginatedPortalRoyaltyStatementList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/PortalRoyaltyStatement'
    ContractDetails:
      type: object
      description: Shared helpers to serialize release and recording information.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        label:
          type: string
          format: uuid
        label_name:
          type: string
          readOnly: true
        payees:
          type: string
        starting_balance:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          writeOnly: true
        name:
          type: string
        contract_type:
          $ref: '#/components/schemas/ContractTypeEnum'
        status:
          $ref: '#/components/schemas/Status65cEnum'
        start_date:
          type:
          - string
          - 'null'
          format: date
        end_date:
          type:
          - string
          - 'null'
          format: date
        territory:
          type: string
          maxLength: 128
        currency:
          type: string
          maxLength: 3
        royalty_basis:
          $ref: '#/components/schemas/RoyaltyBasisEnum'
        distribution_fee_percent:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
        label_share_percent:
          type:
          - string
          - 'null'
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
        label_share_overrides:
          type:
          - object
          - 'null'
          description: Per-category overrides of label_share_percent. Values are the label's share as decimal strings between 0.00 and 100.00; a missing key falls back to label_share_percent.
          properties:
            ad_revenue:
              type: string
              example: '50.00'
            cd:
              type: string
              example: '50.00'
            downloads:
              type: string
              example: '50.00'
            expenses:
              type: string
              example: '50.00'
            licensing:
              type: string
              example: '50.00'
            misc:
              type: string
              example: '50.00'
            physical:
              type: string
              example: '50.00'
            radio:
              type: string
              example: '50.00'
            streaming:
              type: string
              example: '50.00'
            video:
              type: string
              example: '50.00'
            vinyl:
              type: string
              example: '50.00'
          additionalProperties: false
        payment_threshold:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        advance_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        cross_collateralized:
          type: boolean
        file:
          type:
          - string
          - 'null'
          format: uri
        notes:
          type: string
        verified_at:
          type:
          - string
          - 'null'
          format: date-time
        extracting_status:
          type: string
          readOnly: true
        statement_period:
          oneOf:
          - $ref: '#/components/schemas/StatementPeriodEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        tracks_count:
          type: integer
          readOnly: true
          default: 0
        first_sound_recording_title:
          type:
          - string
          - 'null'
          readOnly: true
        all_tracks_have_isrc:
          type: boolean
          readOnly: true
          default: true
        can_delete:
          type: boolean
          readOnly: true
        can_activate:
          type: boolean
          readOnly: true
        has_revenue:
          type: boolean
          readOnly: true
          default: false
        has_expenses:
          type: boolean
          readOnly: true
          default: false
        related_releases:
          type: string
          readOnly: true
        related_recordings:
          type: string
          readOnly: true
        rates_locked:
          type: boolean
          readOnly: true
      required:
      - all_tracks_have_isrc
      - can_activate
      - can_delete
      - created_at
      - extracting_status
      - first_sound_recording_title
      - has_expenses
      - has_revenue
      - id
      - label
      - label_name
      - rates_locked
      - related_recordings
      - related_releases
      - tracks_count
      - updated_at
    NullEnum:
      enum:
      - null
    CountryEnum:
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BQ
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - CV
      - KH
      - CM
      - CA
      - KY
      - CF
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CW
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - KP
      - MK
      - MP
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - BL
      - SH
      - KN
      - LC
      - MF
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SX
      - SK
      - SI
      - SB
      - SO
      - ZA
      - GS
      - KR
      - SS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - UM
      - US
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      type: string
      description: '* `AF` - Afghanistan

        * `AX` - Åland Islands

        * `AL` - Albania

        * `DZ` - Algeria

        * `AS` - American Samoa

        * `AD` - Andorra

        * `AO` - Angola

        * `AI` - Anguilla

        * `AQ` - Antarctica

        * `AG` - Antigua and Barbuda

        * `AR` - Argentina

        * `AM` - Armenia

        * `AW` - Aruba

        * `AU` - Australia

        * `AT` - Austria

        * `AZ` - Azerbaijan

        * `BS` - Bahamas

        * `BH` - Bahrain

        * `BD` - Bangladesh

        * `BB` - Barbados

        * `BY` - Belarus

        * `BE` - Belgium

        * `BZ` - Belize

        * `BJ` - Benin

        * `BM` - Bermuda

        * `BT` - Bhutan

        * `BO` - Bolivia

        * `BQ` - Bonaire, Sint Eustatius and Saba

        * `BA` - Bosnia and Herzegovina

        * `BW` - Botswana

        * `BV` - Bouvet Island

        * `BR` - Brazil

        * `IO` - British Indian Ocean Territory

        * `BN` - Brunei

        * `BG` - Bulgaria

        * `BF` - Burkina Faso

        * `BI` - Burundi

        * `CV` - Cabo Verde

        * `KH` - Cambodia

        * `CM` - Cameroon

        * `CA` - Canada

        * `KY` - Cayman Islands

        * `CF` - Central African Republic

        * `TD` - Chad

        * `CL` - Chile

        * `CN` - China

        * `CX` - Christmas Island

        * `CC` - Cocos (Keeling) Islands

        * `CO` - Colombia

        * `KM` - Comoros

        * `CG` - Congo

        * `CD` - Congo (the Democratic Republic of the)

        * `CK` - Cook Islands

        * `CR` - Costa Rica

        * `CI` - Côte d''Ivoire

        * `HR` - Croatia

        * `CU` - Cuba

        * `CW` - Curaçao

        * `CY` - Cyprus

        * `CZ` - Czechia

        * `DK` - Denmark

        * `DJ` - Djibouti

        * `DM` - Dominica

        * `DO` - Dominican Republic

        * `EC` - Ecuador

        * `EG` - Egypt

        * `SV` - El Salvador

        * `GQ` - Equatorial Guinea

        * `ER` - Eritrea

        * `EE` - Estonia

        * `SZ` - Eswatini

        * `ET` - Ethiopia

        * `FK` - Falkland Islands (Malvinas)

        * `FO` - Faroe Islands

        * `FJ` - Fiji

        * `FI` - Finland

        * `FR` - France

        * `GF` - French Guiana

        * `PF` - French Polynesia

        * `TF` - French Southern Territories

        * `GA` - Gabon

        * `GM` - Gambia

        * `GE` - Georgia

        * `DE` - Germany

        * `GH` - Ghana

        * `GI` - Gibraltar

        * `GR` - Greece

        * `GL` - Greenland

        * `GD` - Grenada

        * `GP` - Guadeloupe

        * `GU` - Guam

        * `GT` - Guatemala

        * `GG` - Guernsey

        * `GN` - Guinea

        * `GW` - Guinea-Bissau

        * `GY` - Guyana

        * `HT` - Haiti

        * `HM` - Heard Island and McDonald Islands

        * `VA` - Holy See

        * `HN` - Honduras

        * `HK` - Hong Kong

        * `HU` - Hungary

        * `IS` - Iceland

        * `IN` - India

        * `ID` - Indonesia

        * `IR` - Iran

        * `IQ` - Iraq

        * `IE` - Ireland

        * `IM` - Isle of Man

        * `IL` - Israel

        * `IT` - Italy

        * `JM` - Jamaica

        * `JP` - Japan

        * `JE` - Jersey

        * `JO` - Jordan

        * `KZ` - Kazakhstan

        * `KE` - Kenya

        * `KI` - Kiribati

        * `KW` - Kuwait

        * `KG` - Kyrgyzstan

        * `LA` - Laos

        * `LV` - Latvia

        * `LB` - Lebanon

        * `LS` - Lesotho

        * `LR` - Liberia

        * `LY` - Libya

        * `LI` - Liechtenstein

        * `LT` - Lithuania

        * `LU` - Luxembourg

        * `MO` - Macao

        * `MG` - Madagascar

        * `MW` - Malawi

        * `MY` - Malaysia

        * `MV` - Maldives

        * `ML` - Mali

        * `MT` - Malta

        * `MH` - Marshall Islands

        * `MQ` - Martinique

        * `MR` - Mauritania

        * `MU` - Mauritius

        * `YT` - Mayotte

        * `MX` - Mexico

        * `FM` - Micronesia

        * `MD` - Moldova

        * `MC` - Monaco

        * `MN` - Mongolia

        * `ME` - Montenegro

        * `MS` - Montserrat

        * `MA` - Morocco

        * `MZ` - Mozambique

        * `MM` - Myanmar

        * `NA` - Namibia

        * `NR` - Nauru

        * `NP` - Nepal

        * `NL` - Netherlands

        * `NC` - New Caledonia

        * `NZ` - New Zealand

        * `NI` - Nicaragua

        * `NE` - Niger

        * `NG` - Nigeria

        * `NU` - Niue

        * `NF` - Norfolk Island

        * `KP` - North Korea

        * `MK` - North Macedonia

        * `MP` - Northern Mariana Islands

        * `NO` - Norway

        * `OM` - Oman

        * `PK` - Pakistan

        * `PW` - Palau

        * `PS` - Palestine, State of

        * `PA` - Panama

        * `PG` - Papua New Guinea

        * `PY` - Paraguay

        * `PE` - Peru

        * `PH` - Philippines

        * `PN` - Pitcairn

        * `PL` - Poland

        * `PT` - Portugal

        * `PR` - Puerto Rico

        * `QA` - Qatar

        * `RE` - Réunion

        * `RO` - Romania

        * `RU` - Russia

        * `RW` - Rwanda

        * `BL` - Saint Barthélemy

        * `SH` - Saint Helena, Ascension and Tristan da Cunha

        * `KN` - Saint Kitts and Nevis

        * `LC` - Saint Lucia

        * `MF` - Saint Martin (French part)

        * `PM` - Saint Pierre and Miquelon

        * `VC` - Saint Vincent and the Grenadines

        * `WS` - Samoa

        * `SM` - San Marino

        * `ST` - Sao Tome and Principe

        * `SA` - Saudi Arabia

        * `SN` - Senegal

        * `RS` - Serbia

        * `SC` - Seychelles

        * `SL` - Sierra Leone

        * `SG` - Singapore

        * `SX` - Sint Maarten (Dutch part)

        * `SK` - Slovakia

        * `SI` - Slovenia

        * `SB` - Solomon Islands

        * `SO` - Somalia

        * `ZA` - South Africa

        * `GS` - South Georgia and the South Sandwich Islands

        * `KR` - South Korea

        * `SS` - South Sudan

        * `ES` - Spain

        * `LK` - Sri Lanka

        * `SD` - Sudan

        * `SR` - Suriname

        * `SJ` - Svalbard and Jan Mayen

        * `SE` - Sweden

        * `CH` - Switzerland

        * `SY` - Syria

        * `TW` - Taiwan

        * `TJ` - Tajikistan

        * `TZ` - Tanzania

        * `TH` - Thailand

        * `TL` - Timor-Leste

        * `TG` - Togo

        * `TK` - Tokelau

        * `TO` - Tonga

        * `TT` - Trinidad and Tobago

        * `TN` - Tunisia

        * `TR` - Türkiye

        * `TM` - Turkmenistan

        * `TC` - Turks and Caicos Islands

        * `TV` - Tuvalu

        * `UG` - Uganda

        * `UA` - Ukraine

        * `AE` - United Arab Emirates

        * `GB` - United Kingdom

        * `UM` - United States Minor Outlying Islands

        * `US` - United States of America

        * `UY` - Uruguay

        * `UZ` - Uzbekistan

        * `VU` - Vanuatu

        * `VE` - Venezuela

        * `VN` - Vietnam

        * `VG` - Virgin Islands (British)

        * `VI` - Virgin Islands (U.S.)

        * `WF` - Wallis and Futuna

        * `EH` - Western Sahara

        * `YE` - Yemen

        * `ZM` - Zambia

        * `ZW` - Zimbabwe'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT