Vendor Invoices are available in the API once they have been cleared in FreeWheel.
| Field Name | Description | Data Type (Length) |
|---|---|---|
| Id | Unique ID for every time an invoice is cleared, unlocked, re-cleared, etc. | string |
| billId | Unique ID for every time an invoice is cleared, unlocked, re-cleared, etc. | integer |
| currencyCode | Currency code (USD default) | string |
| invoiceGrossCost | Invoice total gross dollars | number |
| invoiceNetCost | Invoice total net dollars | number |
| invoiceGrossCash | Invoice gross cash dollars | number |
| invoiceGrossTrade | Invoice gross trade value | number |
| totalUnits | Total units within invoice | integer |
| syscode | Cable Vendor system code (syscode) | string (5) |
| agencyID | Agency ID | integer |
| agencyName | Agency name | string (50) |
| agencyCode | Optional Agency billing code | string (50) |
| officeID | Office ID | integer |
| officeName | Office name | string (50) |
| officeCode | Office billing code (Optional) | string (50) |
| bottomLineInvoice | True/False indicating that the invoice is bottom-line and will have no invoice detail information. | boolean |
| vendor | ||
| vendorRefId | FW unique Vendor ID | integer |
| vendorName |
| string (101) |
| vendorCode | Vendor billing code | string (50) |
| alternateBillCode | Alternate Vendor billing code | string (30) |
| alternateBill | True/False If True, the alternate Vendor billing code is used for Vendor payment | boolean |
| isFee | True/False True: MB Fee % is not applied to the Vendor; False: MB Fee % is applied to the Vendor | boolean |
| mediaRefId | FW media type ID | integer |
| mediaName | Media name associated with vendor media type | string (50) |
| mediaCode | Media type code associated with vendor media type | string (50) |
| clearedDate | Date/Time Stamp when invoice was exported/cleared for payment | string (23) |
| unlockedBillId | Bill ID of related invoice when a negative/ reverse entry is created for unlocked invoices | integer |
| matchOnNet | Spot Only: Indicates whether the invoice was matched on net instead of gross | boolean |
| verificationNet | True/False: Indicates whether the Invoice Total Net Cost represents the Verification Net (true) or the Net (false) on the invoice record | boolean |
| invoiceNetTrade | Total net trade cost on invoice | number |
| invoiceGrossInvestment | Total gross cost on invoice identified as Investment | number |
| invoiceNetInvestment | Total net cost on invoice identified as Investment | number |
| totalTradeUnits | Number of units that are trade | integer |
| invoiceTax1 | First tax amount on invoice | number |
| tax1Type | Tax type for invoiceTax1 Values are:
| string |
| invoiceTax2 | Second tax amount on invoice | number |
| tax2Type | Tax type for InvoiceTax2 Values are:
| string |
| tax1GLAccount | GL Account associated with Tax 1 | string (50) |
| tax2GLAccount | GL Account associated with Tax 2 | string (50) |
| totalAmountDue | Total amount due on invoice | number |
| cashInAdvance | True/False: Indicates whether the invoice is a pre-pay (cash-in-advance) invoice | boolean |
| repBill | True/False: Indicates whether the Rep Bill Code should be used in place of the Vendor Code or Alternate Bill Code | boolean |
| repBillCode | Rep Billing Code | string (50) |
| billingMonthType | Indicate whether the station/package/pub/ publisher/fee Vendor is billed by Broadcast Month (B), Calendar Month (C) or Fiscal (F) | string (1) |
| InvoiceEstimates | ||
| estimateId | System generated estimate number | integer |
| estimateCode | Estimate Billing code (Optional) | string (50) |
| invoiceGrossCost | AMOUNT OF GROSS COST BEING PAID ON ESTIMATE | integer |
| invoiceNetCost | AMOUNT OF NET COST BEING PAID ON ESTIMATE | integer |
| invoiceGrossCash | GROSS CASH AMOUNT BEING PAID ON ESTIMATE | integer |
| invoiceGrossTrade | GROSS TRADE AMOUNT BE PAID ON ESTIMATE | integer |
| totalUnits | TOTAL INVOICE UNITS BEING PAID ON ESTIMATE | integer |
| mediaOrderId | System generated ID associated with the Vendor on the estimate/campaign | |
| Integer | ||
| stationCallLetters |
| string (50) |
| stationBandCode |
| string (50) |
| clientRefId | FreeWheel client ID | integer |
| clientName | Client name | string (50) |
| clientCode | Client billing code (Optional) | string (50) |
| divisionRefId | FreeWheel ID for the division | integer |
| divisionName | Division Name (Optional) | string (50) |
| divisionCode | Division billing code (Optional) | string (50) |
| productRefId | FreeWheel ID for the product | integer |
| productName | Product name | string (50) |
| productCode | Product billing code (Optional) | string (50) |
| networkPackageCode | Network Only: Number used to identify Network packages | integer |
| paidByClient | Vendor invoice paid by Client | boolean |
| invoiceDetails | Invoice Detail Line information | |
| billDetailId | Unique ID for every time an invoice detail item is cleared, unlocked, re-cleared, etc. | integer |
| billId | Unique ID for every time an invoice is cleared, unlocked, re-cleared, etc. | integer |
| id | Unique identifier for the invoice detail item | integer |
| invoiceId | Unique identifier for the invoice | integer |
| network | Spot only: Cable network associated with detail item | string (50) |
| invoiceDetailDate | Invoice Detail Date
| string (23) |
| invoiceDetailTime | Run time of the Unit for Spot and Network String (23) | string (23) |
| invoiceDetailEndDate | Invoice Detail End Date
| |
| invoiceDetailGrossCost | Gross cost of the line detail | number |
| invoiceDetailNetCost | Net cost of the line detail | number |
| unitLength | Unit length for the line detail for Spot and Network | integer |
| isciCode | Spot/Network: ISCI (commercial) ID for the ad | string (50) |
| cashOrTrade | Spot and Network by unit: C = Cash, T = Trade | string (1) |
| comments | Invoice line comments | string (4000) |
| programName | Program for line detail for Spot and Network | string (200) |
| numberOfUnits | Number of invoice line units | integer |
| InvoiceOrderLines | Order line detail pertaining to invoice line | |
| marketName | Market name | string (50) |
| marketCode | Market code | string (50) |
| invoiceDetailGrossCost | Gross amount attributed to order line | integer |
| invoiceDetailNetCost | Net amount attributed to order line | integer |
| lineId | Unique line ID associated with the order Note: For Digital the line ID is unique by package or by placement line | integer |
| isPackage | Digital Only: True/False used to identify if the line ID is associated with the package or placement line | boolean |
| orderLineNumber | Unique line number by order | integer |
| commission | Commission/Agency discount % | number |
| netCharge | Non-commissionable charge or fee associated with Vendor | number |
| daypartCode | Daypart code for the line detail | string (50) |
| rateType | Digital Rate Type | string (50) |
| productName Network | Only: Product name | string (50) |
| productRefId | FreeWheel product Id (Network Only) | integer |
| productCode | Network Only: Product code | string (50) |
| mediaChannelRefId | FreeWheel ID for the media channel / booking category code | integer |
| mediaChannelName | Name of the media channel / booking category | string |
| mediachannelCode | External code for the media channel / booking category | string |
| orderMonth | Month of order corresponding to matched invoice line | string |
| prepaidInvoiceDetail | ||
| amount | Amount on Invoice | number |
| invoiceNumber | Prepaid Invoice Number | string |
| invoiceDate | Date of Invoice | Datetime |
| invoiceMonth | invoice month on invoice | string |
| bottomLineAdjustment | Spot only: Adjustment amount for bottom-line invoices | number |
| bottomLineAdjustmentIncluded | Spot only: True/False – indicates if the BL adjustment amount should be included in the Vendor payment amount | boolean |
| invoiceStatus | Invoice status | string (1) |
| invoiceNotes | Vendor Invoice comments | string (4000) |
| invoiceId | Unique identifier for the invoice | integer |
| invoiceNumber | Vendor Invoice number | string (255) |
| invoiceDate | Vendor Invoice date | string (23) |
| invoiceDueDate | Vendor Invoice due date | string (23) |