Jump to

• Request
• Response

Create a ledger

post

/fscmRestApi/resources/11.13.18.05/publicSectorLedgers

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorLedgers-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login.
• BaseCurrency(optional): 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(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  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(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Maximum Length: 240

  The description of the ledger.
• LedgerId(optional): 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(optional): 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(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "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.",
            "title":"Agency ID"
        },
        "BaseCurrency":{
            "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.",
            "title":"Currency"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ledger.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the ledger was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the ledger was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ledger.",
            "title":"Last Updated By"
        },
        "LedgerDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the ledger.",
            "title":"Description"
        },
        "LedgerId":{
            "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.",
            "title":"Ledger"
        },
        "LedgerType":{
            "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.",
            "title":"Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorLedgers-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login.
• BaseCurrency(optional): 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(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  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(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Maximum Length: 240

  The description of the ledger.
• LedgerId(optional): 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(optional): 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(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "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.",
            "title":"Agency ID"
        },
        "BaseCurrency":{
            "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.",
            "title":"Currency"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ledger.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the ledger was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the ledger was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ledger.",
            "title":"Last Updated By"
        },
        "LedgerDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the ledger.",
            "title":"Description"
        },
        "LedgerId":{
            "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.",
            "title":"Ledger"
        },
        "LedgerType":{
            "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.",
            "title":"Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top