Interface TermScope

export TermScope

interface TermScope {
    catalog_id?: number;
    end_at?: null | string;
    is_date_limited?: boolean;
    item_ids?: null | string[];
    royalty_types?: null | string[];
    start_at?: string;
    territories?: null | string[];
}

Properties

catalog_id? end_at? is_date_limited? item_ids? royalty_types? start_at? territories?

Properties

Optionalcatalog_id

catalog_id?: number

A Project Catalog associated with the income source whose income should be processed with this contract. If set 0 the item_id's are used. If set to a Project Catalog ID that project entire Project Catalog will be used unless a subset of Project Items are specified using the item_ids property.

Optionalend_at

end_at?: null | string

If IsDateLimited=True, specifies the ending date to which to this term applies, can be null if no end date

Optionalis_date_limited

is_date_limited?: boolean

If false then StartDate and EndDate are ignored for calculator scopes

Optionalitem_ids

item_ids?: null | string[]

A list of Project item id's associated with the income source whose income should be processed with this contract. If Project Catalog Id is set these ItemIds must existing in the specified Project Catalog

Optionalroyalty_types

royalty_types?: null | string[]

The type of royalty calculation to use. Valid options are: Music-All Music-Composition Music-Recording Book-Publishing Digital-Content Mining Design-Royalties AI-Training Franchise

Optionalstart_at

start_at?: string

If IsDateLimited=True, specifies the starting date from which to this term applies

Optionalterritories

territories?: null | string[]

A list of ISO 3166-1 alpha-3 codes are three-letter country codes defined in ISO 3166-1, part of the ISO 3166 standard published by the International Organization for Standardization (ISO), to represent countries, dependent territories, and special areas of geographical interest. In the case the scope applies to All territories use [ALL] (including brackets) or leave null.

Settings

Member Visibility

On This Page

Properties