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

Basic Attributes Returned

Field Name	Description	Data Type (Length)
Id	List of Client Bill Transaction Ids	integer
transactionId	Client bill Transaction Id	integer
agencyId	System generated agency ID	integer
agencyName	Agency name	String (50)
officeId	System generated office ID	integer
officeName	Office name	String (50)
officeCode	Office code	String (50)
advertiserName	Advertiser name as defined in Media Billing Client Billing Setup	String (50)
clientRefId	FW Client Id	integer
clientName	Client name	String (50)
clientCode	Client code	String (50)
invoiceAddress
addressType	Invoice work payee invoice traffic	string
line1	Billing address line 1	String (50)
line2	Billing address line 2	String (50)
zip	Billing address zip code	String (50)
state	Billing address state	String (50)
city	Billing address city	String (50)
country	Billing address country	string
currencyCode	Currency code (USD default)	string
mediaBillingInvoiceNumber	Client bill number	String (50)
mediaBillingInvoiceDate	Client bill date	String (23)
mediaBillingDueDate	Client bill payment due date	String (23)
mediaBillingTotalAmountDue	Total Amount due on Client Invoice	number
exportDate	Date Client Bill exported from SBMS	String (23)
originalMediaBillingInvoice	True/False When an Invoice is voided, it will be False for the record that is used to balance the original invoice.	boolean
voidedMediaBillingInvoice	True/False When an Invoice is voided, it will be set to True for both the original and balanced records.	boolean
voidDate	Voided date (both original and balanced records)	String (23)
voidComments	Voided comments (both original and balanced records)	String (50)
campaignInfo
id	System generated estimate number	integer
billHeaderId	ID of the associated Bill Header	integer
productRefId	FW Product Id	integer
productName	Product name	String (50)
productCode	Product code	String (50)
estimate
id	System generated estimate number	Integer
description	Estimate description	String (50)
code	Optional estimate billing code String (50)
mediaRefId	FW Media Id	Integer
mediaName	Estimate media type name	String (50)
mediaCode	Estimate media type code (optional)	String (50)
flightStartDate	Estimate flight start date	String (23)
flightEndDate	Estimate flight end date	String (23)
totalUnits	Total units within bill	integer
totalBillNetDue	Net media cost due on Client bill	number
totalBillGrossDue	Gross media cost due on Client bill	number
mediaBillingFeeAmountDue	Fee due on Client bill	number
totalTaxDue	Tax due on Client bill	number
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
withholdingAmount	Amount withheld based on % setup by Client	number
barterCreditAmountDue	Amount used in barter – subtracted from Billing Amount	number
feeWithholding	Amount of the Fee withheld based on % setup by Client	number
mediaBillinginvoiceId	Client bill system generated ID	integer
invoiceComments	Comments on the Client Bill	String (255)
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
monthOfService	Month of media activity	String (5)
dateRangeStartDate	When billing on date range, start date of the date range being billed	String (23)
dateRangeEndDate	When billing on date range, end date of the date range being billed	String (23)
billType	E = Estimate Bill R = Reconciliation Bill	String (1)
specialAmountBill	True/False	boolean
invoiceType	Indicates whether separate invoices were generated for Fee Vendors and Media Vendor. Only available in Digital. Valid values: NoSeparateFeeVendorInvoice SeparateMediaInvoice SeparateFeeVendorInvoice	String (3)
billDetails
id	System generated ID for Vendor detail records on the Client bill	integer
campaignInfoId	ID of the associated Campaign header	integer
billId	Client bill ID	integer
marketName	Market associated with the Vendor on the Client bill	String (50)
marketCode	Market code associated with the Vendor on the Client bill	String (3)
stationName	Spot: Call Letters + Band Code Network: Package Name Print/Outdoor: Publication/Vendor Name Digital: Publisher/Fee Vendor Name	String (101)
vendor
vendorRefId	FW internal Vendor ID	Integer
vendorName	Vendor name	String (101)
vendorCode	Vendor billing code	String (50)
alternateBillCode	Alternate Vendor billing code	String (50)
alternateBill	True/False If True, the alternate Vendor billing code is used for Vendor payment.	boolean
isFee	True: MB Fee % is not applied to the Vendor. False: MB Fee % is applied to the Vendor.	boolean
mediaRefId	FreeWheel media ID associated with the vendor	integer
mediaName	Name of media associated with the vendor	String
mediaCode	External media code associated with the vendor	String
totalUnits	Total units by vendor	Integer
BillAmount
Gross	Gross amount on the client bill for the vendor. This is based on the Bill Gross Cost defined in Client Billing Setup.	number
net	Net amount on the client bill for the vendor. This is based on the Bill Net Cost defined in Client Billing setup.	number
vendorCost
cost
gross	Total gross cost for the vendor	number
net	Total net cost for the vendor	number
clientCost
gross	Total client gross cost for the vendor	number
net	Total client net cost for the vendor	number
previousVendorCost
cost
gross	Previously billed total gross cost for the vendor	number
net	Previously billed total net cost for the vendor	number
clientCost
gross	Previously billed total client gross cost for the vendor	number
net	Previously billed total client net cost for the vendor	number
vendorTradeCost
cost
gross	Gross cost for the vendor for lines flagged as trade	number
net	Net cost for the vendor for lines flagged as trade	number
clientCost
gross	Client gross cost for the vendor for lines flagged as trade	number
net	Client net cost for the vendor for lines flagged as trade	number
previousVendorTradeCost
cost
gross	Previously billed gross cost for the vendor for lines flagged as trade	number
net	Previously billed net cost for the vendor for lines flagged as trade	number
clientCost
gross	Previously billed client gross cost for the vendor for lines flagged as trade	number
net	Previously billed client net cost for the vendor for lines flagged as trade	number
billDueAmount
gross	Bill gross minus previous bill gross	number
net	Bill Net minus previous bill net	number
previousBillAmount
gross	Previously billed bill gross	number
net	Previously billed bill net	number
originalBillAmount
gross	Represents the Frozen or Original Schedule amount depending on the Original Order Gross option selected on the Client Billing Setup Screen.	number
net	Represents the Frozen or Original Schedule amount depending on the Original Order Gross option selected on the Client Billing Setup Screen.	number
tradeBillAmount
gross	Not Used
net	Bill net amount represented by trade	number
previousTradeBillAmount
gross	Not Used
net	Previously billed bill net amount represented by trade	number
invoiceAdSize	Ad size for the line from the Vendor invoice for Print/Outdoor and Digital	String (100)
taxes
description	Description of tax % and whether it’s based on Vendor gross or net	String (50)
amount	Total tax amount for Vendor	number
previousAmount	Previously Billed tax amount for Vendor	number
dueAmount	Total Tax minus Previously billed tax	number
vendorInvoice
invoiceMonth	Vendor Invoice month	String (10)
bottomLineAdjustment	Spot only: Adjustment amount for bottom-line invoices	number
bottomLineAdjustmentIncluded	Spot only: True/False – indicates if the bottom line adjustment amount should be included in the Vendor payment amount	boolean
invoiceStatus	C= Cleared O = OK to Pay M= Matched R = Received Note: O status is only available for Print/Outdoor & Digital	String (1)
invoiceNotes	Vendor invoice comments	String (4000)
invoiceId	System generated ID associated with each Vendor invoice	integer
invoiceNumber	Vendor invoice number	String (255)
invoiceDate	Vendor invoice date	String (23)
invoiceDueDate	Vendor invoice due date	String (23)
xportDate	Date Client invoice was exported	String (23)
insertionId	Insertion ID for Print/Outdoor and Digital only	Integer
insertionStartDatey	Start date of insertion for Print/Outdoor and Digital only	String (23)
insertionEndDate	End date of insertion for Outdoor and Digital only	String (23)
digitalPackage	Digital Only: True/False – indicates whether the insertion ID represents the package ID	boolean
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
roductRefId	FW Id associated with the product (network only)	integer
productName	Product name (network only)	String (50)
productCode	Product code (network only)	String (50)
billTotalLine	Digital Only: Indicates if a multi-month line is being billed in one month. Options are: Notbillingtotalline, FirstMonth, or LastMonth	String (10)
feeCommission
commission	Amount of commission on the fee number
prevousFeeCommision	Previously billed commission on the fee	number
feeCommissionDue	Commission on Fee amount minus previously billed commission on the fee	number
currencyCode	Currency code (USD default)	String
noVendorInvoice	Fee Vendors that do not have a payable	boolean
isRubiconOrder	True/False - Flag to identify if the digital order came from Rubicon	boolean
mediaChannelRefId	FW ID associated with the media channel / booking	integer
mediaChannelName	Name associated with the media channel	string
mediaChannelCode	External system code associated with the media channel	string
separateFeeVendorInvoice	True/False - For Digital Fees, if true a separate invoice is generated for digital fees separate from media cost	boolean
feeOnly	Boolean field to denote Direct Pay	boolean
clientTax1TaxDue	Tax 1 due field	number
clientTax1Description	Tax type for invoiceTax1 Values are: state local GST PST HST QST	String
clientTax2TaxDue	Tax 2 due field	number
clientTax2Description	Tax type for invoiceTax2 Values are: state local GST PST HST QST	string
customFields	Agency defined fields (key/value pair (string, string))	String (50)

FW Financial API - Client Bill - AR

📘
Note

Basic Attributes Returned

📘Note

Basic Attributes Returned

📘
Note