Update an invoice header for a project contract invoice
/fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}
Request
-
InvoiceId(required): integer(int64)
Unique identifier of the invoice.
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/json
object-
Attachments: array
Project Contract Invoices Attachments
Title:
Project Contract Invoices AttachmentsThe attachments resource is used to view, create, update and delete attachments for project contract invoices. -
CreditMemoReasonCode: string
Title:
Credit Memo Reason CodeMaximum Length:30Indicates the code for the reason to create a credit memo. -
DocumentSubType: string
Title:
Document SubtypeMaximum Length:240A classification that is assigned to documents such as an invoice or a credit memo. Example subtypes are Domestic Invoice and Foreign Invoice. -
Exception: string
Title:
ExceptionMaximum Length:1Indicates that exceptions have occurred for the invoice or for lines on the invoice. Valid values are E - Error, W - Warning, and N - No error. -
InvoiceComment: string
Title:
Invoice CommentMaximum Length:240Free text field for comments that can be printed on an invoice. The default value is the invoice comment defined for the project. -
InvoiceDate: string
(date)
Title:
DateThe invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release. -
InvoiceHeaderDff: array
Invoice Header Descriptive Flexfields
Title:
Invoice Header Descriptive FlexfieldsA listing of all the descriptive flexfields available for project contract invoices. -
InvoiceInstructions: string
Title:
Billing InstructionsMaximum Length:240Free text field to enter instructions for invoice billing. -
InvoiceLines: array
Invoice Lines
Title:
Invoice LinesThe Invoice Lines resource is used to view the details of the invoice lines. -
InvoiceStatusCode: string
Title:
Invoice Status CodeMaximum Length:30Default Value:DRAFTIndicates the code for the status of the invoice. Valid values are SUBMITTED, APPROVAL_REJECTED, RELEASED, DRAFT, REJECTED, TRANSFERRED, ACCEPTED, and APPROVED. -
LastUnreleasedByPersonId: integer
(int64)
Title:
Last Unreleased by Person IDUnique identifier of the person who last unreleased the invoice. -
LastUnreleasedDate: string
(date-time)
Title:
Last Unreleased DateThe date and time when the invoice was last unreleased. -
ReceivablesNumber: string
Title:
Receivables NumberMaximum Length:20The Oracle Receivables invoice number that is determined upon release of the invoice and passed to Oracle Receivables upon transfer. This number can be user-entered in the application or system-generated as defined in the implementation options. -
ReleasedByPersonId: integer
(int64)
Title:
Released by Person IDUnique identifier of the person who released the invoice. -
ReleasedDate: string
(date)
Title:
Released DateThe date on which the invoice was released for transfer. -
SubmittedByPersonId: integer
(int64)
Title:
Submitted by Person IDUnique identifier of the person who submitted the invoice for approval. -
SubmittedDate: string
(date-time)
Title:
Submitted DateThe date and time when the invoice was submitted for approval. -
TaxationCountry: string
Title:
Taxation CountryMaximum Length:2The country of taxation for calculating tax. -
TransferredDate: string
(date)
Title:
Transfer DateIndicates the date on which the invoice is transferred to the Oracle Receivables interface tables. -
UnreleaseComments: string
Title:
Unrelease CommentsMaximum Length:240Comments entered by the person who unreleased the invoice.
arrayProject Contract Invoices AttachmentsarrayInvoice Header Descriptive FlexfieldsarrayInvoice Linesobject-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context for flex fields. -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt
object-
AssessableValue: number
Title:
Assessable ValueAn optional value for an assessable value for the transaction line for estimated tax purposes. -
IntendedUse: string
Title:
Intended UseMaximum Length:240A classification of the products by tax authority for tax purposes. -
IntendedUseClassifId: integer
(int64)
Title:
Intended Use Classification IDUnique identifier of the intended use classification. -
InvoiceLineDff: array
Invoice Line Descriptive Flexfields
Title:
Invoice Line Descriptive FlexfieldsA listing of all the descriptive flexfields available for invoice lines. -
InvoiceLineDistributions: array
Invoice Line Distributions
Title:
Invoice Line DistributionsThe Invoice Line Distributions resource is used to view the details of invoice line distributions. -
InvoiceLineNumber: integer
(int64)
Title:
Invoice Line NumberNumber that identifies an invoice line. -
LineDescription: string
Title:
Invoice Line DescriptionMaximum Length:240Description of the invoice line. -
OutputTaxClassCode: string
Title:
Output Tax ClassificationMaximum Length:150A classification of output tax for the invoice line. -
OutputTaxExempt: string
Title:
Output tax exemptMaximum Length:1Indicates the use of Standard Exemption rules. Options include Standard, Exempt, or Required. The default is based on user tax setup. -
OutputTaxExmtCertNumber: string
Title:
Tax Exemption Certificate NumberMaximum Length:80Identifier of the exemption certificate for item lines that have the Output tax Exempt attribute set to E-exempt. -
OutputTaxExmtReasonCode: string
Title:
Tax Exemption ReasonMaximum Length:30Indicates the code for the reason for tax exemption on lines that have the Output tax Exempt attribute set to E-exempt. -
ProductCategory: string
Title:
Product CategoryMaximum Length:240A classification of products used for tax purposes. -
ProductFcCategoryId: integer
(int64)
Title:
Product FC Category IDUnique identifier of the product fiscal classification category. -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. -
ProductType: string
Title:
Product TypeMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. -
ShipToAccountNumber: string
Title:
Ship-to Account NumberAccount number of the ship-to customer on the invoice line. -
ShipToCustomerId: integer
(int64)
Title:
Ship-to CustomerUnique identifier of the customer account ship-to address that is the project customer's default work site for the project. -
ShipToSiteId: integer
(int64)
Title:
Ship-to Site Use IDUnique identifier of the ship-to address used for taxation. This attribute is populated only if the invoice formats groups by work site and for events using the work site of the event task. -
ShipToSiteName: string
Title:
Ship-to SiteUnique identifier of the ship-to site on the invoice line. -
TransactionBusinessCategory: string
Title:
Transaction Business CategoryMaximum Length:240A classification or categorization of an invoice line for tax purposes as required by a tax authority. -
TranslatedText: string
Title:
Translated DescriptionMaximum Length:1000The translated text of the invoice line. This text is in the language defined in invoice header. -
UserDefinedFiscalClass: string
Title:
User-Defined Fiscal ClassificationMaximum Length:30Indicates the default taxation country.
arrayInvoice Line Descriptive FlexfieldsarrayInvoice Line Distributionsobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context for flex fields. -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt
objectResponse
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object-
AcceptedDate: string
(date-time)
Title:
Accepted DateRead Only:trueThe date and time when the invoice was accepted. -
AccountingDate: string
(date)
Title:
Accounting DateRead Only:trueThe date within a General Ledger (GL) accounting period to which the invoice transactions are posted. The GL date is set by the Transfer Invoice process and it is the date of the first future or open GL period in Oracle Receivables for the invoice date. -
AccountingPeriodName: string
Title:
Accounting PeriodRead Only:trueMaximum Length:15Name of the General Ledger (GL) period for the GL Date attribute. -
ApprovedbyPerson: string
Title:
Approved ByRead Only:trueName of the person who approved the invoice. -
ApprovedbyPersonId: integer
Title:
Approved by Person IDRead Only:trueUnique identifier of the person who approved the invoice. -
ApprovedDate: string
(date)
Title:
Approved DateRead Only:trueThe date on which the invoice is approved. -
ApTransferStatusCode: string
Title:
Invoice Transfer Status to PayablesRead Only:trueMaximum Length:1Indicates the status of the transfer of the invoice to Accounts Payable (AP). Valid values are P - Pending, A - Accepted, and R - Rejected. -
Attachments: array
Project Contract Invoices Attachments
Title:
Project Contract Invoices AttachmentsThe attachments resource is used to view, create, update and delete attachments for project contract invoices. -
BillFromDate: string
(date)
Title:
Bill from DateRead Only:trueThe date through which to invoice the project. Expenditure items with the expenditure item date on or after the bill from date and events with completion dates on or after the bill through date may be included on an invoice. -
BillingTypeCode: string
Title:
Billing TypeRead Only:trueMaximum Length:30Indicates the code used to classify the type of billing. Valid values are EX - External, IP - Interproject, and IC - Intercompany. -
BillSet: integer
(int64)
Title:
Bill SetRead Only:trueIdentifier of a set of invoices created together in the same run which must be released at the same time. -
BillToAccountNumber: string
Title:
Bill-to Account NumberRead Only:trueMaximum Length:30Account number of the bill-to customer. -
BillToAddress: string
Title:
Bill-to AddressRead Only:trueAddress of the bill-to customer. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact IDRead Only:trueUnique identifier of the contact who is a representative for the bill-to customer on the bill plan. -
BillToContactName: string
Title:
Bill-to ContactRead Only:trueMaximum Length:255Name of the contact who is a representative for the bill-to customer on the bill plan. -
BillToCustomerId: integer
(int64)
Title:
Bill-to Customer IDRead Only:trueUnique identifier of the bill-to customer on the invoice. -
BillToCustomerName: string
Title:
Bill-to CustomerRead Only:trueMaximum Length:240Name of the bill-to customer on the invoice. -
BillToDate: string
(date)
Title:
Bill-Through DateRead Only:trueThe date through which to invoice the project. Expenditure items with the expenditure item date on or before the bill to date and events with completion dates on or before the bill through date may be included on an invoice. -
BillToSite: string
Title:
Bill-to SiteRead Only:trueMaximum Length:150Address of the bill-to customer. -
BillToSiteId: integer
(int64)
Title:
Bill-to Site IDRead Only:trueUnique identifier of the customer address. -
Canceled: string
Title:
CanceledRead Only:trueMaximum Length:1Indicates that the invoice was cancelled. -
ContractId: integer
(int64)
Title:
Contract IDRead Only:trueUnique identifier of the contract for the invoice. -
ContractNumber: string
Title:
Contract NumberRead Only:trueMaximum Length:120Number that uniquely identifies the contract for the invoice. -
ContractTypeId: integer
(int64)
Title:
Contract Type IDRead Only:trueUnique identifier for the contract type. -
ContractTypeName: string
Title:
Contract TypeRead Only:trueMaximum Length:150Name of the contract type for the contract on the invoice. -
CreditedInvoiceId: integer
(int64)
Title:
Credited Invoice IDRead Only:trueUnique identifier of the invoice that is credited by this invoice. -
CreditedInvoiceNumber: integer
(int64)
Title:
Credited Invoice NumberRead Only:trueNumber of the credited Invoice. -
CreditMemoReasonCode: string
Title:
Credit Memo Reason CodeMaximum Length:30Indicates the code for the reason to create a credit memo. -
CreditMemoReasonMeaning: string
Title:
Credit Memo ReasonRead Only:trueMaximum Length:80Indicates the reason for creating the credit memo. -
DocumentNumber: string
Title:
Document NumberRead Only:trueMaximum Length:240Number that identifies a document on the bill plan of a grants contract. -
DocumentSubType: string
Title:
Document SubtypeMaximum Length:240A classification that is assigned to documents such as an invoice or a credit memo. Example subtypes are Domestic Invoice and Foreign Invoice. -
Exception: string
Title:
ExceptionMaximum Length:1Indicates that exceptions have occurred for the invoice or for lines on the invoice. Valid values are E - Error, W - Warning, and N - No error. -
ExportProcessId: integer
(int64)
Title:
Export Process IDRead Only:trueUnique identifier of the Export Invoice Details job used to export invoice attributes to a CSV file. -
InvoiceAmount: number
Title:
Amount in Invoice CurrencyRead Only:trueAmount in the invoice currency. -
InvoiceComment: string
Title:
Invoice CommentMaximum Length:240Free text field for comments that can be printed on an invoice. The default value is the invoice comment defined for the project. -
InvoiceCurrencyCode: string
Title:
Invoice CurrencyRead Only:trueMaximum Length:30Indicates the currency code for the invoice that is transferred to Oracle Receivables. -
InvoiceDate: string
(date)
Title:
DateThe invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release. -
InvoiceHeaderDff: array
Invoice Header Descriptive Flexfields
Title:
Invoice Header Descriptive FlexfieldsA listing of all the descriptive flexfields available for project contract invoices. -
InvoiceId: integer
(int64)
Title:
Invoice IDRead Only:trueUnique identifier of the invoice. -
InvoiceInstructions: string
Title:
Billing InstructionsMaximum Length:240Free text field to enter instructions for invoice billing. -
InvoiceLines: array
Invoice Lines
Title:
Invoice LinesThe Invoice Lines resource is used to view the details of the invoice lines. -
InvoiceNumber: integer
(int64)
Title:
NumberRead Only:trueThe sequential number that identifies the invoice within a project contract. -
InvoiceStatusCode: string
Title:
Invoice Status CodeMaximum Length:30Default Value:DRAFTIndicates the code for the status of the invoice. Valid values are SUBMITTED, APPROVAL_REJECTED, RELEASED, DRAFT, REJECTED, TRANSFERRED, ACCEPTED, and APPROVED. -
InvoiceStatusMeaning: string
Title:
StatusRead Only:trueMaximum Length:80Indicates the meaning of the value in the Invoice Status Code attribute. A list of valid values is defined in the lookup type PJB_INVOICE_STATUS_TYPE. Valid values are Accepted, Rejected, Approved, Draft, Transfer rejected, Released, Submitted, or Transferred. You can either enter this attribute or Invoice Status Code. -
InvoiceTypeCode: string
Title:
Invoice Type CodeRead Only:trueMaximum Length:30Indicates the code for the type of the invoice. Valid values are CONCESSION, WRITE_OFF, CANCEL, STANDARD, and CREDIT_MEMO. -
InvoiceTypeMeaning: string
Title:
Invoice TypeRead Only:trueMaximum Length:80The meaning of the value of the Invoice Type Code attribute. Valid values are Standard, Credit Memo, Write-Off, Net Invoice, or Canceled. -
LastUnreleasedByPerson: string
Title:
Last Unreleased by PersonRead Only:trueName of the person who last unreleased the invoice. -
LastUnreleasedByPersonId: integer
(int64)
Title:
Last Unreleased by Person IDUnique identifier of the person who last unreleased the invoice. -
LastUnreleasedDate: string
(date-time)
Title:
Last Unreleased DateThe date and time when the invoice was last unreleased. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocNumber: string
Title:
LOC NumberRead Only:trueMaximum Length:240Number that identifies a letter of credit on the bill plan of a grants contract. -
MajorVersion: integer
(int64)
Title:
Contract VersionRead Only:trueIndicates the version number of the contract. -
Migrated: string
Title:
Migration InvoiceRead Only:trueMaximum Length:1Indicates a migration type of invoice. -
NetCredit: string
Title:
Net CreditRead Only:trueMaximum Length:1Indicator of net credit on the invoice. Valid values are Y - True and N - False. -
NetInvoice: string
Title:
Net InvoiceRead Only:trueMaximum Length:1Indicator of net invoice on the invoice. Valid values are Y - True and N - False. -
OrganizationId: integer
(int64)
Title:
Organization IDRead Only:trueUnique identifier of the business unit associated with the invoice. -
OrganizationName: string
Title:
Business UnitRead Only:trueMaximum Length:240Name of the business unit associated with the invoice. -
PaDate: string
(date)
Title:
Project Accounting DateRead Only:trueThe end date of the Project Accounting (PA) period in which the invoice was generated. The PA period is the open or future PA period on or after the latest date of the expenditure item dates and the event completion dates included on the invoice. -
PaPeriodName: string
Title:
Project Accounting PeriodRead Only:trueMaximum Length:15Name of the Project Accounting (PA) period for the invoice. -
ProjectId: integer
(int64)
Title:
Project IDRead Only:trueUnique identifier of the project associated to the invoice. This value is populated if the Invoice grouping option is set to Associated Project in the Bill Plan. -
ProjectName: string
Title:
Project NameRead Only:trueName of the project associated to the invoice. This value is populated if the Invoice grouping option is set to Associated Project in the Bill Plan. -
ProjectNumber: string
Title:
Project NumberRead Only:trueNumber of the project associated to the invoice.This value is populated if the Invoice grouping option is set to Associated Project in the Bill Plan. -
ReceivablesNumber: string
Title:
Receivables NumberMaximum Length:20The Oracle Receivables invoice number that is determined upon release of the invoice and passed to Oracle Receivables upon transfer. This number can be user-entered in the application or system-generated as defined in the implementation options. -
ReceiverSetupCode: string
Title:
Receiver Setup CodeRead Only:trueMaximum Length:30Indicates if the invoice is for global projects of a receiver business unit. The value is IC_NON_GLOBAL for non global projects and blank for all other scenarios. -
RejectedbyPerson: string
Title:
Rejected ByRead Only:trueName of the person who rejected the invoice. -
RejectedbyPersonId: integer
Title:
Rejected by Person IDRead Only:trueUnique identifier of the person who rejected the invoice. -
RejectedDate: string
(date)
Title:
Rejected DateRead Only:trueThe date on which the invoice is rejected. -
ReleasedbyPerson: string
Title:
Released ByRead Only:trueName of the person who released the invoice. -
ReleasedByPersonId: integer
(int64)
Title:
Released by Person IDUnique identifier of the person who released the invoice. -
ReleasedDate: string
(date)
Title:
Released DateThe date on which the invoice was released for transfer. -
ReportTypeCode: string
Title:
Report Type CodeRead Only:trueMaximum Length:30Indicates the code of the Federal report type specified in the bill plan. -
SubmittedByPerson: string
Title:
Submitted by PersonRead Only:trueName of the person who submitted the invoice for approval. -
SubmittedByPersonId: integer
(int64)
Title:
Submitted by Person IDUnique identifier of the person who submitted the invoice for approval. -
SubmittedDate: string
(date-time)
Title:
Submitted DateThe date and time when the invoice was submitted for approval. -
SystemReference: integer
(int64)
Title:
System ReferenceRead Only:trueIndicates the reference to the invoice created in Oracle Receivables from the draft invoice. The Confirm Invoice Acceptance Status in Receivables process populates the value and holds the RA_CUSTOMER_TRX.CUSTOMER_TRX_ID. -
TaxAmount: number
Title:
Tax Amount in Invoice CurrencyRead Only:trueThe total tax amount in the invoice currency. -
TaxationCountry: string
Title:
Taxation CountryMaximum Length:2The country of taxation for calculating tax. -
TransferredDate: string
(date)
Title:
Transfer DateIndicates the date on which the invoice is transferred to the Oracle Receivables interface tables. -
UnreleaseComments: string
Title:
Unrelease CommentsMaximum Length:240Comments entered by the person who unreleased the invoice.
arrayProject Contract Invoices AttachmentsarrayInvoice Header Descriptive FlexfieldsarrayInvoice LinesarrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context for flex fields. -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
InvoiceId: integer
(int64)
Identifier of the invoice.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
ApTransferErrorCode: string
Title:
Invoice AP Transfer Error CodeRead Only:trueMaximum Length:80Indicates the code related to transfer errors between project billing and Accounts Payable (AP). The Invoice Transfer Error Message attribute contains a description of the error. -
ApTransferStatusCode: string
Title:
Invoice Transfer Status to PayablesRead Only:trueMaximum Length:1Indicates the status of the transfer of the invoice to Accounts Payable (AP). Valid values are P - Pending, A - Accepted, and R - Rejected. -
AssessableValue: number
Title:
Assessable ValueAn optional value for an assessable value for the transaction line for estimated tax purposes. -
BillPlanId: integer
(int64)
Title:
Bill Plan IDRead Only:trueUnique identifier of the bill plan related to the line. -
BillSet: integer
(int64)
Title:
Bill SetRead Only:trueIdentifier of a set of invoices created together in the same run which must be released at the same time. -
ContractCurrencyCode: string
Title:
Contract CurrencyRead Only:trueMaximum Length:30Indicates the code of the currency for the contract related to the invoice line. -
ContractCurrencyLineAmount: number
Title:
Invoice Amount in Contract CurrencyRead Only:trueAmount in contract currency. -
ContractLineId: integer
(int64)
Title:
Contract Line IDRead Only:trueUnique identifier of the contract line related to the invoice line. -
ContractLineNumber: string
Title:
Contract Line NumberRead Only:trueMaximum Length:150Number that identifies the contract line related to the invoice line if the line represents a single contract line. -
CreditedInvoiceLineId: integer
(int64)
Title:
Credited Invoice Line IDRead Only:trueUnique identifier of the invoice line credited by this invoice line. -
DocumentNumber: string
Title:
Document NumberRead Only:trueMaximum Length:240Number that identifies a document on the bill plan of a grants contract. -
Exception: string
Title:
ExceptionRead Only:trueMaximum Length:1Indicates that exceptions have occurred for the invoice line. Valid values are E - Error, W - Warning, and N - No error. -
ExpenditureOrgId: integer
(int64)
Title:
Expenditure Organization IDRead Only:trueUnique identifier of the expenditure organization related to the line. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type IDRead Only:trueUnique identifier of the expenditure type for the invoice line. -
IntendedUse: string
Title:
Intended UseMaximum Length:240A classification of the products by tax authority for tax purposes. -
IntendedUseClassifId: integer
(int64)
Title:
Intended Use Classification IDUnique identifier of the intended use classification. -
InvoiceCurrencyCode: string
Title:
Invoice CurrencyRead Only:trueMaximum Length:30Indicates the currency code for the invoice that is transferred to Oracle Receivables. -
InvoiceCurrencyLineAmount: number
Title:
Amount in Invoice CurrencyRead Only:trueDefault Value:0Amount of the invoice line in the invoice currency. -
InvoiceFormatId: integer
(int64)
Title:
Invoice Format IDRead Only:trueUnique identifier of the invoice format. -
InvoiceFormatName: string
Title:
Invoice Format NameRead Only:trueMaximum Length:30Name of the invoice format. -
InvoiceLineDff: array
Invoice Line Descriptive Flexfields
Title:
Invoice Line Descriptive FlexfieldsA listing of all the descriptive flexfields available for invoice lines. -
InvoiceLineDistributions: array
Invoice Line Distributions
Title:
Invoice Line DistributionsThe Invoice Line Distributions resource is used to view the details of invoice line distributions. -
InvoiceLineId: integer
(int64)
Title:
Invoice Line IDUnique identifier of the invoice line. -
InvoiceLineNumber: integer
(int64)
Title:
Invoice Line NumberNumber that identifies an invoice line. -
InvoiceLineType: string
Title:
Invoice Line TypeRead Only:trueMaximum Length:30Default Value:STANDARDA classification of invoice credit that is assigned to an invoice line. Valid values are CONCESSION, WRITE_OFF, CANCEL, STANDARD, and CREDIT_MEMO. -
InvoiceLineTypeMeaning: string
Title:
Invoice Line Type MeaningRead Only:trueMaximum Length:80Meaning of the invoice line type. -
LedgerCurrencyCode: string
Title:
Ledger CurrencyRead Only:trueMaximum Length:30The currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency. -
LedgerCurrencyLineAmount: number
Title:
Invoice Amount in Ledger CurrencyRead Only:trueAmount of the invoice line in the ledger currency. -
LineDescription: string
Title:
Invoice Line DescriptionMaximum Length:240Description of the invoice line. -
LinkedProjectId: integer
(int64)
Title:
Associated Project IDRead Only:trueUnique identifier of the project associated to the related contract line or contract lines. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. -
LinkedProjectName: string
Title:
Associated Project NameRead Only:trueMaximum Length:240Name of project that is linked to the contract line associated to the invoice line. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. -
LinkedProjectNumber: string
Title:
Associated Project NumberRead Only:trueMaximum Length:25Number of project that is linked to the contract line associated to the invoice line. This value is populated if Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. -
LinkedTaskId: integer
(int64)
Title:
Associated Task IDRead Only:trueUnique identifier of the project task associated to the related contract line or contract lines. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Task Name or Number. -
LinkedTaskName: string
Title:
Associated Task NameRead Only:trueMaximum Length:255Name of the task that is linked to the contract line associated to the invoice line. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. -
LinkedTaskNumber: string
Title:
Associated Task NumberRead Only:trueMaximum Length:100Number of the task that is linked to the contract line associated to the invoice line. This value is populated if a task is associated to the contract line and Invoice Format grouping options are set to group distribution lines by Contract Line Project Name or Number. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocNumber: string
Title:
LOC NumberRead Only:trueMaximum Length:240Number that identifies a letter of credit on the bill plan of a grants contract. -
OutputTaxAmount: number
Title:
Tax Amount in Invoice CurrencyRead Only:trueThe total tax amount in the invoice currency. -
OutputTaxClassCode: string
Title:
Output Tax ClassificationMaximum Length:150A classification of output tax for the invoice line. -
OutputTaxExempt: string
Title:
Output tax exemptMaximum Length:1Indicates the use of Standard Exemption rules. Options include Standard, Exempt, or Required. The default is based on user tax setup. -
OutputTaxExmtCertNumber: string
Title:
Tax Exemption Certificate NumberMaximum Length:80Identifier of the exemption certificate for item lines that have the Output tax Exempt attribute set to E-exempt. -
OutputTaxExmtReasonCode: string
Title:
Tax Exemption ReasonMaximum Length:30Indicates the code for the reason for tax exemption on lines that have the Output tax Exempt attribute set to E-exempt. -
PaymentTermId: integer
(int64)
Title:
Payment Term IDRead Only:trueUnique identifier of the payment term for the receipt from Accounts Receivable (AR) which is applied against the agreement. -
PaymentTermName: string
Title:
Payment TermRead Only:trueMaximum Length:15Name of the payment term. -
ProductCategory: string
Title:
Product CategoryMaximum Length:240A classification of products used for tax purposes. -
ProductFcCategoryId: integer
(int64)
Title:
Product FC Category IDUnique identifier of the product fiscal classification category. -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. -
ProductType: string
Title:
Product TypeMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. -
ReceiverProjectId: integer
(int64)
Title:
Receiver Project IDRead Only:trueUnique identifier of the receiver project. -
ReceiverTaskId: integer
(int64)
Title:
Receiver Task IDRead Only:trueUnique identifier of the receiver task. -
ShipToAccountDescription: string
Title:
Ship-to Account DescriptionRead Only:trueAccount description of the ship-to customer on the invoice line. -
ShipToAccountNumber: string
Title:
Ship-to Account NumberAccount number of the ship-to customer on the invoice line. -
ShipToAddress: string
Title:
Ship-to AddressRead Only:trueAddress of the ship-to customer on the invoice line. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact IDRead Only:trueUnique identifier of the ship-to contact. A representative for the ship to customer of the project. -
ShipToCustomerId: integer
(int64)
Title:
Ship-to CustomerUnique identifier of the customer account ship-to address that is the project customer's default work site for the project. -
ShipToCustomerName: string
Title:
Ship-to CustomerRead Only:trueName of the ship-to customer on the invoice line. -
ShipToSiteId: integer
(int64)
Title:
Ship-to Site Use IDUnique identifier of the ship-to address used for taxation. This attribute is populated only if the invoice formats groups by work site and for events using the work site of the event task. -
ShipToSiteName: string
Title:
Ship-to SiteUnique identifier of the ship-to site on the invoice line. -
TransactionBusinessCategory: string
Title:
Transaction Business CategoryMaximum Length:240A classification or categorization of an invoice line for tax purposes as required by a tax authority. -
TranslatedText: string
Title:
Translated DescriptionMaximum Length:1000The translated text of the invoice line. This text is in the language defined in invoice header. -
UserDefinedFiscalClass: string
Title:
User-Defined Fiscal ClassificationMaximum Length:30Indicates the default taxation country. -
WorkTypeId: integer
(int64)
Title:
Work Type IDRead Only:trueUnique identifier of the work type. -
WorkTypeName: string
Title:
Work TypeRead Only:trueMaximum Length:240Name of the work type.
arrayInvoice Line Descriptive FlexfieldsarrayInvoice Line DistributionsarrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context for flex fields. -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
InvoiceLineId: integer
(int64)
Identifier of the invoice line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
BillingExtensionId: integer
(int64)
Title:
Billing Extension IDRead Only:trueUnique identifier of billing extension used for the transaction. -
BillingJobTitle: string
Title:
Billing Job TitleRead Only:trueMaximum Length:80Indicates the title for the billing job. -
BillingResourceId: integer
(int64)
Title:
Billing Resource IDRead Only:trueUnique identifier of resource breakdown structure element. -
BillJobId: integer
(int64)
Title:
Bill Job IDRead Only:trueUnique identifier of the effective job used when invoicing a labor item as of the last time the expenditure item was invoiced. -
BillPlanId: integer
(int64)
Title:
Bill Plan IDRead Only:trueUnique identifier of the bill plan for the invoice distribution. -
BillRate: number
Title:
Bill RateRead Only:trueBill rate used in deriving the transfer price if the transfer price was based on a rate defined in a bill rate schedule. -
BillSet: integer
(int64)
Title:
Bill SetRead Only:trueNumber of the bill set which is defined in bill plan related to the invoice distribution. -
BillTransactionTypeCode: string
Title:
Billing Transaction Type CodeRead Only:trueMaximum Length:30Indicates the code used to classify the type of bill transaction. Valid values are EI - Expenditure Item or EVT - Billing Event and defined in the lookup PJB_BILL_TRANSACTION_TYPE. -
ContractCurrencyBilledAmount: number
Title:
Invoice Amount in Contract CurrencyRead Only:trueAmount billed in currency of the contract. -
ContractCurrencyCode: string
Title:
Contract CurrencyRead Only:trueMaximum Length:30Indicates the code of the currency for the contract related to the distribution. -
ContractCurrencyInvDateType: string
Title:
Contract Currency Invoice Date TypeRead Only:trueMaximum Length:30Indicates the currency conversion date type used to convert the contract to the invoice currency. -
ContractCurrencyInvExchgDate: string
(date)
Title:
Contract Currency Invoice Conversion DateRead Only:trueIndicates the date used for the conversion of the rates on the contract for the invoice. -
ContractCurrencyInvExchgRate: number
Title:
Contract Currency Invoice Conversion RateRead Only:trueIndicates the rate used to convert the invoice amounts from the transaction currency to the contract currency. -
ContractCurrencyInvRateType: string
Title:
Contract Currency Rate Type CodeRead Only:trueMaximum Length:30Indicates the code for the contract currency rate type. -
ContractLineId: integer
(int64)
Title:
Contract Line IDRead Only:trueUnique Identifier of the contract line for the invoice distribution. -
ContractLineNumber: string
Title:
Contract Line NumberRead Only:trueMaximum Length:150Number of the contract line for the invoice distribution. -
CreditedDistributionId: integer
(int64)
Title:
Origin of AdjustmentRead Only:trueUnique identifier of distribution credited by this distribution. -
CreditedInvoiceId: integer
(int64)
Title:
Credited Invoice IDRead Only:trueUnique identifier of invoice that is credited by this distribution. -
CreditedInvoiceLineId: integer
(int64)
Title:
Credited Invoice Line IDRead Only:trueUnique identifier of invoice line that is credited by this distribution. -
DocumentNumber: string
Title:
Document NumberRead Only:trueMaximum Length:240Number that identifies a document on the bill plan of a grants contract. -
EmployeeBillingTitle: string
Title:
Employee Billing TitleRead Only:trueMaximum Length:80Employee billing title. -
ICTpAmountTypeCode: string
Title:
Intercompany Transfer Price Amount TypeRead Only:trueMaximum Length:30Amount type code used for an inter company price amount. -
ICTpBaseCode: string
Title:
Intercompany Transfer Price BaseRead Only:trueMaximum Length:30Indicates the intercompany transfer price base code of an intercompany transfer invoice. -
IntendedUse: string
Title:
Intended UseRead Only:trueMaximum Length:240A classification of the products by tax authority for tax purposes. -
IntendedUseClassifId: integer
(int64)
Title:
Intended Use Classification IDRead Only:trueUnique identifier of the intended use classification. -
InvBurdenCompileSetId: integer
(int64)
Title:
Invoice Burden Compile SetRead Only:trueUnique identifier of the compiled set used to calculate a burden schedule. This only applies to invoice distributions based on billing event detail. -
InvDiscountReasonCode: string
Title:
Rate Change ReasonRead Only:trueMaximum Length:30Reason code for discount override or rate override. -
InvDistributionTypeCode: string
Title:
Invoice Distribution TypeRead Only:trueMaximum Length:30Indicates the code of the type used to classify invoice distribution. Valid values are WRITE_OFF, CONCESSION, CANCEL, STANDARD, and CREDIT_MEMO. -
InvLineDistNumber: integer
(int64)
Title:
Invoice Distribution NumberRead Only:trueNumber that identifies the invoice distribution. -
InvoiceAmountCalculationCode: string
Title:
Invoice Amount Calculation CodeRead Only:trueMaximum Length:30Indicates the code for the invoice amount calculation. Valid values are I - Indirect, O - Overrides, E - Extension, B - Bill rates, L - Labor Multiplier. -
InvoiceCurrencyBilledAmount: number
Title:
Invoice Amount in Invoice CurrencyRead Only:trueAmount billed in the Invoice currency amount. -
InvoiceCurrencyCode: string
Title:
Invoice CurrencyRead Only:trueMaximum Length:30Indicates the currency code for the invoice that is transferred to Oracle Receivables. -
InvoiceCurrencyCreditAmount: number
Title:
Invoice Currency Credit AmountRead Only:trueCredit amount in the invoice currency. -
InvoiceCurrencyCreditPct: number
Title:
Credit Percentage in Invoice CurrencyRead Only:trueIndicates the percent of credit in the invoice currency. -
InvoiceCurrencyDateType: string
Title:
Invoice Currency Conversion Date TypeRead Only:trueMaximum Length:30Date type of the invoice currency. -
InvoiceCurrencyExchgDate: string
(date)
Title:
Invoice Currency Conversion DateRead Only:trueIndicates the exchange date for the conversion of the invoice currency. -
InvoiceCurrencyExchgRate: number
Title:
Invoice Currency Conversion RateRead Only:trueExchange rate used for the invoice currency. -
InvoiceCurrencyRateType: string
Title:
Invoice Currency Conversion Rate TypeRead Only:trueMaximum Length:30Rate type of the invoice currency. -
InvoiceDate: string
(date)
Title:
DateRead Only:trueThe invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release. -
InvoiceDiscountPercentage: number
Title:
Discount PercentageRead Only:trueIndicates a discount percentage, expressed as a proportion multiplied by 100, that is used to calculate the adjusted invoice and rate. The percentage used is based on the markup defined in the bill rate schedule. -
InvoiceDistId: integer
(int64)
Title:
Invoice Distribution IDUnique identifier of the invoice distribution. -
InvoiceLaborMultiplier: number
Title:
Labor MultiplierRead Only:trueA multiplier that is assigned to the contract line, and is used to calculate the invoice amount for labor items by applying the multipler to the raw cost of the labor items. -
InvoiceMarkupPercentage: number
Title:
Markup PercentageRead Only:trueIndicates the markup percentage used to calculate the adjusted invoice and rate. The percentage used is based on the markup defined in the bill rate schedule. -
LedgerCurrencyBilledAmount: number
Title:
Invoice Amount in Ledger CurrencyRead Only:trueAmount billed in the currency of the ledger. -
LedgerCurrencyCode: string
Title:
Ledger CurrencyRead Only:trueMaximum Length:30Ledger currency code. -
LedgerCurrencyInvDateType: string
Title:
Ledger Currency Invoice Date TypeRead Only:trueMaximum Length:30Date type of the ledger currency. -
LedgerCurrencyInvExchgDate: string
(date)
Title:
Ledger Currency Conversion DateRead Only:trueIndicates the conversion date used to convert the invoice to the ledger currency. -
LedgerCurrencyInvExchgRate: number
Title:
Ledger Currency Conversion RateRead Only:trueIndicates the conversion currency rate used to convert the invoice to the ledger currency. -
LedgerCurrencyInvRateType: string
Title:
Ledger Currency Invoice Rate TypeRead Only:trueMaximum Length:30Indicates the conversion currency rate type used to convert the invoice to the ledger currency. -
LinkedProjectId: integer
(int64)
Title:
Associated Project IDRead Only:trueUnique identifier of project that is linked to the contract line associated to the invoice distribution. -
LinkedProjectName: string
Title:
Associated Project NameRead Only:trueMaximum Length:240Name of the project that is linked to the contract line associated to the invoice distribution. -
LinkedProjectNumber: string
Title:
Associated Project NumberRead Only:trueMaximum Length:25Number of the project that is linked to the contract line associated to the invoice distribution. -
LinkedTaskId: integer
(int64)
Title:
Associated Task IDRead Only:trueUnique identifier of the task that is linked to the contract line associated to the invoice distribution. -
LinkedTaskName: string
Title:
Associated Task NameRead Only:trueMaximum Length:255Name of the task that is linked to the contract line associated to the invoice distribution. -
LinkedTaskNumber: string
Title:
Associated Task NumberRead Only:trueMaximum Length:100Number of the project task that is linked to the contract line associated to the invoice distribution. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocNumber: string
Title:
LOC NumberRead Only:trueMaximum Length:240Number that identifies a letter of credit on the bill plan of a grants contract. -
ProductCategory: string
Title:
Product CategoryRead Only:trueMaximum Length:240A classification of products used for tax purposes. -
ProductFcCategoryId: integer
(int64)
Title:
Product FC Category IDRead Only:trueUnique identifier of the product fiscal classification category. -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationRead Only:trueMaximum Length:240A classification of the products based on the inventory item category by the tax authority for tax purposes. -
ProductType: string
Title:
Product TypeRead Only:trueMaximum Length:240This value is another product related tax classification. The value of product type specifies whether the transaction line is for a good, or a service, or it is a memo line. -
ProjectCurrencyBilledAmount: number
Title:
Invoice Amount in Project CurrencyRead Only:trueAmount billed in the currency of the project. -
ProjectCurrencyCode: string
Title:
Project CurrencyRead Only:trueMaximum Length:30Indicates the currency code of the project. -
ProjectCurrencyInvDateType: string
Title:
Project Currency Invoice Date TypeRead Only:trueMaximum Length:30Date type used for conversion to the project currency. -
ProjectCurrencyInvExchgDate: string
(date)
Title:
Project Currency Conversion DateRead Only:trueIndicates the currency conversion date used to convert the invoice distribution to the project currency. -
ProjectCurrencyInvExchgRate: number
Title:
Project Currency Conversion RateRead Only:trueIndicates the currency conversion rate used to convert the invoice currency to the project currency. -
ProjectCurrencyInvRateType: string
Title:
Project Currency Invoice Rate TypeRead Only:trueMaximum Length:30Indicates the currency conversion rate type used to convert the invoice to the project currency. -
ProviderLegalEntityId: integer
(int64)
Title:
Provider Legal Entity IDRead Only:trueUnique identifier of the provider legal entity. -
Quantity: integer
Title:
QuantityRead Only:trueIndicates the quantity of the source expenditure item for invoice transactions created from expenditure items. -
ReceiverLegalEntityId: integer
(int64)
Title:
Receiver Legal Entity IDRead Only:trueUnique identifier of the receiver legal entity. -
TpInvRulePercentage: number
Title:
Transfer Price Invoice Rule PercentageRead Only:trueIndicates the applied percentage value from the transfer price rule used to create an intercompany invoice. -
TpInvSchLinePercentage: number
Title:
Transfer Price Invoice Schedule Line PercentageRead Only:trueThe applied percentage value from the transfer price schedule line used to create an intercompany invoice. -
TransactionBusinessCategory: string
Title:
Transaction Business CategoryRead Only:trueMaximum Length:240A classification or categorization of a transaction for tax purposes as required by a tax authority. -
TransactionCurrencyBilledAmount: number
Title:
Billed Amount in Transaction CurrencyRead Only:trueBilled amount in the transaction currency. -
TransactionCurrencyCode: string
Title:
Transaction CurrencyRead Only:trueMaximum Length:30Transaction currency for the expenditure or events. -
TransactionDate: string
(date)
Title:
Transaction DateRead Only:trueDate when transaction occurs. -
TransactionId: integer
(int64)
Title:
Transaction IDRead Only:trueUnique identifier of the expenditure item or event related to the invoice distribution. -
TransactionProjectId: integer
(int64)
Title:
Transaction Project IDRead Only:trueUnique identifier of the project related to the invoice distribution transaction. -
TransactionProjectName: string
Title:
Transaction Project NameRead Only:trueMaximum Length:240Name of the project related to the invoice distribution transaction. -
TransactionProjectNumber: string
Title:
Transaction Project NumberRead Only:trueMaximum Length:25Number of the project related to the invoice distribution transaction. -
TransactionTaskId: integer
(int64)
Title:
Transaction Task IDRead Only:trueUnique identifier of the project task related to the invoice distribution transaction. -
TransactionTaskName: string
Title:
Transaction Task NameRead Only:trueMaximum Length:255Name of the project task related to the invoice distribution transaction. -
TransactionTaskNumber: string
Title:
Transaction Task NumberRead Only:trueMaximum Length:100Number of the project task related to the invoice distribution transaction. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type IDRead Only:trueUnique identifier of the Event Type or Expenditure Item Type related to the invoice distribution. -
UserDefinedFiscalClass: string
Title:
User-Defined Fiscal ClassificationRead Only:trueMaximum Length:240Indicates the default taxation country.
arrayLinks- Attachments
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
The attachments resource is used to view, create, update and delete attachments for project contract invoices. - InvoiceId:
- InvoiceHeaderDff
-
Operation: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceHeaderDffParameters:
- InvoiceId:
$request.path.InvoiceId
A listing of all the descriptive flexfields available for project contract invoices. - InvoiceId:
- InvoiceLines
-
Operation: /fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/child/InvoiceLinesParameters:
- InvoiceId:
$request.path.InvoiceId
The Invoice Lines resource is used to view the details of the invoice lines. - InvoiceId:
- approveProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to approve a submitted invoice. - InvoiceId:
- cancelProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to cancel single or multiple standard invoices in released, transferred, or accepted statuses to create credit invoices in draft, submitted, approved, or released statuses. - InvoiceId:
- rejectProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to reject a submitted invoice. - InvoiceId:
- releaseProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to release invoices that have been approved and are ready to be released. - InvoiceId:
- returnToDraftProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to return an approved or approval rejected invoice to draft status. - InvoiceId:
- submitProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to submit invoices for approval. - InvoiceId:
- unreleaseProjectContractInvoice
-
Parameters:
- InvoiceId:
$request.path.InvoiceId
Use this action to unrelease invoices that are either in released status or transfer rejected status. To unrelease an invoice that isn???t the last in sequence, you must first unrelease and delete all subsequent invoices. Invoices that are in transferred or accepted statuses cannot be unreleased. - InvoiceId:
Examples
Example 1
The following example shows how to update an invoice header for a project contract invoice by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500
Request Body Example
The following shows an example of the request body in JSON format.
{
"InvoiceDate": "2022-10-10"
}
Response Body Example
The following shows an example of the response body in JSON format.
{
"BillFromDate": "1952-01-01",
"BillSet": 1,
"BillToContactId": 1086,
"BillToCustomerId": 1004,
"BillToDate": "2022-12-06",
"BillToSiteId": 1017,
"BillingTypeCode": "EX",
"Canceled": null,
"ContractId": 100000015326381,
"CreditMemoReasonCode": null,
"CreditedInvoiceId": null,
"DocumentNumber": null,
"DocumentSubType": null,
"Exception": "N",
"ExportProcessId": null,
"AccountingDate": null,
"AccountingPeriodName": null,
"ApTransferStatusCode": null,
"InvoiceComment": null,
"InvoiceCurrencyCode": "USD",
"InvoiceDate": "2022-10-10",
"InvoiceId": 100101301565500,
"InvoiceInstructions": null,
"InvoiceNumber": 1,
"InvoiceStatusCode": "DRAFT",
"InvoiceTypeCode": "STANDARD",
"LocNumber": null,
"MajorVersion": 2,
"OrganizationId": 204,
"PaDate": null,
"PaPeriodName": null,
"ReceivablesNumber": null,
"ReceiverSetupCode": null,
"ReleasedByPersonId": null,
"ReleasedDate": null,
"ReportTypeCode": null,
"SystemReference": null,
"TaxationCountry": "US",
"TransferredDate": null,
"ContractNumber": "zBI_revcon27",
"ContractTypeName": "Sell : Project lines",
"ContractTypeId": 104,
"BillToCustomerName": "Big Computers",
"CreditedInvoiceNumber": null,
"InvoiceAmount": 2500,
"TaxAmount": 0,
"Migrated": "N",
"NetCredit": null,
"OrganizationName": "Vision Corporation",
"InvoiceStatusMeaning": "Draft",
"InvoiceTypeMeaning": "Standard invoice",
"ApprovedbyPersonId": null,
"RejectedbyPersonId": null,
"ApprovedDate": null,
"RejectedDate": null,
"ApprovedbyPerson": null,
"RejectedbyPerson": null,
"ReleasedbyPerson": null,
"BillToContactName": "Devon Smith",
"CreditMemoReasonMeaning": null,
"BillToSite": "Tulsa (OPS)",
"UnreleaseComments": null,
"LastUnreleasedByPersonId": null,
"LastUnreleasedDate": null,
"LastUnreleasedByPerson": null,
"SubmittedByPersonId": null,
"SubmittedDate": null,
"AcceptedDate": null,
"NetInvoice": "N",
"ProjectId": null,
"SubmittedByPerson": null,
"ProjectName": null,
"ProjectNumber": null,
"BillToAccountNumber": "1004",
"BillToAddress": "East Street South, OK, US",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500",
"name": "projectContractInvoices",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000D78"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500",
"name": "projectContractInvoices",
"kind": "item"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/lov/TaxationCountryLOVVA",
"name": "TaxationCountryLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/lov/DocumentSubtypeLOVVA",
"name": "DocumentSubtypeLOVVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceHeaderDff",
"name": "InvoiceHeaderDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines",
"name": "InvoiceLines",
"kind": "collection"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/submitProjectContractInvoice",
"name": "submitProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/approveProjectContractInvoice",
"name": "approveProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/rejectProjectContractInvoice",
"name": "rejectProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/returnToDraftProjectContractInvoice",
"name": "returnToDraftProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/releaseProjectContractInvoice",
"name": "releaseProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/unreleaseProjectContractInvoice",
"name": "unreleaseProjectContractInvoice",
"kind": "other"
}
]
}
Example 2
The following example shows how to update an invoice header for a project contract invoice by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500
Request Body Example
The following shows an example of the request body in JSON format.
{
"InvoiceComment": "TestComment"
}
Response Body Example
The following shows an example of the response body in JSON format.
{
"BillFromDate": "1952-01-01",
"BillSet": 1,
"BillToContactId": 1086,
"BillToCustomerId": 1004,
"BillToDate": "2022-12-06",
"BillToSiteId": 1017,
"BillingTypeCode": "EX",
"Canceled": null,
"ContractId": 100000015326381,
"CreditMemoReasonCode": null,
"CreditedInvoiceId": null,
"DocumentNumber": null,
"DocumentSubType": null,
"Exception": "N",
"ExportProcessId": null,
"AccountingDate": null,
"AccountingPeriodName": null,
"ApTransferStatusCode": null,
"InvoiceComment": "TestComment",
"InvoiceCurrencyCode": "USD",
"InvoiceDate": "2022-10-10",
"InvoiceId": 100101301565500,
"InvoiceInstructions": null,
"InvoiceNumber": 1,
"InvoiceStatusCode": "DRAFT",
"InvoiceTypeCode": "STANDARD",
"LocNumber": null,
"MajorVersion": 2,
"OrganizationId": 204,
"PaDate": null,
"PaPeriodName": null,
"ReceivablesNumber": null,
"ReceiverSetupCode": null,
"ReleasedByPersonId": null,
"ReleasedDate": null,
"ReportTypeCode": null,
"SystemReference": null,
"TaxationCountry": "US",
"TransferredDate": null,
"ContractNumber": "zBI_revcon27",
"ContractTypeName": "Sell : Project lines",
"ContractTypeId": 104,
"BillToCustomerName": "Big Computers",
"CreditedInvoiceNumber": null,
"InvoiceAmount": 2500,
"TaxAmount": 0,
"Migrated": "N",
"NetCredit": null,
"OrganizationName": "Vision Corporation",
"InvoiceStatusMeaning": "Draft",
"InvoiceTypeMeaning": "Standard invoice",
"ApprovedbyPersonId": null,
"RejectedbyPersonId": null,
"ApprovedDate": null,
"RejectedDate": null,
"ApprovedbyPerson": null,
"RejectedbyPerson": null,
"ReleasedbyPerson": null,
"BillToContactName": "Devon Smith",
"CreditMemoReasonMeaning": null,
"BillToSite": "Tulsa (OPS)",
"UnreleaseComments": null,
"LastUnreleasedByPersonId": null,
"LastUnreleasedDate": null,
"LastUnreleasedByPerson": null,
"SubmittedByPersonId": null,
"SubmittedDate": null,
"AcceptedDate": null,
"NetInvoice": "N",
"ProjectId": null,
"SubmittedByPerson": null,
"ProjectName": null,
"ProjectNumber": null,
"BillToAccountNumber": "1004",
"BillToAddress": "East Street South, OK, US",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500",
"name": "projectContractInvoices",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E78"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500",
"name": "projectContractInvoices",
"kind": "item"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/lov/TaxationCountryLOVVA",
"name": "TaxationCountryLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/lov/DocumentSubtypeLOVVA",
"name": "DocumentSubtypeLOVVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceHeaderDff",
"name": "InvoiceHeaderDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/child/InvoiceLines",
"name": "InvoiceLines",
"kind": "collection"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/submitProjectContractInvoice",
"name": "submitProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/approveProjectContractInvoice",
"name": "approveProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/rejectProjectContractInvoice",
"name": "rejectProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/returnToDraftProjectContractInvoice",
"name": "returnToDraftProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/releaseProjectContractInvoice",
"name": "releaseProjectContractInvoice",
"kind": "other"
},
{
"rel": "action",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/100101301565500/action/unreleaseProjectContractInvoice",
"name": "unreleaseProjectContractInvoice",
"kind": "other"
}
]
}