Jump to

• Request
• Response
• Examples

Get all project commitments

get

/fscmRestApi/resources/11.13.18.05/projectCommitments

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds all project commitments with the specified commitment ID.
    Finder Variables:
    • CommitmentId; integer; Unique identifier of the commitment transaction.
  • findProjectCommitmentbyTypeStatusAndDateRange: Finds all project commitment transactions with the specified source, type, and status for a range of expenditure item dates.
    Finder Variables:
    • ApprovedFlag; boolean; Identifies if the commitment transaction is approved or not in the source application. A value of true means that the project commitment is in approved status and a value of false means that the project commitment is not in approved status.
    • CommitmentSourceType; string; Identifies the commitment transaction as either internal or external. A list of accepted values - Internal, External, or All - is defined in the lookup type PJC_COMMITMENT_TYPE.
    • CommitmentType; string; Identifies the commitment transaction as either purchase requisition, purchase order, supplier invoice, or external. A list of accepted values is defined in the lookup type PJC_CMT_LINE_TYPE.
    • ExpenditureItemDate; string; Date on which the commitment cost was incurred.
    • ProcessingStatus; string; Identifies the commitment transaction as either unprocessed, processed, or error. A list of accepted values - Processed, Unprocessed, or Error - is defined in the lookup type PJC_CMT_PROCESSING_STATUS.
    • ProjectName; string; Name of the project to which the commitment cost is charged.
    • SysEffectiveDate; object.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApprovedFlag; boolean; Identifies if the commitment transaction is approved or not in the source application. A value of true means that the project commitment is in approved status and a value of false means that the project commitment is not in approved status.
  • AwardBudgetPeriod; string; Interval of time (usually twelve months) into which the duration of an award project is divided for budgetary and funding purposes. The award budget period must lie within the project and award start and finish dates.
  • BillableFlag; boolean; Specifies whether the commitment transaction is billable. A value of true means that the project commitment transaction is billable and a value of false means that the project commitment transaction is not billable.
  • BurdenedCostInProjectCurrency; number; Total committed cost in the project currency for the project.
  • BurdenedCostInProviderLedgerCurrency; number; Total committed cost in the provider ledger currency for the project. You must provide a value for this attribute while creating a project commitment transaction for which the burdened cost is accounted externally.
  • BurdenedCostInReceiverLedgerCurrency; number; Total committed cost in the receiver ledger currency for the project.
  • BurdenedCostInTransactionCurrency; number; Total committed cost in the transaction currency for the project. You must provide a value for this attribute while creating an externally burdened project commitment transaction for a project that is enabled for burdening.
  • BusinessUnit; string; Name of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit ID while creating a project commitment.
  • BusinessUnitId; integer; Identifier of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit while creating a project commitment.
  • Buyer; string; Name of the buyer mentioned on the purchase order.
  • CanceledAmount; number; Amount on the purchase order that is cancelled.
  • CanceledQuantity; number; Quantity on the purchase order that is cancelled.
  • CapitalizableFlag; boolean; Specifies whether the commitment transaction is capitalizable. A value of true means that the project commitment transaction is capitalizable and a value of false means that the project commitment transaction is not capitalizable.
  • CommitmentCreationDate; string; Date on which the commitment transaction is created. Default value is the system date while creating a project commitment.
  • CommitmentId; integer; Unique identifier of the commitment transaction.
  • CommitmentNumber; string; Number of the commitment transaction. Examples include purchase requisition number, purchase order number, supplier invoice number, and external commitment transaction number.
  • CommitmentSourceType; string; Identifies the commitment transaction as either internal or external. A list of accepted values - Internal, External, or All - is defined in the lookup type PJC_COMMITMENT_TYPE. Default value is External while creating a project commitment.
  • CommitmentType; string; Identifies the commitment transaction as either purchase requisition, purchase order, supplier invoice, or external. A list of accepted values is defined in the lookup type PJC_CMT_LINE_TYPE. Default value is External while creating a project commitment.
  • ContractId; integer; Identifier of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract Name, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the identifier of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
  • ContractName; string; Name of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the name of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
  • ContractNumber; string; Number of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Name while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the number of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
  • Currency; string; Code identifying the currency in which the commitment transaction cost is incurred. You must enter a value for this attribute for project commitment transactions that are externally costed or accounted. The currency must be an active valid general ledger currency.
  • DeliveredAmount; number; Amount on the purchase order that is delivered.
  • DeliveredQuantity; number; Quantity on the purchase order that is delivered.
  • Document; string; Name of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document ID while creating a project commitment. The document must be active and enabled for commitment sources.
  • DocumentEntry; string; Name of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry ID while creating a project commitment.
  • DocumentEntryId; integer; Identifier of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry while creating a project commitment.
  • DocumentId; integer; Identifier of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document while creating a project commitment. The document must be active and enabled for commitment sources.
  • ExpenditureItemDate; string; Date on which the commitment cost was incurred. The expenditure item date must lie within the project start and finish dates.
  • ExpenditureType; string; A classification of cost that is assigned to each project commitment transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You must enter at least one from among this attribute and Expenditure Type ID while creating a project commitment. The expenditure type must be active as of the expenditure item date.
  • ExpenditureTypeId; integer; Identifier of the expenditure type. You must enter at least one from among this attribute and Expenditure Type while creating a project commitment. The expenditure type must be active as of the expenditure item date.
  • FundingSource; string; Funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source ID while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the name of the associated funding source.
  • FundingSourceId; string; Identifier of the funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the identifier of the associated funding source.
  • InventoryItemId; integer; Identifier of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item Number while creating a project inventory commitment.
  • InventoryItemNumber; string; Number of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item ID while creating a project inventory commitment.
  • InvoicedAmount; number; Amount on the purchase order that is invoiced.
  • InvoicedQuantity; number; Quantity on the purchase order that is invoiced.
  • NeedByDate; string; Date by which the materials must be delivered.
  • OrderedAmount; number; Amount ordered on the purchase order.
  • OrderedQuantity; number; Quantity ordered on the purchase order.
  • Organization; string; Name of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization ID while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.
  • OrganizationId; integer; Identifier of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.
  • OriginalTransactionReference; string; Original transaction reference of a third-party commitment transaction. If duplicate references aren't allowed by the document, then multiple project commitments can't refer to the same original transaction.
  • OriginallyOrderedAmount; number; Original amount on the purchase order.
  • OriginallyOrderedQuantity; number; Original quantity on the purchase order.
  • OutstandingDeliveryAmount; number; Amount for the purchase order quantity that is not yet delivered.
  • OutstandingDeliveryQuantity; number; Quantity on the purchase order that is not yet delivered.
  • OutstandingInvoiceAmount; number; Amount on the purchase order that is not yet invoiced by the supplier.
  • OutstandingInvoiceQuantity; number; Quantity on the purchase order that is not yet invoiced by the supplier.
  • OverbilledAmount; number; Amount that is overbilled by the supplier.
  • OverbilledQuantity; number; Quantity that is overbilled by the supplier.
  • ProcessingStatus; string; Identifies the commitment transaction as either unprocessed, processed, or error. A list of accepted values - Processed, Unprocessed, or Error - is defined in the lookup type PJC_CMT_PROCESSING_STATUS. Default value is Unprocessed while creating a project commitment.
  • ProjectId; integer; Identifier of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project Number, and Project Name while creating a project commitment. The project must be active and in an appropriate status.
  • ProjectName; string; Name of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Number while creating a project commitment. The project must be active and in an appropriate status.
  • ProjectNumber; string; Number of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Name while creating a project commitment. The project must be active and in an appropriate status.
  • PromisedDate; string; Date by which the supplier has committed to deliver the materials.
  • ProviderAccountingDate; string; Date used to determine the provider accounting period for a commitment transaction. You must provide a value for this attribute for an externally accounted project commitment transaction.
  • ProviderAccountingPeriod; string; Accounting period of the commitment transaction in the accounting calendar of the provider organization.
  • ProviderProjectAccountingDate; string; Date used to determine the provider project accounting period of the commitment transaction.
  • ProviderProjectAccountingPeriod; string; Project accounting period of the commitment transaction in the project accounting calendar of the provider organization.
  • Quantity; number; Quantity entered on the commitment transaction. You must enter a value for this attribute while creating a project commitment that is not externally costed and uses a rate-based expenditure type.
  • RawCostInProjectCurrency; number; Cost committed in the project currency for the project that is directly attributable to the work performed .
  • RawCostInProviderLedgerCurrency; number; Cost committed in the provider ledger currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally accounted project commitment transaction.
  • RawCostInReceiverLedgerCurrency; number; Cost committed in the receiver ledger currency for the project that is directly attributable to the work performed.
  • RawCostInTransactionCurrency; number; Cost committed in the transaction currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally costed project commitment transaction.
  • ReceiverAccountingDate; string; Date used to determine the receiver accounting period for a commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.
  • ReceiverAccountingPeriod; string; Accounting period of the commitment transaction in the accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.
  • ReceiverProjectAccountingDate; string; Date used to determine the receiver project accounting period of the commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.
  • ReceiverProjectAccountingPeriod; string; Project accounting period of the commitment transaction in the project accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.
  • Requester; string; Name of the person who created the purchase requisition.
  • Supplier; string; Name of the supplier who sent the invoice. You can enter either this attribute or Supplier ID or both while creating a project commitment. The supplier must be active as of the expenditure item date.
  • SupplierId; integer; Identifier of the supplier who sent the invoice. You can enter either this attribute or Supplier or both while creating a project commitment. The supplier must be active as of the expenditure item date.
  • TaskId; integer; Identifier of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task Number, and Task Name while creating a project commitment. The task must be active and included in a published task structure.
  • TaskName; string; Name of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Number while creating a project commitment. The task must be active and included in a published task structure.
  • TaskNumber; string; Number of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Name while creating a project commitment. The task must be active and included in a published task structure.
  • TransactionSource; string; Name of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source ID while creating a project commitment.
  • TransactionSourceId; integer; Identifier of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source while creating a project commitment.
  • UnitOfMeasure; string; Name of the unit of measure for the item that is requested, ordered, or supplied. You must enter at least one from among this attribute and Unit of Measure Code while creating a project commitment that is not externally costed.
  • UnitOfMeasureCode; string; Code identifying the unit of measure of the item that is requested, ordered, or supplied. You must enter at least one from among this attribute or Unit of Measure while creating a project commitment that is not externally costed.
  • UnitPrice; number; Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero.
  • WorkType; string; Name of the work type for the commitment transaction. You can enter either this attribute or Work Type ID or both while creating a project commitment. The work type must be active as of the expenditure item date.
  • WorkTypeId; integer; Identifier of the work type for the commitment transaction. You can enter either this attribute or Work Type or both while creating a project commitment. The work type must be active as of the expenditure item date.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : projectCommitments

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectCommitments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectCommitments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectCommitments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectCommitments-item-response

Type: object

Show Source

• ApprovedFlag: boolean
  Title: Approved

  Maximum Length: 1

  Identifies if the commitment transaction is approved or not in the source application. A value of true means that the project commitment is in approved status and a value of false means that the project commitment is not in approved status.
• AwardBudgetPeriod: string
  Title: Award Budget Period

  Maximum Length: 15

  Interval of time (usually twelve months) into which the duration of an award project is divided for budgetary and funding purposes. The award budget period must lie within the project and award start and finish dates.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Specifies whether the commitment transaction is billable. A value of true means that the project commitment transaction is billable and a value of false means that the project commitment transaction is not billable.
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency

  Total committed cost in the project currency for the project.
• BurdenedCostInProviderLedgerCurrency: number
  Title: Burdened Cost in Provider Ledger Currency

  Total committed cost in the provider ledger currency for the project. You must provide a value for this attribute while creating a project commitment transaction for which the burdened cost is accounted externally.
• BurdenedCostInReceiverLedgerCurrency: number
  Title: Burdened Cost in Receiver Ledger Currency

  Total committed cost in the receiver ledger currency for the project.
• BurdenedCostInTransactionCurrency: number
  Title: Burdened Cost in Transaction Currency

  Total committed cost in the transaction currency for the project. You must provide a value for this attribute while creating an externally burdened project commitment transaction for a project that is enabled for burdening.
• BusinessUnit: string
  Title: Business Unit

  Maximum Length: 240

  Name of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit ID while creating a project commitment.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Identifier of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit while creating a project commitment.
• Buyer: string
  Title: Buyer

  Maximum Length: 2000

  Name of the buyer mentioned on the purchase order.
• CanceledAmount: number
  Title: Canceled Amount

  Amount on the purchase order that is cancelled.
• CanceledQuantity: number
  Title: Canceled Quantity

  Quantity on the purchase order that is cancelled.
• CapitalizableFlag: boolean
  Title: Capitalizable

  Maximum Length: 1

  Specifies whether the commitment transaction is capitalizable. A value of true means that the project commitment transaction is capitalizable and a value of false means that the project commitment transaction is not capitalizable.
• CommitmentCreationDate: string (date)
  Title: Commitment Creation Date

  Date on which the commitment transaction is created. Default value is the system date while creating a project commitment.
• CommitmentId: integer (int64)
  Title: Commitment ID

  Unique identifier of the commitment transaction.
• CommitmentNumber: string
  Title: Commitment Number

  Maximum Length: 64

  Number of the commitment transaction. Examples include purchase requisition number, purchase order number, supplier invoice number, and external commitment transaction number.
• CommitmentSourceType: string
  Title: Commitment Source Type

  Maximum Length: 80

  Identifies the commitment transaction as either internal or external. A list of accepted values - Internal, External, or All - is defined in the lookup type PJC_COMMITMENT_TYPE. Default value is External while creating a project commitment.
• CommitmentType: string
  Title: Commitment Type

  Maximum Length: 80

  Identifies the commitment transaction as either purchase requisition, purchase order, supplier invoice, or external. A list of accepted values is defined in the lookup type PJC_CMT_LINE_TYPE. Default value is External while creating a project commitment.
• ContractId: integer (int64)
  Title: Contract ID

  Identifier of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract Name, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the identifier of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
• ContractName: string
  Title: Contract Name

  Maximum Length: 300

  Name of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the name of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
• ContractNumber: string
  Title: Contract Number

  Maximum Length: 120

  Number of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Name while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the number of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.
• Currency: string
  Title: Currency

  Maximum Length: 15

  Code identifying the currency in which the commitment transaction cost is incurred. You must enter a value for this attribute for project commitment transactions that are externally costed or accounted. The currency must be an active valid general ledger currency.
• DeliveredAmount: number
  Title: Delivered Amount

  Amount on the purchase order that is delivered.
• DeliveredQuantity: number
  Title: Delivered Quantity

  Quantity on the purchase order that is delivered.
• Document: string
  Title: Document

  Maximum Length: 240

  Name of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document ID while creating a project commitment. The document must be active and enabled for commitment sources.
• DocumentEntry: string
  Title: Document Entry

  Maximum Length: 240

  Name of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry ID while creating a project commitment.
• DocumentEntryId: integer (int64)
  Title: Document Entry ID

  Identifier of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry while creating a project commitment.
• DocumentId: integer (int64)
  Title: Document ID

  Identifier of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document while creating a project commitment. The document must be active and enabled for commitment sources.
• ExpenditureItemDate: string (date)
  Title: Expenditure Item Date

  Date on which the commitment cost was incurred. The expenditure item date must lie within the project start and finish dates.
• ExpenditureType: string
  Title: Expenditure Type

  Maximum Length: 240

  A classification of cost that is assigned to each project commitment transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You must enter at least one from among this attribute and Expenditure Type ID while creating a project commitment. The expenditure type must be active as of the expenditure item date.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Identifier of the expenditure type. You must enter at least one from among this attribute and Expenditure Type while creating a project commitment. The expenditure type must be active as of the expenditure item date.
• FundingSource: string
  Title: Funding Source

  Maximum Length: 360

  Funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source ID while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the name of the associated funding source.
• FundingSourceId: string
  Title: Funding Source ID

  Maximum Length: 150

  Identifier of the funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the identifier of the associated funding source.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  Identifier of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item Number while creating a project inventory commitment.
• InventoryItemNumber: string
  Title: Inventory Item Number

  Maximum Length: 300

  Number of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item ID while creating a project inventory commitment.
• InvoicedAmount: number
  Title: Invoiced Amount

  Amount on the purchase order that is invoiced.
• InvoicedQuantity: number
  Title: Invoiced Quantity

  Quantity on the purchase order that is invoiced.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NeedByDate: string (date)
  Title: Need-by Date

  Date by which the materials must be delivered.
• OrderedAmount: number
  Title: Ordered Amount

  Amount ordered on the purchase order.
• OrderedQuantity: number
  Title: Ordered Quantity

  Quantity ordered on the purchase order.
• Organization: string
  Title: Organization

  Maximum Length: 240

  Name of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization ID while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.
• OrganizationId: integer (int64)
  Title: Organization ID

  Identifier of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.
• OriginallyOrderedAmount: number
  Title: Originally Ordered Amount

  Original amount on the purchase order.
• OriginallyOrderedQuantity: number
  Title: Originally Ordered Quantity

  Original quantity on the purchase order.
• OriginalTransactionReference: string
  Title: Original Transaction Reference

  Maximum Length: 120

  Original transaction reference of a third-party commitment transaction. If duplicate references aren't allowed by the document, then multiple project commitments can't refer to the same original transaction.
• OutstandingDeliveryAmount: number
  Title: Outstanding Delivery Amount

  Amount for the purchase order quantity that is not yet delivered.
• OutstandingDeliveryQuantity: number
  Title: Outstanding Delivery Quantity

  Quantity on the purchase order that is not yet delivered.
• OutstandingInvoiceAmount: number
  Title: Outstanding Invoice Amount

  Amount on the purchase order that is not yet invoiced by the supplier.
• OutstandingInvoiceQuantity: number
  Title: Outstanding Invoice Quantity

  Quantity on the purchase order that is not yet invoiced by the supplier.
• OverbilledAmount: number
  Title: Overbilled Amount

  Amount that is overbilled by the supplier.
• OverbilledQuantity: number
  Title: Overbilled Quantity

  Quantity that is overbilled by the supplier.
• ProcessingStatus: string
  Title: Processing Status

  Maximum Length: 80

  Identifies the commitment transaction as either unprocessed, processed, or error. A list of accepted values - Processed, Unprocessed, or Error - is defined in the lookup type PJC_CMT_PROCESSING_STATUS. Default value is Unprocessed while creating a project commitment.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project Number, and Project Name while creating a project commitment. The project must be active and in an appropriate status.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Number while creating a project commitment. The project must be active and in an appropriate status.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Number of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Name while creating a project commitment. The project must be active and in an appropriate status.
• PromisedDate: string (date)
  Title: Promised Date

  Date by which the supplier has committed to deliver the materials.
• ProviderAccountingDate: string (date)
  Title: Provider Accounting Date

  Date used to determine the provider accounting period for a commitment transaction. You must provide a value for this attribute for an externally accounted project commitment transaction.
• ProviderAccountingPeriod: string
  Title: Provider Accounting Period

  Maximum Length: 15

  Accounting period of the commitment transaction in the accounting calendar of the provider organization.
• ProviderProjectAccountingDate: string (date)
  Title: Provider Project Accounting Date

  Date used to determine the provider project accounting period of the commitment transaction.
• ProviderProjectAccountingPeriod: string
  Title: Provider Project Accounting Period

  Maximum Length: 20

  Project accounting period of the commitment transaction in the project accounting calendar of the provider organization.
• Quantity: number
  Title: Quantity

  Quantity entered on the commitment transaction. You must enter a value for this attribute while creating a project commitment that is not externally costed and uses a rate-based expenditure type.
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency

  Cost committed in the project currency for the project that is directly attributable to the work performed .
• RawCostInProviderLedgerCurrency: number
  Title: Raw Cost in Provider Ledger Currency

  Cost committed in the provider ledger currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally accounted project commitment transaction.
• RawCostInReceiverLedgerCurrency: number
  Title: Raw Cost in Receiver Ledger Currency

  Cost committed in the receiver ledger currency for the project that is directly attributable to the work performed.
• RawCostInTransactionCurrency: number
  Title: Raw Cost in Transaction Currency

  Cost committed in the transaction currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally costed project commitment transaction.
• ReceiverAccountingDate: string (date)
  Title: Receiver Accounting Date

  Date used to determine the receiver accounting period for a commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.
• ReceiverAccountingPeriod: string
  Title: Receiver Accounting Period

  Maximum Length: 15

  Accounting period of the commitment transaction in the accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.
• ReceiverProjectAccountingDate: string (date)
  Title: Receiver Project Accounting Date

  Date used to determine the receiver project accounting period of the commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.
• ReceiverProjectAccountingPeriod: string
  Title: Receiver Project Accounting Period

  Maximum Length: 15

  Project accounting period of the commitment transaction in the project accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.
• Requester: string
  Title: Requester

  Maximum Length: 2000

  Name of the person who created the purchase requisition.
• Supplier: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier who sent the invoice. You can enter either this attribute or Supplier ID or both while creating a project commitment. The supplier must be active as of the expenditure item date.
• SupplierId: integer (int64)
  Title: Supplier ID

  Identifier of the supplier who sent the invoice. You can enter either this attribute or Supplier or both while creating a project commitment. The supplier must be active as of the expenditure item date.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task Number, and Task Name while creating a project commitment. The task must be active and included in a published task structure.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Number while creating a project commitment. The task must be active and included in a published task structure.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Name while creating a project commitment. The task must be active and included in a published task structure.
• TransactionSource: string
  Title: Transaction Source

  Maximum Length: 240

  Name of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source ID while creating a project commitment.
• TransactionSourceId: integer (int64)
  Title: Transaction Source ID

  Identifier of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source while creating a project commitment.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 80

  Name of the unit of measure for the item that is requested, ordered, or supplied. You must enter at least one from among this attribute and Unit of Measure Code while creating a project commitment that is not externally costed.
• UnitOfMeasureCode: string
  Title: Unit of Measure Code

  Maximum Length: 30

  Code identifying the unit of measure of the item that is requested, ordered, or supplied. You must enter at least one from among this attribute or Unit of Measure while creating a project commitment that is not externally costed.
• UnitPrice: number
  Title: Unit Price

  Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero.
• WorkType: string
  Title: Work Type

  Maximum Length: 240

  Name of the work type for the commitment transaction. You can enter either this attribute or Work Type ID or both while creating a project commitment. The work type must be active as of the expenditure item date.
• WorkTypeId: integer (int64)
  Title: Work Type ID

  Identifier of the work type for the commitment transaction. You can enter either this attribute or Work Type or both while creating a project commitment. The work type must be active as of the expenditure item date.

{
    "type":"object",
    "properties":{
        "DocumentEntryId":{
            "title":"Document Entry ID",
            "type":"integer",
            "description":"Identifier of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry while creating a project commitment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Contract Number",
            "maxLength":"120",
            "type":"string",
            "description":"Number of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Name while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the number of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProviderAccountingDate":{
            "title":"Provider Accounting Date",
            "type":"string",
            "description":"Date used to determine the provider accounting period for a commitment transaction. You must provide a value for this attribute for an externally accounted project commitment transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Identifier of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document while creating a project commitment. The document must be active and enabled for commitment sources.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Document":{
            "title":"Document",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the document used to capture the commitment transaction. You must enter at least one from among this attribute and Document ID while creating a project commitment. The document must be active and enabled for commitment sources.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OutstandingDeliveryAmount":{
            "title":"Outstanding Delivery Amount",
            "type":"number",
            "description":"Amount for the purchase order quantity that is not yet delivered.",
            "nullable":true,
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Date",
            "type":"string",
            "description":"Date by which the supplier has committed to deliver the materials.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostInProviderLedgerCurrency":{
            "title":"Burdened Cost in Provider Ledger Currency",
            "type":"number",
            "description":"Total committed cost in the provider ledger currency for the project. You must provide a value for this attribute while creating a project commitment transaction for which the burdened cost is accounted externally.",
            "nullable":true,
            "x-queryable":true
        },
        "Requester":{
            "title":"Requester",
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the person who created the purchase requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicedQuantity":{
            "title":"Invoiced Quantity",
            "type":"number",
            "description":"Quantity on the purchase order that is invoiced.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Code identifying the currency in which the commitment transaction cost is incurred. You must enter a value for this attribute for project commitment transactions that are externally costed or accounted. The currency must be an active valid general ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"Cost committed in the project currency for the project that is directly attributable to the work performed .",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverProjectAccountingDate":{
            "title":"Receiver Project Accounting Date",
            "type":"string",
            "description":"Date used to determine the receiver project accounting period of the commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OverbilledQuantity":{
            "title":"Overbilled Quantity",
            "type":"number",
            "description":"Quantity that is overbilled by the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessingStatus":{
            "title":"Processing Status",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the commitment transaction as either unprocessed, processed, or error. A list of accepted values - Processed, Unprocessed, or Error - is defined in the lookup type PJC_CMT_PROCESSING_STATUS. Default value is Unprocessed while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CommitmentSourceType":{
            "title":"Commitment Source Type",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the commitment transaction as either internal or external. A list of accepted values - Internal, External, or All - is defined in the lookup type PJC_COMMITMENT_TYPE. Default value is External while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the unit of measure for the item that is requested, ordered, or supplied. You must enter at least one from among this attribute and Unit of Measure Code while creating a project commitment that is not externally costed.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit while creating a project commitment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"Identifier of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item Number while creating a project inventory commitment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RawCostInReceiverLedgerCurrency":{
            "title":"Raw Cost in Receiver Ledger Currency",
            "type":"number",
            "description":"Cost committed in the receiver ledger currency for the project that is directly attributable to the work performed.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Identifier of the expenditure type. You must enter at least one from among this attribute and Expenditure Type while creating a project commitment. The expenditure type must be active as of the expenditure item date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommitmentId":{
            "title":"Commitment ID",
            "type":"integer",
            "description":"Unique identifier of the commitment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Identifier of the supplier who sent the invoice. You can enter either this attribute or Supplier or both while creating a project commitment. The supplier must be active as of the expenditure item date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"Total committed cost in the project currency for the project.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureType":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"A classification of cost that is assigned to each project commitment transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You must enter at least one from among this attribute and Expenditure Type ID while creating a project commitment. The expenditure type must be active as of the expenditure item date.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OriginallyOrderedQuantity":{
            "title":"Originally Ordered Quantity",
            "type":"number",
            "description":"Original quantity on the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Number while creating a project commitment. The task must be active and included in a published task structure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CanceledQuantity":{
            "title":"Canceled Quantity",
            "type":"number",
            "description":"Quantity on the purchase order that is cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure business unit that incurred the commitment cost. You must enter at least one from among this attribute and Business Unit ID while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CommitmentCreationDate":{
            "title":"Commitment Creation Date",
            "type":"string",
            "description":"Date on which the commitment transaction is created. Default value is the system date while creating a project commitment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FundingSource":{
            "title":"Funding Source",
            "maxLength":"360",
            "type":"string",
            "description":"Funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source ID while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the name of the associated funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OrderedAmount":{
            "title":"Ordered Amount",
            "type":"number",
            "description":"Amount ordered on the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicedAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"Amount on the purchase order that is invoiced.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardBudgetPeriod":{
            "title":"Award Budget Period",
            "maxLength":"15",
            "type":"string",
            "description":"Interval of time (usually twelve months) into which the duration of an award project is divided for budgetary and funding purposes. The award budget period must lie within the project and award start and finish dates.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OutstandingDeliveryQuantity":{
            "title":"Outstanding Delivery Quantity",
            "type":"number",
            "description":"Quantity on the purchase order that is not yet delivered.",
            "nullable":true,
            "x-queryable":true
        },
        "OutstandingInvoiceAmount":{
            "title":"Outstanding Invoice Amount",
            "type":"number",
            "description":"Amount on the purchase order that is not yet invoiced by the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying the unit of measure of the item that is requested, ordered, or supplied. You must enter at least one from among this attribute or Unit of Measure while creating a project commitment that is not externally costed.",
            "nullable":true,
            "x-queryable":true
        },
        "CommitmentNumber":{
            "title":"Commitment Number",
            "maxLength":"64",
            "type":"string",
            "description":"Number of the commitment transaction. Examples include purchase requisition number, purchase order number, supplier invoice number, and external commitment transaction number.",
            "nullable":false,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization ID while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task Number, and Task Name while creating a project commitment. The task must be active and included in a published task structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProviderAccountingPeriod":{
            "title":"Provider Accounting Period",
            "maxLength":"15",
            "type":"string",
            "description":"Accounting period of the commitment transaction in the accounting calendar of the provider organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Number while creating a project commitment. The project must be active and in an appropriate status.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CanceledAmount":{
            "title":"Canceled Amount",
            "type":"number",
            "description":"Amount on the purchase order that is cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverProjectAccountingPeriod":{
            "title":"Receiver Project Accounting Period",
            "maxLength":"15",
            "type":"string",
            "description":"Project accounting period of the commitment transaction in the project accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostInTransactionCurrency":{
            "title":"Burdened Cost in Transaction Currency",
            "type":"number",
            "description":"Total committed cost in the transaction currency for the project. You must provide a value for this attribute while creating an externally burdened project commitment transaction for a project that is enabled for burdening.",
            "nullable":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the buyer mentioned on the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Identifier of the expenditure organization to which the commitment cost is charged. You must enter at least one from among this attribute and Organization while creating a project commitment. The organization must be an active project expenditure organization as of the expenditure item date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginallyOrderedAmount":{
            "title":"Originally Ordered Amount",
            "type":"number",
            "description":"Original amount on the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkTypeId":{
            "title":"Work Type ID",
            "type":"integer",
            "description":"Identifier of the work type for the commitment transaction. You can enter either this attribute or Work Type or both while creating a project commitment. The work type must be active as of the expenditure item date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiverAccountingPeriod":{
            "title":"Receiver Accounting Period",
            "maxLength":"15",
            "type":"string",
            "description":"Accounting period of the commitment transaction in the accounting calendar of the receiver organization. The receiver is the organization that owns the project that incurred the commitment cost.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSourceId":{
            "title":"Transaction Source ID",
            "type":"integer",
            "description":"Identifier of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source while creating a project commitment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentEntry":{
            "title":"Document Entry",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the document entry used to capture the commitment transaction. You must enter at least one from among this attribute and Document Entry ID while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CapitalizableFlag":{
            "title":"Capitalizable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies whether the commitment transaction is capitalizable. A value of true means that the project commitment transaction is capitalizable and a value of false means that the project commitment transaction is not capitalizable.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInTransactionCurrency":{
            "title":"Raw Cost in Transaction Currency",
            "type":"number",
            "description":"Cost committed in the transaction currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally costed project commitment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who sent the invoice. You can enter either this attribute or Supplier ID or both while creating a project commitment. The supplier must be active as of the expenditure item date.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OverbilledAmount":{
            "title":"Overbilled Amount",
            "type":"number",
            "description":"Amount that is overbilled by the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalTransactionReference":{
            "title":"Original Transaction Reference",
            "maxLength":"120",
            "type":"string",
            "description":"Original transaction reference of a third-party commitment transaction. If duplicate references aren't allowed by the document, then multiple project commitments can't refer to the same original transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "BurdenedCostInReceiverLedgerCurrency":{
            "title":"Burdened Cost in Receiver Ledger Currency",
            "type":"number",
            "description":"Total committed cost in the receiver ledger currency for the project.",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProviderLedgerCurrency":{
            "title":"Raw Cost in Provider Ledger Currency",
            "type":"number",
            "description":"Cost committed in the provider ledger currency for the project that is directly attributable to the work performed. You must provide a value for this attribute while creating an externally accounted project commitment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "title":"Inventory Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"Number of the inventory item for the commitment cost. You must enter at least one from among this attribute, Inventory Item, and Inventory Item ID while creating a project inventory commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ApprovedFlag":{
            "title":"Approved",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies if the commitment transaction is approved or not in the source application. A value of true means that the project commitment is in approved status and a value of false means that the project commitment is not in approved status.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSource":{
            "title":"Transaction Source",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the application in which the commitment transaction was originally created. You must enter at least one from among this attribute and Transaction Source ID while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "WorkType":{
            "title":"Work Type",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the work type for the commitment transaction. You can enter either this attribute or Work Type ID or both while creating a project commitment. The work type must be active as of the expenditure item date.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project ID, and Project Name while creating a project commitment. The project must be active and in an appropriate status.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project to which the commitment cost is charged. You must enter at least one from among this attribute, Project Number, and Project Name while creating a project commitment. The project must be active and in an appropriate status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number of the task to which the commitment cost is charged. You must enter at least one from among this attribute, Task ID, and Task Name while creating a project commitment. The task must be active and included in a published task structure.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies whether the commitment transaction is billable. A value of true means that the project commitment transaction is billable and a value of false means that the project commitment transaction is not billable.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity entered on the commitment transaction. You must enter a value for this attribute while creating a project commitment that is not externally costed and uses a rate-based expenditure type.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderProjectAccountingPeriod":{
            "title":"Provider Project Accounting Period",
            "maxLength":"20",
            "type":"string",
            "description":"Project accounting period of the commitment transaction in the project accounting calendar of the provider organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractId":{
            "title":"Contract ID",
            "type":"integer",
            "description":"Identifier of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract Name, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the identifier of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenditureItemDate":{
            "title":"Expenditure Item Date",
            "type":"string",
            "description":"Date on which the commitment cost was incurred. The expenditure item date must lie within the project start and finish dates.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ContractName":{
            "title":"Contract Name",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the contract for the commitment transaction of a sponsored project. If the sponsored project is associated to multiple contracts then you must enter at least one from among this attribute, Contract ID, and Contract Number while creating a project commitment. If the sponsored project is associated to a single contract, then the default value is the name of the associated contract. The contract must be in one of the following statuses: Draft, Active, Under amendment, or Expired.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FundingSourceId":{
            "title":"Funding Source ID",
            "maxLength":"150",
            "type":"string",
            "description":"Identifier of the funding source of a project commitment that is processed for sponsored project costing. If the sponsored project is associated to multiple contracts or a single contract with multiple funding sources then you must enter at least one from among this attribute and Funding Source while creating a project commitment. If the sponsored project is associated to a single contract and a single funding source, then the default value is the identifier of the associated funding source.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveredQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "description":"Quantity on the purchase order that is delivered.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveredAmount":{
            "title":"Delivered Amount",
            "type":"number",
            "description":"Amount on the purchase order that is delivered.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero.",
            "nullable":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Date by which the materials must be delivered.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderedQuantity":{
            "title":"Ordered Quantity",
            "type":"number",
            "description":"Quantity ordered on the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "OutstandingInvoiceQuantity":{
            "title":"Outstanding Invoice Quantity",
            "type":"number",
            "description":"Quantity on the purchase order that is not yet invoiced by the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "CommitmentType":{
            "title":"Commitment Type",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the commitment transaction as either purchase requisition, purchase order, supplier invoice, or external. A list of accepted values is defined in the lookup type PJC_CMT_LINE_TYPE. Default value is External while creating a project commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProviderProjectAccountingDate":{
            "title":"Provider Project Accounting Date",
            "type":"string",
            "description":"Date used to determine the provider project accounting period of the commitment transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverAccountingDate":{
            "title":"Receiver Accounting Date",
            "type":"string",
            "description":"Date used to determine the receiver accounting period for a commitment transaction. The receiver is the organization that owns the project that incurred the commitment cost.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get all project commitments by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments

Example of Response Body

The following shows an example of the response body in JSON format.

{
"items": [
  {
"CommitmentId": 9390,
"CommitmentNumber": "10501004",
"BusinessUnitId": 204,
"BusinessUnit": "Vision Operations",
"OrganizationId": 458,
"Organization": "Vision Services",
"TransactionSourceId": 300100007235514,
"TransactionSource": "Oracle Fusion Purchasing",
"DocumentId": 300100007235521,
"Document": "Purchase Requisition",
"DocumentEntryId": 300100007235523,
"DocumentEntry": "Item Cost",
"ProjectId": 300100008820583,
"ProjectNumber": "OTBI VS Project",
"ProjectName": "OTBI VS Project",
"TaskId": 300100008871481,
"TaskNumber": "1.1",
"TaskName": "1.1",
"CommitmentSourceType": "Internal",
"CommitmentType": "Purchase requisition",
"ProcessingStatus": "Processed",
"ApprovedFlag": true,
"CommitmentCreationDate": null,
"OriginalTransactionReference": null,
"OriginallyOrderedQuantity": null,
"OriginallyOrderedAmount": null,
"OrderedAmount": null,
"DeliveredAmount": null,
"CanceledAmount": null,
"OverbilledAmount": null,
"InvoicedAmount": null,
"OutstandingInvoiceAmount": null,
"OutstandingDeliveryAmount": null,
"OrderedQuantity": null,
"DeliveredQuantity": null,
"CanceledQuantity": null,
"InvoicedQuantity": null,
"OverbilledQuantity": null,
"OutstandingInvoiceQuantity": null,
"OutstandingDeliveryQuantity": null,
"Quantity": 5,
"Currency": "USD",
"BurdenedCostInTransactionCurrency": 3300,
"RawCostInTransactionCurrency": 2500,
"RawCostInProjectCurrency": 2500,
"BurdenedCostInProjectCurrency": 3300,
"RawCostInReceiverLedgerCurrency": 2500,
"BurdenedCostInReceiverLedgerCurrency": 3300,
"RawCostInProviderLedgerCurrency": 2500,
"BurdenedCostInProviderLedgerCurrency": 3300,
"ExpenditureTypeId": 10012,
"ExpenditureType": "Supplies",
"ExpenditureItemDate": "2012-05-08",
"ProviderProjectAccountingDate": "2012-05-08",
"ProviderProjectAccountingPeriod": "19-12",
"ProviderAccountingDate": "2012-05-08",
"ProviderAccountingPeriod": "May-12",
"ReceiverAccountingPeriod": "May-12",
"ReceiverAccountingDate": "2012-05-08",
"ReceiverProjectAccountingDate": "2012-05-08",
"ReceiverProjectAccountingPeriod": "May-W1-12",
"NeedByDate": "2012-05-08",
"PromisedDate": null,
"CapitalizableFlag": true,
"BillableFlag": true,
"InventoryItemId": null,
"InventoryItemNumber": null,
"UnitOfMeasureCode": "Ea",
"UnitOfMeasure": "Each",
"UnitPrice": 500,
"SupplierId": 7,
"Supplier": "Capp Consulting",
"Requester": "Abraham Mason",
"Buyer": null,
"WorkTypeId": 10020,
"WorkType": "Commercial Customer-billable",
"ContractId": null,
"ContractName": null,
"ContractNumber": null,
"FundingSourceId": null,
"FundingSource": null,
"AwardBudgetPeriod": null

Back to Top