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

Siebel Invoice


The Siebel Invoice ASI is used by multiple BIPs, 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 is used by each calling BIP to access information in an external billing system.

Figure 35 describes the Siebel Invoice ASI structure.

Figure 35.  Siebel Invoice ASI

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

Table 76.  Siebel Invoice Integration Components
Integration Component
XML Tag
User Keys

CME Invoice Details

CmeInvoiceDetails

No user keys.

CME Invoice Duplicate Request

CmeInvoiceDuplicateRequest

No user keys.

Invoice

Invoice

1 Id
  1. Document Number, Document Type

Invoice Line Items

InvoiceLineItems

1 Id
  1. Integration Id
  2. Line Number

Table 77 lists the fields and their attributes.

Table 77.  Siebel Invoice ASI Fields
Name
XML Tag
Data Type
Length
Required

Invoice

Account Id

AccountId

DTYPE_ID

 

N

Account Integration Id

AccountIntegrationId

DTYPE_TEXT

30

N

Account Location

AccountLocation

DTYPE_TEXT

30

N

Account Name

AccountName

DTYPE_TEXT

50

N

Account Organization Name

AccountOrganizationName

DTYPE_TEXT

100

N

Activity Id

ActivityId

DTYPE_ID

 

N

Activity User Defined Unique Id

ActivityUserDefinedUniqueId

DTYPE_TEXT

30

N

Amount Paid

AmountPaid

DTYPE_TEXT

 

N

Balance Forward

BalanceForward

DTYPE_TEXT

 

N

Bill To Person Id

BillToPersonId

DTYPE_TEXT

30

N

Billing End Date

BillingEndDate

DTYPE_TEXT

 

N

Billing Start Date

BillingStartDate

DTYPE_TEXT

 

N

Contract Id

ContractId

DTYPE_ID

 

N

Contract Integration Id

ContractIntegrationId

DTYPE_TEXT

30

N

Contract Name

ContractName

DTYPE_TEXT

50

N

Contract Organization Name

ContractOrganizationName

DTYPE_TEXT

100

N

Contract Revision Number

ContractRevisionNumber

DTYPE_NUMBER

 

N

Currency Code

CurrencyCode

DTYPE_TEXT

20

N

Delinquent Flag

DelinquentFlag

DTYPE_TEXT

 

N

Document Date

DocumentDate

DTYPE_TEXT

 

N

Document Description

DocumentDescription

DTYPE_TEXT

250

N

Document Number

DocumentNumber

DTYPE_TEXT

50

N

Document Period Id

DocumentPeriodId

DTYPE_ID

 

N

Document Period Name

DocumentPeriodName

DTYPE_TEXT

50

N

Document Period Organization Name

DocumentPeriodOrganizationName

DTYPE_TEXT

100

N

Document Revision Number

DocumentRevisionNumber

DTYPE_NUMBER

 

N

Document Status

DocumentStatus

DTYPE_TEXT

30

N

Document Sub Type

DocumentSubType

DTYPE_TEXT

30

N

Document Type

DocumentType

DTYPE_TEXT

30

N

Id

Id

DTYPE_ID

30

N

Integration Id

IntegrationId

DTYPE_TEXT

30

N

Order Id

OrderId

DTYPE_ID

 

N

Order Integration Id

OrderIntegrationId

DTYPE_TEXT

30

N

Order Number

OrderNumber

DTYPE_TEXT

30

N

Order Organization Name

OrderOrganizationName

DTYPE_TEXT

100

N

Order Type

OrderType

DTYPE_TEXT

50

N

Payment Term

PaymentTerm

DTYPE_TEXT

50

N

Payment Term Due Date

PaymentTermDueDate

DTYPE_DATETIME

 

N

Payment Term Id

PaymentTermId

DTYPE_ID

 

N

Payment Term Net Days

PaymentTermNetDays

DTYPE_NUMBER

 

N

Project Id

ProjectId

DTYPE_ID

 

N

Project Integration Id

ProjectIntegrationId

DTYPE_TEXT

30

N

Project Number

ProjectNumber

DTYPE_TEXT

30

N

Project Organization Name

ProjectOrganizationName

DTYPE_TEXT

100

N

STORED Adjustment Amount

STOREDAdjustmentAmount

DTYPE_TEXT

 

N

STORED Discount Amount

STOREDDiscountAmount

DTYPE_TEXT

 

N

STORED Gross Amount

STOREDGrossAmount

DTYPE_TEXT

 

N

STORED Surcharge Amount

STOREDSurchargeAmount

DTYPE_TEXT

 

N

STORED Tax Amount

STOREDTaxAmount

DTYPE_TEXT

 

N

Service Request Id

ServiceRequestId

DTYPE_ID

 

N

Service Request Number

ServiceRequestNumber

DTYPE_TEXT

64

N

Service Request Organization Name

ServiceRequestOrganizationName

DTYPE_TEXT

100

N

Status

Status

DTYPE_TEXT

30

N

Total Amount

TotalAmount

DTYPE_TEXT

 

N

Type Code

TypeCode

DTYPE_TEXT

 

N

operation

operation

DTYPE_TEXT

30

N

Invoice Line Items

Activity Id

ActivityId

DTYPE_ID

 

N

Activity User Defined Unique Id

ActivityUserDefinedUniqueId

DTYPE_TEXT

30

N

Contract Id

ContractId

DTYPE_ID

 

N

Contract Integration Id

ContractIntegrationId

DTYPE_TEXT

30

N

Contract Line Id

ContractLineId

DTYPE_ID

 

N

Contract Name

ContractName

DTYPE_TEXT

50

N

Contract Organization Name

ContractOrganizationName

DTYPE_TEXT

100

N

Contract Revision Number

ContractRevisionNumber

DTYPE_NUMBER

 

N

Currency Code

CurrencyCode

DTYPE_TEXT

20

N

Description

Description

DTYPE_TEXT

250

N

Discount Amount

DiscountAmount

DTYPE_TEXT

 

N

Gross Amount

GrossAmount

DTYPE_TEXT

 

N

Id

Id

DTYPE_ID

30

N

Integration Id

IntegrationId

DTYPE_TEXT

30

N

Line Number

LineNumber

DTYPE_NUMBER

 

N

Line Quantity

LineQuantity

DTYPE_NUMBER

 

N

Line Type

LineType

DTYPE_TEXT

30

N

Order Id

OrderId

DTYPE_ID

 

N

Order Integration Id

OrderIntegrationId

DTYPE_TEXT

30

N

Order Item Id

OrderItemId

DTYPE_ID

 

N

Order Item Integration Id

OrderItemIntegrationId

DTYPE_TEXT

30

N

Order Line Number

OrderLineNumber

DTYPE_NUMBER

 

N

Order Number

OrderNumber

DTYPE_TEXT

30

N

Order Organization Name

OrderOrganizationName

DTYPE_TEXT

100

N

Order Type

OrderType

DTYPE_TEXT

50

N

Person Id

PersonId

DTYPE_ID

 

N

Product Id

ProductId

DTYPE_ID

 

N

Product Integration Id

ProductIntegrationId

DTYPE_TEXT

30

N

Product Name

ProductName

DTYPE_TEXT

100

N

Product Organization Name

ProductOrganizationName

DTYPE_TEXT

100

N

Product Vendor Organization Name

ProductVendorOrganizationName

DTYPE_TEXT

100

N

Project Id

ProjectId

DTYPE_ID

 

N

Project Integration Id

ProjectIntegrationId

DTYPE_TEXT

30

N

Project Item Id

ProjectItemId

DTYPE_ID

 

N

Project Item Number

ProjectItemNumber

DTYPE_TEXT

30

N

Project Number

ProjectNumber

DTYPE_TEXT

30

N

Project Organization Name

ProjectOrganizationName

DTYPE_TEXT

100

N

Project Resource Id

ProjectResourceId

DTYPE_ID

 

N

Project Resource Number

ProjectResourceNumber

DTYPE_TEXT

30

N

Service Request Id

ServiceRequestId

DTYPE_ID

 

N

Service Request Number

ServiceRequestNumber

DTYPE_TEXT

64

N

Service Request Organization Name

ServiceRequestOrganizationName

DTYPE_TEXT

100

N

Surcharge Amount

SurchargeAmount

DTYPE_TEXT

 

N

Tax Amount

TaxAmount

DTYPE_TEXT

 

N

Unit of Measure

UnitofMeasure

DTYPE_TEXT

30

N

operation

operation

DTYPE_TEXT

30

N

CME Invoice Details

Amount

Amount2

DTYPE_TEXT

 

N

Call Type

CallType

DTYPE_TEXT

 

N

Currency

Currency

DTYPE_TEXT

 

N

Date/Time

DateTime

DTYPE_TEXT

 

N

Duration

Duration

DTYPE_TEXT

 

N

Id

Id

DTYPE_ID

30

N

Invoice Header Id

InvoiceHeaderId

DTYPE_TEXT

 

N

Line Number

LineNumber

DTYPE_TEXT

 

N

Location

Location

DTYPE_TEXT

 

N

Number Called

NumberCalled

DTYPE_TEXT

 

N

Originating Number

OriginatingNumber

DTYPE_TEXT

 

N

Period

Period

DTYPE_TEXT

 

N

Rate

Rate

DTYPE_TEXT

 

N

Segment

Segment

DTYPE_TEXT

 

N

Service

Service

DTYPE_TEXT

 

N

Vid

Vid

DTYPE_ID

 

N

operation

operation

DTYPE_TEXT

30

N

CME Invoice Duplicate Request

Copies

Copies

DTYPE_NUMBER

 

N

Id

Id

DTYPE_ID

30

N

operation

operation

DTYPE_TEXT

30

N

Application Services Interface Reference