Jump to

• Request
• Response
• Examples

Update an expenditure item

patch

/fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}

Request

Path Parameters

• ExpenditureItemId(required): integer(int64)
  The identifier of the expenditure item.

Header Parameters

• Metadata-Context: string
  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: string
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ExternalBillRate: number
  Title: External Bill Rate

  The unit rate at which an expenditure item is billed on external contracts.
• ExternalBillRateCurrency: string
  Title: External Bill Rate Currency

  Maximum Length: 15

  The currency in which an expenditure item is billed on external contracts.
• ExternalBillRateSourceName: string
  Title: External Bill Rate Source Name

  Maximum Length: 150

  The name of the external source from where the external bill rate originates.
• ExternalBillRateSourceReference: string
  Title: External Bill Rate Source Reference

  Maximum Length: 30

  The unique identifier of the external bill rate in the external source.
• IntercompanyBillRate: number
  Title: Intercompany Bill Rate

  The unit rate at which an expenditure item is billed on intercompany contracts.
• IntercompanyBillRateCurrency: string
  Title: Intercompany Bill Rate Currency

  Maximum Length: 15

  The currency in which an expenditure item is billed on intercompany contracts.
• IntercompanyBillRateSourceName: string
  Title: Intercompany Bill Rate Source Name

  Maximum Length: 150

  The name of the external source from where the intercompany bill rate originates.
• IntercompanyBillRateSourceReference: string
  Title: Intercompany Bill Rate Source Reference

  Maximum Length: 20

  The unique identifier of the intercompany bill rate in the external source.
• ProjectExpenditureItemsDFF: array Project Expenditure Items Descriptive Flexfields
  Title: Project Expenditure Items Descriptive Flexfields

  The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

{
    "type":"object",
    "properties":{
        "ExternalBillRate":{
            "title":"External Bill Rate",
            "type":"number",
            "description":"The unit rate at which an expenditure item is billed on external contracts.",
            "nullable":true
        },
        "ExternalBillRateCurrency":{
            "title":"External Bill Rate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency in which an expenditure item is billed on external contracts.",
            "nullable":true
        },
        "ExternalBillRateSourceName":{
            "title":"External Bill Rate Source Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the external source from where the external bill rate originates.",
            "nullable":true
        },
        "ExternalBillRateSourceReference":{
            "title":"External Bill Rate Source Reference",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the external bill rate in the external source.",
            "nullable":true
        },
        "IntercompanyBillRate":{
            "title":"Intercompany Bill Rate",
            "type":"number",
            "description":"The unit rate at which an expenditure item is billed on intercompany contracts.",
            "nullable":true
        },
        "IntercompanyBillRateCurrency":{
            "title":"Intercompany Bill Rate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency in which an expenditure item is billed on intercompany contracts.",
            "nullable":true
        },
        "IntercompanyBillRateSourceName":{
            "title":"Intercompany Bill Rate Source Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the external source from where the intercompany bill rate originates.",
            "nullable":true
        },
        "IntercompanyBillRateSourceReference":{
            "title":"Intercompany Bill Rate Source Reference",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the intercompany bill rate in the external source.",
            "nullable":true
        },
        "ProjectExpenditureItemsDFF":{
            "title":"Project Expenditure Items Descriptive Flexfields",
            "type":"array",
            "description":"The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.",
            "items":{
                "$ref":"#/components/schemas/projectExpenditureItems-ProjectExpenditureItemsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Project Expenditure Items Descriptive Flexfields

Type: array

Title: Project Expenditure Items Descriptive Flexfields

The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

Show Source

• Array of: object projectExpenditureItems-ProjectExpenditureItemsDFF-item-patch-request

{
    "title":"Project Expenditure Items Descriptive Flexfields",
    "type":"array",
    "description":"The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.",
    "items":{
        "$ref":"#/components/schemas/projectExpenditureItems-ProjectExpenditureItemsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : projectExpenditureItems-ProjectExpenditureItemsDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Code that identifies the context for the segments of the project expenditure items.
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Name of the context for the segments of the project expenditure items.

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the context for the segments of the project expenditure items.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Name of the context for the segments of the project expenditure items.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : projectExpenditureItems-item-response

Type: object

Show Source

• ExpenditureItemId: integer (int64)
  Title: Transaction Number

  The identifier of the expenditure item.
• ExternalBillRate: number
  Title: External Bill Rate

  The unit rate at which an expenditure item is billed on external contracts.
• ExternalBillRateCurrency: string
  Title: External Bill Rate Currency

  Maximum Length: 15

  The currency in which an expenditure item is billed on external contracts.
• ExternalBillRateSourceName: string
  Title: External Bill Rate Source Name

  Maximum Length: 150

  The name of the external source from where the external bill rate originates.
• ExternalBillRateSourceReference: string
  Title: External Bill Rate Source Reference

  Maximum Length: 30

  The unique identifier of the external bill rate in the external source.
• IntercompanyBillRate: number
  Title: Intercompany Bill Rate

  The unit rate at which an expenditure item is billed on intercompany contracts.
• IntercompanyBillRateCurrency: string
  Title: Intercompany Bill Rate Currency

  Maximum Length: 15

  The currency in which an expenditure item is billed on intercompany contracts.
• IntercompanyBillRateSourceName: string
  Title: Intercompany Bill Rate Source Name

  Maximum Length: 150

  The name of the external source from where the intercompany bill rate originates.
• IntercompanyBillRateSourceReference: string
  Title: Intercompany Bill Rate Source Reference

  Maximum Length: 20

  The unique identifier of the intercompany bill rate in the external source.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectExpenditureItemsDFF: array Project Expenditure Items Descriptive Flexfields
  Title: Project Expenditure Items Descriptive Flexfields

  The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

{
    "type":"object",
    "properties":{
        "ExpenditureItemId":{
            "title":"Transaction Number",
            "type":"integer",
            "description":"The identifier of the expenditure item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalBillRate":{
            "title":"External Bill Rate",
            "type":"number",
            "description":"The unit rate at which an expenditure item is billed on external contracts.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillRateCurrency":{
            "title":"External Bill Rate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency in which an expenditure item is billed on external contracts.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillRateSourceName":{
            "title":"External Bill Rate Source Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the external source from where the external bill rate originates.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillRateSourceReference":{
            "title":"External Bill Rate Source Reference",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the external bill rate in the external source.",
            "nullable":true,
            "x-queryable":true
        },
        "IntercompanyBillRate":{
            "title":"Intercompany Bill Rate",
            "type":"number",
            "description":"The unit rate at which an expenditure item is billed on intercompany contracts.",
            "nullable":true,
            "x-queryable":true
        },
        "IntercompanyBillRateCurrency":{
            "title":"Intercompany Bill Rate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency in which an expenditure item is billed on intercompany contracts.",
            "nullable":true,
            "x-queryable":true
        },
        "IntercompanyBillRateSourceName":{
            "title":"Intercompany Bill Rate Source Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the external source from where the intercompany bill rate originates.",
            "nullable":true,
            "x-queryable":true
        },
        "IntercompanyBillRateSourceReference":{
            "title":"Intercompany Bill Rate Source Reference",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the intercompany bill rate in the external source.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectExpenditureItemsDFF":{
            "title":"Project Expenditure Items Descriptive Flexfields",
            "type":"array",
            "description":"The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.",
            "items":{
                "$ref":"#/components/schemas/projectExpenditureItems-ProjectExpenditureItemsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Project Expenditure Items Descriptive Flexfields

Type: array

Title: Project Expenditure Items Descriptive Flexfields

The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

Show Source

• Array of: object projectExpenditureItems-ProjectExpenditureItemsDFF-item-response

{
    "title":"Project Expenditure Items Descriptive Flexfields",
    "type":"array",
    "description":"The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.",
    "items":{
        "$ref":"#/components/schemas/projectExpenditureItems-ProjectExpenditureItemsDFF-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : projectExpenditureItems-ProjectExpenditureItemsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Code that identifies the context for the segments of the project expenditure items.
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Name of the context for the segments of the project expenditure items.
• ExpenditureItemId: integer (int64)
  Title: Transaction Number

  The identifier of the expenditure item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ExpenditureItemId":{
            "title":"Transaction Number",
            "type":"integer",
            "description":"The identifier of the expenditure item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the context for the segments of the project expenditure items.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Name of the context for the segments of the project expenditure items.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

ProjectExpenditureItemsDFF

Operation: /fscmRestApi/resources/11.13.18.05/projectExpenditureItems/{ExpenditureItemId}/child/ProjectExpenditureItemsDFF

Parameters:

• ExpenditureItemId: $request.path.ExpenditureItemId

The Project Expenditure Items Descriptive Flexfields resource is used to view and update additional information for project costs.

Back to Top

Examples

The following example shows how to update an expenditure item by submitting a PATCH request on the REST resource using cURL.

<Enter the cURL command syntax>

cURL Command Example

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.17.08/projectExpenditureItems/{ExpenditureItemId}

Request Body Example

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

{
            "ExternalBillRate" : "3",
            "ExternalBillRateCurrency" : "INR",
            "ExternalBillRateSourceName" : "abc11",
            "ExternalBillRateSourceReference" : "abc"
}

Response Body Example

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

{
  "ExternalBillRate" : 3,
  "ExternalBillRateCurrency" : "INR",
  "ExternalBillRateSourceName" : "abc11",
  "ExternalBillRateSourceReference" : "abc",
  "ExpenditureItemId" : 7690976,
  "IntercompanyBillRate" : null,
  "IntercompanyBillRateCurrency" : null,
  "IntercompanyBillRateSourceName" : null,
  "IntercompanyBillRateSourceReference" : null,
  "links" : [ ...
]
}

Back to Top