Jump to

• Request
• Response

Get all accounting transactions

get

/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • simpleSearchFinder: Finds the accounting transaction (event line) that matches the specified value. Finder Variables:
    • value; string; The unique identifier for the accounting transaction.
  • PrimaryKey: Finds the accounting transaction that matches the specified primary key criteria. Finder Variables:
    • EventLineId; integer; The unique identifier for the accounting transaction.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorEventTransactionLines

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorEventTransactionLines-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorEventTransactionLines-item

{
    "items":{
        "$ref":"#/definitions/publicSectorEventTransactionLines-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorEventTransactionLines-item

Type: object

Show Source

• AccountingDate(optional): string(date-time)
  Title: Accounting Date

  The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the accounting transaction. Value is mandatory and is supplied by the calling application.
• BatchRequestId(optional): string
  Maximum Length: 30

  Unique identifier assigned by the system to facilitate the Generate Accounting process.
• BusinessFunctionId(optional): string
  Title: Business Function

  Maximum Length: 30

  Identifies a specific agency business activity that is also referenced on the applicable accounting event for the transaction.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the accounting transaction.
• CreationDate(optional): string(date-time)
  The date and time that the accounting transaction was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency that the transaction amount is stated in. Value is mandatory and is supplied by the calling application.
• EventLineId(optional): integer(int64)
  The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.
• EventLineStatus(optional): string
  Title: Status

  Maximum Length: 1

  The status of the accounting transaction. Accepted values are C (Created) and G (Journal Generated). Transactions begin in a C status and move to a G status once an accounting journal has been generated.
• FeeItemId(optional): string
  Title: Fee Item ID

  Maximum Length: 30

  The fee item associated with the accounting transaction. Value is mandatory if Fee Item Id is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
• LastUpdateDate(optional): string(date-time)
  The date and time that the accounting transaction was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the accounting transaction.
• links(optional): array Items
  Title: Items

  Link Relations
• SourceName(optional): string
  Title: Source Table

  Maximum Length: 30

  The name of the application table that contains the source transaction which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
• TransactionId(optional): integer(int64)
  Title: Transaction ID

  The unique identifier of the source transaction on the source application table which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
• TransactionType(optional): string
  Title: Transaction Type

  Maximum Length: 50

  The type of transaction or business activity the accounting transaction represents. Value is mandatory if Transaction Type is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
• TransAmount(optional): number
  Title: Transaction Amount

  The amount of the accounting transaction. Value is mandatory and is supplied by the calling application.

{
    "properties":{
        "AccountingDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application.",
            "title":"Accounting Date"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "title":"Agency ID"
        },
        "BatchRequestId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier assigned by the system to facilitate the Generate Accounting process."
        },
        "BusinessFunctionId":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies a specific agency business activity that is also referenced on the applicable accounting event for the transaction.",
            "title":"Business Function"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting transaction."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting transaction was created."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency that the transaction amount is stated in. Value is mandatory and is supplied by the calling application.",
            "title":"Currency"
        },
        "EventLineId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action."
        },
        "EventLineStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the accounting transaction. Accepted values are C (Created) and G (Journal Generated).  Transactions begin in a C status and move to a G status once an accounting journal has been generated.",
            "title":"Status"
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The fee item associated with the accounting transaction. Value is mandatory if Fee Item Id is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.",
            "title":"Fee Item ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the accounting transaction was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting transaction."
        },
        "SourceName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the application table that contains the source transaction which supports the accounting transaction.  Value is mandatory and is supplied by the calling application.",
            "title":"Source Table"
        },
        "TransAmount":{
            "type":"number",
            "description":"The amount of the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "title":"Transaction Amount"
        },
        "TransactionId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the source transaction on the source application table which supports the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "title":"Transaction ID"
        },
        "TransactionType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of transaction or business activity the accounting transaction represents.  Value is mandatory if Transaction Type is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.",
            "title":"Transaction 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