Jump to

• Request
• Response

Update a ledger

patch

/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}

Request

Path Parameters

• publicSectorLedgersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and LedgerId ---for the Ledgers resource and used to uniquely identify an instance of Ledgers. The client should not generate the hash key value. Instead, the client should query on the Ledgers collection resource with a filter on the primary key values in order to navigate to a specific instance of Ledgers.
  
  For example: publicSectorLedgers?q=AgencyId=<value1>;LedgerId=<value2>

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BaseCurrency: string
  Title: Currency

  Maximum Length: 3

  Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No). The default value is Y.
• LedgerDescription: string
  Title: Description

  Maximum Length: 240

  The description of the ledger.
• LedgerType: string
  Title: Type

  Maximum Length: 1

  The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type.

{
    "type":"object",
    "properties":{
        "BaseCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency.",
            "nullable":false
        },
        "LedgerDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the ledger.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No).  The default value is Y.",
            "nullable":false
        },
        "LedgerType":{
            "title":"Type",
            "maxLength":"1",
            "type":"string",
            "description":"The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login.
• BaseCurrency: string
  Title: Currency

  Maximum Length: 3

  Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the ledger.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the ledger was created.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No). The default value is Y.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the ledger was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the ledger.
• LedgerDescription: string
  Title: Description

  Maximum Length: 240

  The description of the ledger.
• LedgerId: string
  Title: Ledger

  Maximum Length: 30

  The unique identifier of the ledger. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action.
• LedgerType: string
  Title: Type

  Maximum Length: 1

  The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the ledger was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerId":{
            "title":"Ledger",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the ledger. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action.",
            "nullable":false,
            "x-queryable":true
        },
        "BaseCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency.",
            "nullable":false,
            "x-queryable":true
        },
        "LedgerDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the ledger.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No).  The default value is Y.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the ledger was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerType":{
            "title":"Type",
            "maxLength":"1",
            "type":"string",
            "description":"The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type.",
            "nullable":false,
            "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