Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the funds held in the deposit account.",
            "nullable":false
        },
        "MinimumDeposit":{
            "title":"Minimum Deposit",
            "type":"number",
            "description":"The amount acceptable for deposits made after the initial deposit.",
            "nullable":false
        },
        "DepositAccountAtnRule":{
            "title":"Account Auto Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The rule that defines the format used to generate deposit account numbers.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency for which a deposit account will be created.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "DepositBankAccountName":{
            "title":"Deposit Bank Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the bank account in which the funds associated with the deposit account are held.",
            "nullable":true
        },
        "MultipleProject":{
            "title":"Assign Multiple Projects",
            "maxLength":"1",
            "type":"string",
            "description":"The option that specifies whether the deposit account can be linked to more than one project.",
            "nullable":false
        },
        "DocGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The document group specified for deposit account attachments.",
            "nullable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"A division within the agency devoted to a specific function.",
            "nullable":true
        },
        "MinimumBalance":{
            "title":"Minimum Balance",
            "type":"number",
            "description":"The balance that must be maintained in the deposit account.",
            "nullable":false
        },
        "MultiplePermit":{
            "title":"Assign Multiple Transactions",
            "maxLength":"1",
            "type":"string",
            "description":"The option that specifies whether a deposit account can be linked to more than one transaction.",
            "nullable":false
        },
        "InitialDeposit":{
            "title":"Initial Deposit",
            "type":"number",
            "description":"The amount that must be deposited when the deposit account is created.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the funds held in the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumDeposit":{
            "title":"Minimum Deposit",
            "type":"number",
            "description":"The amount acceptable for deposits made after the initial deposit.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountAtnRule":{
            "title":"Account Auto Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The rule that defines the format used to generate deposit account numbers.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency for which a deposit account will be created.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DepositBankAccountName":{
            "title":"Deposit Bank Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the bank account in which the funds associated with the deposit account are held.",
            "nullable":true,
            "x-queryable":true
        },
        "MultipleProject":{
            "title":"Assign Multiple Projects",
            "maxLength":"1",
            "type":"string",
            "description":"The option that specifies whether the deposit account can be linked to more than one project.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The document group specified for deposit account attachments.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"A division within the agency devoted to a specific function.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumBalance":{
            "title":"Minimum Balance",
            "type":"number",
            "description":"The balance that must be maintained in the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "MultiplePermit":{
            "title":"Assign Multiple Transactions",
            "maxLength":"1",
            "type":"string",
            "description":"The option that specifies whether a deposit account can be linked to more than one transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "InitialDeposit":{
            "title":"Initial Deposit",
            "type":"number",
            "description":"The amount that must be deposited when the deposit account is created.",
            "nullable":false,
            "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