Jump to

• Request
• Response

Get all deposit account data

get

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts

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 deposit accounts.
    Finder Variables:
    • DepositAccountKey; integer; The unique identifier for the deposit accounts.
  • simpleSearchFinder: Finds deposit accounts that match the primary key criteria specified.
    Finder Variables:
    • value; string; Finds deposit accounts that match the primary key criteria specified.
• 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:
  

  • AccountDescription; string; Indicates the user defined text for the deposit account.
  • AccountStatus; string; Indicates the status of the deposit account.
  • AccountType; string; Indicates the type of deposit account.
  • AutopayFlag; boolean; Indicates whether fees can be paid out of the deposit account by the batch auto-pay process.
  • AvailableBalance; number; Indicates the balance of funds in the deposit account that are available for use.
  • CurrencyCode; string; Indicates the currency of the funds held in the deposit account.
  • DepositAccountKey; integer; The unique system generated numeric identifier of the deposit account.
  • DepositAccountName; string; The unique user-defined alphanumeric identifier of the deposit account.
  • DepositAccountNumber; string; The unique agency-defined alphanumeric identifier of the deposit account.
  • DepositAccountPuid; string; The unique alphanumeric identifier of the deposit account.
  • FeeChargeOption; string; The code that identifies the intent of utilization of funds in the deposit account.
  • InitialDeposit; number; Indicates the initial amount that should be deposited when the deposit account is created.
  • LockAccount; string; Indicates whether the deposit account is locked for update.
  • MigratedDataFlag; string; Indicates whether the deposit account was migrated from an external application or entered by a user.
  • MinimumBalance; number; Indicates the minimum balance that should be maintained in the deposit account.
  • MinimumDeposit; number; Indicates the minimum amount acceptable for deposits made after the initial deposit.
  • Purpose; string; Agency-defined attribute that indicates what the deposit account is used for.
  • VerificationStatus; string; Indicates the stage of verification of the deposit account.
• 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 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 : publicSectorDepositAccounts

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BillingandPayment",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorDepositAccounts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-item-response"
    }
}

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

Type: object

Show Source

• AccountDescription: string
  Title: Account Description

  Maximum Length: 360

  Indicates the user defined text for the deposit account.
• AccountStatus: string
  Title: Account Status

  Maximum Length: 30

  Indicates the status of the deposit account.
• AccountType: string
  Title: Account Type

  Maximum Length: 30

  Indicates the type of deposit account.
• AutopayFlag: boolean
  Title: Allow Auto-Pay

  Maximum Length: 1

  Indicates whether fees can be paid out of the deposit account by the batch auto-pay process.
• AvailableBalance: number
  Title: Available Balance

  Default Value: 0

  Indicates the balance of funds in the deposit account that are available for use.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  Indicates the currency of the funds held in the deposit account.
• DepositAccountActivities: array Deposit Account Activities
  Title: Deposit Account Activities

  The deposit account activities resource is used to list activities for a deposit account.
• DepositAccountFund: array Deposit Account Funds
  Title: Deposit Account Funds

  The deposit account funds resource is used to assign fund information to a deposit account.
• DepositAccountKey: integer (int64)
  Title: Deposit Account Key

  Read Only: true

  The unique system generated numeric identifier of the deposit account.
• DepositAccountName: string
  Title: Name

  Maximum Length: 35

  The unique user-defined alphanumeric identifier of the deposit account.
• DepositAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositAccountOwner: array Deposit Account Owners
  Title: Deposit Account Owners

  The deposit account owners resource is used to assign owners to a deposit account.
• DepositAccountProject: array Deposit Account Projects
  Title: Deposit Account Projects

  The deposit account projects resource is used to assign projects to a deposit account.
• DepositAccountPuid: string
  Title: Public Unique ID

  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account.
• DepositAccountRecord: array Deposit Account Records
  Title: Deposit Account Records

  The deposit account records resource is used to assign transactions to a deposit account.
• DepositAccountUser: array Deposit Account Users
  Title: Deposit Account Users

  The deposit account users resource is used to assign users to a deposit account.
• DepositAccountUserInvite: array Deposit Account User Invites
  Title: Deposit Account User Invites

  The deposit account authorized user invites resource is used to get list of invited users.
• FeeChargeOption: string
  Title: Access Type

  Maximum Length: 30

  The code that identifies the intent of utilization of funds in the deposit account.
• InitialDeposit: number
  Title: Initial Deposit

  Default Value: 0

  Indicates the initial amount that should be deposited when the deposit account is created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockAccount: string
  Title: Account Lock

  Maximum Length: 1

  Default Value: N

  Indicates whether the deposit account is locked for update.
• MigratedDataFlag: string
  Title: Migrated Data

  Read Only: true

  Maximum Length: 3

  Default Value: N

  Indicates whether the deposit account was migrated from an external application or entered by a user.
• MinimumBalance: number
  Title: Minimum Balance

  Default Value: 0

  Indicates the minimum balance that should be maintained in the deposit account.
• MinimumDeposit: number
  Title: Minimum Deposit

  Default Value: 0

  Indicates the minimum amount acceptable for deposits made after the initial deposit.
• Purpose: string
  Title: Purpose

  Maximum Length: 30

  Agency-defined attribute that indicates what the deposit account is used for.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 30

  Indicates the stage of verification of the deposit account.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "title":"Migrated Data",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the deposit account was migrated from an external application or entered by a user.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the stage of verification of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumBalance":{
            "title":"Minimum Balance",
            "type":"number",
            "description":"Indicates the minimum balance that should be maintained in the deposit account.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "FeeChargeOption":{
            "title":"Access Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the intent of utilization of funds in the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "title":"Deposit Account Key",
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountActivities":{
            "title":"Deposit Account Activities",
            "type":"array",
            "description":"The deposit account activities resource is used to list activities for a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountActivities-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the currency of the funds held in the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountPuid":{
            "title":"Public Unique ID",
            "maxLength":"480",
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountStatus":{
            "title":"Account Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "AvailableBalance":{
            "title":"Available Balance",
            "type":"number",
            "description":"Indicates the balance of funds in the deposit account that are available for use.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "AutopayFlag":{
            "title":"Allow Auto-Pay",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether fees can be paid out of the deposit account by the batch auto-pay process.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountUserInvite":{
            "title":"Deposit Account User Invites",
            "type":"array",
            "description":"The deposit account authorized user invites resource is used to get list of invited users.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUserInvite-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepositAccountUser":{
            "title":"Deposit Account Users",
            "type":"array",
            "description":"The deposit account users resource is used to assign users to a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUser-item-response"
            }
        },
        "AccountDescription":{
            "title":"Account Description",
            "maxLength":"360",
            "type":"string",
            "description":"Indicates the user defined text for the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountName":{
            "title":"Name",
            "maxLength":"35",
            "type":"string",
            "description":"The unique user-defined alphanumeric identifier of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountOwner":{
            "title":"Deposit Account Owners",
            "type":"array",
            "description":"The deposit account owners resource is used to assign owners to a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountOwner-item-response"
            }
        },
        "Purpose":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Agency-defined attribute that indicates what the deposit account is used for.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "title":"Account Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountFund":{
            "title":"Deposit Account Funds",
            "type":"array",
            "description":"The deposit account funds resource is used to assign fund information to a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountFund-item-response"
            },
            "x-cardinality":"1"
        },
        "InitialDeposit":{
            "title":"Initial Deposit",
            "type":"number",
            "description":"Indicates the initial amount that should be deposited when the deposit account is created.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "MinimumDeposit":{
            "title":"Minimum Deposit",
            "type":"number",
            "description":"Indicates the minimum amount acceptable for deposits made after the initial deposit.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountRecord":{
            "title":"Deposit Account Records",
            "type":"array",
            "description":"The deposit account records resource is used to assign transactions to a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountRecord-item-response"
            }
        },
        "DepositAccountProject":{
            "title":"Deposit Account Projects",
            "type":"array",
            "description":"The deposit account projects resource is used to assign projects to a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountProject-item-response"
            }
        },
        "LockAccount":{
            "title":"Account Lock",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the deposit account is locked for update.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        }
    }
}

Nested Schema : Deposit Account Activities

Type: array

Title: Deposit Account Activities

The deposit account activities resource is used to list activities for a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountActivities-item-response

{
    "title":"Deposit Account Activities",
    "type":"array",
    "description":"The deposit account activities resource is used to list activities for a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountActivities-item-response"
    }
}

Nested Schema : Deposit Account Funds

Type: array

Title: Deposit Account Funds

The deposit account funds resource is used to assign fund information to a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountFund-item-response

{
    "title":"Deposit Account Funds",
    "type":"array",
    "description":"The deposit account funds resource is used to assign fund information to a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountFund-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Deposit Account Owners

Type: array

Title: Deposit Account Owners

The deposit account owners resource is used to assign owners to a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountOwner-item-response

{
    "title":"Deposit Account Owners",
    "type":"array",
    "description":"The deposit account owners resource is used to assign owners to a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountOwner-item-response"
    }
}

Nested Schema : Deposit Account Projects

Type: array

Title: Deposit Account Projects

The deposit account projects resource is used to assign projects to a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountProject-item-response

{
    "title":"Deposit Account Projects",
    "type":"array",
    "description":"The deposit account projects resource is used to assign projects to a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountProject-item-response"
    }
}

Nested Schema : Deposit Account Records

Type: array

Title: Deposit Account Records

The deposit account records resource is used to assign transactions to a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountRecord-item-response

{
    "title":"Deposit Account Records",
    "type":"array",
    "description":"The deposit account records resource is used to assign transactions to a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountRecord-item-response"
    }
}

Nested Schema : Deposit Account Users

Type: array

Title: Deposit Account Users

The deposit account users resource is used to assign users to a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountUser-item-response

{
    "title":"Deposit Account Users",
    "type":"array",
    "description":"The deposit account users resource is used to assign users to a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUser-item-response"
    }
}

Nested Schema : Deposit Account User Invites

Type: array

Title: Deposit Account User Invites

The deposit account authorized user invites resource is used to get list of invited users.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountUserInvite-item-response

{
    "title":"Deposit Account User Invites",
    "type":"array",
    "description":"The deposit account authorized user invites resource is used to get list of invited users.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUserInvite-item-response"
    }
}

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 : publicSectorDepositAccounts-DepositAccountActivities-item-response

Type: object

Show Source

• AccountActvtyPuid: string
  Title: Public Unique ID

  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account activity.
• ActivityStatus: string
  Title: Status

  Maximum Length: 30

  Indicates the status of the deposit account activity.
• ActivityStatusDesc: string
  Read Only: true

  Maximum Length: 80

  The descriptive value of the status for the deposit account activity record.
• AgencyId: integer (int32)
  The unique identifier of the agency associated with the deposit account.
• BankAccountTransferNum: integer (int64)
  The unique number sequence assigned to the bank account transfer.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The identifier assigned to classify a source record.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  The value of currency for deposit account activity record.
• DepositAccountKey: integer (int64)
  The unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositAccountPuid: string
  Maximum Length: 480

  The unique alphanumeric public identifier of the deposit account.
• DepositActivityKey: integer (int64)
  Title: Activity Key

  The unique system-generated numeric identifier of an activity recorded for the deposit account.
• DepositActivityOrigin: string
  Title: Activity Origin

  Maximum Length: 30

  Indicates the origin of the deposit account activity.
• DepositActivityReference: string
  Title: Payment Reference

  Maximum Length: 50

  The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.
• DepositActivityType: string
  Title: Activity

  Maximum Length: 30

  Indicates the type of activity recorded for the deposit account.
• DepositActivityTypeDesc: string
  Read Only: true

  Maximum Length: 80

  The descriptive value of the account type for the deposit account activity record.
• DepositAmount: number
  Title: Deposit Amount

  Indicates the amount added to the deposit account.
• FarReceiptStatus: string
  Maximum Length: 30

  Indicates the receivable receipt status associated with the deposit account activity.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  Indicates the user-friendly fee item identifier associated with the deposit account activity.
• FeeRecordKey: integer (int64)
  Title: Fee Record Key

  The unique key of the fee record associated with the deposit account activity record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MigratedDataFlag: string
  Maximum Length: 3

  Default Value: N

  A flag to indicate that the data was migrated from another system.
• PartyId: integer (int64)
  Title: Party ID

  Indicates the applicant or contact party ID for each deposit account activity record.
• PaymentMethodCode: string
  Maximum Length: 30

  Indicates the payment method code associated with the deposit account activity.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Maximum Length: 50

  Indicates the payment reference ID associated with the deposit account activity.
• ProjectCode: string
  Title: Project

  Maximum Length: 30

  Indicates the project associated with the deposit account activity.
• ReceiptLineNumber: integer (int32)
  The line number assigned to each receipt on the cash drawer payment record.
• ReceiptNumber: string
  Maximum Length: 50

  The unique identifier assigned to each receipt on the cash drawer payment record.
• RecordId: string
  Title: Transaction ID

  Maximum Length: 50

  Indicates the user-friendly record identifier associated with the deposit account activity.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier associated with the deposit account activity.
• RefundDate: string (date)
  Title: Refund Date

  Indicates the refund date associated with the deposit account activity.
• RefundMethodCode: string
  Title: Refund Method

  Maximum Length: 30

  Indicates the refund method ID associated with the deposit account activity.
• RefundReasonCode: string
  Title: Refund Reason

  Maximum Length: 30

  Indicates the refund reason code associated with the deposit account activity.
• RefundReferenceId: string
  Title: Refund Reference

  Maximum Length: 50

  Indicates the refund reference ID associated with the deposit account activity.
• SourceRecordKey: integer (int64)
  Title: Source Record Key

  The unique key of the source record associated with the deposit account activity record.
• TransactionDate: string (date)
  Title: Transaction Date

  Indicates the date associated with the deposit account activity.
• TransferAmount: number
  The amount transferred from bank account.
• TransferCurrency: string
  Maximum Length: 3

  The currency of the amount transferred from bank account.
• TransferDate: string (date)
  The date when a bank transfer was submitted.
• TransferFlag: string
  Maximum Length: 1

  Indicates whether an activity should be included for calculating bank transfer amount.
• TransferId: integer (int64)
  The unique identifier of the bank account transfer.
• WithdrawalAmount: number
  Title: Withdrawal Amount

  Indicates the amount subtracted from the deposit account.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":"3",
            "type":"string",
            "description":"A flag to indicate that the data was migrated from another system.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the deposit account activity.",
            "nullable":false,
            "x-queryable":true
        },
        "RefundMethodCode":{
            "title":"Refund Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the refund method ID associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the deposit account.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ActivityStatusDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"The descriptive value of the status for the deposit account activity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositActivityReference":{
            "title":"Payment Reference",
            "maxLength":"50",
            "type":"string",
            "description":"The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the receivable receipt status associated with the deposit account activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number assigned to each receipt on the cash drawer payment record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"The value of currency for deposit account activity record.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the payment reference ID associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique alphanumeric public identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the user-friendly fee item identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the amount transferred from bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether an activity should be included for calculating bank transfer amount.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The identifier assigned to classify a source record.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique record type identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReasonCode":{
            "title":"Refund Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the refund reason code associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityOrigin":{
            "title":"Activity Origin",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the origin of the deposit account activity.",
            "nullable":false,
            "x-queryable":true
        },
        "TransferDate":{
            "type":"string",
            "description":"The date when a bank transfer was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the project associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferId":{
            "type":"integer",
            "description":"The unique identifier of the bank account transfer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordId":{
            "title":"Transaction ID",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the user-friendly record identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Indicates the date associated with the deposit account activity.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier assigned to each receipt on the cash drawer payment record.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityKey":{
            "title":"Activity Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an activity recorded for the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAmount":{
            "title":"Deposit Amount",
            "type":"number",
            "description":"Indicates the amount added to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "BankAccountTransferNum":{
            "type":"integer",
            "description":"The unique number sequence assigned to the bank account transfer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositActivityTypeDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"The descriptive value of the account type for the deposit account activity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundDate":{
            "title":"Refund Date",
            "type":"string",
            "description":"Indicates the refund date associated with the deposit account activity.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "title":"Refund Reference",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the refund reference ID associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment method code associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityType":{
            "title":"Activity",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of activity recorded for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "WithdrawalAmount":{
            "title":"Withdrawal Amount",
            "type":"number",
            "description":"Indicates the amount subtracted from the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "TransferAmount":{
            "type":"number",
            "description":"The amount transferred from bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceRecordKey":{
            "title":"Source Record Key",
            "type":"integer",
            "description":"The unique key of the source record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Indicates the applicant or contact party ID for each deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "title":"Fee Record Key",
            "type":"integer",
            "description":"The unique key of the fee record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountActvtyPuid":{
            "title":"Public Unique ID",
            "maxLength":"480",
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account activity.",
            "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."
        }
    }
}

Nested Schema : publicSectorDepositAccounts-DepositAccountFund-item-response

Type: object

Show Source

• AssetAccountCombination: integer (int64)
  The cash general ledger account code combination to be populated on the external transaction.
• BusinessUnitName: string
  Maximum Length: 360

  The business unit associated to the bank account.
• DepositAccountKey: integer (int64)
  The unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• 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.
• DepositFundKey: integer (int64)
  Title: Deposit Account Fund Key

  The unique record key assigned to the deposit account fund record.
• LetterOfCreditAmount: number
  Title: Amount

  The amount on the letter of credit.
• LetterOfCreditCurrency: string
  Title: Currency

  Maximum Length: 3

  The currency of the amount on the letter of credit.
• LetterOfCreditExpirationDate: string (date)
  Title: Expiration Date

  The date on which the letter of credit expires.
• LetterOfCreditIssuerAddress: string
  Title: Issuer Address

  Maximum Length: 240

  The address of the organization who issued the letter of credit.
• LetterOfCreditIssuerName: string
  Title: Issuer Name

  Maximum Length: 100

  The name of the organization who issued the letter of credit.
• LetterOfCreditNumber: string
  Title: Number

  Maximum Length: 50

  The number assigned to the letter of credit.
• LetterOfCreditRenewFlag: boolean
  Title: Renewable

  Maximum Length: 1

  Indicates whether a letter of credit is renewable upon expiration.
• LetterOfCreditStartDate: string (date)
  Title: Start Date

  The date from which the letter of credit is effective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OffsetAccountCombination: integer (int64)
  The offset general ledger account code combination to be populated on the external transaction.
• SecurityType: string
  Title: Funding Type

  Maximum Length: 30

  Indicates the type of funding provided for the deposit account.
• SecurityTypeDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the type of funding provided for the deposit account.

{
    "type":"object",
    "properties":{
        "OffsetAccountCombination":{
            "type":"integer",
            "description":"The offset general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecurityType":{
            "title":"Funding Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of funding provided for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "SecurityTypeDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the type of funding provided for the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LetterOfCreditIssuerName":{
            "title":"Issuer Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the organization who issued the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":"240",
            "type":"string",
            "description":"The address of the organization who issued the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditNumber":{
            "title":"Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number assigned to the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetAccountCombination":{
            "type":"integer",
            "description":"The cash general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LetterOfCreditExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date on which the letter of credit expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditRenewFlag":{
            "title":"Renewable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a letter of credit is renewable upon expiration.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which the letter of credit is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DepositFundKey":{
            "title":"Deposit Account Fund Key",
            "type":"integer",
            "description":"The unique record key assigned to the deposit account fund record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "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
        },
        "LetterOfCreditCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the amount on the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount on the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "maxLength":"360",
            "type":"string",
            "description":"The business unit associated to the bank account.",
            "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 : publicSectorDepositAccounts-DepositAccountOwner-item-response

Type: object

Show Source

• AccountOwnerPuid: string
  Title: Public Unique ID

  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account owner record.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  First address line of the owner address assigned to the deposit account.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  Second address line of the owner address assigned to the deposit account.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  Third address line of the owner address assigned to the deposit account.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth address line of the owner address assigned to the deposit account.
• City: string
  Title: City

  Maximum Length: 60

  City of the owner address assigned to the deposit account.
• Comments: string
  Title: Comments

  Maximum Length: 480

  Comments provided by user for change of ownership.
• Country: string
  Title: Country

  Maximum Length: 3

  Country of the owner address assigned to the deposit account.
• County: string
  Title: County

  Maximum Length: 60

  County of the owner address assigned to the deposit account.
• DepositAccountKey: integer (int64)
  The unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositAccountPuid: string
  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account record.
• DepositOwnershipKey: integer (int64)
  Title: Ownership Key

  The unique system-generated numeric identifier of an owner assigned to a deposit account.
• EmailAddress: string
  Title: Email Address

  Maximum Length: 320

  Email identifier of the owner assigned to the deposit account.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  First name of the person assigned as owner to the deposit account.
• InactiveReasonCode: string
  Title: Inactive Reason Code

  Maximum Length: 30

  Reason code provided by user for change of ownership.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  Last name of the person assigned as owner to the deposit account.
• LicenseHolderName: string
  Title: License Holder Name

  Maximum Length: 360

  Name on the license provided to establish a deposit account.
• LicenseNumber: string
  Title: License Number

  Maximum Length: 30

  The number of the license provided to establish a deposit account.
• LicenseType: string
  Title: License Type

  Maximum Length: 30

  The type of the license provided to establish a deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  Middle name of the person assigned as owner to the deposit account.
• MigratedDataFlag: string
  Title: Migrated Data

  Read Only: true

  Maximum Length: 3

  Default Value: N

  Identifies whether the ownership record is migrated or not.
• OwnerName: string
  Title: Name

  Maximum Length: 360

  Name of the person or business assigned as owner to the deposit account.
• PartyId: integer (int64)
  Title: Owner Party ID

  Identifier of the party assigned as owner to the deposit account.
• PartyType: string
  Title: Account Owner Type

  Maximum Length: 30

  Identifies the type of the party assigned as owner to the deposit account.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 10

  Phone area code of the owner assigned to the deposit account.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  Phone country code of the owner assigned to the deposit account.
• PhoneExtention: string
  Title: Phone Extension

  Maximum Length: 20

  Phone extension code of the owner assigned to the deposit account.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  Phone number of the owner assigned to the deposit account.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Postal code of the owner address assigned to the deposit account.
• PostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10

  Extended postal code of the owner address assigned to the deposit account.
• PrimaryOwner: boolean
  Title: Primary Owner

  Maximum Length: 1

  Identifies whether the owner is the primary owner or not.
• Province: string
  Title: Province

  Maximum Length: 60

  Province of the owner address assigned to the deposit account.
• State: string
  Title: State

  Maximum Length: 60

  State of the owner address assigned to the deposit account.
• ValidFromDate: string (date-time)
  Title: Valid From

  Identifies the start date of the ownership record.
• ValidToDate: string (date-time)
  Title: Valid To

  Identifies the end date of the ownership record.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "title":"Migrated Data",
            "maxLength":"3",
            "type":"string",
            "description":"Identifies whether the ownership record is migrated or not.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the person or business assigned as owner to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseNumber":{
            "title":"License Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal code of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"County of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneExtention":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"Phone extension code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "LicenseType":{
            "title":"License Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositAccountPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account record.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone area code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone country code of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "InactiveReasonCode":{
            "title":"Inactive Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Reason code provided by user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositOwnershipKey":{
            "title":"Ownership Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an owner assigned to a deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccountOwnerPuid":{
            "title":"Public Unique ID",
            "maxLength":"480",
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account owner record.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyType":{
            "title":"Account Owner Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the type of the party assigned as owner to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "LicenseHolderName":{
            "title":"License Holder Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name on the license provided to establish a deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"Valid To",
            "type":"string",
            "description":"Identifies the end date of the ownership record.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the person assigned as owner to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"480",
            "type":"string",
            "description":"Comments provided by user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third address line of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"First address line of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"City of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"Middle name of the person assigned as owner to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"Email identifier of the owner assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"Province of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryOwner":{
            "title":"Primary Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies whether the owner is the primary owner or not.",
            "nullable":false,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"Extended postal code of the owner address assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Owner Party ID",
            "type":"integer",
            "description":"Identifier of the party assigned as owner to the deposit account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"State of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"Valid From",
            "type":"string",
            "description":"Identifies the start date of the ownership record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"Country of the owner address assigned to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"Phone number of the owner assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the person assigned as owner to the deposit account.",
            "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 : publicSectorDepositAccounts-DepositAccountProject-item-response

Type: object

Show Source

• AssignStatus: string
  Title: Assign Status

  Maximum Length: 1

  Status of the project assignment.
• DepositAccountKey: integer (int64)
  Unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  Unique agency-defined alphanumeric identifier of the deposit account.
• DepositProjectKey: integer (int64)
  Title: Project Key

  Unique system-generated numeric identifier of a project assigned to a deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryAccountFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the deposit account is the primary account for the specified project.
• ProjectCode: string
  Title: Project Code

  Maximum Length: 30

  Unique agency-defined alphanumeric identifier of a project assigned to a deposit account.

{
    "type":"object",
    "properties":{
        "DepositProjectKey":{
            "title":"Project Key",
            "type":"integer",
            "description":"Unique system-generated numeric identifier of a project assigned to a deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique agency-defined alphanumeric identifier of a project assigned to a deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"Unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignStatus":{
            "title":"Assign Status",
            "maxLength":"1",
            "type":"string",
            "description":"Status of the project assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryAccountFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the deposit account is the primary account for the specified project.",
            "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 : publicSectorDepositAccounts-DepositAccountRecord-item-response

Type: object

Show Source

• AllRecords: string
  Title: All Records

  Maximum Length: 1

  The value that identifies whether the transaction association applies to all records.
• AllRecordsDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the value that identifies whether the transaction association applies to all records.
• AssignStatus: string
  Title: Assign Status

  Maximum Length: 1

  The status of the transaction's assignment to the deposit account.
• AssignStatusDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the status of the transaction's assignment to the deposit account.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The reason code provided by the user for change of ownership.
• DepositAccountKey: integer (int64)
  The unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositRecordKey: integer (int64)
  Title: Transaction Key

  The unique system-generated numeric identifier of a transaction assigned to the deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryAccount: string
  Title: Primary Account

  Maximum Length: 1

  Indicates whether the deposit account is the primary account for the transaction.
• PrimaryAccountDesc: string
  Read Only: true

  Maximum Length: 80

  Describes whether the deposit account is the primary account for the transaction. The default value is Y.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The unique record type assigned to the deposit account.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier assigned to the deposit account.
• SourceRecordId: string
  Title: Transaction ID

  Maximum Length: 50

  The user-friendly record identifier assigned to the deposit account.
• SourceRecordKey: integer (int64)
  Title: Source Record Key

  The key of the source record assigned to the deposit account.

{
    "type":"object",
    "properties":{
        "AllRecords":{
            "title":"All Records",
            "maxLength":"1",
            "type":"string",
            "description":"The value that identifies whether the transaction association applies to all records.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositRecordKey":{
            "title":"Transaction Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of a transaction assigned to the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrimaryAccount":{
            "title":"Primary Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the deposit account is the primary account for the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryAccountDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes whether the deposit account is the primary account for the transaction. The default value is Y.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllRecordsDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the value that identifies whether the transaction association applies to all records.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceRecordKey":{
            "title":"Source Record Key",
            "type":"integer",
            "description":"The key of the source record assigned to the deposit account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique record type assigned to the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The reason code provided by the user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignStatusDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the status of the transaction's assignment to the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique record type identifier assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRecordId":{
            "title":"Transaction ID",
            "maxLength":"50",
            "type":"string",
            "description":"The user-friendly record identifier assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignStatus":{
            "title":"Assign Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the transaction's assignment to the deposit account.",
            "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 : publicSectorDepositAccounts-DepositAccountUser-item-response

Type: object

Show Source

• AssignStatus: string
  Title: Status

  Maximum Length: 1

  Indicates the status of the authorized user's assignment.
• DepositAccountAccess: array Deposit Account Access
  Title: Deposit Account Access

  The deposit account access resource is used to grant access to users for a deposit account.
• DepositAccountKey: integer (int64)
  Unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  Unique agency-defined alphanumeric identifier of the deposit account.
• DepositApplicantKey: integer (int64)
  Unique system-generated numeric identifier of the deposit account authorized user.
• EmailAddress: string
  Title: Email Address

  Maximum Length: 320

  Indicates the authorized user's email address.
• InvitedBy: string
  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates whether a person was invited by an owner or agency staff.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether authorized user is owner of the deposit account.
• PartyId: integer (int64)
  Title: Authorized User Party ID

  Indicates the authorized user's party ID.
• UserName: string
  Title: Name

  Maximum Length: 360

  The name of the user eligible to access a deposit account record.

{
    "type":"object",
    "properties":{
        "InvitedBy":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether a person was invited by an owner or agency staff.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-queryable":true
        },
        "UserName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user eligible to access a deposit account record.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositApplicantKey":{
            "type":"integer",
            "description":"Unique system-generated numeric identifier of the deposit account authorized user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Authorized User Party ID",
            "type":"integer",
            "description":"Indicates the authorized user's party ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether authorized user is owner of the deposit account.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"Unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"Indicates the authorized user's email address.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignStatus":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the status of the authorized user's assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountAccess":{
            "title":"Deposit Account Access",
            "type":"array",
            "description":"The deposit account access resource is used to grant access to users for a deposit account.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response"
            }
        }
    }
}

Nested Schema : Deposit Account Access

Type: array

Title: Deposit Account Access

The deposit account access resource is used to grant access to users for a deposit account.

Show Source

• Array of: object publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response

{
    "title":"Deposit Account Access",
    "type":"array",
    "description":"The deposit account access resource is used to grant access to users for a deposit account.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response"
    }
}

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 : publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response

Type: object

Show Source

• AccessCode: string
  Title: Access Code

  Maximum Length: 30

  Indicates an action the authorized user can perform for the deposit account.
• DepositAccountKey: integer (int64)
  Unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  Unique agency-defined alphanumeric identifier of the deposit account.
• DepositApplicantKey: integer (int64)
  Unique system-generated numeric identifier of the deposit account authorized user.
• DepositPermissionKey: integer (int64)
  Unique system-generated numeric identifier of the deposit account permission.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether an action is enabled for the authorized user for the deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  The party identifier of the authorized user.
• UserName: string
  Title: Name

  Maximum Length: 360

  The name of the user eligible to perform an action for a deposit account record.

{
    "type":"object",
    "properties":{
        "UserName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user eligible to perform an action for a deposit account record.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositApplicantKey":{
            "type":"integer",
            "description":"Unique system-generated numeric identifier of the deposit account authorized user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The party identifier of the authorized user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositPermissionKey":{
            "type":"integer",
            "description":"Unique system-generated numeric identifier of the deposit account permission.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccessCode":{
            "title":"Access Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates an action the authorized user can perform for the deposit account.",
            "nullable":false,
            "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",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an action is enabled for the authorized user for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"Unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : publicSectorDepositAccounts-DepositAccountUserInvite-item-response

Type: object

Show Source

• DepositAccountKey: integer (int64)
  The unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• EmailAddress: string
  Title: Email Address

  Maximum Length: 320

  The email address of the user invited to be an authorized user.
• InvitedBy: string
  Title: Invitation Source

  Maximum Length: 20

  Indicates whether an authorized user was invited by an owner or agency staff.
• InviteKey: integer (int64)
  Title: Invite Key

  The unique system-generated numeric identifier of the deposit account user invite.
• InviteStatus: string
  Title: Invite Status

  Maximum Length: 30

  The status of the invite sent to authorize users.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserAccess: string
  Title: User Access

  Maximum Length: 1000

  The user access provided to the invited user.
• UserName: string
  Title: User Name

  Maximum Length: 360

  The name of the user invited to be an authorized user.

{
    "type":"object",
    "properties":{
        "InvitedBy":{
            "title":"Invitation Source",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates whether an authorized user was invited by an owner or agency staff.",
            "nullable":false,
            "x-queryable":true
        },
        "InviteStatus":{
            "title":"Invite Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the invite sent to authorize users.",
            "nullable":false,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user invited to be an authorized user.",
            "nullable":false,
            "x-queryable":true
        },
        "InviteKey":{
            "title":"Invite Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account user invite.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "UserAccess":{
            "title":"User Access",
            "maxLength":"1000",
            "type":"string",
            "description":"The user access provided to the invited user.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user invited to be an authorized user.",
            "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"
    }
}

Back to Top