1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Sustainability
  4. Sustainability Ledgers

Update one sustainability ledger

patch

/fscmRestApi/resources/11.13.18.05/sustainabilityLedgers/{LedgerId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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
Nested Schema : Ledger Legal Entity Assignments
Type: array
Title: Ledger Legal Entity Assignments
A setup task to assign legal entities to a sustainability ledger, which contains sustainability activity records of a legal entity.
Show Source
Nested Schema : sustainabilityLedgers-LedgerLeAssignment-item-patch-request
Type: object
Show Source
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 : sustainabilityLedgers-item-response
Type: object
Show Source
Nested Schema : Ledger Legal Entity Assignments
Type: array
Title: Ledger Legal Entity Assignments
A setup task to assign legal entities to a sustainability ledger, which contains sustainability activity records of a legal entity.
Show Source
Nested Schema : sustainabilityLedgers-LedgerLeAssignment-item-response
Type: object
Show Source
Links
AccountingCalendarsLovVA
The following properties are defined on the LOV link relation:
  • Source Attribute: GlCalendar; Target Attribute: UserPeriodSetName
  • Display Attribute: UserPeriodSetName
LedgerLeAssignment
Parameters:
  • LedgerId: $request.path.LedgerId
A setup task to assign legal entities to a sustainability ledger, which contains sustainability activity records of a legal entity.
retrieveFuturePeriods
Parameters:
  • LedgerId: $request.path.LedgerId
Retrieves all future periods. This action retrieves all future periods associated with the accounting calendar and creates them in a sustainability period with an open status.
Back to Top

Examples

This example describes how to update update the Accounting Calendar and the First Period associated with a sustainability ledger. You haven't retrieved periods so far for this ledger.

Note:

  • A sustainability ledger once created cannot be deleted.
  • You cannot modify the Accounting Calendar and the First Period associated with a sustainability ledger once periods have been retrieved for the ledger.
  • You cannot remove the assignment of a Legal Entity to the sustainability ledger once you have created activities for this assignment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sustainabilityLedgers/LedgerId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
    "GlCalendar": "Accounting NZ",
    "FirstLedgerPeriodName": "Jun-23"
}

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "LedgerId": 300100608267605,
    "LedgerName": "Vision Corp Ledger",
    "Description": "Vision Corp Ledger",
    "GlCalendarId": 300100036671868,
    "GlCalendar": "Accounting NZ",
    "FirstLedgerPeriodName": "Jun-23",
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2024-08-01T07:57:58+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2024-08-01T08:07:07+00:00",
    "IsPeriodOpenForLedger": "N",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityLedgers/300100608267605",
            "name": "sustainabilityLedgers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityLedgers/300100608267605",
            "name": "sustainabilityLedgers",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityLedgers/300100608267605/child/LedgerLeAssignment",
            "name": "LedgerLeAssignment",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityLedgers/300100608267605/action/retrieveFuturePeriods",
            "name": "retrieveFuturePeriods",
            "kind": "other"
        }
    ]
}
Back to Top