Jump to

• Request
• Response

Get an accounting rule line

get

/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines/{publicSectorAccountingRuleLinesUniqID}

Request

Path Parameters

• publicSectorAccountingRuleLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, AccountingRuleId, EffectiveStartDate, EffectiveEndDate and LineNumber ---for the Accounting Rule Lines resource and used to uniquely identify an instance of Accounting Rule Lines. The client should not generate the hash key value. Instead, the client should query on the Accounting Rule Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Accounting Rule Lines.
  
  For example: publicSectorAccountingRuleLines?q=AgencyId=<value1>;AccountingRuleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;LineNumber=<value5>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AccountId: string
  Title: Account

  Maximum Length: 30

  The type of economic activity for an accounting transaction line. Value is mandatory and is defined by the user during a create action.
• AccountingRuleId: string
  Title: Accounting Rule

  Maximum Length: 50

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

  Default Value: 1

  The unique identifier of the agency associated with the accounting rule line. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time that the accounting rule line was created.
• DebitCredit: string
  Title: Debit or Credit

  Maximum Length: 1

  Identifies a line as a debit or a credit distribution. The value is defined by lookup type ORA_PSC_CC_DR_CR.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and is defined by the user during a create action.
• DivisionId: string
  Title: Division

  Maximum Length: 30

  The sub-grouping within a department for an accounting transaction line. Value is optional and is defined by the user during a create action.
• EffectiveEndDate: string (date)
  Title: End Date

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

  The first day that the rule may be used.
• FunctionId: string
  Title: Function

  Maximum Length: 30

  The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.
• FundId: string
  Title: Fund

  Maximum Length: 30

  The source or target of funding for an accounting transaction line. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting rule line.
• LineNumber: integer (int32)
  Title: Line Number

  The unique identifier of an accounting rule line. Identifies a debit or credit distribution line associated with a rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  The meaning for a debit or credit value.
• Percentage: number
  Title: Percent

  The proportion of the transaction amount allocated to the distribution line.
• ProgramId: string
  Title: Program

  Maximum Length: 30

  A set of activities performed by an agency to accomplish a specific goal that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.
• RoundAdjustment: string
  Title: Rounding Adjustment

  Maximum Length: 1

  Indicates whether the distribution line is used for any rounding adjustment required. Valid values are Y (line can contain a rounding adjustment) and N (line will not contain a rounding adjustment). Default value is N.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting rule line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionId":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the accounting rule line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DebitCredit":{
            "title":"Debit or Credit",
            "maxLength":"1",
            "type":"string",
            "description":"Identifies a line as a debit or a credit distribution. The value is defined by lookup type ORA_PSC_CC_DR_CR.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the accounting rule line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "maxLength":"30",
            "type":"string",
            "description":"The type of economic activity for an accounting transaction line. Value is mandatory and is defined by the user during a create action.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting rule line. 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
        },
        "EffectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last day that the rule may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The proportion of the transaction amount allocated to the distribution line.",
            "nullable":false,
            "x-hints":{
                "precision":"10",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "title":"Program",
            "maxLength":"30",
            "type":"string",
            "description":"A set of activities performed by an agency to accomplish a specific goal that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "DivisionId":{
            "title":"Division",
            "maxLength":"30",
            "type":"string",
            "description":"The sub-grouping within a department for an accounting transaction line. Value is optional and is defined by the user during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The unique identifier of an accounting rule line. Identifies a debit or credit distribution line associated with a rule.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "RoundAdjustment":{
            "title":"Rounding Adjustment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the distribution line is used for any rounding adjustment required. Valid values are Y (line can contain a rounding adjustment) and N (line will not contain a rounding adjustment). Default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingRuleId":{
            "title":"Accounting Rule",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the accounting rule. Describes how accounting journal entries are created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.",
            "nullable":false,
            "x-queryable":true
        },
        "FundId":{
            "title":"Fund",
            "maxLength":"30",
            "type":"string",
            "description":"The source or target of funding for an accounting transaction line. Value is mandatory and is defined by the user during a create action.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and is defined by the user during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first day that the rule may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The meaning for a debit or credit value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the accounting rule line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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