Application Services Interface Reference > Predefined Application Service Interfaces >

Siebel Invoice


The Siebel Invoice ASI allows the implementation of replication of invoices from back office accounting systems to the Siebel application, which allows Sales professionals, call center agents, partners, as well as the end customer, access to invoice information in Siebel for related inquiries. A typical process involves the creation of the invoice in the back end system following the fulfillment of an order followed by the replication of this invoice (as well as all of its updates) in the front end systems. As all other ASIs, the Siebel Invoice ASI allows the creation, update, deletion and queries of invoice information inbound and outbound of Siebel applications.

Figure 24 describes the structure of the Siebel Invoice ASI.

Figure 24.  Siebel Invoice ASI

Click for full size image

Table 38 lists the integration components of the Siebel Invoice ASI.

Table 38.  Siebel Invoice Integration Components
Integration Component
XML Tag
User Keys
FS Invoice (primary)
Invoice
  1. Id
  2. Integration Id
  3. Document Type, Document Number
FS Invoice Line Items
FSInvoiceLineItems
  1. Id
  2. Integration Id
  3. LIne Number

The Siebel Invoice ASI uses the same User Keys as the FS Invoice integration component. The fields can be used for the integration. This means that values for each of these fields may be written to an XML file for transportation. Table 39 lists the fields and their attributes.

Table 39.  Siebel Invoice ASI Fields
Name
XML Tag
Data Type
Length
Req.
Notes
FS Invoice
Account Id
AccountId
DTYPE_ID
15
 
Used for picking from Picklist Account.
User key field for Invoice.
Account Integration Id
AccountIntegrationId
DTYPE_TEXT
30
 
Used for picking from Picklist Account.
User key field for Invoice.
Account Location
AccountLocation
DTYPE_TEXT
30
 
Used for picking from Picklist Account.
Account Name
AccountName
DTYPE_TEXT
50
 
Used for picking from Picklist Account.
Account Organization Name
AccountOrganizationName
DTYPE_TEXT
100
 
Used for picking from Picklist Account.
Activity Id
ActivityId
DTYPE_ID
15
 
Used for picking from FS Activity Pick List.
Activity User Defined Unique Id
ActivityUserDefinedUniqueId
DTYPE_TEXT
30
 
Used for picking from FS Activity Pick List.
Amount Paid
AmountPaid
DTYPE_CURRENCY
22
 
 
Balance Forward
BalanceForward
DTYPE_CURRENCY
22
 
 
Contract Id
ContractId
DTYPE_ID
15
 
Used for picking from Service Agreement.
Contract Integration Id
ContractIntegrationId
DTYPE_TEXT
30
 
Used for picking from Service Agreement.
Contract Name
ContractName
DTYPE_TEXT
50
 
Used for picking from Service Agreement.
Contract Organization Name
ContractOrganizationName
DTYPE_TEXT
100
 
Used for picking from Service Agreement.
Contract Revision Number
ContractRevisionNumber
DTYPE_NUMBER
22
 
Used for picking from Service Agreement.
Currency Code
CurrencyCode
DTYPE_TEXT
20
Y
Used for picking from Picklist Currency.
Delinquent Flag
DelinquentFlag
DTYPE_BOOL
1
 
 
Document Date
DocumentDate
DTYPE_UTCDATETIME
7
 
 
Document Description
DocumentDescription
DTYPE_TEXT
250
 
 
Document Number
DocumentNumber
DTYPE_TEXT
50
Y
User key field for Invoice.
Document Period Id
DocumentPeriodId
DTYPE_ID
15
 
Used for picking from Picklist Period.
Document Period Name
DocumentPeriodName
DTYPE_TEXT
50
 
Used for picking from Picklist Period.
Document Period Organization Name
DocumentPeriodOrganizationName
DTYPE_TEXT
100
 
Used for picking from Picklist Period.
Document Revision Number
DocumentRevisionNumber
DTYPE_NUMBER
15
 
 
Document Status
DocumentStatus
DTYPE_TEXT
30
 
Bound by FS_INVOICE_TYPE LOV
Document Sub Type
DocumentSubType
DTYPE_TEXT
30
 
Bound by FS_INVOICE_CODE LOV.
Document Type
DocumentType
DTYPE_TEXT
30
 
Bound by FS_INVOICE_TYPE LOV.
User key field for Invoice.
Id
Id
DTYPE_ID
30
 
 
Integration Id
IntegrationId
DTYPE_TEXT
30
 
 
Order Id
OrderId
DTYPE_ID
15
 
Used for picking from Order Entry Picklist.
Order Integration Id
OrderIntegrationId
DTYPE_TEXT
30
 
Used for picking from Order Entry Picklist.
Order Number
OrderNumber
DTYPE_TEXT
30
 
Used for picking from Order Entry Picklist.
Order Organization Name
OrderOrganizationName
DTYPE_TEXT
100
 
Used for picking from Order Entry Picklist.
Order Type
OrderType
DTYPE_TEXT
50
 
Used for picking from Order Entry Picklist.
Payment Term
PaymentTerm
DTYPE_TEXT
50
 
Used for picking from Picklist Payment Term.
Payment Term Id
PaymentTermId
DTYPE_ID
15
 
Used for picking from Picklist Payment Term.
Project Id
ProjectId
DTYPE_ID
15
 
Used for picking from Picklist Project.
Project Integration Id
ProjectIntegrationId
DTYPE_TEXT
30
 
Used for picking from Picklist Project.
Project Number
ProjectNumber
DTYPE_TEXT
30
 
Used for picking from Picklist Project.
Project Organization Name
ProjectOrganizationName
DTYPE_TEXT
100
 
Used for picking from Picklist Project.
STORED Adjustment Amount
STOREDAdjustmentAmount
DTYPE_CURRENCY
22
 
 
STORED Discount Amount
STOREDDiscountAmount
DTYPE_CURRENCY
22
 
 
STORED Gross Amount
STOREDGrossAmount
DTYPE_CURRENCY
22
 
 
STORED Surcharge Amount
STOREDSurchargeAmount
DTYPE_CURRENCY
22
 
 
STORED Tax Amount
STOREDTaxAmount
DTYPE_CURRENCY
22
 
 
Service Request Id
ServiceRequestId
DTYPE_ID
15
 
Used for picking from Service Request Picklist.
Service Request Number
ServiceRequestNumber
DTYPE_TEXT
64
 
Used for picking from Service Request Picklist.
Service Request Organization Name
ServiceRequestOrganizationName
DTYPE_TEXT
100
 
Used for picking from Service Request Picklist.
FS Invoice Line Items
Activity Id
ActivityId
DTYPE_ID
15
 
Used for picking from FS Activity Picklist.
Activity User Defined Unique Id
ActivityUserDefinedUniqueId
DTYPE_TEXT
30
 
Used for picking from FS Activity Picklist.
Contract Id
ContractId
DTYPE_ID
15
 
Used for picking from FS PickList Agreement Item - All.
Contract Integration Id
ContractIntegrationId
DTYPE_TEXT
30
 
Used for picking from FS PickList Agreement Item - All.
Contract Line Id
ContractLineId
DTYPE_ID
15
 
Used for picking from FS PickList Agreement Item - All.
Contract Name
ContractName
DTYPE_TEXT
50
 
Used for picking from FS PickList Agreement Item - All.
Contract Organization Name
ContractOrganizationName
DTYPE_TEXT
100
 
Used for picking from FS PickList Agreement Item - All.
Contract Revision Number
ContractRevisionNumber
DTYPE_NUMBER
22
 
Used for picking from FS PickList Agreement Item - All.
CurrencyCode
CurrencyCode
DTYPE_TEXT
20
Y
Used for picking from Picklist Currency.
Description
Description
DTYPE_TEXT
250
 
 
Discount Amount
DiscountAmount
DTYPE_CURRENCY
22
 
 
Gross Amount
GrossAmount
DTYPE_CURRENCY
22
 
 
Id
Id
DTYPE_ID
30
 
User key field for Line Item.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Line Item.
Line Number
LineNumber
DTYPE_NUMBER
22
Y
User key field for Line Item.
Line Quantity
LineQuantity
DTYPE_NUMBER
22
Y
 
Line Type
LineType
DTYPE_TEXT
30
 
Used for picking from FS Invoice Line Item Type Picklist.
Order Id
OrderId
DTYPE_ID
15
 
Used for picking from Order Entry Picklist.
Order Integration Id
OrderIntegrationId
DTYPE_TEXT
30
 
Used for picking from Order Entry Picklist.
Order Item Id
OrderItemId
DTYPE_ID
15
 
Used for picking from Order Entry - Line Item Picklist.
Order Item Integration Id
OrderItemIntegrationId
DTYPE_TEXT
30
 
Used for picking from Order Entry - Line Item Picklist.
Order Line Number
OrderLineNumber
DTYPE_NUMBER
22
 
Used for picking from Order Entry - Line Item Picklist.
Order Number
OrderNumber
DTYPE_TEXT
30
 
Used for picking from Order Entry - Line Item Picklist.
Order Organization Name
OrderOrganizationName
DTYPE_TEXT
100
 
Used for picking from Order Entry - Line Item Picklist.
Order Type
OrderType
DTYPE_TEXT
50
 
Used for picking from Order Entry - Line Item Picklist.
Person Id
PersonId
DTYPE_ID
15
 
Used for picking from PS PickList Project Resource.
Product Id
ProductId
DTYPE_ID
15
 
Used for picking from Order Entry - Product PickList.
Product Integration Id
ProductIntegrationId
DTYPE_TEXT
30
 
Used for picking from Order Entry - Product PickList.
Product Name
ProductName
DTYPE_TEXT
100
 
Used for picking from Order Entry - Product PickList.
Product Organization Name
ProductOrganizationName
DTYPE_TEXT
100
 
Used for picking from Order Entry - Product PickList.
Product Vendor Organization Name
ProductVendorOrganizationName
DTYPE_TEXT
100
 
Used for picking from Order Entry - Product PickList.
Project Id
ProjectId
DTYPE_ID
15
 
Used for picking from Picklist Project.
Project Integration Id
ProjectIntegrationId
DTYPE_TEXT
30
 
Used for picking from Picklist Project.
Project Item Id
ProjectItemId
DTYPE_ID
15
 
Used for picking from Project Item PickList.
Project Item Number
ProjectItemNumber
DTYPE_TEXT
30
 
Used for picking from Project Item PickList.
Project Number
ProjectNumber
DTYPE_TEXT
30
 
Used for picking from Picklist Project.
Project Organization Name
ProjectOrganizationName
DTYPE_TEXT
100
 
Used for picking from Picklist Project.
Project Resource Id
ProjectResourceId
DTYPE_ID
15
 
Used for picking from PS PickList Project Resource.
Project Resource Number
ProjectResourceNumber
DTYPE_TEXT
30
 
Used for picking from PS PickList Project Resource.
Service Request Id
ServiceRequestId
DTYPE_ID
15
 
Used for picking from Service Request Picklist.
Service Request Number
ServiceRequestNumber
DTYPE_TEXT
64
 
Used for picking from Service Request Picklist.
Service Request Organization Name
ServiceRequestOrganizationName
DTYPE_TEXT
100
 
Used for picking from Service Request Picklist.
Surcharge Amount
SurchargeAmount
DTYPE_CURRENCY
22
 
 
Tax Amount
TaxAmount
DTYPE_CURRENCY
22
 
 
Unit of Measure
UnitofMeasure
DTYPE_TEXT
30
Y
Bound by UNIT_OF_MEASURE LOV.


 Application Services Interface Reference 
 Published: 15 May 2003