syntax = "proto3"; package fincleartech.ibroker; option java_package = "io.fincleartech.protobuf.ibroker.accounts"; option java_multiple_files = true; import "google/protobuf/wrappers.proto"; import "google/protobuf/empty.proto"; import "google/rpc/status.proto"; import "fincleartech/ibroker/common.proto"; message FinancialSettlementDetails { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; // Unique iBROKER Settlement Details Identifier for this specific method // Maximum size 9 google.protobuf.StringValue financial_settlement_details_id = 2; // Bank BSB Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 7 google.protobuf.StringValue bsb_number = 3; // Bank Account Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 9 google.protobuf.StringValue bank_account_number = 4; // Bank Account Name // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 100 google.protobuf.StringValue bank_account_name = 5; // Flag indicating if this method is approved for direct debit. google.protobuf.BoolValue direct_debit = 6; // Flag indicating if this method is the default payment method for the account. // Can only be one default Payment for an account google.protobuf.BoolValue default_payment = 7; // Flag indicating if this method is the default receipt method for the account. // Can only be one default Receipt for an account google.protobuf.BoolValue default_receipt = 8; // Flag indicating if this method is currently active. google.protobuf.BoolValue current = 9; // CMT fund code. // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue cmt_fund = 10; // Used for criteria to generate payments // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue payment_gen_method = 11; // Used for criteria to generate receipts // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue receipt_gen_method = 12; // Financial settlement method, identifies how the this method will be settled financially // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue settlement_type = 13; // Flag indicating if automatic financial contra is enabled for this method. google.protobuf.BoolValue auto_contra = 14; // Ability to group financial settlements within the same logical business function i.e. Margin lending accounts // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue settlement_group = 15; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Maximum size 4 google.protobuf.StringValue hold_reason = 16; // The iBroker user id of the last user to modify the method. // Available options as defined in iBROKER // Maximum size 18 google.protobuf.StringValue user_id = 17; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 18; } message CreateFinancialSettlementDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // Bank BSB Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 7 google.protobuf.StringValue bsb_number = 3; // Bank Account Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 9 google.protobuf.StringValue bank_account_number = 4; // Bank Account Name // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 100 google.protobuf.StringValue bank_account_name = 5; // Flag indicating if this method is approved for direct debit. google.protobuf.BoolValue direct_debit = 6; // Flag indicating if this method is the default payment method for the account. // Can only be one default Payment for an account google.protobuf.BoolValue default_payment = 7; // Flag indicating if this method is the default receipt method for the account. // Can only be one default Receipt for an account google.protobuf.BoolValue default_receipt = 8; // Flag indicating if this method is currently active. google.protobuf.BoolValue current = 9; // CMT fund code. // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue cmt_fund = 10; // Used for criteria to generate payments // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue payment_gen_method = 11; // Used for criteria to generate receipts // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue receipt_gen_method = 12; // Financial settlement method, identifies how the this method will be settled financially // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue settlement_type = 13; // Flag indicating if automatic financial contra is enabled for this method. google.protobuf.BoolValue auto_contra = 14; // Ability to group financial settlements within the same logical business function i.e. Margin lending accounts // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue settlement_group = 15; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Maximum size 4 google.protobuf.StringValue hold_reason = 16; // The iBROKER user id to record as the modifier. google.protobuf.StringValue user_id = 17; } message CreateFinancialSettlementDetailsResponse { // Response Status. When status code is OK, response body will be populated. google.rpc.Status status = 1; // iBroker Account Number google.protobuf.StringValue account_number = 2; // Unique iBROKER Settlement Details Identifier for this specific method google.protobuf.StringValue financial_settlement_details_id = 3; } message UpdateFinancialSettlementDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // Unique iBROKER Settlement Details Identifier for this specific method google.protobuf.StringValue financial_settlement_details_id = 3; // Bank BSB Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 7 google.protobuf.StringValue bsb_number = 4; // Bank Account Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 9 google.protobuf.StringValue bank_account_number = 5; // Bank Account Name // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 100 google.protobuf.StringValue bank_account_name = 6; // Flag indicating if this method is approved for direct debit. google.protobuf.BoolValue direct_debit = 7; // Flag indicating if this method is the default payment method for the account. // Can only be one default Payment for an account google.protobuf.BoolValue default_payment = 8; // Flag indicating if this method is the default receipt method for the account. // Can only be one default Receipt for an account google.protobuf.BoolValue default_receipt = 9; // Flag indicating if this method is currently active. google.protobuf.BoolValue current = 10; // CMT fund code. // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue cmt_fund = 11; // Used for criteria to generate payments // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue payment_gen_method = 12; // Used for criteria to generate receipts // Available options as defined in iBROKER // Maximum size 1 google.protobuf.StringValue receipt_gen_method = 13; // Flag indicating if automatic financial contra is enabled for this method. google.protobuf.BoolValue auto_contra = 14; // Ability to group financial settlements within the same logical business function i.e. Margin lending accounts // Available options as defined in iBROKER // Maximum size 5 google.protobuf.StringValue settlement_group = 15; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Maximum size 4 google.protobuf.StringValue hold_reason = 16; // The last modification date before this update. fincleartech.ibroker.DateTimeValue entry_date_time = 17; // The iBroker user id to record as the modifier. google.protobuf.StringValue user_id = 18; } message UpdateFinancialSettlementDetailsResponse { // Response Status. google.rpc.Status status = 1; } message GetFinancialSettlementDetailsRequest { // iBroker Account Number google.protobuf.StringValue account_number = 1; // iBroker Settlement Details Identifier google.protobuf.StringValue financial_settlement_details_id = 2; } message GetFinancialSettlementDetailsResponse { // Response Status. When status code is OK, response body will be populated. google.rpc.Status status = 1; // Details for the requested settlement method. FinancialSettlementDetails financial_settlement_details = 2; } message DistributionDetails { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; // The type of document associated with the account produced within iBROKER (CNOT - Contract Note, ETTS - Options Trading Statement) // Available options as defined in iBROKER // Maximum size 12 google.protobuf.StringValue delivery_type = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email, POST - Standard Postal services) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 3; // The source information that will be utilised in the distribution of the document. // Available options as defined in iBROKER linked to the communication type // Maximum size 2 google.protobuf.StringValue communication_destination_type = 4; // Flag indicating if this is to distribiute the original contract note google.protobuf.BoolValue cnote_original = 5; // The number of copies for the distribution // Valid Values are Numeric // Maximum size 3 fincleartech.ibroker.NumberValue cnote_copies = 6; // Defines the server that will be utilised to distribute the documents // Available options for communication_type = POST as defined in iBROKER otherwise must be the same as communication_type // Maximum size 10 google.protobuf.StringValue distribution_server = 7; // Licensed parameter option, if not licensed the value must be set to false. google.protobuf.BoolValue fallback_record = 8; // Flag indicating if distribution is active google.protobuf.BoolValue current = 9; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 10; } message CreateDistributionDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The type of document associated with the account produced within iBROKER (CNOT - Contract Note, ETTS - Options Trading Statement) // Available options as defined in iBROKER // Maximum size 12 google.protobuf.StringValue delivery_type = 3; // The method how the distribution will be transmitted (EMAIL - Electronic email, POST - Standard Postal services) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 4; // The source information that will be utilised in the distribution of the document. // Available options as defined in iBROKER linked to the communication type // Maximum size 2 google.protobuf.StringValue communication_destination_type = 5; // Flag indicating if this is to distribiute the original contract note google.protobuf.BoolValue cnote_original = 6; // The number of copies for the distribution // Valid Values are Numeric // Maximum size 3 fincleartech.ibroker.NumberValue cnote_copies = 7; // Defines the server that will be utilised to distribute the documents // Available options for communication_type = POST as defined in iBROKER otherwise must be the same as communication_type // Maximum size 10 google.protobuf.StringValue distribution_server = 8; // Licensed parameter option, if not licensed the value must be set to false. google.protobuf.BoolValue fallback_record = 9; // Flag indicating if distribution is active google.protobuf.BoolValue current = 10; } message CreateDistributionDetailsResponse { // Response Status. google.rpc.Status status = 1; } message UpdateDistributionDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The type of document associated with the account produced within iBROKER (CNOT - Contract Note, ETTS - Options Trading Statement) // Available options as defined in iBROKER // Maximum size 12 google.protobuf.StringValue delivery_type = 3; // The method how the distribution will be transmitted (EMAIL - Electronic email, POST - Standard Postal services) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 4; // The source information that will be utilised in the distribution of the document. // Available options as defined in iBROKER linked to the communication type // Maximum size 2 google.protobuf.StringValue communication_destination_type = 5; // Flag indicating if this is to distribiute the original contract note google.protobuf.BoolValue cnote_original = 6; // The number of copies for the distribution // Valid Values are Numeric // Maximum size 3 fincleartech.ibroker.NumberValue cnote_copies = 7; // Defines the server that will be utilised to distribute the documents // Available options for communication_type = POST as defined in iBROKER otherwise must be the same as communication_type // Maximum size 10 google.protobuf.StringValue distribution_server = 8; // Licensed parameter option, if not licensed the value must be set to false. google.protobuf.BoolValue fallback_record = 9; // Flag indicating if distribution is active google.protobuf.BoolValue current = 10; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 11; } message UpdateDistributionDetailsResponse { // Response Status. google.rpc.Status status = 1; } message GetDistributionDetailsRequest { google.protobuf.StringValue account_number = 1; } message GetDistributionDetailsResponse { // Response Status. google.rpc.Status status = 1; // distribution details repeated DistributionDetails distribution_detail = 2; } message CommunicationDetails { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 2; // The reference for the type of distribution linked to the communication_type (HOME - Home email address) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_destination_type = 3; // The details of the address that will be distributed to such as email address. // Maximum size 100 google.protobuf.StringValue communication_data = 4; // General remarks held against the method // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 5; // Flag indicating if communication is active google.protobuf.BoolValue current = 6; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 10; } message CreateCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 3; // The reference for the type of distribution linked to the communication_type (HOME - Home email address) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active google.protobuf.BoolValue current = 7; } message CreateCommunicationDetailsResponse { // Response Status. google.rpc.Status status = 1; } message UpdateCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_type = 3; // The reference for the type of distribution linked to the communication_type (HOME - Home email address) // Available options as defined in iBROKER // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active google.protobuf.BoolValue current = 7; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 8; } message UpdateCommunicationDetailsResponse { // Response Status. google.rpc.Status status = 1; } message GetCommunicationDetailsRequest { google.protobuf.StringValue account_number = 1; } message GetCommunicationDetailsResponse { // Response Status. google.rpc.Status status = 1; repeated CommunicationDetails communication_detail = 2; } message CreateClientRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // The last name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 60 google.protobuf.StringValue last_name = 2; // The first name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 10 google.protobuf.StringValue first_name = 3; // The Salutation (if Any) the Client has // Optional Maximum size 15 google.protobuf.StringValue salutation = 4; // If the client is an organisation, the name of the organisation // Optional, although mandatory if the client_type = 'O' (Organisation) // Maximum size 200 google.protobuf.StringValue organisation_name = 5; // An internal reference that can be used to refer to the client // Optional, maximum size 60 google.protobuf.StringValue internal_reference = 6; // Identifies if the client is an Individual or Organisation // Mandatory // Available options as defined in iBROKER. Currently the only values are I (Individual) O (Organisation) // Maximum size 1 google.protobuf.StringValue client_type = 7; // Flag indicating if client is active google.protobuf.BoolValue current = 8; // Identifies the date of birth for the individual // Optional, only enterable if client_type = 'I' (Individual) fincleartech.ibroker.DateTimeValue date_of_birth = 9; // The name of the clients mother. For security and verification purposes. // Optional, only enterable if Individual // Maximum size 50 google.protobuf.StringValue mothers_name = 10; // Identifies the gender of the client // Available options as defined in iBROKER. Currently the only values are M - Male, F - Female // Maximum size 1 google.protobuf.StringValue gender = 11; // The name of the clients employer, used for security and verification purposes // Only enterable if Individual // Maximum size 50 google.protobuf.StringValue employee_name = 12; // The Australian Company number (ACN) // Optional, must be entered for Client Type of Organisation // Maximum size 20 google.protobuf.StringValue acn = 13; // Free format comments that can be held against each client // Optional // Maximum size 200 google.protobuf.StringValue client_comments = 15; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 16; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 17; // The position of the last name for display purposes. // Acceptable values are L - Last, F First // Maximum size 1 google.protobuf.StringValue last_name_position = 18; // The date on which the organisation was incorporated (Only valid for Client Type = Organisation) fincleartech.ibroker.DateTimeValue date_incorporated = 19; // The Legal Identity Indentifier (LEI) of the organisation (Only valid for Client Type = Organisation) // Optional // Maximu size 20 google.protobuf.StringValue legal_entity_identifier = 20; // The type of the investor // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue investor_type = 21; // The Tax File Number for the Individual or Organisation // Optional - Only a TFN or ABN can be entered // Maximum size 12 google.protobuf.StringValue tfn = 22; // The Australian Business Number of the Individual or Organisation // Optional - Only a TFN or a ABN can be entered. // Maximum size 11 google.protobuf.StringValue abn = 23; // The preference from the client on sending the Tax File Number and/or ABN. // Acceptable values are T - TFN or A - ABN // Mandatory // Maximum size 1 google.protobuf.StringValue tfn_preference = 24; // The date on which the Tax File Number or ABN Australian Business Number was received. fincleartech.ibroker.DateTimeValue date_received = 25; // The tax exemption code for the Tax File Number // Available options as defined in iBROKER. // Optional // Maximum size 1 google.protobuf.StringValue tfn_exempt_code = 26; // The expiry date that relates to the Tax Exemption code fincleartech.ibroker.DateTimeValue tfn_exempt_expiry_date = 27; } message CreateClientResponse { // Response Status. google.rpc.Status status = 1; google.protobuf.StringValue client_number = 2; } message UpdateClientRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // The unique identifier of the client. // Maximum size 8 google.protobuf.StringValue client_number = 2; // The last name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 60 google.protobuf.StringValue last_name = 3; // The first name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 10 google.protobuf.StringValue first_name = 4; // The Salutation (if Any) the Client has // Optional // Maximum size 15 google.protobuf.StringValue salutation = 5; // If the client is an organisation, the name of the organisation // Optional, although mandatory if the client_type = 'O' (Organisation) // Maximum size 200 google.protobuf.StringValue organisation_name = 6; // An internal reference that can be used to refer to the client // Optional, maximum size 60 google.protobuf.StringValue internal_reference = 7; // Identifies if the client is an Individual or Organisation // Mandatory // Available options as defined in iBROKER. Currently the only values are I (Individual) O (Organisation) // Maximum size 1 google.protobuf.StringValue client_type = 8; // Flag indicating if client is active google.protobuf.BoolValue current = 9; // Identifies the date of birth for the individual // Optional, only enterable if client_type = 'I' (Individual) fincleartech.ibroker.DateTimeValue date_of_birth = 10; // The mothers maiden name, used for security purposes // Maximum size 50 google.protobuf.StringValue mothers_name = 11; // Identifies the gender of the client // Available options as defined in iBROKER. Currently the only values are M - Male, F - Female // Maximum size 1 google.protobuf.StringValue gender = 12; // The name of the clients employer, used for security and verification purposes // Only enterable if Individual // Maximum size 50 google.protobuf.StringValue employee_name = 13; // The Australian Company number (ACN) // Optional, must be entered for Client Type of Organisation // Maximum size 20 google.protobuf.StringValue acn = 14; // Which feature/stored procedure the client was created // Optional // Maximum size 50 google.protobuf.StringValue creation_source = 15; // Free format comments that can be held against each client // Optional // Maximum size 200 google.protobuf.StringValue client_comments = 16; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 17; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 18; // The position of the last name for display purposes. // Acceptable values are L - Last, F First // Maximum size 1 google.protobuf.StringValue last_name_position = 19; // The date on which the organisation was incorporated (Only valid for Client Type = Organisation) fincleartech.ibroker.DateTimeValue date_incorporated = 20; // The Legal Identity Indentifier (LEI) of the organisation (Only valid for Client Type = Organisation) // Optional // Maximu size 20 google.protobuf.StringValue legal_entity_identifier = 21; // The type of the investor // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue investor_type = 22; // The Tax File Number for the Individual or Organisation // Optional - Only a TFN or ABN can be entered // Maximum size 12 google.protobuf.StringValue tfn = 23; // The Australian Business Number of the Individual or Organisation // Optional - Only a TFN or a ABN can be entered. // Maximum size 11 google.protobuf.StringValue abn = 24; // The preference from the client on sending the Tax File Number and/or ABN. // Acceptable values are T - TFN or A - ABN // Mandatory // Maximum size 1 google.protobuf.StringValue tfn_preference = 25; // The date on which the Tax File Number or ABN Australian Business Number was received. fincleartech.ibroker.DateTimeValue date_received = 26; // The tax exemption code for the Tax File Number // Available options as defined in iBROKER. // Optional // Maximum size 1 google.protobuf.StringValue tfn_exempt_code = 27; // The expiry date that relates to the Tax Exemption code fincleartech.ibroker.DateTimeValue tfn_exempt_expiry_date = 28; } message UpdateClientResponse { // Response Status. google.rpc.Status status = 1; } message GetClientRequest { google.protobuf.StringValue client_number = 1; } message GetClientResponse { // Response Status. google.rpc.Status status = 1; // The last name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 60 google.protobuf.StringValue last_name = 2; // The first name the client is known by // Optional, although mandatory if the client_type = 'I' (Individual) // Maximum size 10 google.protobuf.StringValue first_name = 3; // The Salutation (if Any) the Client has // Optional // Maximum size 15 google.protobuf.StringValue salutation = 4; // If the client is an organisation, the name of the organisation // Optional, although mandatory if the client_type = 'O' (Organisation) // Maximum size 200 google.protobuf.StringValue organisation_name = 5; // An internal reference that can be used to refer to the client // Optional, maximum size 60 google.protobuf.StringValue internal_reference = 6; // Identifies if the client is an Individual or Organisation // Mandatory // Available options as defined in iBROKER. Currently the only values are I (Individual) O (Organisation) // Maximum size 1 google.protobuf.StringValue client_type = 7; // Flag indicating if client is active google.protobuf.BoolValue current = 8; // Identifies the date of birth for the individual // Optional, only enterable if client_type = 'I' (Individual) fincleartech.ibroker.DateTimeValue date_of_birth = 9; // The mothers maiden name, used for security purposes // Maximum size 50 google.protobuf.StringValue mothers_name = 10; // Identifies the gender of the client // Available options as defined in iBROKER. Currently the only values are M - Male, F - Female // Maximum size 1 google.protobuf.StringValue gender = 11; // The name of the clients employer, used for security and verification purposes // Only enterable if Individual // Maximum size 50 google.protobuf.StringValue employee_name = 12; // The Australian Company number (ACN) // Optional, must be entered for Client Type of Organisation // Maximum size 20 google.protobuf.StringValue acn = 13; // Which feature/stored procedure the client was created // Optional // Maximum size 50 google.protobuf.StringValue creation_source = 14; // Free format comments that can be held against each client // Optional // Maximum size 200 google.protobuf.StringValue client_comments = 15; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 16; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 17; // The position of the last name for display purposes. // Acceptable values are L - Last, F First // Maximum size 1 google.protobuf.StringValue last_name_position = 18; // The date on which the organisation was incorporated (Only valid for Client Type = Organisation) fincleartech.ibroker.DateTimeValue date_incorporated = 19; // The Legal Identity Indentifier (LEI) of the organisation (Only valid for Client Type = Organisation) // Optional // Maximu size 20 google.protobuf.StringValue legal_entity_identifier = 20; // The type of the investor // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue investor_type = 21; // The Tax File Number for the Individual or Organisation // Optional - Only a TFN or ABN can be entered // Maximum size 12 google.protobuf.StringValue tfn = 22; // The Australian Business Number of the Individual or Organisation // Optional - Only a TFN or a ABN can be entered. // Maximum size 11 google.protobuf.StringValue abn = 23; // The preference from the client on sending the Tax File Number and/or ABN. // Acceptable values are T - TFN or A - ABN // Mandatory // Maximum size 1 google.protobuf.StringValue tfn_preference = 24; // The date on which the Tax File Number or ABN Australian Business Number was received. fincleartech.ibroker.DateTimeValue date_received = 25; // The tax exemption code for the Tax File Number // Available options as defined in iBROKER. // Optional // Maximum size 1 google.protobuf.StringValue tfn_exempt_code = 26; // The expiry date that relates to the Tax Exemption code fincleartech.ibroker.DateTimeValue tfn_exempt_expiry_date = 27; } message CreateClientAccountRelationshipRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The unique identifier of a client // Mandatory // Maximum size 8 google.protobuf.StringValue client_number = 3; // Code that points to the rate of withholding tax available for the client // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue withholding_tax_code = 8; /// Flag indicating if client is active google.protobuf.BoolValue current = 9; // The type of relationship the client has with the account // Available options as defined in iBROKER. // Mandatory // Maximum size 3 google.protobuf.StringValue relationship_type = 12; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 13; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 14; // The sequence the holder should be displayed // Mandatory // Maximum size 38 google.protobuf.StringValue holder_sequence = 15; } message CreateClientAccountRelationshipResponse { // Response Status. google.rpc.Status status = 1; } message UpdateClientAccountRelationshipRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // The unique identifier of a client // Mandatory // Maximum size 8 google.protobuf.StringValue client_number = 3; // The type of relationship the client has with the account // Available options as defined in iBROKER. // Mandatory // Maximum size 3 google.protobuf.StringValue relationship_type = 12; // Code that points to the rate of withholding tax available for the client // Optional // Maximum size 4 google.protobuf.StringValue withholding_tax_code = 8; // Flag indicating if client is active google.protobuf.BoolValue current = 9; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 13; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 14; // The sequence the holder should be displayed // Mandatory // Maximum size 38 google.protobuf.StringValue holder_sequence = 15; } message UpdateClientAccountRelationshipResponse { // Response Status. google.rpc.Status status = 1; } message GetClientAccountRelationshipRequest { // The unique identifier of a client // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 1; // The unique identifier of a client // Mandatory // Maximum size 8 google.protobuf.StringValue client_number = 2; // The type of relationship the client has with the account // Available options as defined in iBROKER. // Mandatory // Maximum size 3 google.protobuf.StringValue relationship_type = 3; } message GetClientAccountRelationshipResponse { // Response Status. google.rpc.Status status = 1; // Code that points to the rate of withholding tax available for the client // Optional // Maximum size 4 google.protobuf.StringValue withholding_tax_code = 6; // Flag indicating if client is active google.protobuf.BoolValue current = 7; // The date on which the client was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 11; // The identification of the user who created the client // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 12; // The sequence the holder should be displayed // Mandatory // Maximum size 38 google.protobuf.StringValue holder_sequence = 13; } message Address { // First line of the address // Mandatory // Maximum size 40 google.protobuf.StringValue address_line_1 = 1; // Second line of the address // Mandatory // Maximum size 40 google.protobuf.StringValue address_line_2 = 2; // Third line of the address // Mandatory // Maximum size 40 google.protobuf.StringValue address_line_3 = 3; // The town which the address is located // Mandatory // Maximum size 35 google.protobuf.StringValue town = 4; // The state which the address is located // Mandatory // Maximum size 35 google.protobuf.StringValue state = 5; // The postcode which the address is located // Mandatory // Maximum size 16 google.protobuf.StringValue post_code = 6; // The country code which the address is located // Available options as defined in iBROKER. // Mandatory // Maximum Size 2 google.protobuf.StringValue country = 7; } message CreateEquityAccountRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Flag indicating if equity account is active google.protobuf.BoolValue current = 2; // The account name of the equity account is known as // Mandatory // Maximum size 350 google.protobuf.StringValue account_name = 3; // Any title associated with the equity account // Optional // Maximu size 60 google.protobuf.StringValue account_title = 4; // The surname of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue surname = 5; // The given name of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue given_name = 6; // Any salutation associated with the equity account // Optional // Maximum size 15 google.protobuf.StringValue salutation = 7; // The type of equity account (from an iBROKER perspective), this account type will associate the types of processing the acocunt is capable of. // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue account_type = 8; // The sub classification of type of equity account (from an iBROKER perspective) // Available options as defined in iBROKER. // Optional // Maximum size 1 google.protobuf.StringValue account_sub_type = 9; // The password associated with the account // Optional // Maximum size 255 google.protobuf.StringValue password = 10; // A series of single character codes the account may have interest in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 1 character each code with a maximum of 8 interests google.protobuf.StringValue interest_codes = 11; // A series of two character codes the account may have an occupation in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 2 character each code with a maximum of 9 occupations google.protobuf.StringValue occupation_codes = 12; // The business contact telephone number for the account. // Optional // Maximum size 20 google.protobuf.StringValue business_phone = 13; // The private contact telephone number for the account. // Optional // Maximum size 20 google.protobuf.StringValue private_phone = 14; // The fax telephone number for the account. // Optional // Maximum size 20 google.protobuf.StringValue fax = 15; // The mobile contact telephone number for the account. // Optional // Maximum size 20 google.protobuf.StringValue mobile_phone = 16; // Indicator to identify if the account is a portfolio account google.protobuf.BoolValue portfolio_holding = 17; // Indicator to identify if the account is a sponsored account google.protobuf.BoolValue sponsored = 18; // The name used for any standard mail-outs // Mandatory // Maximum size 350 google.protobuf.StringValue mail_account_name = 19; // The designation used for any standard mail-outs // Optional // Maximum size 35 google.protobuf.StringValue mail_designation = 20; // The addressee used for any standard mail-outs // Optional // Maximum size 80 google.protobuf.StringValue mail_addressee = 21; // Mailing address structure Address mail_address = 22; // The account name used for any registrations of issuer sponsored stock // Mandatory // Maximum size 350 google.protobuf.StringValue registration_account_name = 29; // The designation used for any registrations of issue sponsored stock // Optional // Maximum size 35 google.protobuf.StringValue registration_designation = 30; // The addressee used for any registrations of issuer sponsored stock // Optional // Maximum size 80 google.protobuf.StringValue registration_addressee = 31; // Registration address structure Address registration_address = 32; // The country code which the address is located // Available options as defined in iBROKER. // Optional // Maximum Size 2 google.protobuf.StringValue country_code = 39; // The code for the adviser allocated to the equity account // Available options as defined in iBROKER. // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 40; // A quick access reference key for the equity account // Mandatory // Maximum size 6 google.protobuf.StringValue account_code = 43; // The branch that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 44; // The department that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 45; // Identifies if the client is regarded as being a bad debt google.protobuf.BoolValue bad_debt = 46; // The predfined scale at which the brokerage will be charged on contract notes // Available options as defined in iBROKER. // Mandatory // Maximum size 8 google.protobuf.StringValue brokerage = 48; // Identifies if the account is permitted to short sell google.protobuf.BoolValue allow_short_sell = 49; // Identifies if the registration address should be used when printing contract notes replacing the mailing address google.protobuf.BoolValue include_registration_address = 50; // Identifies the default for obligations created for the account if they can be partially delivered to/from the account google.protobuf.BoolValue part_settle = 51; // Identifies the types of markets the account can trade in. For this account it must be EQTY // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue market_type = 52; // The participant Identifier the account is associated with // Optional // Maximum size 5 google.protobuf.StringValue participant_id = 53; // An external identifier that can be used when accessing an account // Optional // Maximum size 8 google.protobuf.StringValue alternate_account_number = 54; // Identifies if the standard trust processing is included for the equity account google.protobuf.BoolValue trust = 55; // The general residency of the account in regards to Foreign ownership. // Available options as defined in iBROKER. // Mandatory // Maximuum size 1 google.protobuf.StringValue residency = 56; // Indicates where Billing is applicable for the account exempt or waived // Optional // Maximum size 4 google.protobuf.StringValue default_event_action = 57; // The email address of the equity account // Optional // Maximum size 100 google.protobuf.StringValue email_address = 58; // Purpose for which the email address is used // Mandatory if the email address is entered // Maximum size 1 google.protobuf.StringValue email_purpose = 59; // Indicates whether the account has authority to send holding Advise details google.protobuf.BoolValue hold_det_authority = 60; // Indicates the bank details will default from the account for the Hin google.protobuf.BoolValue hold_det_default = 61; // The type of GST the account is trading under // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue gst_code = 62; // The first client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_1 = 63; // The second client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_2 = 64; // The third client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_3 = 65; // The fourth client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_4 = 66; // The date/time the equity acocunt was created fincleartech.ibroker.DateTimeValue entry_date_time = 67; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 68; } message CreateEquityAccountResponse { // Response Status. google.rpc.Status status = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; } message UpdateEquityAccountRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // Flag indicating if equity account is active google.protobuf.BoolValue current = 3; // The account name of the equity name is known as // Mandatory // Maximum size 350 google.protobuf.StringValue account_name = 4; // Any title associated with the account // Optional // Maximu size 60 google.protobuf.StringValue account_title = 5; // The surname of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue surname = 6; // The given name of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue given_name = 7; // Any salutation associated with the equity account // Optional // Maximum size 15 google.protobuf.StringValue salutation = 8; // The sub classification of type of account (from an iBROKER perspective) // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue account_sub_type = 10; // The password associated with the equity account // Optional // Maximum size 255 google.protobuf.StringValue password = 11; // A series of single character codes the equity account may have interest in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 1 character each code with a maximum of 8 interests google.protobuf.StringValue interest_codes = 12; // A series of two character codes the equtiy account may have an occupation in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 2 character each code with a maximum of 9 occupations google.protobuf.StringValue occupation_codes = 13; // The contact telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue business_phone = 14; // The private contact telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue private_phone = 15; // The fax telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue fax = 16; // The mobile telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue mobile_phone = 17; // Indicator to identify if the equtiy account is a sponsored account google.protobuf.BoolValue sponsored = 18; // The code for the adviser allocated to the equity account // Available options as defined in iBROKER. // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 19; // A quick access reference key for the equity account // Mandatory // Maximum size 6 google.protobuf.StringValue account_code = 22; // The branch that is allocated to each equity account // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 23; // The department that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 24; // google.protobuf.StringValue dvp = 25; // The predfined scale at which the brokerage will be charged on contract notes // Available options as defined in iBROKER. // Mandatory // Maximum size 8 google.protobuf.StringValue brokerage = 26; // Identifies if the account is permitted to short sell google.protobuf.BoolValue allow_short_sell = 27; // Identifies if the registration address should be used when printing contract notes replacing the mailing address google.protobuf.BoolValue include_registration_address = 28; // Identifies the default for obligations created for the account if they can be partially delivered to/from the account google.protobuf.BoolValue part_settle = 29; // The participant Identifier the account is associated with // Optional // Maximum size 5 google.protobuf.StringValue participant_id = 30; // An external identifier that can be used when accessing an equity account // Optional // Macimum size 8 google.protobuf.StringValue alternate_account_number = 31; // Identifies if the standard trust processing is included for the equity acocunt google.protobuf.BoolValue trust = 32; // The general residency of the equity account in regards to Foreign ownership. // Available options as defined in iBROKER. // Mandatory // Maximu size 1 google.protobuf.StringValue residency = 33; // Indicates where Billing is applicable for the account exempt or waived // Optional // Maximum size 4 google.protobuf.StringValue default_event_action = 34; // Indicates whether the account has authority to send holding Advise details google.protobuf.BoolValue hold_det_authority = 37; // Indicates the bank details will default from the account for the Hin google.protobuf.BoolValue hold_det_default = 38; // The type of GST the equity account is trading under // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue gst_code = 39; // The first client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_1 = 40; // The second client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_2 = 41; // The third client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_3 = 42; // The fourth client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_4 = 43; // The entry date/time the equity account was created fincleartech.ibroker.DateTimeValue entry_date_time = 44; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 45; } message UpdateEquityAccountResponse { // Response Status. google.rpc.Status status = 1; } message GetEquityAccountRequest { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; } message GetEquityAccountResponse { // Response Status. google.rpc.Status status = 1; // Flag indicating if equity account is active google.protobuf.BoolValue current = 2; // The account name of the equity account is known as // Mandatory // Maximum size 350 google.protobuf.StringValue account_name = 3; // Any title associated with the equity account // Optional // Maximu size 60 google.protobuf.StringValue account_title = 4; // The surname of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue surname = 5; // The given name of the equity account // Mandatory // Maximum size 60 google.protobuf.StringValue given_name = 6; // Any salutation associated with the equity account // Optional // Maximum size 15 google.protobuf.StringValue salutation = 7; // The type of account (from an iBROKER perspective), this account type will associate the types of processing the equity account is capable of. // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue account_type = 8; // The description type of equity account (from an iBROKER perspective) // Available options as defined in iBROKER. // Mandatory // Maximum size 40 google.protobuf.StringValue account_type_description = 9; // The sub classification of type of equity account (from an iBROKER perspective) // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue account_sub_type = 10; // The password associated with the equity account // Optional // Maximum size 255 google.protobuf.StringValue password = 11; // A series of single character codes the equity account may have interest in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 1 character each code with a maximum of 8 interests google.protobuf.StringValue interest_codes = 12; // A series of two character codes the equity account may have an occupation in. Fully user definable // Available options as defined in iBROKER. // Optional // Maximum size 2 character each code with a maximum of 9 occupations google.protobuf.StringValue occupation_codes = 13; // The contact telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue business_phone = 14; // The private contact telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue private_phone = 15; // The fax telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue fax = 16; // The mobile telephone number for the equity account. // Optional // Maximum size 20 google.protobuf.StringValue mobile_phone = 17; // Indicator to identify if the equity account is a portfolio account google.protobuf.BoolValue portfolio_holding = 18; // Indicator to identify if the equity account is sponsored account google.protobuf.BoolValue sponsored = 19; // The name used for any standard mail-outs // Mandatory // Maximum size 350 google.protobuf.StringValue mail_account_name = 20; // The designation used for any standard mail-outs // Optional // Maximum size 35 google.protobuf.StringValue mail_designation = 21; // The addressee used for any standard mail-outs // Optional // Maximum size 80 google.protobuf.StringValue mail_addressee = 22; // Mailing address structure Address mail_address = 23; // The account name used for any registrations of issue sponsored stock // Mandatory // Maximum size 350 google.protobuf.StringValue registration_account_name = 30; // The designation used for any registrations of issue sponsored stock // Optional // Maximum size 35 google.protobuf.StringValue registration_designation = 31; // The addressee used for any registrations of issue sponsored stock // Optional // Maximum size 80 google.protobuf.StringValue registration_addressee = 32; // Registration address structure Address registration_address = 33; // The country code which the address is located // Available options as defined in iBROKER. // Optional // Maximum Size 2 google.protobuf.StringValue country_code = 40; // The code for the adviser allocated to the equity account // Available options as defined in iBROKER. // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 41; // A quick access reference key for the equity account // Mandatory // Maximum size 6 google.protobuf.StringValue account_code = 44; // The branch that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 45; // The department that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 46; // Identifies if the equity account is regarded as a bad debt google.protobuf.BoolValue bad_debt = 47; // google.protobuf.StringValue dvp = 48; // The scale at which the brokerage will be charged on contract notes // Available options as defined in iBROKER. // Mandatory // Maximum size 8 google.protobuf.StringValue brokerage = 49; // Identifies if the equity account is permitted to short sell google.protobuf.BoolValue allow_short_sell = 50; // Identifies if the registration address should be used when printing contract notes replacing the mailing address google.protobuf.BoolValue include_registration_address = 51; // Identifies the default for obligations created for the account if they can be partially delivered to/from the equity account google.protobuf.BoolValue part_settle = 52; // Identifies the types of markets the equity account can trade in. Must be EQTY. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue market_type = 53; // An external identifier that can be used when accessing an equity account // Optional // Macimum size 8 google.protobuf.StringValue alternate_account_number = 55; // Identifies if the standard trust processing is included for the equity account google.protobuf.BoolValue trust = 56; // The general residency of the equity account in regards to Foreign ownership. // Available options as defined in iBROKER. // Mandatory // Maximu size google.protobuf.StringValue residency = 57; // Indicates where Billing is applicable for the account exempt or waived // Optional // Maximum size 4 google.protobuf.StringValue default_event_action = 58; // The email address of the equity account // Optional // Maximum size 100 google.protobuf.StringValue email_address = 59; // Purpose for which the email address is used // Mandatory if the email address is entered // Maximum size 1 google.protobuf.StringValue email_purpose = 60; // Indicates whether the account has authority to send holding Advise details google.protobuf.BoolValue hold_det_authority = 61; // Indicates the bank details will default from the account for the Hin google.protobuf.BoolValue hold_det_default = 62; // The type of GST the account is trading under // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue gst_code = 63; // The first client associated with the client // Mandatory // Maximum size 8 google.protobuf.StringValue client_number_1 = 64; // The second client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_2 = 65; // The third client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_3 = 66; // The fourth client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_4 = 67; // The entry date/time the trading account was created fincleartech.ibroker.DateTimeValue entry_date_time = 68; // The database user ID who created the trading account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 69; // Identifies if the account currently has notes allocated aginst it. google.protobuf.BoolValue notes_present = 70; } message CreateAdviserRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Flag indicating if adviser account is active google.protobuf.BoolValue current = 2; // The name of the adviser // Mandatory // Maximum size 200 google.protobuf.StringValue adviser_name = 3; // The code associated with the adviser // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 4; // The salutation associated with the adviser // Optional // Maximum size 15 google.protobuf.StringValue salutation = 5; // The branch where the adviser is located // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 6; // The department where the adviser is located // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 7; // The division where the adviser is located // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue division = 8; // The advisor group / desk the adviser has been associated with // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue group = 9; // The general ledger category any financial postings will be associated with // Available options as defined in iBROKER. // Optional // Maximum size 2 google.protobuf.StringValue general_ledger_category = 10; // The telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue telephone_number = 11; // The after hours telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue after_hours_telephone_number = 12; // The type of license the dealer currently holds // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue dealer_type = 13; // The license number the dealer currently holds // Optional // Maximum size 10 google.protobuf.StringValue dealer_license_number = 14; // The default brokerage classification the adviser financial postings will be allocated to // Available options as defined in iBROKER. // Optional // Maximum size 3 google.protobuf.StringValue default_brokerage_class = 15; } message CreateAdviserResponse { // Response Status. google.rpc.Status status = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; } message UpdateAdviserRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // Flag indicating if adviser account is active google.protobuf.BoolValue current = 3; // The name of the adviser // Mandatory // Maximum size 200 google.protobuf.StringValue adviser_name = 4; // The salutation associated with the adviser // Optional // Maximum size 15 google.protobuf.StringValue salutation = 6; // The branch where the adviser is located // Available options as defined in iBROKER // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 7; // The department where the adviser is located // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 8; // The division where the adviser is located // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue division = 9; // The group / desk the adviser is allocated within // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue group = 10; // The general ledger category any financial postings will be associated with // Available options as defined in iBROKER. // Optional // Maximum size 2 google.protobuf.StringValue general_ledger_category = 11; // The telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue telephone_number = 12; // The after hours telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue after_hours_telephone_number = 13; // The type of license the dealer currently holds // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue dealer_type = 14; // The license number the dealer currently holds // Optional // Maximum size 10 google.protobuf.StringValue dealer_license_number = 15; // The default brokerage classification the adviser financial postings will be allocated to // Available options as defined in iBROKER. // Optional // Maximum size 3 google.protobuf.StringValue default_brokerage_class = 16; // The entry date time the adviser record was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 17; } message UpdateAdviserResponse { // Response Status. google.rpc.Status status = 1; } message GetAdviserRequest { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; } message GetAdviserResponse { // Response Status. google.rpc.Status status = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; // Flag indicating if adviser account is active google.protobuf.BoolValue current = 3; // The name of the adviser // Mandatory // Maximum size 200 google.protobuf.StringValue adviser_name = 4; // The code associated with the adviser // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 5; // The salutation associated with the adviser // Optional // Maximum size 15 google.protobuf.StringValue salutation = 6; // The branch where the adviser is located // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 7; // The department where the adviser is located // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 8; // The division where the adviser is located // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue division = 9; // The group / desk the adviser has been allocated within // Available options as defined in iBROKER. // Optional // Maximum size 4 google.protobuf.StringValue group = 10; // The general ledger category any financial postings will be associated with // Available options as defined in iBROKER. // Optional // Maximum size 2 google.protobuf.StringValue general_ledger_category = 11; // The telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue telephone_number = 12; // The after hours telephone number of the adviser // Optional // Maximum size 20 google.protobuf.StringValue after_hours_telephone_number = 13; // The type of license the dealer currently holds // Available options as defined in iBROKER. // Mandatory // Maximum size 1 google.protobuf.StringValue dealer_type = 14; // The license number the dealer currently holds // Optional // Maximum size 10 google.protobuf.StringValue dealer_license_number = 15; // The default brokerage classification the adviser financial postings will be allocated to // Available options as defined in iBROKER. // Optional // Maximum size 3 google.protobuf.StringValue default_brokerage_class = 16; // The entry date time the adviser record was created // Mandatory fincleartech.ibroker.DateTimeValue entry_date_time = 17; } service IBrokerAccountsService { rpc CreateFinancialSettlementDetails (CreateFinancialSettlementDetailsRequest) returns (CreateFinancialSettlementDetailsResponse); rpc UpdateFinancialSettlementDetails (UpdateFinancialSettlementDetailsRequest) returns (UpdateFinancialSettlementDetailsResponse); rpc GetFinancialSettlementDetails (GetFinancialSettlementDetailsRequest) returns (GetFinancialSettlementDetailsResponse); rpc CreateDistributionDetails (CreateDistributionDetailsRequest) returns (CreateDistributionDetailsResponse); rpc UpdateDistributionDetails (UpdateDistributionDetailsRequest) returns (UpdateDistributionDetailsResponse); rpc GetDistributionDetails (GetDistributionDetailsRequest) returns (GetDistributionDetailsResponse); rpc CreateCommunicationDetails (CreateCommunicationDetailsRequest) returns (CreateCommunicationDetailsResponse); rpc UpdateCommunicationDetails (UpdateCommunicationDetailsRequest) returns (UpdateCommunicationDetailsResponse); rpc GetCommunicationDetails (GetCommunicationDetailsRequest) returns (GetCommunicationDetailsResponse); rpc CreateClient (CreateClientRequest) returns (CreateClientResponse); rpc UpdateClient (UpdateClientRequest) returns (UpdateClientResponse); rpc GetClient (GetClientRequest) returns (GetClientResponse); // Maintain postal or residential/registered addresses for clients rpc CreateClientAddress (google.protobuf.Empty) returns (google.protobuf.Empty); rpc UpdateClientAddress (google.protobuf.Empty) returns (google.protobuf.Empty); rpc GetClientAddress (google.protobuf.Empty) returns (google.protobuf.Empty); // Create account addresses (excluding registration and general) rpc CreateAccountAddress (google.protobuf.Empty) returns (google.protobuf.Empty); // Maintain account addresses rpc UpdateAccountAddress (google.protobuf.Empty) returns (google.protobuf.Empty); rpc GetAccountAddress (google.protobuf.Empty) returns (google.protobuf.Empty); // Maintain the relationship between clients and accounts rpc CreateClientAccountRelationship (CreateClientAccountRelationshipRequest) returns (CreateClientAccountRelationshipResponse); rpc UpdateClientAccountRelationship (UpdateClientAccountRelationshipRequest) returns (UpdateClientAccountRelationshipResponse); rpc GetClientAccountRelationship (GetClientAccountRelationshipRequest) returns (GetClientAccountRelationshipResponse); // Create an iBroker account of type Client (C) or Institutional (I), marketType=EQTY rpc CreateEquityAccount (CreateEquityAccountRequest) returns (CreateEquityAccountResponse); rpc UpdateEquityAccount (UpdateEquityAccountRequest) returns (UpdateEquityAccountResponse); rpc GetEquityAccount (GetEquityAccountRequest) returns (GetEquityAccountResponse); // Create an iBroker account of type Adviser (A) rpc CreateAdviser (CreateAdviserRequest) returns (CreateAdviserResponse); rpc UpdateAdviser (UpdateAdviserRequest) returns (UpdateAdviserResponse); rpc GetAdviser (GetAdviserRequest) returns (GetAdviserResponse); // Create an iBroker Client Option account (C) (marketType=OPT) rpc CreateOptionsAccount(google.protobuf.Empty) returns (google.protobuf.Empty); rpc UpdateOptionsAccount(google.protobuf.Empty) returns (google.protobuf.Empty); rpc GetOptionsAccount(google.protobuf.Empty) returns (google.protobuf.Empty); // Create a new Settlement Account (HIN) associated with an existing iBroker Account rpc CreateSettlementAccount(google.protobuf.Empty) returns (google.protobuf.Empty); rpc UpdateSettlementAccount(google.protobuf.Empty) returns (google.protobuf.Empty); rpc GetSettlementAccount(google.protobuf.Empty) returns (google.protobuf.Empty); // Maintain standing settlement instructions for an account rpc CreateAccountSettlementInstruction(google.protobuf.Empty) returns (google.protobuf.Empty); rpc UpdateAccountSettlementInstruction(google.protobuf.Empty) returns (google.protobuf.Empty); rpc GetAccountSettlementInstruction(google.protobuf.Empty) returns (google.protobuf.Empty); }