Invoice Header
Defines invoice general information such as supplier, supplier site, invoice number, invoice date, as well as default information used to create invoice lines.
QName: {http://xmlns.oracle.com/apps/financials/payables/invoices/quickInvoices/invoiceInterfaceService/}InvoiceInterfaceHeader
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Contains |
|
|
Contains |
|
|
Contains |
|
|
Handled by |
Attributes
The following table describes attributes in the service data object.
| Name | Type | Description |
|---|---|---|
|
AcctsPayCodeCombinationId |
long |
Accounting flexfield identifier for accounts payable liability account. |
|
AddTaxToInvoiceAmountFlag |
boolean |
Indicates whether the invoice amount should be grossed up by the calculated tax. |
|
AmountApplicableToDiscount |
decimal |
Amount of invoice applicable to a discount. |
|
ApplicationId |
long |
Application identifier. |
|
ApplyAdvancesFlag |
boolean |
A value of Y indicates that applicable advances are applied against expense reports and other invoices. |
|
Attribute1 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute10 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute11 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute12 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute13 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute14 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute15 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute2 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute3 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute4 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute5 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute6 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute7 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute8 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
Attribute9 |
string |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeCategory |
string |
Descriptive Flexfield: structure definition of the user descriptive flexfield. |
|
AttributeDate1 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeDate2 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeDate3 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeDate4 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeDate5 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeNumber1 |
decimal |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeNumber2 |
decimal |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeNumber3 |
decimal |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeNumber4 |
decimal |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AttributeNumber5 |
decimal |
Descriptive Flexfield: segment of the user descriptive flexfield. |
|
AwtGroupId |
long |
Withholding tax group identifier. |
|
AwtGroupName |
string |
Withholding tax group name. |
|
B2BProgramName |
string |
Name of program that invokes the invoice service to create B2B invoices. |
|
B2BSiteCode |
string |
B2B Site Code. When a supplier site is enabled for sending B2B invoices, a B2B site code is assigned by the deploying company to the supplier site. |
|
BankChargeBearer |
string |
Bearer of bank charge cost. |
|
BudgetDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Budgetary calendar period date applicable for funds check. |
|
CalculateTaxDuringImportFlag |
boolean |
Indicates whether tax should be calculated or not for the imported invoice. |
|
ControlAmount |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
Allows user to enter total tax amount to be prorated by Oracle Fusion Tax. |
|
CorrectionPeriod |
string |
Correction period. |
|
CorrectionYear |
decimal |
Correction year. |
|
CorrelationId |
string |
A unique identifier for the request payload. The value is used to convey the request status after completing the operation. |
|
CustomerRegistrationCode |
string |
Customer legal registration code. |
|
CustomerRegistrationNumber |
string |
Customer legal registration number. |
|
DeliveryChannelCode |
string |
Delivery channel code. |
|
Description |
string |
Invoice description. |
|
DocumentCategoryCode |
string |
Sequential numbering or voucher number document category. |
|
DocumentSubType |
string |
Replaces a global descriptive flexfield: In certain countries, a tax or governmental authority defines and classifies document types for reporting purposes. |
|
ExchangeDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date exchange rate is effective, usually accounting date of a transaction. |
|
ExchangeRate |
decimal |
Exchange rate for foreign currency invoices. |
|
ExchangeRateType |
string |
Exchange rate type for foreign currency invoices. |
|
ExclusivePaymentFlag |
boolean |
Flag that indicates whether to pay invoice on a separate payment document. |
|
ExternalBankAccountId |
long |
External bank account identifier. |
|
ExternalDocumentReference |
string |
Internal document reference number from Receivables application. Used for XML invoices. |
|
FirstPartyRegistrationId |
long |
First party tax registration identifier. |
|
FirstPartyRegistrationNumber |
string |
First party tax registration number. |
|
GlDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Accounting date to default to invoice distributions. |
|
GlobalAttribute1 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute10 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute11 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute12 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute13 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute14 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute15 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute16 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute17 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute18 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute19 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute2 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute20 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute3 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute4 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute5 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute6 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute7 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute8 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttribute9 |
string |
Global Descriptive Flexfield: segment of the global descriptive flexfield. |
|
GlobalAttributeCategory |
string |
Global Descriptive Flexfield: structure definition of the global descriptive flexfield. |
|
GlobalAttributeDate1 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeDate2 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeDate3 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeDate4 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeDate5 |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeNumber1 |
decimal |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeNumber2 |
decimal |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeNumber3 |
decimal |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeNumber4 |
decimal |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GlobalAttributeNumber5 |
decimal |
Global Descriptive Flexfield: segment of the global descriptive flexfield |
|
GoodsReceivedDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date invoice items received. |
|
GroupId |
string |
Group identifier. |
|
ImageDocumentNumber |
string |
Document number for invoice image |
|
ImageDocumentUri |
string |
URL for invoice image |
|
ImportDocumentDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Import document date. |
|
ImportDocumentNumber |
string |
Import document number. |
|
InvoiceAmount |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
Invoice amount. |
|
InvoiceCurrencyCode |
string |
Currency of invoice. |
|
InvoiceDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Invoice date. |
|
InvoiceHeaderRejection |
Invoice header rejection. |
|
|
InvoiceId |
long |
Invoice identifier.
|
|
InvoiceIncludesPrepayFlag |
boolean |
Prepayment included in invoice amount. |
|
InvoiceInterfaceLine |
Invoice interface line information. |
|
|
InvoiceNumber |
string |
Invoice number. |
|
InvoiceReceivedDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date invoice received. |
|
InvoiceTypeLookupCode |
string |
Type of invoice. Possible values are Standard or Credit. |
|
LegalEntityId |
long |
Legal entity identifier. |
|
LegalEntityName |
string |
Legal entity name. |
|
LoadRequestId |
long |
Load request ID.
|
|
NetOfRetainageFlag |
boolean |
Indicates whether invoice amount is net of retainage. |
|
NoExchangeRateBaseAmount |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
Invoice amount in the functional currency. Used only when the Calculate User Exchange Rate option is enabled, and used only for foreign currency invoices when the conversion rate type is User. The application uses this value and the invoice amount to calculate the exchange rate. |
|
OperatingUnit |
string |
Organization name. |
|
OrgId |
decimal |
Indicates the identifier of the business unit associated to the row. |
|
PONumber |
string |
Purchase order number. |
|
PaidOnBehalfEmployeeId |
long |
When an expense report gets split in Both Pay scenario, the new expense report's PaidOnBehalfEmployeeId gets populated with the original expense report's employee identifier. |
|
PartyId |
long |
Party identifier. |
|
PartySiteId |
long |
Party-site identifier. |
|
PayGroupLookupCode |
string |
Name of pay group. |
|
PayProcTrxnTypeCode |
string |
Type of payment processing transaction or document. |
|
PaymentCrossRate |
decimal |
Conversion rate between invoice and payment. |
|
PaymentCrossRateDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Cross currency payment rate date. |
|
PaymentCrossRateType |
string |
Cross currency payment rate type. |
|
PaymentCurrencyCode |
string |
Cross currency payment currency. |
|
PaymentFunction |
string |
The function or purpose of the payment. |
|
PaymentMethodCode |
string |
Payment method identifier. |
|
PaymentMethodLookupCode |
string |
Name of payment method. |
|
PaymentPriority |
int |
Number representing payment priority of a scheduled payment, values range from 1 to 99. |
|
PaymentReasonCode |
string |
Payment reason code. |
|
PaymentReasonComments |
string |
Free text field available for entering a reason for the payment. |
|
PortOfEntryCode |
string |
Customs location code. |
|
PrepayApplyAmount |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
The amount of prepayment that the user wants to apply to the invoice. This amount has to be positive. |
|
PrepayGlDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The accounting date to be used for the prepayment application. If left null, the accounting date of the invoice is used. |
|
PrepayLineNumber |
int |
The invoice line of an existing prepayment to be applied to the imported invoice. |
|
PrepayNumber |
string |
The invoice number of an existing, fully paid prepayment to be applied to the imported invoice. |
|
ProductTable |
string |
Product source table name. |
|
Reference1 |
string |
A reference to a record in another application. |
|
Reference2 |
string |
A reference to a record in another application. |
|
ReferenceKey1 |
string |
Primary key information that uniquely identifies a record in other products view. |
|
ReferenceKey2 |
string |
Primary key information that uniquely identifies a record in other products view. |
|
ReferenceKey3 |
string |
Primary key information that uniquely identifies a record in other products view. |
|
ReferenceKey4 |
string |
Primary key information that uniquely identifies a record in other products view. |
|
ReferenceKey5 |
string |
Primary key information that uniquely identifies a record in other products view. |
|
RelationshipId |
long |
Third party relationship identifier |
|
RemitToAddressId |
long |
Remit-to address identifier where the payment should be sent |
|
RemitToAddressName |
string |
Remit-to address where the payment should be sent |
|
RemitToSupplierId |
long |
Third party supplier identifier |
|
RemitToSupplierName |
string |
Third party supplier |
|
RemitToSupplierNumber |
string |
Third party supplier number |
|
RemittanceMessage1 |
string |
Remittance message for use in payment processing. |
|
RemittanceMessage2 |
string |
Remittance message for use in payment processing. |
|
RemittanceMessage3 |
string |
Remittance message for use in payment processing. |
|
RequesterEmailAddress |
string |
The email address of the employee for the requested items |
|
RequesterEmployeeNumber |
string |
The employee number of the employee who requested goods or services on the invoice line. |
|
RequesterFirstName |
string |
The first name of the employee who requested goods or services on the invoice line. This value is used to derive the requester ID. If you use Invoice Approval Workflow then you can define rules that use the requester ID to generate a hierarchical list of approvers for the line. |
|
RequesterId |
long |
Requester of invoice is used by the Invoice Approval Workflow process to generate the list of approvers. |
|
RequesterLastName |
string |
The last name of the employee who requested goods or services on the invoice line. This value is used to derive the requester ID. If you use Invoice Approval Workflow then you can define rules that use the requester ID to generate a hierarchical list of approvers for the line. |
|
RoutingAttribute1 |
string |
Captures additional attributes that can be used for routing payables invoice images |
|
RoutingAttribute2 |
string |
Captures additional attributes that can be used for routing payables invoice images |
|
RoutingAttribute3 |
string |
Captures additional attributes that can be used for routing payables invoice images |
|
RoutingAttribute4 |
string |
Captures additional attributes that can be used for routing payables invoice images |
|
RoutingAttribute5 |
string |
Captures additional attributes that can be used for routing payables invoice images |
|
SettlementPriority |
string |
The priority with which the financial institution or payment system should settle payment for this document. |
|
ShipToLocation |
string |
Ship-to location for purchase order matching. Used for XML invoices. |
|
Source |
string |
Identifies the external system from which the invoice is imported. |
|
Status |
string |
Status of import data. |
|
SupplierTaxExchangeRate |
decimal |
Replaces a global descriptive flexfield: The supplier conversion rate is entered in online invoices to calculate the supplier tax amount for foreign currency invoices. The gain or loss in the tax amount for foreign currency invoices is the difference between the in-house tax amount using the in-house exchange rate and the supplier tax amount using the supplier exchange rate that you enter here. A manual journal entry is posted to the GL to incorporate the gain or loss. |
|
SupplierTaxInvoiceDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Replaces a global descriptive flexfield: To satisfy reporting requirements in certain countries, the Tax Invoice Date on the supplier-issued tax invoice needs to be recorded. |
|
SupplierTaxInvoiceNumber |
string |
Replaces a global descriptive flexfield: In some countries such as Thailand, there is a requirement to report on a supplier issued tax invoice that is distinct from the regular invoice. The tax invoice is either attached to the standard supplier invoice, in the case of goods or the supplier may issue it when they receive the payment. |
|
TaxInvoiceInternalSequence |
string |
Replaces a global descriptive flexfield: To satisfy reporting requirements in certain countries, the company-issued tax invoice date and number. This field is used to record the company-specific tax invoice number, in sequence, issued by the company for a supplier-issued tax invoice. This is required to comply with reporting requirements. |
|
TaxInvoiceRecordingDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Replaces a global descriptive flexfield: To satisfy reporting requirements in certain countries, the company-specific tax invoice date and number needs to be captured. This field is used to record the date the company receives or records the supplier-issued tax invoice and is required to comply with reporting requirements. |
|
TaxRelatedInvoiceId |
long |
Tax Driver: Invoice ID of related document for tax purposes. |
|
TaxationCountry |
string |
Replaces a global descriptive flexfield: This country sets the context for other tax drivers. The value defaults to the legal entity country but can be overridden by the user. |
|
TermsDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
Date used with payment terms to calculate scheduled payment of an invoice. |
|
TermsId |
long |
Payment terms identifier. |
|
TermsName |
string |
Payment terms name. |
|
ThirdPartyRegistrationId |
long |
Third party tax registration identifier. |
|
ThirdPartyRegistrationNumber |
string |
Third party tax registration number. |
|
USSGLTransactionCode |
string |
Default transaction code for creating US Standard General Ledger journal entries such as Oracle Fusion Public Sector Payables. |
|
UniqueRemittanceIdentifier |
string |
Unique remittance identifier provided by the payee. |
|
UriCheckDigit |
string |
Unique remittance identifier check digit. |
|
VendorEmailAddress |
string |
Supplier e-mail address for XML invoice rejections. |
|
VendorId |
long |
Supplier identifier. |
|
VendorName |
string |
Supplier name. |
|
VendorNumber |
string |
Supplier number. |
|
VendorSiteCode |
string |
Supplier-site code. |
|
VendorSiteId |
long |
Supplier-site identifier. |
|
VendorSiteOverride |
string |
Indicates whether the vendor site details provided by the Collaboration Messaging Framework (CMK) can be used for creating an invoice, provided that the pay site is valid for invoice creation. If the value is Y, then the CMK's vendor site information will be utilized for invoice creation. Valid values are Y and N. |
|
VoucherNumber |
string |
Valid voucher number if Sequential Numbering is enabled or invalid if Sequential Numbering is not enabled. |
|
WorkflowFlag |
boolean |
Indicates whether the Payables Open Interface Workflow should process the record, valid values are Y or N. |
|
attachments |
Supporting documents attached to the B2B invoices. |