logo

Marketron Data Rest API (V1)

Download OpenAPI specification:Download

Introduction

Marketron’s Data API allows developers to access their companies data from Marketron’s data warehouse. Allowing companies to keep data synced and up to date across their ecosystem, eliminating data inconsistencies from legacy data sharing processes.

GraphQL

Interested in consuming the Data API via GraphQL? Please visit Marketron's Data API GraphQL documentation and playground at https://api.marketronnxt.com/graphql

Versioning

The API version is denoted in the URI. This API's base URI is: https://api.marketronnxt.com/data/V1

Setup

To access Marketron’s Data API you will need to contact support@marketron.com in order to request access and receive an API key with credentials.

Authentication

Authenticating with the Marketron Data API requires both a username / password and an API Key that will be provided to you.

In order to call any of the REST or GraphQL end points, you must first retrieve an Authentication Token. This is done by making a GET request to /login. Your request must contain the following items.

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

apiKey

Security Scheme Type API Key
Header parameter name: X-API-Key

Body {

"username": "<your username>",
"password": "<your password>"

}

Header {

"x-api-key": "<your provided key>",
"content-type": "application/json",
"x-request-id": "<generated request id>"

}

The generated request id is a unique ID that should be generated for each new API call. This is used by Marketron to keep track of each call. The format for the ID should be UUID V4 e.g. 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

You should get a response containing your Authentication Token. This token is should be in all your future request headers.

Login

Logs in user

Authenticate into the API, receive a bearer token to execute additional endpoints.

Authorizations:
apiKey
Request Body schema: application/json

Optional description in Markdown

username
required
string

Username provided by Marketron specific for accessing the API.

password
required
string

Password for username, provided by Marketron.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token_type": "string",
  • "access_token": "string",
  • "expires_in": 0
}

Company

List all Companies for a user

List all Companies the autheticated user is associated with. Companies may be alternatively known as Markets or Database instance.

Authorizations:
bearerAuthapiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists Company details

Company details for a specific company. Companies may be alternatively known as Markets or Database instance.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyName": "string",
  • "parentCompanyId": "string",
  • "customerNumber": 0
}

Stations

Lists Stations for company

List all Stations or Media Outlets associated with a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists Station details

Station Details for a specific Sation or Media Outlet.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

stationId
required
string

Station Id.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fullName": "string",
  • "isActive": true,
  • "isTrueStation": true,
  • "companyId": "string"
}

Clients

Lists Clients

List all Clients for a given company, clients include Advertisers and Agencies.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Client Name max length 255.

clientType
string

Current valid values are Advertiser, Agency, Prospect, Other.

clientCode
string

Client Code max length 50.

hasDefaultAgency
boolean

Client has default agency.

city
string

City of client max length 100.

state
string

State of client max length 50.

postalCode
string

PostalCode of client max length 50.

externalClientNumber
string

External Number of client max length 50.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Create Client for a given company

Create Client for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

companyId
string

UID of Company.

name
required
string

Name of Client max length 255.

clientType
required
string

Current valid values are Advertiser, Agency, Prospect, Other.

clientCode
string

Code assigned to client max length 50.

revenueSourceId
string

UID of revenue Source.

agencyId
string

UID of Agency.

productCodeId
string

UID of Product Code.

commision
integer

Commision value.

billingFrequency
string

MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

externalClientNumber
string

External Number of client max length 50.

creditPolicy
string

Credit Policy of client max length 200.

secondaryProductCodeId
string

UID of Secondary Product Code.

Array of objects

List of MiscellaneousData.

Array of objects

List of Client Addresses information.

Array of objects

List of Client AccountExecutives information.

Array of objects

List of Client Contacts information.

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "name": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Lists Client details

Client details for a specific Client.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

clientId
required
string

ID of Client.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "address": {
    },
  • "contact": {
    },
  • "accountExecutiveId": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "secondaryProductCodeId": "string",
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "creditPolicy": "string",
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Update Client for a given company

Update Client for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

clientId
required
string

ID of client

Request Body schema: application/json

object sent as part of body of the request.

id
string

UID of Client.

companyId
string

UID of Company.

name
required
string

Name of Client max length 255.

clientType
required
string

Current valid values are Advertiser, Agency, Prospect, Other.

clientCode
string

Code assigned to client max length 50.

revenueSourceId
string

UID of revenue Source.

agencyId
string

UID of Agency.

productCodeId
string

UID of Product Code.

commision
integer

Commision value.

billingFrequency
string

MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

externalClientNumber
string

External Number of client max length 50.

creditPolicy
string

Credit Policy of client max length 200.

secondaryProductCodeId
string

UID of Secondary Product Code.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Array of objects

List of Client Addresses information.

Array of objects

List of Client AccountExecutives information.

Array of objects

List of Client Contacts information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "name": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Patch Client for a given company

Patch Client for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

clientId
required
string

ID of client

Request Body schema: application/json

object sent as part of body of the request.

id
string

UID of Client.

companyId
string

UID of Company.

name
string

Name of Client max length 255.

clientType
string

Current valid values are Advertiser, Agency, Prospect, Other.

clientCode
string

Code assigned to client max length 50.

revenueSourceId
string

UID of revenue Source.

agencyId
string

UID of Agency.

productCodeId
string

UID of Product Code.

commision
integer

Commision value.

billingFrequency
string

MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

externalClientNumber
string

External Number of client max length 50.

creditPolicy
string

Credit Policy of client max length 200.

secondaryProductCodeId
string

UID of Secondary Product Code.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Array of objects

List of Client Addresses information.

Array of objects

List of Client AccountExecutives information.

Array of objects

List of Client Contacts information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "name": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "string",
  • "clientType": "string",
  • "clientCode": "string",
  • "revenueSourceId": "string",
  • "agencyId": "string",
  • "productCodeId": "string",
  • "commision": 0,
  • "billingFrequency": "string",
  • "externalClientNumber": "string",
  • "creditPolicy": "string",
  • "secondaryProductCodeId": "string",
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ],
  • "addresses": [
    ],
  • "accountExecutives": [
    ],
  • "contacts": [
    ]
}

AccountExecutive

Lists Account Executives

List all Account Executives or Sales Reps for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

firstName
string

AccountExecutive First Name max length 100.

lastName
string

AccountExecutive Last Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Create AccountExecutive for a given company

Create AccountExecutive for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

firstName
string

First Name of AccountExecutive max length 100.

lastName
string

Last Name of AccountExecutive max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

geographicalScope
string

Geographical region the account executive is assigned max length 25.

location
string

Location of AccountExecutive max length 50.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "firstName": "string",
  • "lastName": "string",
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Lists Account Executives details

Account Executives details for a specific Account Executive.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

accountExecId
required
string

ID of Account Executive.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "firstName": "string",
  • "lastName": "string",
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Update AccountExecutive for a given company

Update AccountExecutive for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

accountExecId
required
string

ID of AccountExecutive

Request Body schema: application/json

object sent as part of body of the request.

firstName
string

First Name of AccountExecutive max length 100.

lastName
string

Last Name of AccountExecutive max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

geographicalScope
string

Geographical region the account executive is assigned max length 25.

location
string

Location of AccountExecutive max length 50.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "firstName": "string",
  • "lastName": "string",
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Patch AccountExecutive for a given company

Patch AccountExecutive for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

accountExecId
required
string

ID of AccountExecutive

Request Body schema: application/json

object sent as part of body of the request.

firstName
string

First Name of AccountExecutive max length 100.

lastName
string

Last Name of AccountExecutive max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

geographicalScope
string

Geographical region the account executive is assigned max length 25.

location
string

Location of AccountExecutive max length 50.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "firstName": "string",
  • "lastName": "string",
  • "geographicalScope": "string",
  • "location": "string",
  • "miscellaneousData": [
    ]
}

RevenueSources

Lists Revenue Sources

List all Revenue Sources for a given company, alternatively known as Revenue Type or Income Account.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Revenue Source Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Create RevenueSource for a given company

Create RevenueSource for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Revenue Source max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Lists Revenue Source details

Revenue Source details for a Revenue Source.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

revenueSourceId
required
string

ID of Revenue Source.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Update RevenueSource for a given company

Update RevenueSource for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

revenueSourceId
required
string

ID of RevenueSource

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Revenue Source max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Patch RevenueSource for a given company

Patch RevenueSource for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

revenueSourceId
required
string

ID of RevenueSource

Request Body schema: application/json

object sent as part of body of the request.

name
string

Name of Revenue Source max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

SaleTypeCategory

Lists SaleType Categories

List all SaleType Category for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Sale Type Category Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Create SaleType Category for a given company

Create SaleType Category for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Sale Type Category max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Lists SaleType Category details

SaleType Category details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeCategoryId
required
string

ID of saleTypeCategory.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Update SaleType Category for a given company

Update SaleType Category for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeCategoryId
required
string

ID of SaleTypeCategory

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Sale Type Category max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Patch SaleType Category for a given company

Patch SaleType Category for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeCategoryId
required
string

ID of SaleTypeCategory

Request Body schema: application/json

object sent as part of body of the request.

name
string

Name of Sale Type Category max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

Invoices

List all Sales Data for a given company

List all Sales Data for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Sale date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Sale date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

Responses

Response samples

Content type
application/json
{
  • "advertiserId": "string",
  • "advertiserName": "string",
  • "agencyId": "string",
  • "agencyName": "string",
  • "orderNumber": "string",
  • "transactionNumber": "string",
  • "transactionDate": "string",
  • "stationId": "string",
  • "netRevenue": 0,
  • "revenueSourceId": "string",
  • "salesTypeId": "string",
  • "salesCategoryId": "string",
  • "id": "string",
  • "recordStatus": "string",
  • "modifiedUtc": "string"
}

List all Invoices for a given company

List all Invoices for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Invoice date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Invoice date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of Station.

revenueSourceId
string

UID of RevenueSource.

saleTypeId
string

UID of SaleType.

saleTypeCategoryId
string

UID of SaleTypeCategory.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

tradeType
string

Current valid values are Cash, Trade.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Display Invoice in PDF format for a given company

Display Invoice in PDF format for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of Company

invoiceId
required
string

ID of Invoice

Responses

Lists Invoice V3 details

Invoice details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

invoiceId
required
string

UID of Invoice.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "advertiserId": "string",
  • "advertiserName": "string",
  • "agencyId": "string",
  • "agencyName": "string",
  • "amount": 0,
  • "agencyCommissionAmount": 0,
  • "orderDiscountAmount": 0,
  • "taxAmount": 0,
  • "createdUtc": "string",
  • "dueDate": "string",
  • "transactionDate": "string",
  • "description": "string",
  • "transactionNumber": "string",
  • "referenceNumber": "string",
  • "orderNumber": "string",
  • "orderBuyType": "string",
  • "isDeleted": true,
  • "invoiceAccounts": [
    ],
  • "invoiceAccountExecutives": [
    ]
}

AssetEvents

List all Asset Events for a given company

List all Asset Events for a given company, alternatively known as Inventory Type.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Asset Event Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Lists AssetEvent details

AssetEvent details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

assetEventId
required
string

ID of AssetEvent.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ],
  • "stationIds": [
    ]
}

ProductCodes

List all Product Codes for a given company

List all Product Codes for a given company, alternatively known as Competitive Codes.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Product Code Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List a particular product code for a given company

List a particular product code for a given company, alternatively known as Competitive Code.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

productCodeId
required
string

ID of productCode

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ]
}

AdjustmentData

List all AR Adjustments for a given company

List all AR Adjustments for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Adjustment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Adjustment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

tradeType
string

Current valid values are Cash, Trade.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List all AR Adjustment Summary for a given company

List all AR Adjustment Summary for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Adjustment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Adjustment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

tradeType
string

Current valid values are Cash, Trade.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

AssetCodes

List all Asset Codes for a given company

List all Asset Codes for a given company, alternatively known as Inventory Type.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Asset Code Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Lists AssetCode details

AssetCode details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

assetCodeId
required
string

ID of AssetCode.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "miscellaneousData": [
    ],
  • "stationIds": [
    ]
}

Orders

List all Order Summaries for a given company

List all Order Summaries for a given company

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 100.

minimumOrderDate
string

Minimum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumOrderDate
string

Maximum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

advertiserIds
Array of strings

UID of Advertiser, supports single or multiple GUIDs.

agencyIds
Array of strings

UID of Agency, supports single or multiple GUIDs.

estimateNumber
string

Number assigned by Agency max length 50.

orderNumber
string

Number for the Order max length 50.

revenueSourceId
string

UID of Revenue Source.

stationId
string

UID of Station.

minimumFirstSpotDateTimeUtc
string

Minimum first spot date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumFirstSpotDateTimeUtc
string

Maximum first spot date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

minimumOriginatedDate
string

Minimum Originated date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumOriginatedDate
string

Maximum Originated date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

tradeType
string

Current valid values are Cash, Trade.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List Order details for a given company

List Order details for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 5.

minimumOrderDate
string

Minimum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumOrderDate
string

Maximum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

estimateNumber
string

Number assigned by Agency max length 50.

orderNumber
string

Number for the Order max length 50.

accountExecutiveId
string

UID for Account Executive / Sale Rep.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

minimumOriginatedDate
string

Minimum Originated date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumOriginatedDate
string

Maximum Originated date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

tradeType
string

Current valid values are Cash, Trade.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List Order details for a given order

List Order details for a given order.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

orderId
required
string

ID of order

Responses

Response samples

Content type
application/json
{
  • "advertiserId": "string",
  • "accountExecutiveId": "string",
  • "agencyId": "string",
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "eOrderId": "string",
  • "estimateNumber": "string",
  • "purchaseOrderNumber": "string",
  • "agencyClientCode": "string",
  • "agencyProductCode": "string",
  • "agencyEstimateCode": "string",
  • "geographicalScope": "string",
  • "originatedDate": "string",
  • "tradeType": "string",
  • "billingFrequency": "string",
  • "miscellaneousData": [
    ],
  • "orderLines": [
    ],
  • "commissionSplitSummaries": [
    ],
  • "id": "string",
  • "recordStatus": "string",
  • "modifiedUtc": "string"
}

SaleTypes

Lists SaleTypes

List all SaleTypes for a given company. Alternatively known as Inventory Type or Spot Type.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

name
string

Sale Type Name max length 100.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Create SaleType for a given company

Create SaleType for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Sale Type max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

saleTypeCategoryId
string

UID for Sale Type Category.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Lists SaleType details

SaleTypes details, alternatively known as Inventory Type or Spot Type.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeId
required
string

ID of saleType.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Update SaleType for a given company

Update SaleType for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeId
required
string

ID of SaleType

Request Body schema: application/json

object sent as part of body of the request.

name
required
string

Name of Sale Type max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

saleTypeCategoryId
string

UID for Sale Type Category.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Patch SaleType for a given company

Patch SaleType for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

saleTypeId
required
string

ID of SaleType

Request Body schema: application/json

object sent as part of body of the request.

name
string

Name of Sale Type max length 100.

isActive
boolean

True (Active), False (Inactive).

isDeleted
boolean

True (Deleted), False (Not-Deleted).

saleTypeCategoryId
string

UID for Sale Type Category.

Array of objects

List of MiscellaneousData.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isActive": true,
  • "isDeleted": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "name": "string",
  • "isDeleted": true,
  • "isActive": true,
  • "saleTypeCategoryId": "string",
  • "miscellaneousData": [
    ]
}

Payments

List all AR Payments for a given company

List all AR Payments for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Payment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Payment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

tradeType
string

Current valid values are Cash, Trade.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

paymentType
string

Current valid values are Creditcard, ACH, Cash, Check, Trade, Other.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List all AR PaymentSummary for a given company

List all AR PaymentSummary for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Payment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Payment date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

recordStatus
string

Status of the record 1 (Active), 2 (Inactive), 3 (Deleted).

tradeType
string

Current valid values are Cash, Trade.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

transactionNumber
string

Transaction Number assigned to the transaction max length 200.

paymentType
string

Current valid values are Creditcard, ACH, Cash, Check, Trade, Other.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

AgingData

List all AR Aging Data for a given company

List all AR Aging Data for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumDate
string

Minimum Aging date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumDate
string

Maximum Aging date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

UID of station.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List all AR Aging Summary for a given company

List all AR Aging Summary for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

advertiserIsDeleted
boolean

True (Deleted), False (Not-Deleted).

advertiserIsActive
boolean

True (Active), False (Inactive).

advertiserCreditPolicy
string

Credit Policy for a Advertiser.

includeAgency
boolean

True (Include), False (Not-Include).

agingMethod
string

Current valid values are Calendar, Daily.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Spots

List Spots

List Spots for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 100.

startDate
string

Startdate of the spot to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

endDate
string

Enddate of the spot to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

Station ID

orderNumber
string

Ordernumber

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

scheduledStatus
string

Status of the spot scheduled e.g. Scheduled, Reconciled, Bumped.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List NonSpots

List NonSpots for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 100.

startDate
string

Startdate of the spot to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

endDate
string

Enddate of the spot to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

stationId
string

Station ID

orderNumber
string

Ordernumber

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isDeleted
boolean

True (Deleted), False (Not-Deleted).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

DataSubscription

List all DataSubscriptions for a given company

List all DataSubscriptions for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

List a particular DataSubscription for a given company

List a particular DataSubscription for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

dataSubscriptionId
required
string

ID of dataSubscription

Responses

Response samples

Content type
application/json
{
  • "dataSubscriptionId": "string",
  • "createdUtc": "string",
  • "userNameCreated": "string",
  • "isEnabled": "string",
  • "callbackKey": "string",
  • "callbackURL": "string",
  • "dataTypes": [
    ]
}

Create DataSubscription for a given company

Create DataSubscription for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

callbackKey
required
string

Optional string value that we will passed in the notifications to authetiicate notifcation source max length 50.

callbackURL
required
string

Url the DataSubscriber wants the notifications to be Posted.

dataTypes
required
array

List of datatypes of dataSubscription. Current valid values are AcctExec, AssetCode, AssetEvent, Client, Media, Order, ProductCode, RevenueSource, SaleType, SaleTypeCategory, Spot and Proposal.

Responses

Request samples

Content type
application/json
{
  • "callbackKey": "string",
  • "callbackURL": "string",
  • "dataTypes": [ ]
}

Response samples

Content type
application/json
{
  • "dataSubscriptionId": "string",
  • "createdUtc": "string",
  • "userNameCreated": "string",
  • "isEnabled": "string",
  • "callbackKey": "string",
  • "callbackURL": "string",
  • "dataTypes": [
    ]
}

Update DataSubscription for a given company

Update DataSubscription for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

dataSubscriptionId
required
string

ID of dataSubscription

Request Body schema: application/json

object sent as part of body of the request.

callbackKey
required
string

Optional string value that we will passed in the notifications to authetiicate notifcation source max length 50.

callbackURL
required
string

Url the DataSubscriber wants the notifications to be Posted.

dataTypes
required
array

List of datatypes of dataSubscription. Current valid values are AcctExec, AssetCode, AssetEvent, Client, Media, Order, ProductCode, RevenueSource, SaleType, SaleTypeCategory, Spot and Proposal.

IsEnabled
boolean

It allows the DataSubscriber to turn notification on or off.

Responses

Request samples

Content type
application/json
{
  • "callbackKey": "string",
  • "callbackURL": "string",
  • "dataTypes": [ ],
  • "IsEnabled": true
}

Response samples

Content type
application/json
{
  • "dataSubscriptionId": "string",
  • "createdUtc": "string",
  • "userNameCreated": "string",
  • "isEnabled": "string",
  • "callbackKey": "string",
  • "callbackURL": "string",
  • "dataTypes": [
    ]
}

OrderProjection

List all Order Projections for a given company

List all Order Projections for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 100.

minimumOrderDate
string

Minimum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumOrderDate
string

Maximum Order date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

estimateNumber
string

Number assigned by Agency.

orderNumber
string

Number for the Order.

accountExecutiveId
string

UID for Account Executive / Sale Rep.

revenueSourceId
string

UID of Revenue Source.

stationId
string

UID of station.

minimumProjectionMonth
string

Minimum Month of year projection value must be present for Month MM (Min month and Min year both must be passed as combination).

maximumProjectionMonth
string

Maximum Month of year projection value must be present for Month MM (Max Month and Max Year both must be passed as combination).

includeNtr
boolean

Include NTR value in Order Projections (True\False).

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

minimumProjectionYear
string

Minimum year of projection value must be present for Year YYYY (Min month and Min year both must be passed as combination).

maximumProjectionYear
string

Maximum year of projection value must be present for Year YYYY (Max Month and Max Year both must be passed as combination).

projectBy
string

Current valid values are Calendar, Broadcast, AsBilled.

adjustByActuals
boolean

Include AdjustByActuals in Order Projections (True\False).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Media

List Media

List Media for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumStartDate
string

Minimum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumStartDate
string

Maximum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

minimumEndDate
string

Minimum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumEndDate
string

Maximum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isci
string

ISCI of media max length 50.

cartNumber
string

Media cartnumber max length 20.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Lists Media details

Media details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

mediaId
required
string

UID of Media.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "mediaName": "string",
  • "isci": "string",
  • "clientId": "string",
  • "tapeNumber": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "length": 0,
  • "coOpName": "string",
  • "isLive": true,
  • "logDescription": "string",
  • "mediaScript": "string",
  • "productCodeId": "string",
  • "talent": "string",
  • "tone": "string",
  • "mediaCartNumbers": [
    ]
}

List Media V2

List Media for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumStartDate
string

Minimum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumStartDate
string

Maximum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

minimumEndDate
string

Minimum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumEndDate
string

Maximum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isci
string

ISCI of media max length 50.

cartNumber
string

Media cartnumber max length 20.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Lists Media V2 details

Media details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

mediaId
required
string

UID of Media.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "mediaName": "string",
  • "isci": "string",
  • "clientId": "string",
  • "tapeNumber": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "length": 0,
  • "coOpName": "string",
  • "isLive": true,
  • "logDescription": "string",
  • "mediaScript": "string",
  • "productCodeId": "string",
  • "talent": "string",
  • "tone": "string",
  • "mediaCarts": [
    ]
}

List Media V3

List Media for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumStartDate
string

Minimum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumStartDate
string

Maximum StartDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

minimumEndDate
string

Minimum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

maximumEndDate
string

Maximum EndDate of the Media to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

isci
string

ISCI of media max length 50.

cartNumber
string

Media cartnumber max length 20.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

externalId
string

Media externalId max length 50.

minimumLength
integer

Minimum length of the Media to be passed.

maximumLength
integer

Maximum length of the Media to be passed.

isDeleted
boolean

True (Deleted), False (Not-Deleted).

hasCartNumber
boolean

True (has-CartNumber), False (No-CartNumber).

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Lists Media V3 details

Media details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

mediaId
required
string

UID of Media.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isci": "string",
  • "clientId": "string",
  • "tapeNumber": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "createdUtc": "string",
  • "modifiedUtc": "string",
  • "isDeleted": true,
  • "length": 0,
  • "coOpName": "string",
  • "isLive": true,
  • "logDescription": "string",
  • "mediaScript": "string",
  • "productCodeId": "string",
  • "talent": "string",
  • "tone": "string",
  • "externalId": "string",
  • "mediaCarts": [
    ]
}

ExternalRequest

Lists ExternalRequest details

ExternalRequest details.

Authorizations:
bearerAuthapiKey
path Parameters
externalRequestId
required
string

UID of ExternalRequest.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdUtc": "string",
  • "mxUserIdCreated": "string",
  • "requestTypeCode": "string",
  • "payLoad": "string"
}