Get all bank reconciliation activity data
get
/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions
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: The unique identifier for the bank reconciliation activity.
Finder Variables:- ReconHistoryKey; integer; The key recon history for bank reconciliation activity.
- simpleSearchFinder: Finds bank reconciliation activity that match the primary key criteria specified.
Finder Variables:- value; string; Finds bank reconciliation activity that match the primary key criteria specified.
- PrimaryKey: The unique identifier for the bank reconciliation activity.
-
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:- AccountingFlag; string; Indicates whether the accounting transaction should be created in the bank reconciliation system.
- AgencyId; integer; The agency associated with the bank reconciliation activity.
- Amount; number; Amount of the payment or refund.
- AssetAccountCombination; integer; Indicates the cash general ledger account code combination of the external transaction.
- AuthorizationCode; string; The authorization code value returned by the payment gateway.
- AuthorizationDatetime; string; The authorization date returned by the payment gateway.
- BankAccountName; string; Indicates the name of the bank account in which payments will be deposited or refunds will be issued from.
- BusinessUnitName; string; Indicates the name of the business unit associated to the bank account to which payments and refunds belong.
- CashierId; string; Cashier identifier associated with the receipt of cash and checks.
- CheckDate; string; Check date recorded for a check transaction.
- CheckNumber; string; Check number recorded for a check transaction.
- CurrencyCode; string; Currency code of the transaction recorded for a payment or refund.
- DepositAccountNumber; string; Deposit account number.
- DepositSlipNumber; string; Unique identifier associated with the deposit of cash and checks.
- DrawerId; string; Cash drawer identifier associated with the receipt of cash and checks.
- ExternalTransactionId; integer; The unique identifier of the external transaction.
- ManualReconDatetime; string; Date the bank reconciliation transaction was reconciled when the transaction is reconciled manually.
- ManualReconStatusCode; string; Status of the bank reconciliation transaction when the transaction is reconciled manually.
- OffsetAccountCombination; integer; Indicates the offset general ledger account code combination of the external transaction.
- PaymentDate; string; Date on which the transaction was recorded for a payment.
- PaymentMethodCode; string; Indicates the payment method code associated with the bank reconciliation activity.
- PaymentMethodName; string; Indicates the name of the payment method code associated with the bank reconciliation activity.
- PaymentReferenceId; string; Unique identifier associated with a payment or refund.
- PaymentTransactionId; string; Transaction identifier associated with a payment or refund.
- PublishedStatusCode; string; Indicates the publish status code of the transaction.
- PublishedStatusName; string; Indicates name of the publish status code of the transaction.
- ReceiptLineNumber; integer; Line number associated with the receipt of cash and checks.
- ReceiptNumber; string; Unique identifier associated with the receipt of cash and checks.
- ReconHistoryKey; integer; The unique identifier associated with the bank reconciliation activity.
- ReconciliationSystemCode; string; Indicates the bank reconciliation system that will reconcile the transaction with the bank statement.
- RefundDatetime; string; Date and time when the refund was processed.
- RefundMethodCode; string; Identifies the mode of refund.
- RefundReferenceId; string; Unique identifier associated with a refund.
- RefundRequestCode; string; Refund code or reference value returned by the payment gateway.
- RefundTransactionId; string; Transaction ID received from the payment gateway.
- RefundTypeCode; string; Indicates whether a refund transaction is a chargeback or refund.
- ReversalFlag; string; Indicates a check return.
- SessionId; string; Cashier session identifier associated with the receipt of cash and checks.
- SourceTransactionKey; integer; Identifies the payment history key or the refund history key of the transaction.
- TransactionCategoryCode; string; Indicates whether the bank reconciliation activity is a payment or refund by code.
- TransactionCategoryName; string; Indicates whether the bank reconciliation activity is a payment or refund by name.
- TransactionType; string; Indicates the transaction type that will be passed to reconcile 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 TopResponse
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.
Root Schema : publicSectorBankReconciliationTransactions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBankReconciliationTransactions-item-response
Type:
Show Source
object
-
AccountingFlag: string
Title:
Accounting Flag
Maximum Length:1
Default Value:N
Indicates whether the accounting transaction should be created in the bank reconciliation system. -
AgencyId: integer
(int64)
Title:
Agency ID
Default Value:1
The agency associated with the bank reconciliation activity. -
Amount: number
Title:
Amount
Default Value:0
Amount of the payment or refund. -
AssetAccountCombination: integer
(int64)
Title:
Asset Account Combination
Indicates the cash general ledger account code combination of the external transaction. -
AuthorizationCode: string
Maximum Length:
10
The authorization code value returned by the payment gateway. -
AuthorizationDatetime: string
(date-time)
Title:
Authorization Date and Time
The authorization date returned by the payment gateway. -
BankAccountName: string
Title:
Bank Account Name
Maximum Length:360
Indicates the name of the bank account in which payments will be deposited or refunds will be issued from. -
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:360
Indicates the name of the business unit associated to the bank account to which payments and refunds belong. -
CashierId: string
Title:
Cashier ID
Maximum Length:50
Cashier identifier associated with the receipt of cash and checks. -
CheckDate: string
(date)
Title:
Check Date
Check date recorded for a check transaction. -
CheckNumber: string
Title:
Check Number
Maximum Length:10
Check number recorded for a check transaction. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
Default Value:USD
Currency code of the transaction recorded for a payment or refund. -
DepositAccountNumber: string
Title:
Deposit Account Number
Maximum Length:30
Deposit account number. -
DepositSlipNumber: string
Title:
Deposit Slip Number
Maximum Length:50
Unique identifier associated with the deposit of cash and checks. -
DrawerId: string
Title:
Cash Drawer ID
Maximum Length:30
Cash drawer identifier associated with the receipt of cash and checks. -
ExternalTransactionId: integer
(int64)
The unique identifier of the external transaction.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualReconDatetime: string
(date-time)
Title:
Manual Reconciliation Date and Time
Date the bank reconciliation transaction was reconciled when the transaction is reconciled manually. -
ManualReconStatusCode: string
Title:
Manual Reconciliation Status Code
Maximum Length:30
Status of the bank reconciliation transaction when the transaction is reconciled manually. -
OffsetAccountCombination: integer
(int64)
Title:
Offset Account Combination
Indicates the offset general ledger account code combination of the external transaction. -
PaymentDate: string
(date)
Title:
Payment Date
Date on which the transaction was recorded for a payment. -
PaymentMethodCode: string
Title:
Payment Method Code
Maximum Length:30
Default Value:PRCK
Indicates the payment method code associated with the bank reconciliation activity. -
PaymentMethodName: string
Title:
Payment Method Name
Read Only:true
Maximum Length:80
Indicates the name of the payment method code associated with the bank reconciliation activity. -
PaymentReferenceId: string
Title:
Payment Reference ID
Maximum Length:50
Unique identifier associated with a payment or refund. -
PaymentTransactionId: string
Title:
Payment Transaction ID
Maximum Length:50
Transaction identifier associated with a payment or refund. -
PublishedStatusCode: string
Title:
Published Status Code
Maximum Length:30
Default Value:ORA_UNPUBLISHED
Indicates the publish status code of the transaction. -
PublishedStatusName: string
Title:
Published Status Name
Read Only:true
Maximum Length:80
Indicates name of the publish status code of the transaction. -
ReceiptLineNumber: integer
(int32)
Title:
Receipt Line Number
Line number associated with the receipt of cash and checks. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:50
Unique identifier associated with the receipt of cash and checks. -
ReconciliationSystemCode: string
Title:
Reconciliation System Code
Maximum Length:30
Default Value:ORA_CASH
Indicates the bank reconciliation system that will reconcile the transaction with the bank statement. -
ReconHistoryKey: integer
(int64)
Title:
Reconciliation History Key
Read Only:true
The unique identifier associated with the bank reconciliation activity. -
RefundDatetime: string
(date-time)
Title:
Refund Date and Time
Date and time when the refund was processed. -
RefundMethodCode: string
Title:
Refund Method Code
Maximum Length:30
Identifies the mode of refund. -
RefundReferenceId: string
Title:
Refund Reference ID
Maximum Length:50
Unique identifier associated with a refund. -
RefundRequestCode: string
Title:
Refund Request Code
Maximum Length:20
Refund code or reference value returned by the payment gateway. -
RefundTransactionId: string
Title:
Refund Transaction ID
Maximum Length:50
Transaction ID received from the payment gateway. -
RefundTypeCode: string
Title:
Refund Type Code
Maximum Length:10
Indicates whether a refund transaction is a chargeback or refund. -
ReversalFlag: string
Title:
Reversal Flag
Maximum Length:1
Default Value:N
Indicates a check return. -
SessionId: string
Title:
Cashier Session ID
Maximum Length:50
Cashier session identifier associated with the receipt of cash and checks. -
SourceTransactionKey: integer
(int64)
Title:
Source Transaction Key
Identifies the payment history key or the refund history key of the transaction. -
TransactionCategoryCode: string
Title:
Transaction Category Code
Maximum Length:30
Default Value:ORA_PAYMENT
Indicates whether the bank reconciliation activity is a payment or refund by code. -
TransactionCategoryName: string
Title:
Transaction Category Name
Read Only:true
Maximum Length:80
Indicates whether the bank reconciliation activity is a payment or refund by name. -
TransactionType: string
Title:
Transaction Type
Maximum Length:30
Indicates the transaction type that will be passed to reconcile 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.