Bookshelf Home | Contents | Index | Search | PDF

Application Services Interface Reference > Siebel Communications, Media, and Energy ASIs >

Invoice Interface

---

The Invoice Interface ASI is used by multiple Integration Business Processes including Sync Invoice Header, Query Invoice Details, and Request Duplicate Invoice. The ASI has four types of fields associated with it, a different subset of which are used by each calling Integration Business process to access information in an external billing system.

Figure 102 describes the Invoice Interface ASI structure and Table 243 lists the field definitions.

Figure 102.  Invoice Interface ASI

Table 242 lists the integration components and XML tags of this ASI.

Table 242.  Invoice Interface Integration Components

Integration Component	XML Tag	User Keys
CME Invoice Details	CmeInvoiceDetails
CME Invoice Duplicate	CmeInvoiceDuplicateRequest
Invoice	Invoice	Id Integration Id Document Number, Document Type Id, Integration Id, operation
Invoice Line Items	InvoiceLineItems	Id Integration Id Line Number Id, Integration Id, operation

Table 243 lists the Invoice Interface fields and their attributes.

Table 243.  Invoice Interface ASI Fields

Name	XML Tag	Data Type	Length	Req.	Notes
Invoice
Account Id	AccountId	DTYPE_ID
Account Integration Id	AccountIntegrationId	DTYPE_TEXT	30
Account Location	AccountLocation	DTYPE_TEXT	30
Account Name	AccountName	DTYPE_TEXT	50
Account Organization Name	AccountOrganizationName	DTYPE_TEXT	100
Activity Id	ActivityId	DTYPE_ID
Activity User Defined Unique Id	ActivityUserDefinedUniqueId	DTYPE_TEXT	30
Amount Paid	AmountPaid	DTYPE_TEXT
Balance Forward	BalanceForward	DTYPE_TEXT
Bill To Person Id	BillToPersonId	DTYPE_TEXT	30
Billing End Date	BillingEndDate	DTYPE_TEXT
Billing Start Date	BillingStartDate	DTYPE_TEXT
Contract Id	ContractId	DTYPE_ID
Contract Integration Id	ContractIntegrationId	DTYPE_TEXT	30
Contract Name	ContractName	DTYPE_TEXT	50
Contract Organization Name	ContractOrganizationName	DTYPE_TEXT	100
Contract Revision Number	ContractRevisionNumber	DTYPE_NUMBER
Currency Code	CurrencyCode	DTYPE_TEXT	20
Delinquent Flag	DelinquentFlag	DTYPE_TEXT
Document Date	DocumentDate	DTYPE_TEXT
Document Description	DocumentDescription	DTYPE_TEXT	250
Document Number	DocumentNumber	DTYPE_TEXT	50
Document Period Id	DocumentPeriodId	DTYPE_ID
Document Period Name	DocumentPeriodName	DTYPE_TEXT	50
Document Period Organization Name	DocumentPeriodOrganizationName	DTYPE_TEXT	100
Document Revision Number	DocumentRevisionNumber	DTYPE_NUMBER
Document Status	DocumentStatus	DTYPE_TEXT	30
Document Sub Type	DocumentSubType	DTYPE_TEXT	30
Document Type	DocumentType	DTYPE_TEXT	30
Id	Id	DTYPE_ID	30
Integration Id	IntegrationId	DTYPE_TEXT	30
Order Id	OrderId	DTYPE_ID
Order Integration Id	OrderIntegrationId	DTYPE_TEXT	30
Order Number	OrderNumber	DTYPE_TEXT	30
Order Organization Name	OrderOrganizationName	DTYPE_TEXT	100
Order Type	OrderType	DTYPE_TEXT	50
Payment Term	PaymentTerm	DTYPE_TEXT	50
Payment Term Due Date	PaymentTermDueDate	DTYPE_DATETIME
Payment Term Id	PaymentTermId	DTYPE_ID
Payment Term Net Days	PaymentTermNetDays	DTYPE_NUMBER
Project Id	ProjectId	DTYPE_ID
Project Integration Id	ProjectIntegrationId	DTYPE_TEXT	30
Project Number	ProjectNumber	DTYPE_TEXT	30
Project Organization Name	ProjectOrganizationName	DTYPE_TEXT	100
STORED Adjustment Amount	STOREDAdjustmentAmount	DTYPE_TEXT
STORED Discount Amount	STOREDDiscountAmount	DTYPE_TEXT
STORED Gross Amount	STOREDGrossAmount	DTYPE_TEXT
STORED Surcharge Amount	STOREDSurchargeAmount	DTYPE_TEXT
STORED Tax Amount	STOREDTaxAmount	DTYPE_TEXT
Service Request Id	ServiceRequestId	DTYPE_ID
Service Request Number	ServiceRequestNumber	DTYPE_TEXT	64
Service Request Organization Name	ServiceRequestOrganizationName	DTYPE_TEXT	100
Status	Status	DTYPE_TEXT	30
Total Amount	TotalAmount	DTYPE_TEXT
Type Code	TypeCode	DTYPE_TEXT
operation	operation	DTYPE_TEXT	30
Invoice Line Items
Activity Id	ActivityId	DTYPE_ID
Activity User Defined Unique Id	ActivityUserDefinedUniqueId	DTYPE_TEXT	30
Contract Id	ContractId	DTYPE_ID
Contract Integration Id	ContractIntegrationId	DTYPE_TEXT	30
Contract Line Id	ContractLineId	DTYPE_ID
Contract Name	ContractName	DTYPE_TEXT	50
Contract Organization Name	ContractOrganizationName	DTYPE_TEXT	100
Contract Revision Number	ContractRevisionNumber	DTYPE_NUMBER
CurrencyCode	CurrencyCode	DTYPE_TEXT	20
Description	Description	DTYPE_TEXT	250
Discount Amount	DiscountAmount	DTYPE_TEXT
Gross Amount	GrossAmount	DTYPE_TEXT
Id	Id	DTYPE_ID	30
Integration Id	IntegrationId	DTYPE_TEXT	30
Line Number	LineNumber	DTYPE_NUMBER
Line Quantity	LineQuantity	DTYPE_NUMBER
Line Type	LineType	DTYPE_TEXT	30
Order Id	OrderId	DTYPE_ID
Order Integration Id	OrderIntegrationId	DTYPE_TEXT	30
Order Item Id	OrderItemId	DTYPE_ID
Order Item Integration Id	OrderItemIntegrationId	DTYPE_TEXT	30
Order Line Number	OrderLineNumber	DTYPE_NUMBER
Order Number	OrderNumber	DTYPE_TEXT	30
Order Organization Name	OrderOrganizationName	DTYPE_TEXT	100
Order Type	OrderType	DTYPE_TEXT	50
Person Id	PersonId	DTYPE_ID
Product Id	ProductId	DTYPE_ID
Product Integration Id	ProductIntegrationId	DTYPE_TEXT	30
Product Name	ProductName	DTYPE_TEXT	100
Product Organization Name	ProductOrganizationName	DTYPE_TEXT	100
Product Vendor Organization Name	ProductVendorOrganizationName	DTYPE_TEXT	100
Project Id	ProjectId	DTYPE_ID
Project Integration Id	ProjectIntegrationId	DTYPE_TEXT	30
Project Item Id	ProjectItemId	DTYPE_ID
Project Item Number	ProjectItemNumber	DTYPE_TEXT	30
Project Number	ProjectNumber	DTYPE_TEXT	30
Project Organization Name	ProjectOrganizationName	DTYPE_TEXT	100
Project Resource Id	ProjectResourceId	DTYPE_ID
Project Resource Number	ProjectResourceNumber	DTYPE_TEXT	30
Service Request Id	ServiceRequestId	DTYPE_ID
Service Request Number	ServiceRequestNumber	DTYPE_TEXT	64
Service Request Organization Name	ServiceRequestOrganizationName	DTYPE_TEXT	100
Surcharge Amount	SurchargeAmount	DTYPE_TEXT
Tax Amount	TaxAmount	DTYPE_TEXT
Unit of Measure	UnitofMeasure	DTYPE_TEXT	30
operation	operation	DTYPE_TEXT	30
CME Invoice Details
Amount	Amount2	DTYPE_TEXT
Call Type	CallType	DTYPE_TEXT
Currency	Currency	DTYPE_TEXT
Date/Time	DateTime	DTYPE_TEXT
Duration	Duration	DTYPE_TEXT
Id	Id	DTYPE_ID	30
Invoice Header Id	InvoiceHeaderId	DTYPE_TEXT
Line Number	LineNumber	DTYPE_TEXT
Location	Location	DTYPE_TEXT
Number Called	NumberCalled	DTYPE_TEXT
Originating Number	OriginatingNumber	DTYPE_TEXT
Period	Period	DTYPE_TEXT
Rate	Rate	DTYPE_TEXT
Segment	Segment	DTYPE_TEXT
Service	Service	DTYPE_TEXT
Vid	Vid	DTYPE_ID
operation	operation	DTYPE_TEXT	30
CME Invoice Duplicate Request
Copies	Copies	DTYPE_NUMBER
Id	Id	DTYPE_ID	30
operation	operation	DTYPE_TEXT	30

Bookshelf Home | Contents | Index | Search | PDF