Jump to

• Request
• Response

Get all accounting events

get

/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds an accounting event with the specified primary key criteria.
    Finder Variables:
    • AccountingEventId; string; The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required.
  • simpleSearchFinder: Finds an accounting event with the specified accounting event identifier.
    Finder Variables:
    • value; string; The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountingEventId; string; The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required. Value is delivered as seed data.
  • BusinessFunctionId; string; An internal code that identifies the type of agency transaction. This code is not exposed to users.
  • CreatedBy; string; The user who created the accounting event.
  • CreationDate; string; The date and time that the accounting event was created.
  • DeletedFlag; boolean; Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
  • EnabledFlag; string; Indicates whether the accounting event is available to be used. The default value is N.
  • EventDescription; string; The description of the accounting event.
  • LastUpdateDate; string; The date and time that the accounting event was last updated.
  • LastUpdatedBy; string; The user who last updated the accounting event.
  • SeedDataLock; integer; Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
  • SourceName; string; The name of the application table that contains the source transaction that supports the accounting transaction.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : publicSectorAccountingEvents

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountingEvents-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorAccountingEvents-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountingEvents-item-response"
    }
}

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

Type: object

Show Source

• AccountingEventFields: array Accounting Event Fields
  Title: Accounting Event Fields

  The accounting event field resource is used to view event fields. An accounting event field defines a field name from a business source table, which is used in accounting rule criteria to specify the field values for generating accounting entries.
• AccountingEventId: string
  Title: Accounting Event

  Maximum Length: 30

  The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required. Value is delivered as seed data.
• BusinessFunctionId: string
  Title: Business Function

  Read Only: true

  Maximum Length: 30

  An internal code that identifies the type of agency transaction. This code is not exposed to users.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time that the accounting event was created.
• DeletedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: N

  Indicates whether the accounting event is available to be used. The default value is N.
• EventDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the accounting event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time that the accounting event was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Read Only: true

  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SourceName: string
  Title: Source Table

  Read Only: true

  Maximum Length: 30

  The name of the application table that contains the source transaction that supports the accounting transaction.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the accounting event 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 accounting event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "SourceName":{
            "title":"Source Table",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the application table that contains the source transaction that supports the accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessFunctionId":{
            "title":"Business Function",
            "maxLength":"30",
            "type":"string",
            "description":"An internal code that identifies the type of agency transaction. This code is not exposed to users.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountingEventId":{
            "title":"Accounting Event",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required. Value is delivered as seed data.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "AccountingEventFields":{
            "title":"Accounting Event Fields",
            "type":"array",
            "description":"The accounting event field resource is used to view event fields. An accounting event field defines a field name from a business source table, which is used in accounting rule criteria to specify the field values for generating accounting entries.",
            "items":{
                "$ref":"#/components/schemas/publicSectorAccountingEvents-AccountingEventFields-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the accounting event is available to be used. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the accounting event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the accounting event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Accounting Event Fields

Type: array

Title: Accounting Event Fields

The accounting event field resource is used to view event fields. An accounting event field defines a field name from a business source table, which is used in accounting rule criteria to specify the field values for generating accounting entries.

Show Source

• Array of: object publicSectorAccountingEvents-AccountingEventFields-item-response

{
    "title":"Accounting Event Fields",
    "type":"array",
    "description":"The accounting event field resource is used to view event fields. An accounting event field defines a field name from a business source table, which is used in accounting rule criteria to specify the field values for generating accounting entries.",
    "items":{
        "$ref":"#/components/schemas/publicSectorAccountingEvents-AccountingEventFields-item-response"
    }
}

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 : publicSectorAccountingEvents-AccountingEventFields-item-response

Type: object

Show Source

• AccountingEventId: string
  Title: Accounting Event

  Maximum Length: 30

  The accounting event identifier. Defined in an accounting event.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the accounting event field was created.
• DeletedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that seed data has been deleted. True means the data is deleted. False means the data is active. The default value is false.
• DisplayField: string
  Maximum Length: 50

  The field name displayed on the page.
• FieldDescription: string
  Title: Description

  Maximum Length: 200

  The description of the field name.
• FieldName: string
  Title: Field Name

  Maximum Length: 30

  Field name whose value defines the transactions to which the accounting event applies.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the accounting event field was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting event field.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PromptField: string
  Maximum Length: 30

  The service field that is used to get the field values.
• PromptTable: string
  Maximum Length: 100

  The service name that is used to get the field values.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.
• SeedDataLock: integer (int32)
  Read Only: true

  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting event field.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the accounting event field 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 accounting event field.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptField":{
            "maxLength":"30",
            "type":"string",
            "description":"The service field that  is used to get the field values.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "FieldDescription":{
            "title":"Description",
            "maxLength":"200",
            "type":"string",
            "description":"The description of the field name.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingEventId":{
            "title":"Accounting Event",
            "maxLength":"30",
            "type":"string",
            "description":"The accounting event identifier. Defined in an accounting event.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y"
            },
            "x-queryable":true
        },
        "DisplayField":{
            "maxLength":"50",
            "type":"string",
            "description":"The field name displayed on the page.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that seed data has been deleted. True means the data is deleted. False means the data is active. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "PromptTable":{
            "maxLength":"100",
            "type":"string",
            "description":"The service name that is used to get the field values.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"30",
            "type":"string",
            "description":"Field name whose value defines the transactions to which the accounting event applies.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the accounting event field 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