Jump to

• Request
• Response

Create an accounting rule

post

/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules

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 : publicSectorAccountingRules-item

Type: object

Show Source

• AccountingEventId(optional): string
  Title: Accounting Event

  Maximum Length: 30

  The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required.
• AccountingRuleGroup(optional): string
  Title: Accounting Rule Group

  Maximum Length: 50

  The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group.
• AccountingRuleId(optional): string
  Title: Accounting Rule

  Maximum Length: 50

  The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login.
• CompleteFlag(optional): string
  Title: Valid

  Maximum Length: 1

  Indicates whether the rule is complete and valid for processing. The default value is false.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time that the accounting rule was created.
• EffectiveEndDate(optional): string(date)
  Title: End Date

  The last day that the rule may be used.
• EffectiveStartDate(optional): string(date)
  Title: Start Date

  The first day that the rule may be used.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The user who last updated the accounting rule.
• LedgerId(optional): string
  Title: Ledger

  Maximum Length: 30

  The unique identifier of the ledger that the rule is associated with. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action.
• links(optional): array Items
  Title: Items

  Link Relations
• RuleDescription(optional): string
  Title: Description

  Maximum Length: 240

  The description of the rule.

{
    "properties":{
        "AccountingEventId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required.",
            "title":"Accounting Event"
        },
        "AccountingRuleGroup":{
            "maxLength":50,
            "type":"string",
            "description":"The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group.",
            "title":"Accounting Rule Group"
        },
        "AccountingRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Accounting Rule"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CompleteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the rule is complete and valid for processing. The default value is false.",
            "title":"Valid"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting rule.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting rule was created.",
            "title":"Creation Date"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the rule may be used.",
            "title":"End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the rule may be used.",
            "title":"Start Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting rule was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting rule.",
            "title":"Last Updated By"
        },
        "LedgerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the ledger that the rule is associated with. 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"
        },
        "RuleDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the rule.",
            "title":"Description"
        },
        "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 : publicSectorAccountingRules-item

Type: object

Show Source

• AccountingEventId(optional): string
  Title: Accounting Event

  Maximum Length: 30

  The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required.
• AccountingRuleGroup(optional): string
  Title: Accounting Rule Group

  Maximum Length: 50

  The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group.
• AccountingRuleId(optional): string
  Title: Accounting Rule

  Maximum Length: 50

  The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login.
• CompleteFlag(optional): string
  Title: Valid

  Maximum Length: 1

  Indicates whether the rule is complete and valid for processing. The default value is false.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time that the accounting rule was created.
• EffectiveEndDate(optional): string(date)
  Title: End Date

  The last day that the rule may be used.
• EffectiveStartDate(optional): string(date)
  Title: Start Date

  The first day that the rule may be used.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The user who last updated the accounting rule.
• LedgerId(optional): string
  Title: Ledger

  Maximum Length: 30

  The unique identifier of the ledger that the rule is associated with. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action.
• links(optional): array Items
  Title: Items

  Link Relations
• RuleDescription(optional): string
  Title: Description

  Maximum Length: 240

  The description of the rule.

{
    "properties":{
        "AccountingEventId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required.",
            "title":"Accounting Event"
        },
        "AccountingRuleGroup":{
            "maxLength":50,
            "type":"string",
            "description":"The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group.",
            "title":"Accounting Rule Group"
        },
        "AccountingRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Accounting Rule"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CompleteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the rule is complete and valid for processing. The default value is false.",
            "title":"Valid"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting rule.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting rule was created.",
            "title":"Creation Date"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the rule may be used.",
            "title":"End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the rule may be used.",
            "title":"Start Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting rule was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting rule.",
            "title":"Last Updated By"
        },
        "LedgerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the ledger that the rule is associated with. 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"
        },
        "RuleDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the rule.",
            "title":"Description"
        },
        "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