1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Commitments

Create a project commitment

post

/fscmRestApi/resources/11.13.18.05/projectCommitments

Request

Header Parameters
  • 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.
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Burdened Cost in Project Currency
    Total committed cost in the project currency for the project.
  • 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.
  • Title: Burdened Cost in Receiver Ledger Currency
    Total committed cost in the receiver ledger currency for the project.
  • 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.
  • 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.
  • 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.
  • Title: Buyer
    Maximum Length: 2000
    Name of the buyer mentioned on the purchase order.
  • Title: Canceled Amount
    Amount on the purchase order that is cancelled.
  • Title: Canceled Quantity
    Quantity on the purchase order that is cancelled.
  • 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.
  • Title: Commitment Creation Date
    Date on which the commitment transaction is created. Default value is the system date while creating a project commitment.
  • Title: Commitment ID
    Unique identifier of the commitment transaction.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Delivered Amount
    Amount on the purchase order that is delivered.
  • Title: Delivered Quantity
    Quantity on the purchase order that is delivered.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Invoiced Amount
    Amount on the purchase order that is invoiced.
  • Title: Invoiced Quantity
    Quantity on the purchase order that is invoiced.
  • Title: Need-by Date
    Date by which the materials must be delivered.
  • Title: Ordered Amount
    Amount ordered on the purchase order.
  • Title: Ordered Quantity
    Quantity ordered on the purchase order.
  • 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.
  • 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.
  • Title: Originally Ordered Amount
    Original amount on the purchase order.
  • Title: Originally Ordered Quantity
    Original quantity on the purchase order.
  • 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.
  • Title: Outstanding Delivery Amount
    Amount for the purchase order quantity that is not yet delivered.
  • Title: Outstanding Delivery Quantity
    Quantity on the purchase order that is not yet delivered.
  • Title: Outstanding Invoice Amount
    Amount on the purchase order that is not yet invoiced by the supplier.
  • Title: Outstanding Invoice Quantity
    Quantity on the purchase order that is not yet invoiced by the supplier.
  • Title: Overbilled Amount
    Amount that is overbilled by the supplier.
  • Title: Overbilled Quantity
    Quantity that is overbilled by the supplier.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Promised Date
    Date by which the supplier has committed to deliver the materials.
  • 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.
  • Title: Provider Accounting Period
    Maximum Length: 15
    Accounting period of the commitment transaction in the accounting calendar of the provider organization.
  • Title: Provider Project Accounting Date
    Date used to determine the provider project accounting period of the commitment transaction.
  • Title: Provider Project Accounting Period
    Maximum Length: 20
    Project accounting period of the commitment transaction in the project accounting calendar of the provider organization.
  • 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.
  • Title: Raw Cost in Project Currency
    Cost committed in the project currency for the project that is directly attributable to the work performed .
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Requester
    Maximum Length: 2000
    Name of the person who created the purchase requisition.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Unit Price
    Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Burdened Cost in Project Currency
    Total committed cost in the project currency for the project.
  • 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.
  • Title: Burdened Cost in Receiver Ledger Currency
    Total committed cost in the receiver ledger currency for the project.
  • 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.
  • 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.
  • 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.
  • Title: Buyer
    Maximum Length: 2000
    Name of the buyer mentioned on the purchase order.
  • Title: Canceled Amount
    Amount on the purchase order that is cancelled.
  • Title: Canceled Quantity
    Quantity on the purchase order that is cancelled.
  • 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.
  • Title: Commitment Creation Date
    Date on which the commitment transaction is created. Default value is the system date while creating a project commitment.
  • Title: Commitment ID
    Unique identifier of the commitment transaction.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Delivered Amount
    Amount on the purchase order that is delivered.
  • Title: Delivered Quantity
    Quantity on the purchase order that is delivered.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Invoiced Amount
    Amount on the purchase order that is invoiced.
  • Title: Invoiced Quantity
    Quantity on the purchase order that is invoiced.
  • Links
  • Title: Need-by Date
    Date by which the materials must be delivered.
  • Title: Ordered Amount
    Amount ordered on the purchase order.
  • Title: Ordered Quantity
    Quantity ordered on the purchase order.
  • 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.
  • 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.
  • Title: Originally Ordered Amount
    Original amount on the purchase order.
  • Title: Originally Ordered Quantity
    Original quantity on the purchase order.
  • 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.
  • Title: Outstanding Delivery Amount
    Amount for the purchase order quantity that is not yet delivered.
  • Title: Outstanding Delivery Quantity
    Quantity on the purchase order that is not yet delivered.
  • Title: Outstanding Invoice Amount
    Amount on the purchase order that is not yet invoiced by the supplier.
  • Title: Outstanding Invoice Quantity
    Quantity on the purchase order that is not yet invoiced by the supplier.
  • Title: Overbilled Amount
    Amount that is overbilled by the supplier.
  • Title: Overbilled Quantity
    Quantity that is overbilled by the supplier.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Promised Date
    Date by which the supplier has committed to deliver the materials.
  • 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.
  • Title: Provider Accounting Period
    Maximum Length: 15
    Accounting period of the commitment transaction in the accounting calendar of the provider organization.
  • Title: Provider Project Accounting Date
    Date used to determine the provider project accounting period of the commitment transaction.
  • Title: Provider Project Accounting Period
    Maximum Length: 20
    Project accounting period of the commitment transaction in the project accounting calendar of the provider organization.
  • 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.
  • Title: Raw Cost in Project Currency
    Cost committed in the project currency for the project that is directly attributable to the work performed .
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Requester
    Maximum Length: 2000
    Name of the person who created the purchase requisition.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Unit Price
    Price per unit of the item that is requested, ordered, or supplied. You cannot enter a value less than zero.
  • 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.
  • 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.
Back to Top

Examples

Example 1

The following example shows how to create a project commitment by submitting a POST request on the REST resource using cURL.

curl --user  ppm_cloud_user -X POST -d @example_request_payload.json --header  "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments

Request Body Example

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

{
             "CommitmentNumber": "1000097",
            "BusinessUnitId": 202,
            "BusinessUnit": "Vision College",
            "OrganizationId": 300100014554154,
            "Organization": "Vision College",
            "TransactionSource": "External commitment Source",
            "Document": "External Document",
            "DocumentEntry": "External Document Entry",
            "ProjectId": 300100179449141,
            "TaskId": 100100116334932,
            "CommitmentSourceType": "External",
            "CommitmentType": "External",
            "ProcessingStatus": "Processed",
            "ApprovedFlag": true,
            "CommitmentCreationDate": null,
            "OriginalTransactionReference": "${TIMESTAMP}test1",
            "OriginallyOrderedQuantity": 5,
            "DeliveredAmount": 0,
            "CanceledAmount": 0,
            "OverbilledAmount": 0,
            "InvoicedAmount": 0,
            "OrderedQuantity": 5,
            "DeliveredQuantity": 0,
            "CanceledQuantity": 0,
            "InvoicedQuantity": 0,
            "OverbilledQuantity": 0,
            "OutstandingInvoiceQuantity": 5,
            "OutstandingDeliveryQuantity": 5,
            "Quantity": 5,
            "Currency": "USD",
            "RawCostInTransactionCurrency": 2500,
            "RawCostInProjectCurrency": 2500,
            "RawCostInReceiverLedgerCurrency": 2500,
            "RawCostInProviderLedgerCurrency": 2500,
            "ExpenditureTypeId": 10012,
            "ExpenditureType": "Supplier Invoices",
            "ExpenditureItemDate": "2021-02-02",
            "ProviderProjectAccountingDate": "2021-02-02",
            "ProviderProjectAccountingPeriod": "JAN-10",
            "ProviderAccountingDate": "2021-02-02",
            "ProviderAccountingPeriod": "JAN-10",
            "ReceiverAccountingPeriod": "JAN-10",
            "ReceiverAccountingDate": "2021-02-02",
            "ReceiverProjectAccountingDate": "2021-02-02",
            "ReceiverProjectAccountingPeriod": "JAN-10",
            "NeedByDate": "2019-02-02",
            "PromisedDate": null,
            "CapitalizableFlag": false,
            "BillableFlag": true,
            "InventoryItemId": 100100102189776,
            "UnitPrice": 500,
            "SupplierId": 7,
            "Supplier": "Capp Consulting",
            "Requester": null,
            "Buyer": "Devon Smith",
            "WorkTypeId": 10020,
            "WorkType": "Commercial Customer-billable",
            "ContractId": 300100179449097,
            "FundingSourceId": "300100038787369",
            "AwardBudgetPeriod": null
 }

Response Body Example

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

{
    "CommitmentId": 300100570669500,
    "CommitmentNumber": "1000097",
    "BusinessUnitId": 300100014554154,
    "BusinessUnit": "Vision College",
    "OrganizationId": 300100014554154,
    "Organization": "Vision College",
    "TransactionSourceId": 300100039540586,
    "TransactionSource": "External commitment Source",
    "DocumentId": 300100039540587,
    "Document": "External Document",
    "DocumentEntryId": 300100039540588,
    "DocumentEntry": "External Document Entry",
    "ProjectId": 300100179449141,
    "ProjectNumber": "PJO_Award_PRJ_2",
    "ProjectName": "PJO_Award_PRJ_2",
    "TaskId": 100100116334932,
    "TaskNumber": "2.2",
    "TaskName": "Therapies for Cancer",
    "CommitmentSourceType": "External",
    "CommitmentType": "External",
    "ProcessingStatus": "Processed",
    "ApprovedFlag": true,
    "CommitmentCreationDate": null,
    "OriginalTransactionReference": "${TIMESTAMP}test1",
    "OriginallyOrderedQuantity": 5,
    "OriginallyOrderedAmount": null,
    "OrderedAmount": null,
    "DeliveredAmount": 0,
    "CanceledAmount": 0,
    "OverbilledAmount": 0,
    "InvoicedAmount": 0,
    "OutstandingInvoiceAmount": null,
    "OutstandingDeliveryAmount": null,
    "OrderedQuantity": 5,
    "DeliveredQuantity": 0,
    "CanceledQuantity": 0,
    "InvoicedQuantity": 0,
    "OverbilledQuantity": 0,
    "OutstandingInvoiceQuantity": 5,
    "OutstandingDeliveryQuantity": 5,
    "Quantity": 5,
    "Currency": "USD",
    "BurdenedCostInTransactionCurrency": null,
    "RawCostInTransactionCurrency": 2500,
    "RawCostInProjectCurrency": 2500,
    "BurdenedCostInProjectCurrency": null,
    "RawCostInReceiverLedgerCurrency": 2500,
    "BurdenedCostInReceiverLedgerCurrency": null,
    "RawCostInProviderLedgerCurrency": 2500,
    "BurdenedCostInProviderLedgerCurrency": null,
    "ExpenditureTypeId": 10012,
    "ExpenditureType": "Supplies",
    "ExpenditureItemDate": "2021-02-02",
    "ProviderProjectAccountingDate": "2021-02-02",
    "ProviderProjectAccountingPeriod": "JAN-10",
    "ProviderAccountingDate": "2021-02-02",
    "ProviderAccountingPeriod": "JAN-10",
    "ReceiverAccountingPeriod": "JAN-10",
    "ReceiverAccountingDate": "2021-02-02",
    "ReceiverProjectAccountingDate": "2021-02-02",
    "ReceiverProjectAccountingPeriod": "JAN-10",
    "NeedByDate": "2019-02-02",
    "PromisedDate": null,
    "CapitalizableFlag": false,
    "BillableFlag": true,
    "InventoryItemId": 100100102189776,
    "InventoryItemNumber": null,
    "UnitOfMeasureCode": null,
    "UnitOfMeasure": null,
    "UnitPrice": 500,
    "SupplierId": 7,
    "Supplier": null,
    "Requester": null,
    "Buyer": "Devon Smith",
    "WorkTypeId": 10020,
    "WorkType": "Commercial Customer-billable",
    "ContractId": 300100179449097,
    "ContractName": "PJO_Award_1",
    "ContractNumber": "PJO_Award_1",
    "FundingSourceId": "300100038787369",
    "FundingSource": "Dept of Health and Human Services (DHHS)",
    "AwardBudgetPeriod": null,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500",
            "name": "projectCommitments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500",
            "name": "projectCommitments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/WorkTypeSetIdVVO1",
            "name": "WorkTypeSetIdVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/InventoryItemCwaVVO1",
            "name": "InventoryItemCwaVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/ExpTypeLovVVO1",
            "name": "ExpTypeLovVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/FundingSourceNameIdVA",
            "name": "FundingSourceNameIdVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/ProjectDistinctExpOrgPVO1",
            "name": "ProjectDistinctExpOrgPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/TransactionDocEntryCwaVVO1",
            "name": "TransactionDocEntryCwaVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/ContractNameIdVA",
            "name": "ContractNameIdVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/PjcLookupPVO3",
            "name": "PjcLookupPVO3",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/PjcLookupPVO2",
            "name": "PjcLookupPVO2",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/TransactionSourceCwaVVO1",
            "name": "TransactionSourceCwaVVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/PjcLookupPVO1",
            "name": "PjcLookupPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/AwardBudgetPeriodPVO1",
            "name": "AwardBudgetPeriodPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/ProjectSearchPVO1",
            "name": "ProjectSearchPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/SupplierPVO1",
            "name": "SupplierPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/FinancialTaskCostingLOVPVO1",
            "name": "FinancialTaskCostingLOVPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/UnitOfMeasurePVO1",
            "name": "UnitOfMeasurePVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/BusinessUnitPVO1",
            "name": "BusinessUnitPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectCommitments/300100570669500/lov/TransactionDocCwaVVO1",
            "name": "TransactionDocCwaVVO1",
            "kind": "collection"
        }
    ]
}
Back to Top