Update a deposit account options data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountOptions/{AgencyId}
Request
Path Parameters
-
AgencyId(required): integer(int32)
The unique identifier of the agency for which a deposit account will be created.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency for which a deposit account will be created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
The currency of the funds held in the deposit account. -
DepartmentId: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
DepositAccountAtnRule: string
Title:
Account Auto Number Rule
Maximum Length:20
The rule that defines the format used to generate deposit account numbers. -
DepositBankAccountName: string
Title:
Deposit Bank Account Name
Maximum Length:360
The name of the bank account in which the funds associated with the deposit account are held. -
DocGroupId: string
Maximum Length:
30
The document group specified for deposit account attachments. -
InitialDeposit: number
Title:
Initial Deposit
The amount that must be deposited when the deposit account is created. -
MinimumBalance: number
Title:
Minimum Balance
The balance that must be maintained in the deposit account. -
MinimumDeposit: number
Title:
Minimum Deposit
The amount acceptable for deposits made after the initial deposit. -
MultiplePermit: string
Title:
Assign Multiple Transactions
Maximum Length:1
The option that specifies whether a deposit account can be linked to more than one transaction. -
MultipleProject: string
Title:
Assign Multiple Projects
Maximum Length:1
The option that specifies whether the deposit account can be linked to more than one project.
Response
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 : publicSectorDepositAccountOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency for which a deposit account will be created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
The currency of the funds held in the deposit account. -
DepartmentId: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
DepositAccountAtnRule: string
Title:
Account Auto Number Rule
Maximum Length:20
The rule that defines the format used to generate deposit account numbers. -
DepositBankAccountName: string
Title:
Deposit Bank Account Name
Maximum Length:360
The name of the bank account in which the funds associated with the deposit account are held. -
DocGroupId: string
Maximum Length:
30
The document group specified for deposit account attachments. -
InitialDeposit: number
Title:
Initial Deposit
The amount that must be deposited when the deposit account is created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumBalance: number
Title:
Minimum Balance
The balance that must be maintained in the deposit account. -
MinimumDeposit: number
Title:
Minimum Deposit
The amount acceptable for deposits made after the initial deposit. -
MultiplePermit: string
Title:
Assign Multiple Transactions
Maximum Length:1
The option that specifies whether a deposit account can be linked to more than one transaction. -
MultipleProject: string
Title:
Assign Multiple Projects
Maximum Length:1
The option that specifies whether the deposit account can be linked to more than one project.
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.