This set of calls is only for those agencies using the Media Billing Module in SBMS.

Client Bill data is available in the API once it is recorded in FreeWheel.

📘

Note

A Client Bill is a bill produced by the Agency for their Client to pay.

Basic Attributes

The following attributes are returned by the API calls in this section.

Field Name

Description

Data Type (Length)

  1. Id

List of Client Bill Transaction Ids

integer

  1. transactionId

Client bill Transaction Id

integer

  1. agencyId

System generated agency ID

integer

  1. agencyName

Agency name

String (50)

  1. officeId

System generated office ID

integer

  1. officeName

Office name

String (50)

  1. officeCode

Office code

String (50)

  1. advertiserName

Advertiser name as defined in Media Billing Client Billing Setup

String (50)

  1. clientRefId

FW Client Id

integer

  1. clientName

Client name

String (50)

  1. clientCode

Client code

String (50)

  1. invoiceAddress

a. addressType

Invoice

  • work
  • payee
  • invoice
  • traffic

string

b. line1

Billing address line 1

String (50)

c. line2

Billing address line 2

String (50)

d. zip

Billing address zip code

String (50)

e. state

Billing address state

String (50)

f. city

Billing address city

String (50)

g. country

Billing address country

string

  1. currencyCode

Currency code (USD default)

string

  1. mediaBillingInvoiceNumber

Client bill number

String (50)

  1. mediaBillingInvoiceDate

Client bill date

String (23)

  1. mediaBillingDueDate

Client bill payment due date

String (23)

  1. mediaBillingTotalAmountDue

Total Amount due on Client Invoice

number

  1. exportDate

Date Client Bill exported from SBMS

String (23)

  1. originalMediaBillingInvoice

True/False

When an Invoice is voided, it will be False for the record that is used to balance the original invoice.

boolean

  1. voidedMediaBillingInvoice

True/False

When an Invoice is voided, it will be set to True for both the original and balanced records.

boolean

  1. voidDate

Voided date (both original and balanced records)

String (23)

  1. voidComments

Voided comments (both original and balanced records)

String (50)

  1. campaignInfo

a. id

System generated estimate number

integer

b. billHeaderId

ID of the associated Bill Header

integer

c. productRefId

FW Product Id

integer

d. productName

Product name

String (50)

e. productCode

Product code

String (50)

f. estimate

i. id

System generated estimate number

Integer

ii. description

Estimate description

String (50)

iii. code

Optional estimate billing code String (50)

iv. mediaRefId

FW Media Id

Integer

v. mediaName

Estimate media type name

String (50)

vi. mediaCode

Estimate media type code (optional)

String (50)

vii. flightStartDate

Estimate flight start date

String (23)

viii. flightEndDate

Estimate flight end date

String (23)

g. totalUnits

Total units within bill

integer

h. totalBillNetDue

Net media cost due on Client bill

number

i. totalBillGrossDue

Gross media cost due on Client bill

number

j. mediaBillingFeeAmountDue

Fee due on Client bill

number

k. totalTaxDue

Tax due on Client bill

number

l. specialAmountDue

Special Amount Due on the Invoice

Note: This option is only available for Spot and Network estimates that are setup with Special Amount billing.

number

m. withholdingAmount

Amount withheld based on % setup by Client

number

n. barterCreditAmountDue

Amount used in barter – subtracted from Billing Amount

number

o. feeWithholding

Amount of the Fee withheld based on % setup by Client

number

p. mediaBillinginvoiceId

Client bill system generated ID

integer

q. invoiceComments

Comments on the Client Bill

String (255)

r. hasSeparateMediaFeeOption

True/False

If True - When invoice was generated, the Fee amount was one page with the base invoice number and –Fee appended. The media amount was on a separate page with the base invoice number and –Media appended.

boolean

s. monthOfService

Month of media activity

String (5)

t. dateRangeStartDate

When billing on date range, start date of the date range being billed

String (23)

u. dateRangeEndDate

When billing on date range, end date of the date range being billed

String (23)

v. billType

E = Estimate Bill
R = Reconciliation Bill

String (1)

w. specialAmountBill

True/False

boolean

x. invoiceType

Indicates whether separate invoices were generated for Fee Vendors and Media Vendor. Only available in Digital.

Valid values:

  • NoSeparateFeeVendorInvoice
  • SeparateMediaInvoice
  • SeparateFeeVendorInvoice

String (3)

y. billDetails

i. id

System generated ID for Vendor detail records on the Client bill

integer

ii. campaignInfoId

ID of the associated Campaign header

integer

iii. billId

Client bill ID

integer

iv. marketName

Market associated with the Vendor on the Client bill

String (50)

v. marketCode

Market code associated with the Vendor on the Client bill

String (3)

vi. stationName

  • **Spot**: Call Letters + Band Code
  • **Network**: Package Name
  • Print/Outdoor: Publication/Vendor Name
  • Digital: Publisher/Fee Vendor Name

String (101)

vii. vendor

a) vendorRefId

FW internal Vendor ID

Integer

b) vendorName

Vendor name

String (101)

c) vendorCode

Vendor billing code

String (50)

d) alternateBillCode

Alternate Vendor billing code

String (50)

e) alternateBill

True/False

If True, the alternate Vendor billing code is used for Vendor payment.

boolean

f) isFee

  • **True**: MB Fee % is not applied to the Vendor.
  • **False**: MB Fee % is applied to the Vendor.

boolean

g) mediaRefId

FreeWheel media ID associated with the vendor

integer

h) mediaName

Name of media associated with the vendor

String

i) mediaCode

External media code associated with the vendor

String

viii. totalUnits

Total units by vendor

Integer

ix. BillAmount

a) Gross

Gross amount on the client bill for the vendor.

This is based on the Bill Gross Cost defined in Client Billing Setup.

number

b) net

Net amount on the client bill for the vendor.

This is based on the Bill Net Cost defined in Client Billing setup.

number

x. vendorCost

a) cost

  1. gross

Total gross cost for the vendor

number

  1. net

Total net cost for the vendor

number

b) clientCost

  1. gross

Total client gross cost for the vendor

number

  1. net

Total client net cost for the vendor

number

c) previousVendorCost

  1. cost

(a) gross

Previously billed total gross cost for the vendor

number

(b) net

Previously billed total net cost for the vendor

number

  1. clientCost

(a) gross

Previously billed total client gross cost for the vendor

number

(b) net

Previously billed total client net cost for the vendor

number

d) vendorTradeCost

  1. cost

(a) gross

Gross cost for the vendor for lines flagged as trade

number

(b) net

Net cost for the vendor for lines flagged as trade

number

  1. clientCost

(a) gross

Client gross cost for the vendor for lines flagged as trade

number

(b) net

Client net cost for the vendor for lines flagged as trade

number

e) previousVendorTradeCost

  1. cost

(a) gross

Previously billed gross cost for the vendor for lines flagged as trade

number

(b) net

Previously billed net cost for the vendor for lines flagged as trade

number

  1. clientCost

(a) gross

Previously billed client gross cost for the vendor for lines flagged as trade

number

(b) net

Previously billed client net cost for the vendor for lines flagged as trade

number

f) billDueAmount

  1. gross

Bill gross minus previous bill gross

number

  1. net

Bill Net minus previous bill net

number

f) previousBillAmount

  1. gross

Previously billed bill gross

number

  1. net

Previously billed bill net

number

g) originalBillAmount

  1. gross

Represents the Frozen or Original Schedule amount depending on the Original Order Gross option selected on the Client Billing Setup Screen.

number

  1. net

Represents the Frozen or Original Schedule amount depending on the Original Order Gross option selected on the Client Billing Setup Screen.

number

h) tradeBillAmount

  1. gross

Not Used

  1. net

Bill net amount represented by trade

number

i) previousTradeBillAmount

  1. gross

Not Used

  1. net

Previously billed bill net amount represented by trade

number

j) invoiceAdSize

Ad size for the line from the Vendor invoice for Print/Outdoor and Digital

String (100)

k) taxes

  1. description

Description of tax % and whether it’s based on Vendor gross or net

String (50)

  1. amount

Total tax amount for Vendor

number

  1. previousAmount

Previously Billed tax amount for Vendor

number

  1. dueAmount

Total Tax minus Previously billed tax

number

l) vendorInvoice

  1. invoiceMonth

Vendor Invoice month

String (10)

  1. bottomLineAdjustment

Spot only: Adjustment amount for bottom-line invoices

number

  1. bottomLineAdjustmentIncluded

Spot only: True/False – indicates if the bottom line adjustment amount should be included in the Vendor payment amount

boolean

  1. invoiceStatus
  • C= Cleared
  • O = OK to Pay
  • M= Matched
  • R = Received

Note: O status is only available for Print/Outdoor & Digital

String (1)

  1. invoiceNotes

Vendor invoice comments

String (4000)

  1. invoiceId

System generated ID associated with each Vendor invoice

integer

  1. invoiceNumber

Vendor invoice number

String (255)

  1. invoiceDate

Vendor invoice date

String (23)

  1. invoiceDueDate

Vendor invoice due date

String (23)

m) exportDate

Date Client invoice was exported

String (23)

n) insertionId

Insertion ID for Print/Outdoor and Digital only

Integer

o) insertionStartDatey

Start date of insertion for Print/Outdoor and Digital only

String (23)

p) insertionEndDate

End date of insertion for Outdoor and Digital only

String (23)

q) digitalPackage

Digital Only: True/False – indicates whether the insertion ID represents the package ID

boolean

  1. partialInvoice

Network only: if the Invoice Based on BC Month option is selected, even if the Vendor Invoice is selected on Calendar Month type, the Client Invoice will always be billed based on Broadcast Month. In case of Estimate Bill based on Invoice or Recon Bill, the program will consider Vendor Invoices from two Calendar Months and include only those that fall into the selected Broadcast Month on the Client Invoice. The Partial Invoice flag is used to indicate such Stations.

boolean

  1. productRefId

FW Id associated with the product (network only)

integer

  1. productName

Product name
(network only)

String (50)

  1. productCode

Product code (network only)

String (50)

  1. billTotalLine

Digital Only: Indicates if a multi-month line is being billed in one month. Options are:
Notbillingtotalline, FirstMonth, or LastMonth

String (10)

  1. feeCommission

(aa) commission

Amount of commission on the fee number

(bb) prevousFeeCommision

Previously billed commission on the fee

number

(cc) feeCommissionDue

Commission on Fee amount minus previously billed commission on the fee

number

(dd) currencyCode

Currency code (USD default)

String

  1. noVendorInvoice

Fee Vendors that do not have a payable

boolean

  1. isRubiconOrder

True/False - Flag to identify if the digital order came from Rubicon

boolean

  1. mediaChannelRefId

FW ID associated with the media channel / booking

integer

  1. mediaChannelName

Name associated with the media channel

string

  1. mediaChannelCode

External system code associated with the media channel

string

r. separateFeeVendorInvoice

True/False - For Digital Fees, if true a separate invoice is generated for digital fees separate from media cost

boolean

s. feeOnly

Boolean field to denote Direct Pay

boolean

t. clientTax1TaxDue

Tax 1 due field

number

u. clientTax1Description

Tax type for invoiceTax1

Values are:

  • state
  • local
  • GST
  • PST
  • HST
  • QST

String

v. clientTax2TaxDue

Tax 2 due field

number

w. clientTax2Description

Tax type for invoiceTax2

Values are:

  • state
  • local
  • GST
  • PST
  • HST
  • QST

string

x. customFields

Agency defined fields
(key/value pair (string, string))

String (50)