Jump to

• Request
• Response

Create a bank reconciliation options data

post

/fscmRestApi/resources/11.13.18.05/publicSectorBankReconciliationOptions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the bank reconciliation options.
• AssetAccountCombination: integer (int64)
  Title: Asset Account Combination

  Indicates the cash general ledger account code combination of the external transaction.
• BankAccountId: integer (int64)
  Title: Bank Account ID

  Identifier associated with the bank account name.
• 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.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Identifier associated with the business unit name.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 360

  Indicates the name of the business unit associated with the bank account to which payments and refunds belong.
• Description: string
  Title: Description

  Maximum Length: 360

  Indicates the description value that should be passed to reconcile the transaction.
• DescriptionOptionCode: string
  Title: Description Text Option Code

  Maximum Length: 30

  Indicates the description option code that is passed to reconcile the transaction.
• EnabledFlag: string
  Title: Enabled Flag

  Maximum Length: 1

  Default Value: N

  Indicates whether the reconciliation option is enabled.
• ErrorHandlingOptionCode: string
  Title: Error Handling Option Code

  Maximum Length: 30

  Default Value: ORA_STOP

  Option that indicates how the process will behave when there are errors.
• OffsetAccountCombination: integer (int64)
  Title: Offset Account Combination

  Indicates the offset general ledger account code combination of the external transaction.
• PaymentMethodCode: string
  Title: Payment Method Code

  Maximum Length: 30

  Default Value: PRCK

  Indicates the payment method code associated with the bank reconciliation option.
• ReconciliationSystemCode: string
  Title: Reconciliation System Code

  Maximum Length: 30

  Default Value: ORA_CASH

  Indicates the bank reconciliation system code that will reconcile the payment transaction with the bank statement.
• ReferenceText: string
  Title: Reference Text

  Maximum Length: 30

  Indicates the reference text value that will be passed to reconcile the transaction.
• ReferenceTextOptionCode: string
  Title: Reference Text Option Code

  Maximum Length: 30

  Default Value: ORA_CHECK

  Indicates the reference text option code that will be passed to reconcile the transaction.
• ReturnCheckFlag: string
  Title: Return Check Flag

  Maximum Length: 1

  Default Value: N

  Indicates whether returned checks should be included in the bank reconciliation.
• StartDate: string (date)
  Title: Start Date

  Indicates the date from which payments and refunds will be reconciled.
• TransactionCategoryCode: string
  Title: Transaction Category Code

  Maximum Length: 30

  Default Value: ORA_PAYMENT

  Indicates the transaction category code of the bank reconciliation option.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "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 the transaction.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the description value that should be passed to reconcile the transaction.",
            "nullable":true
        },
        "ErrorHandlingOptionCode":{
            "title":"Error Handling Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Option that indicates how the process will behave when there are errors.",
            "nullable":false,
            "default":"ORA_STOP"
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the bank reconciliation options.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "TransactionCategoryCode":{
            "title":"Transaction Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the transaction category code of the bank reconciliation option.",
            "nullable":false,
            "default":"ORA_PAYMENT"
        },
        "DescriptionOptionCode":{
            "title":"Description Text Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the description option code that is passed to reconcile the transaction.",
            "nullable":true
        },
        "ReferenceTextOptionCode":{
            "title":"Reference Text Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reference text option code that will be passed to reconcile the transaction.",
            "nullable":false,
            "default":"ORA_CHECK"
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier associated with the business unit name.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReturnCheckFlag":{
            "title":"Return Check Flag",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether returned checks should be included in the bank reconciliation.",
            "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"
            }
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment method code associated with the bank reconciliation option.",
            "nullable":false,
            "default":"PRCK"
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Indicates the date from which payments and refunds will be reconciled.",
            "format":"date",
            "nullable":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
        },
        "ReferenceText":{
            "title":"Reference Text",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reference text value that will be passed to reconcile the transaction.",
            "nullable":true
        },
        "BankAccountId":{
            "title":"Bank Account ID",
            "type":"integer",
            "description":"Identifier associated with the bank account name.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EnabledFlag":{
            "title":"Enabled Flag",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the reconciliation option is enabled.",
            "nullable":false,
            "default":"N"
        },
        "ReconciliationSystemCode":{
            "title":"Reconciliation System Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the bank reconciliation system code that will reconcile the payment transaction with the bank statement.",
            "nullable":false,
            "default":"ORA_CASH"
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the name of the business unit associated with the bank account to which payments and refunds belong.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the bank reconciliation options.
• AssetAccountCombination: integer (int64)
  Title: Asset Account Combination

  Indicates the cash general ledger account code combination of the external transaction.
• BankAccountId: integer (int64)
  Title: Bank Account ID

  Identifier associated with the bank account name.
• 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.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Identifier associated with the business unit name.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 360

  Indicates the name of the business unit associated with the bank account to which payments and refunds belong.
• Description: string
  Title: Description

  Maximum Length: 360

  Indicates the description value that should be passed to reconcile the transaction.
• DescriptionOptionCode: string
  Title: Description Text Option Code

  Maximum Length: 30

  Indicates the description option code that is passed to reconcile the transaction.
• EnabledFlag: string
  Title: Enabled Flag

  Maximum Length: 1

  Default Value: N

  Indicates whether the reconciliation option is enabled.
• EnableFlagName: string
  Title: Enabled Flag Name

  Read Only: true

  Maximum Length: 80

  Indicates the descriptive value for the enabled flag.
• ErrorHandlingOptionCode: string
  Title: Error Handling Option Code

  Maximum Length: 30

  Default Value: ORA_STOP

  Option that indicates how the process will behave when there are errors.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OffsetAccountCombination: integer (int64)
  Title: Offset Account Combination

  Indicates the offset general ledger account code combination of the external transaction.
• PaymentMethodCode: string
  Title: Payment Method Code

  Maximum Length: 30

  Default Value: PRCK

  Indicates the payment method code associated with the bank reconciliation option.
• 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 option.
• ReconciliationSystemCode: string
  Title: Reconciliation System Code

  Maximum Length: 30

  Default Value: ORA_CASH

  Indicates the bank reconciliation system code that will reconcile the payment transaction with the bank statement.
• ReferenceText: string
  Title: Reference Text

  Maximum Length: 30

  Indicates the reference text value that will be passed to reconcile the transaction.
• ReferenceTextOptionCode: string
  Title: Reference Text Option Code

  Maximum Length: 30

  Default Value: ORA_CHECK

  Indicates the reference text option code that will be passed to reconcile the transaction.
• ReturnCheckFlag: string
  Title: Return Check Flag

  Maximum Length: 1

  Default Value: N

  Indicates whether returned checks should be included in the bank reconciliation.
• StartDate: string (date)
  Title: Start Date

  Indicates the date from which payments and refunds will be reconciled.
• TransactionCategoryCode: string
  Title: Transaction Category Code

  Maximum Length: 30

  Default Value: ORA_PAYMENT

  Indicates the transaction category code of the bank reconciliation option.
• TransactionCategoryName: string
  Title: Transaction Category Name

  Read Only: true

  Maximum Length: 80

  Indicates the name of the transaction category code of the bank reconciliation option.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "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 the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the description value that should be passed to reconcile the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorHandlingOptionCode":{
            "title":"Error Handling Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Option that indicates how the process will behave when there are errors.",
            "nullable":false,
            "default":"ORA_STOP",
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the bank reconciliation options.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "TransactionCategoryCode":{
            "title":"Transaction Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the transaction category code of the bank reconciliation option.",
            "nullable":false,
            "default":"ORA_PAYMENT",
            "x-queryable":true
        },
        "DescriptionOptionCode":{
            "title":"Description Text Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the description option code that is passed to reconcile the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTextOptionCode":{
            "title":"Reference Text Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reference text option code that will be passed to reconcile the transaction.",
            "nullable":false,
            "default":"ORA_CHECK",
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier associated with the business unit name.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReturnCheckFlag":{
            "title":"Return Check Flag",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether returned checks should be included in the bank reconciliation.",
            "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
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment method code associated with the bank reconciliation option.",
            "nullable":false,
            "default":"PRCK",
            "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 option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableFlagName":{
            "title":"Enabled Flag Name",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the descriptive value for the enabled flag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Indicates the date from which payments and refunds will be reconciled.",
            "format":"date",
            "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
        },
        "ReferenceText":{
            "title":"Reference Text",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reference text value that will be passed to reconcile the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCategoryName":{
            "title":"Transaction Category Name",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the name of the transaction category code of the bank reconciliation option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccountId":{
            "title":"Bank Account ID",
            "type":"integer",
            "description":"Identifier associated with the bank account name.",
            "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"
            }
        },
        "EnabledFlag":{
            "title":"Enabled Flag",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the reconciliation option is enabled.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ReconciliationSystemCode":{
            "title":"Reconciliation System Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the bank reconciliation system code that will reconcile the payment transaction with the bank statement.",
            "nullable":false,
            "default":"ORA_CASH",
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the name of the business unit associated with the bank account to which payments and refunds belong.",
            "nullable":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