Get an accounting transaction
get
/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines/{EventLineId}
Request
Path Parameters
-
EventLineId(required): integer(int64)
The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorEventTransactionLines-item-response
Type:
Show Source
object
-
AccountingDate: string
(date-time)
Title:
Accounting Date
The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application. -
AccountingEventId: string
Title:
Accounting Event
Maximum Length:30
Indicates the accounting event the rule is associated with. -
AccountPurpose: string
Title:
Deposit Account Purpose
Maximum Length:30
Indicates the purpose of the deposit account used to charge the transaction. -
AccountType: string
Title:
Deposit Account Type
Maximum Length:30
Indicates the type of deposit account used to charge the transaction. -
AgencyId: 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: string
Maximum Length:
30
Unique identifier assigned by the system to facilitate the Generate Accounting process. -
BusinessFunctionId: 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. -
Classification: string
Title:
Classification
Maximum Length:7
Indicates the the product offering associated with the transaction. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the accounting transaction. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the accounting transaction was created. -
CurrencyCode: 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. -
EventId: integer
(int64)
Indicates the unique identifier of the event.
-
EventLineId: integer
(int64)
The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.
-
EventLineStatus: string
Title:
Status
Maximum Length:1
Default Value:C
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: 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. -
IssueSubtypeId: string
Title:
Issue Subtype
Maximum Length:50
Indicates the unique identifier of the issue subtype. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the accounting transaction was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the accounting transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
Indicates the method of payment used in the payment transaction. -
PaymentReferenceId: string
Title:
Payment Reference ID
Maximum Length:50
Indicates the payment reference ID associated with the transaction. -
RefundMethodCode: string
Title:
Refund Method
Maximum Length:30
Indicates the refund payment method associated with the transaction. -
RefundReasonCode: string
Title:
Refund Reason
Maximum Length:20
Indicates the refund reason associated with the transaction. -
RefundReferenceId: string
Title:
Refund Reference ID
Maximum Length:50
Indicates the refund reference ID associated with the transaction. -
ReversalReasonCd: string
Title:
Reversal Reason
Maximum Length:30
Indicates the reversal reason associated with the transaction. -
ReversalTranType: string
Title:
Reversal Transaction Type
Maximum Length:30
Indicates the type of transaction. Usually it is the record type associated with the transaction. -
RuleClassification: string
Title:
Event Type
Maximum Length:50
Indicates the type of accounting entry to be generated including the source transaction table. -
SourceName: 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: 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: 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: number
Title:
Transaction Amount
The amount of the accounting transaction. Value is mandatory and is supplied by the calling application. -
TrustAccountNumber: string
Title:
Deposit Account Number
Maximum Length:30
Indicates the deposit account used to charge the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.