Invoice Interface Table
This extract file interface handles header records for each invoice in the extract set. Note that every invoice in the current extract file set must have the same invoice date. If it is required to load invoices with several different dates, then multiple extract file sets are required, one for each individual invoice date. Data loaded via this interface is primarily bound for the INVOICE CXP
Customer Experience Platform, or CXP, is MDS Global's self-service app that allows business customers to manage their own accounts and subscriptions. Admin schema table.
|
External table name |
Schema |
Mapped file |
|---|---|---|
|
Invoice_Interface |
Staging |
invoice.dat |
Invoice interface table fields
|
Column Heading |
Type |
Length |
Description |
|---|---|---|---|
|
EXTERNAL _INVOICE_ID |
VarChar2 |
40 |
Unique invoice identifier as used by the originating CRM data base. |
| EXTERNAL_ORGANISATION_UNIT_ID | VarChar2 | 40 | Unique identifier denoting the CRM name for the organisation unit that owns the invoice. |
| ORGANISATION_UNIT_LEVEL | Integer | The level within the organisation unit hierarchy, at which the current organisation unit resides. There is an assumption that EXTERNAL_ORGANISATION_UNIT_ID values are only unique at the level within the hierarchy that are indicated to be at. Therefore, for example, a node with an identifier of 'ABC' at level 1 is considered to be a different node to a node with identifier 'ABC' at level 2. | |
| EXTERNAL_DELIVERY_ADDRESS_ID | VarChar2 | 40 | A CRM derived delivery address identifier. This value provides a link to the delivery_address.dat extract file record that contains the details of the current invoice's delivery address. |
| EXTERNAL _STATEMENT _ID | VarChar2 | 40 | The CRM derived identifier for the statement produced alongside the current invoice. |
| INVOICE_DESCRIPTION | VarChar2 | 100 | A textual description for the current invoice. For example 'ongoing monthly invoice', final invoice' etc. |
| INVOICE_DUE_DATE |
Date |
Date that the invoice becomes due for payment. DATE_FORMAT DATE MASK "yyyymmddhh24miss" | |
| PREVIOUS_INVOICE_DATE | Date | Date of the previous invoice for the current organisation unit. This value is used to check for gaps in the invoice history of each customer. Missing invoices represent a risk because they might hide organisation unit hierarchy changes that have not been reflected in the database and thus open up the possibility of data corruption (attaching invoices to the wrong version of an organisation unit hierarchy node). When missing invoices are detected, the data loader will refuse to load the extract and flag up a warning. To load the extract, either the missing invoices need to be loaded first, or the data loader needs to be run in a special override mode. DATE_FORMAT DATE MASK "yyyymmddhh24miss" | |
| BILLING_FREQUENCY | VarChar2 | 40 | This value is only required for on cycle invoices. It can be left NULL for off cycle invoices. BILLING_FREQUENCY is an enumerated type. Possible values would include: Daily WeeklyMonthly Quarterly Yearly |
| PAYMENT_TYPE | VarChar2 | 40 | The payment type that is expected to be used to pay off this invoice. This value is usually derived from the payment scheme the customer has registered to use with the CRM. |
| INVOICE_FORMAT | VarChar2 | 40 | An indication of the billing format used to produce the original invoice. One of the elements used to determine the formatting of invoices by CXP. |
| TAXATION_DOMAIN | VarChar2 | 40 | The market area (geographical or other) with which the current invoice is associated. One of the elements used to determine the formatting of invoices by CXP. |
| Locale | VarChar2 | 12 | A set of preference information related to the invoice's language, environment and/or cultural conventions. When combined with the preferences associated with the application user, the Locale is used to determine the formatting of invoices by CXP. |
| ATTRIBUTE_1 | VarChar2 | 100 | Customisable invoice data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP. |
| ATTRIBUTE_2 | VarChar2 | 100 | Customisable invoice data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP. |
| ATTRIBUTE_3 | VarChar2 | 100 | Customisable invoice data element. This field is usually used to hold a value specific to the original CRM data base's billing profile, which is not otherwise directly supported by CXP. |