Jump to

• Request
• Response

Update a set of bank reconciliation activity data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationTransactions/{ReconHistoryKey}

Request

Path Parameters

• ReconHistoryKey(required): integer(int64)
  The unique identifier associated with the bank reconciliation activity.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountingFlag: string
  Title: Accounting Flag

  Maximum Length: 1

  Default Value: N

  Indicates whether the accounting transaction should be created in the bank reconciliation system.
• AssetAccountCombination: integer (int64)
  Title: Asset Account Combination

  Indicates the cash general ledger account code combination of the external transaction.
• 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.
• CheckDate: string (date)
  Title: Check Date

  Check date recorded for a check transaction.
• ExternalTransactionId: integer (int64)
  The unique identifier of the external transaction.
• 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.
• PublishedStatusCode: string
  Title: Published Status Code

  Maximum Length: 30

  Default Value: ORA_UNPUBLISHED

  Indicates the publish status code of the transaction.
• ReversalFlag: string
  Title: Reversal Flag

  Maximum Length: 1

  Default Value: N

  Indicates a check return.
• 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.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 30

  Indicates the transaction type that will be passed to reconcile transaction.

{
    "type":"object",
    "properties":{
        "ManualReconDatetime":{
            "title":"Manual Reconciliation Date and Time",
            "type":"string",
            "description":"Date the bank reconciliation transaction was reconciled when the transaction is reconciled manually.",
            "format":"date-time",
            "nullable":true
        },
        "OffsetAccountCombination":{
            "title":"Offset Account Combination",
            "type":"integer",
            "description":"Indicates the offset general ledger account code combination of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the transaction type that will be passed to reconcile transaction.",
            "nullable":true
        },
        "TransactionCategoryCode":{
            "title":"Transaction Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the bank reconciliation activity is a payment or refund by code.",
            "nullable":false,
            "default":"ORA_PAYMENT"
        },
        "ManualReconStatusCode":{
            "title":"Manual Reconciliation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the bank reconciliation transaction when the transaction is reconciled manually.",
            "nullable":true
        },
        "AccountingFlag":{
            "title":"Accounting Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the accounting transaction should be created in the bank reconciliation system.",
            "nullable":false,
            "default":"N"
        },
        "AssetAccountCombination":{
            "title":"Asset Account Combination",
            "type":"integer",
            "description":"Indicates the cash general ledger account code combination of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BankAccountName":{
            "title":"Bank Account Name",
            "maxLength":360,
            "type":"string",
            "description":"Indicates the name of the bank account in which payments will be deposited or refunds will be issued from.",
            "nullable":true
        },
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PublishedStatusCode":{
            "title":"Published Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the publish status code of the transaction.",
            "nullable":true,
            "default":"ORA_UNPUBLISHED"
        },
        "CheckDate":{
            "title":"Check Date",
            "type":"string",
            "description":"Check date recorded for a check transaction.",
            "format":"date",
            "nullable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":360,
            "type":"string",
            "description":"Indicates the name of the business unit associated to the bank account to which payments and refunds belong.",
            "nullable":true
        },
        "ReversalFlag":{
            "title":"Reversal Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates a check return.",
            "nullable":false,
            "default":"N"
        }
    }
}

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

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "title":"Payment Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Transaction identifier associated with a payment or refund.",
            "nullable":true,
            "x-queryable":true
        },
        "ReconHistoryKey":{
            "title":"Reconciliation History Key",
            "type":"integer",
            "description":"The unique identifier associated with the bank reconciliation activity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RefundMethodCode":{
            "title":"Refund Method Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the mode of refund.",
            "nullable":true,
            "x-queryable":true
        },
        "OffsetAccountCombination":{
            "title":"Offset Account Combination",
            "type":"integer",
            "description":"Indicates the offset general ledger account code combination of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the transaction type that will be passed to reconcile transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency associated with the bank reconciliation activity.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CashierId":{
            "title":"Cashier ID",
            "maxLength":50,
            "type":"string",
            "description":"Cashier identifier associated with the receipt of cash and checks.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountingFlag":{
            "title":"Accounting Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the accounting transaction should be created in the bank reconciliation system.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AssetAccountCombination":{
            "title":"Asset Account Combination",
            "type":"integer",
            "description":"Indicates the cash general ledger account code combination of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodName":{
            "title":"Payment Method Name",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the name of the payment method code associated with the bank reconciliation activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line Number",
            "type":"integer",
            "description":"Line number associated with the receipt of cash and checks.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier associated with a payment or refund.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"Currency code of the transaction recorded for a payment or refund.",
            "nullable":true,
            "default":"USD",
            "x-queryable":true
        },
        "PublishedStatusName":{
            "title":"Published Status Name",
            "maxLength":80,
            "type":"string",
            "description":"Indicates name of the publish status code of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DrawerId":{
            "title":"Cash Drawer ID",
            "maxLength":30,
            "type":"string",
            "description":"Cash drawer identifier associated with the receipt of cash and checks.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCategoryName":{
            "title":"Transaction Category Name",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the bank reconciliation activity is a payment or refund by name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RefundTransactionId":{
            "title":"Refund Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Transaction ID received from the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionKey":{
            "title":"Source Transaction Key",
            "type":"integer",
            "description":"Identifies the payment history key or the refund history key of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CheckDate":{
            "title":"Check Date",
            "type":"string",
            "description":"Check date recorded for a check transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":360,
            "type":"string",
            "description":"Indicates the name of the business unit associated to the bank account to which payments and refunds belong.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionId":{
            "title":"Cashier Session ID",
            "maxLength":50,
            "type":"string",
            "description":"Cashier session identifier associated with the receipt of cash and checks.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier associated with the receipt of cash and checks.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationCode":{
            "maxLength":10,
            "type":"string",
            "description":"The authorization code value returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualReconDatetime":{
            "title":"Manual Reconciliation Date and Time",
            "type":"string",
            "description":"Date the bank reconciliation transaction was reconciled when the transaction is reconciled manually.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RefundDatetime":{
            "title":"Refund Date and Time",
            "type":"string",
            "description":"Date and time when the refund was processed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCategoryCode":{
            "title":"Transaction Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the bank reconciliation activity is a payment or refund by code.",
            "nullable":false,
            "default":"ORA_PAYMENT",
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Date on which the transaction was recorded for a payment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the payment or refund.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "ManualReconStatusCode":{
            "title":"Manual Reconciliation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the bank reconciliation transaction when the transaction is reconciled manually.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositSlipNumber":{
            "title":"Deposit Slip Number",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier associated with the deposit of cash and checks.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundTypeCode":{
            "title":"Refund Type Code",
            "maxLength":10,
            "type":"string",
            "description":"Indicates whether a refund transaction is a chargeback or refund.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the payment method code associated with the bank reconciliation activity.",
            "nullable":false,
            "default":"PRCK",
            "x-queryable":true
        },
        "CheckNumber":{
            "title":"Check Number",
            "maxLength":10,
            "type":"string",
            "description":"Check number recorded for a check transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "title":"Refund Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier associated with a refund.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountName":{
            "title":"Bank Account Name",
            "maxLength":360,
            "type":"string",
            "description":"Indicates the name of the bank account in which payments will be deposited or refunds will be issued from.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationDatetime":{
            "title":"Authorization Date and Time",
            "type":"string",
            "description":"The authorization date returned by the payment gateway.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "title":"Deposit Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Deposit account number.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishedStatusCode":{
            "title":"Published Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the publish status code of the transaction.",
            "nullable":true,
            "default":"ORA_UNPUBLISHED",
            "x-queryable":true
        },
        "RefundRequestCode":{
            "title":"Refund Request Code",
            "maxLength":20,
            "type":"string",
            "description":"Refund code or reference value returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "ReconciliationSystemCode":{
            "title":"Reconciliation System Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the bank reconciliation system that will reconcile the transaction with the bank statement.",
            "nullable":false,
            "default":"ORA_CASH",
            "x-queryable":true
        },
        "ReversalFlag":{
            "title":"Reversal Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates a check return.",
            "nullable":false,
            "default":"N",
            "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