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 "fincleartech/ibroker/common.proto"; 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 // Mandatory // 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. // Optional 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 // Mandatory 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 // Mandatory google.protobuf.BoolValue default_receipt = 8; // Flag indicating if this method is currently active. // Mandatory google.protobuf.BoolValue current = 9; // CMT fund code. // Available options as defined in iBROKER // Optional // Maximum size 5 google.protobuf.StringValue cmt_fund = 10; // Used for criteria to generate payments // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue payment_gen_method = 11; // Used for criteria to generate receipts // Available options as defined in iBROKER // Optional // 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. Example Q - Cheque, B - Bpay // Mandatory // Maximum size 1 google.protobuf.StringValue settlement_type = 13; // Flag indicating if automatic financial contra is enabled for this method. // Optional 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 // Optional // Maximum size 5 google.protobuf.StringValue settlement_group = 15; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Optional // Maximum size 4 google.protobuf.StringValue hold_reason = 16; // The iBROKER user id to record as the modifier. // Mandatory google.protobuf.StringValue user_id = 17; } message CreateFinancialSettlementDetailsResponse { // Response Status. When status code is OK, response body will be populated. fincleartech.ibroker.ResponseStatus status = 1; // Unique iBROKER Settlement Details Identifier for this specific method google.protobuf.StringValue financial_settlement_details_id = 2; } 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 // Mandatory // 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. // Optional 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 // Mandatory 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 // Mandatory 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 // Optional // Maximum size 5 google.protobuf.StringValue cmt_fund = 11; // Used for criteria to generate payments // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue payment_gen_method = 12; // Used for criteria to generate receipts // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue receipt_gen_method = 13; // Flag indicating if automatic financial contra is enabled for this method. // Optional 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 // Optional // Maximum size 5 google.protobuf.StringValue settlement_group = 15; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Optional // 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. // Mandatory google.protobuf.StringValue user_id = 18; } message UpdateFinancialSettlementDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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. fincleartech.ibroker.ResponseStatus status = 1; // Bank BSB Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 7 google.protobuf.StringValue bsb_number = 2; // Bank Account Number // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 9 google.protobuf.StringValue bank_account_number = 3; // Bank Account Name // Mandatory for Settlement Type of Direct Transfer (T) and BPay (B) // Maximum size 100 google.protobuf.StringValue bank_account_name = 4; // Flag indicating if this method is approved for direct debit // Optional google.protobuf.BoolValue direct_debit = 5; // Flag indicating if this method is the default payment method for the account. // Can only be one default Payment for an account // Mandatory google.protobuf.BoolValue default_payment = 6; // Flag indicating if this method is the default receipt method for the account. // Can only be one default Receipt for an account // Mandatory google.protobuf.BoolValue default_receipt = 7; // Flag indicating if this method is currently active. // Mandatory google.protobuf.BoolValue current = 8; // CMT fund code. Available options as defined in iBROKER // Optional // Maximum size 5 google.protobuf.StringValue cmt_fund = 9; // Used for criteria to generate payments. Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue payment_gen_method = 10; // Used for criteria to generate receipts // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue receipt_gen_method = 11; // Financial settlement method, identifies how the this method will be settled financially // Available options as defined in iBROKER. Example Q - Cheque, B - Bpay // Mandatory // Maximum size 1 google.protobuf.StringValue settlement_type = 12; // Flag indicating if automatic financial contra is enabled for this method. // Optional google.protobuf.BoolValue auto_contra = 13; // Ability to group financial settlements within the same logical business function i.e. Margin lending accounts // Available options as defined in iBROKER // Optional // Maximum size 5 google.protobuf.StringValue settlement_group = 14; // Ability to place financial settlements on hold by default // Available options as defined in iBROKER // Optional // Maximum size 4 google.protobuf.StringValue hold_reason = 15; // The iBroker user id of the last user to modify the method. // Available options as defined in iBROKER // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 16; // The date/time the record was created/modified fincleartech.ibroker.DateTimeValue entry_date_time = 17; } message DistributionDetails { // iBROKER Account Number // Mandatory // 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 // Mandatory // 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 // Mandatory // 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 //Mandatory // Maximum size 2 google.protobuf.StringValue communication_destination_type = 4; // Flag indicating if this is to distribiute the original contract note // Optional google.protobuf.BoolValue cnote_original = 5; // The number of copies for the distribution // Mandatory // 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 // Mandatory // 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 (i.e current) //Mandatory google.protobuf.BoolValue current = 9; // The date/time the record was created 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 // 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. fincleartech.ibroker.ResponseStatus 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 // Mandatory 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 // Mandatory 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 // Mandatory 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 // Mandatory google.protobuf.StringValue communication_destination_type = 5; // Flag indicating if this is to distribiute the original contract note // Optional google.protobuf.BoolValue cnote_original = 6; // The number of copies for the distribution // Maximum size 3 // Mandatory 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 // Mandatory 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 // Mandatory google.protobuf.BoolValue current = 10; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 11; } message UpdateDistributionDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetDistributionDetailsRequest { google.protobuf.StringValue account_number = 1; } message GetDistributionDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // distribution details repeated DistributionDetails distribution_detail = 2; } message CommunicationDetails { // iBROKER Account Number // Maximum size 8 // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 1; // iBROKER Client Number // Maximum size 8 google.protobuf.StringValue client_number = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Mandatory // 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 // Mandatory // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The details of the address that will be distributed to such as email address. // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active // Mandatory google.protobuf.BoolValue current = 7; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 8; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 9; } message CreateClientCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Client Number // Mandatory // Maximum size 8 google.protobuf.StringValue client_number = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Mandatory // 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 // Mandatory // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Optional // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active // Mandatory google.protobuf.BoolValue current = 7; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 17; } message CreateClientCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message UpdateClientCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue client_number = 2; // The method how the distribution will be transmitted (EMAIL - Electronic email) // Available options as defined in iBROKER // Mandatory // 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 // Mandatory // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Optional // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active // Mandatory google.protobuf.BoolValue current = 7; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 8; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 17; } message UpdateClientCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetClientCommunicationDetailsRequest { google.protobuf.StringValue client_number = 1; } message GetClientCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; repeated CommunicationDetails communication_detail = 2; } message CreateAccountCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // 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 // Mandatory // 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 // Mandatory // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Optional // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active // Mandatory google.protobuf.BoolValue current = 7; } message CreateAccountCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message UpdateAccountCommunicationDetailsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // 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 // Mandatory // 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 // Mandatory // Maximum size 10 google.protobuf.StringValue communication_destination_type = 4; // The contents of the address that will be distributed to such as email address. // Mandatory // Maximum size 100 google.protobuf.StringValue communication_data = 5; // General remarks held against the method // Optional // Maximum size 100 google.protobuf.StringValue communication_data_remarks = 6; // Flag indicating if communication is active // Mandatory google.protobuf.BoolValue current = 7; // The last modification time for the method. fincleartech.ibroker.DateTimeValue entry_date_time = 8; } message UpdateAccountCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetAccountCommunicationDetailsRequest { // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 1; } message GetAccountCommunicationDetailsResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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 employer_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 // Maximum 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; // mailing address Address mail_address = 28; // registration address Address registration_address = 29; } message CreateClientResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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 employer_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. fincleartech.ibroker.ResponseStatus status = 1; } message GetClientRequest { google.protobuf.StringValue client_number = 1; } message GetClientResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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 employer_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 only for HLD relationship type // Optional fincleartech.ibroker.NumberValue holder_sequence = 15; } message CreateClientAccountRelationshipResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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 only for HLD relationship type // Optional fincleartech.ibroker.NumberValue holder_sequence = 15; } message UpdateClientAccountRelationshipResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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. fincleartech.ibroker.ResponseStatus 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 fincleartech.ibroker.NumberValue 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 address_line_4 = 4; // The town which the address is located // Mandatory // Maximum size 35 google.protobuf.StringValue address_line_5 = 5; // The town which the address is located // Mandatory // Maximum size 35 google.protobuf.StringValue town = 6; // The state which the address is located // Mandatory // Maximum size 35 google.protobuf.StringValue state = 7; // The postcode which the address is located // Mandatory // Maximum size 16 google.protobuf.StringValue post_code = 8; // The country code which the address is located // Available options as defined in iBROKER. // Mandatory // Maximum Size 2 google.protobuf.StringValue country = 9; } 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; // 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; // GL category code google.protobuf.StringValue gl_category_code = 69; } message CreateEquityAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; } message GetEquityAccountRequest { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; } message GetEquityAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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; // 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. fincleartech.ibroker.ResponseStatus 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. fincleartech.ibroker.ResponseStatus status = 1; } message GetAdviserRequest { // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 1; } message GetAdviserResponse { // Response Status. fincleartech.ibroker.ResponseStatus 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; } message CreateAccountSettlementInstructionRequest { // 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 // Mandatory google.protobuf.StringValue account_number = 2; // iBROKER Settlement Group. There are 4 groups. I - Issuer, S - Sponsored, P - Participant, - N - Non-CHESS // Maximum size 1 // Mandatory google.protobuf.StringValue settlement_group = 3; // Participant Id Requesting the Settlement Account. Mandatory when settlement group is 'S' // Maximum size 5 // Mandatory if settlement group = 'S' or 'P' google.protobuf.StringValue participant_id = 4; // CSP Settlement Account (HIN). Mandatory when settlement group is 'S' // Maximum size 16 // Optional google.protobuf.StringValue settlement_account = 5; // Settlement Instruction used for Buy Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue buy_settle_instruction = 6; // Settlement Instruction used for Sell Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue sell_settle_instruction = 7; // Supplementary Reference sent on CSP messaging // Maximum size 1 // Optional google.protobuf.StringValue supplementary_ref = 8; // Secondary match flag is sent on CSP messaging // Maximum size 1 // Optional google.protobuf.BoolValue secondary_match = 9; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 10; // Y = record is the default settlement instruction // Maximum size 1 // Mandaotry google.protobuf.BoolValue default = 11; // The database user ID who created the record // Optional // Maximum size 18 google.protobuf.StringValue user_id = 12; } message CreateAccountSettlementInstructionResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue settlement_instruction_id = 2; } message UpdateAccountSettlementInstructionRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Settlement?? google.protobuf.StringValue settlement_instruction_id = 2; // Settlement Instruction used for Buy Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue buy_settle_instruction = 3; // Settlement Instruction used for Sell Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue sell_settle_instruction = 4; // Supplementary Reference sent on CSP messaging // Maximum size 1 // Optional google.protobuf.StringValue supplementary_ref = 5; // Secondary match flag is sent on CSP messaging // Maximum size 1 // Optional google.protobuf.BoolValue secondary_match = 6; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 7; // Y = record is the default settlement instruction // Maximum size 1 // Mandatory google.protobuf.BoolValue default = 8; fincleartech.ibroker.DateTimeValue entry_date_time = 12; // The database user ID who created the record // Optional // Maximum size 18 google.protobuf.StringValue user_id = 10; } message UpdateAccountSettlementInstructionResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetAccountSettlementInstructionsRequest { google.protobuf.StringValue account_number = 1; } message SettlementInstruction { google.protobuf.StringValue settlement_instruction_id = 1; // iBROKER Account Number // Maximum size 8 // Mandatory google.protobuf.StringValue account_number = 2; // iBROKER Settlement Group. There are 4 groups. I - Issuer, S - Sponsored, P - Participant, - N - Non-CHESS // Maximum size 1 // Mandatory google.protobuf.StringValue settlement_group = 3; // Participant Id Requesting the Settlement Account. Mandatory when settlement group is 'S' // Maximum size 5 // Mandatory if settlement group = 'S' or 'P' google.protobuf.StringValue participant_id = 4; // CSP Settlement Account (HIN). Mandatory when settlement group is 'S' // Maximum size 10 // Optional google.protobuf.StringValue settlement_account = 5; // Settlement Instruction used for Buy Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue buy_settle_instruction = 6; // Settlement Instruction used for Sell Transaction. Example when settlement group is I, then I, when S then either S or T // Maximum size 1 // Mandatory google.protobuf.StringValue sell_settle_instruction = 7; // Supplementary Reference sent on CSP messaging // Maximum size 1 // Optional google.protobuf.StringValue supplementary_ref = 8; // Secondary match flag is sent on CSP messaging // Maximum size 1 // Optional google.protobuf.BoolValue secondary_match = 9; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 10; // Y = record is the default settlement instruction // Maximum size 1 // Mandatory google.protobuf.BoolValue default = 11; fincleartech.ibroker.DateTimeValue entry_date_time = 12; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 13; } message GetAccountSettlementInstructionsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; repeated SettlementInstruction settlement_instruction = 2; } message CreateSettlementAccountRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Participant Id Requesting the Settlement Account // Mandatory // Maximum size 5 google.protobuf.StringValue participant_id = 2; // Holder type of the Settlement account S for Sponsored D for Direct or E for Entrepot // Mandatory // Maxium size 1 google.protobuf.StringValue holder_type = 3; // for future use google.protobuf.StringValue entrepot_type = 4; //Residency of the settlement account. Eg 'F'- Foreign, 'D' – Domestic. If not supplied will default from IBROKER Account // Optional //Maximum size 1 google.protobuf.StringValue residency = 5; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 6; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 7; //Indictor advising whether the Settlement account will be the default for the iBROKER account //Mandatory google.protobuf.BoolValue default_for_account = 8; //Indictor advising whether the Settlement account and iBROKER account relationship is currnet or not //Mandatory google.protobuf.BoolValue current_for_account = 9; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 10; } message CreateSettlementAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue temp_settlement_account = 2; } message GetSettlementAccountRequest { // iBROKER Account Number. If supplied will obtain the Settlement Account attached to the iBROKER account. If not supplied will return the default and current account attached to the settlement account. // Optional // Maximum size 8 google.protobuf.StringValue account_number = 1; // Participant Id Requesting the Settlement Account // Mandatory // Maximum size 5 google.protobuf.StringValue participant_id = 2; // the Settlement Account number (HIN) // Mandatory // Maximum size 16 google.protobuf.StringValue settlement_account = 3; } message GetSettlementAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // Returns the holder type of the settlement account. S - Sponsored , D - Direct google.protobuf.StringValue holder_type = 2; // for future use google.protobuf.StringValue entrepot_type = 3; // Status of the settlement account google.protobuf.StringValue holder_status = 4; // Residency indicator of the settlement Account. D-Domestic, F-Foreign google.protobuf.StringValue residency = 5; // Indcates if settlement account is current or non current google.protobuf.BoolValue current = 6; // iBROKER account number linked to settlement account google.protobuf.StringValue account_number = 7; // indcates whether the settlement is the default for the iBROKER account. google.protobuf.BoolValue default_for_account = 8; // indicates where the settlement account and iBROKER account relationship is current or non current. google.protobuf.BoolValue current_for_account = 9; // last updated entry date time of the record. fincleartech.ibroker.DateTimeValue entry_date_time = 10; //user that last updated the record google.protobuf.StringValue user_id = 11; } message CreateOptionsAccountRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Flag indicating if record is active //Mandatory //Maximum size 1 google.protobuf.BoolValue current = 2; // The account name of the option is known as // Mandatory // Maximum size 200 google.protobuf.StringValue account_name = 3; // Any title associated with the option account // Optional // Maximu size 60 google.protobuf.StringValue account_title = 4; // The surname of the option account // Mandatory // Maximum size 60 google.protobuf.StringValue surname = 5; // The given name of the option account // Mandatory // Maximum size 60 google.protobuf.StringValue given_name = 6; // Any salutation associated with the option account // Optional // Maximum size 15 google.protobuf.StringValue salutation = 7; // The type of option 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 option 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; // The name used for any standard mail-outs // Mandatory // Maximum size 350 google.protobuf.StringValue mail_account_name = 17; // The designation used for any standard mail-outs // Optional // Maximum size 35 google.protobuf.StringValue mail_designation = 18; // The addressee used for any standard mail-outs // Optional // Maximum size 80 google.protobuf.StringValue mail_addressee = 19; // Mailing address structure Address mail_address = 20; // The account name used for any registrations of issuer sponsored stock // Mandatory // Maximum size 350 google.protobuf.StringValue registration_account_name = 21; // The designation used for any registrations of issue sponsored stock // Optional // Maximum size 35 google.protobuf.StringValue registration_designation = 22; // The addressee used for any registrations of issuer sponsored stock // Optional // Maximum size 80 google.protobuf.StringValue registration_addressee = 23; // Registration address structure //Optional //Maximum size 80 Address registration_address = 24; // The country code which the address is located // Available options as defined in iBROKER. // Optional // Maximum Size 2 google.protobuf.StringValue country_code = 25; // 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 = 26; // A quick access reference key for the equity account // Mandatory // Maximum size 6 google.protobuf.StringValue account_code = 27; // The branch that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 28; // The department that is allocated to each equity account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 29; // Identifies if the client is regarded as being a bad debt google.protobuf.BoolValue bad_debt = 30; // 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 = 31; // Identifies if the account is permitted to short sell google.protobuf.BoolValue allow_short_sell = 32; // Identifies if the registration address should be used when printing contract notes replacing the mailing address //Mandatory google.protobuf.BoolValue include_registration_address = 33; // Identifies the default for obligations created for the account if they can be partially delivered to/from the account google.protobuf.BoolValue part_settle = 34; // The participant Identifier the account is associated with // Optional // Maximum size 5 google.protobuf.StringValue participant_id = 35; // An external identifier that can be used when accessing an account // Optional // Maximum size 8 google.protobuf.StringValue alternate_account_number = 36; // Identifies if the standard trust processing is included for the equity account google.protobuf.BoolValue trust = 37; // 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 = 38; // Indicates where Billing is applicable for the account exempt or waived // Optional // Maximum size 4 google.protobuf.StringValue default_event_action = 39; // The email address of the equity account // Optional // Maximum size 100 google.protobuf.StringValue email_address = 40; // Purpose for which the email address is used // Mandatory if the email address is entered // Maximum size 1 google.protobuf.StringValue email_purpose = 41; // Indicates whether the account has authority to send holding Advise details // Optional google.protobuf.BoolValue hold_det_authority = 42; // Indicates the bank details will default from the account for the Hin // Optional google.protobuf.BoolValue hold_det_default = 43; // Indicates whether the account has interest paid // Optional google.protobuf.BoolValue interest_paid = 44; // Indicates whether the account can lodge paperless collateral // Optional google.protobuf.BoolValue paperless_collateral = 45; // Indicates the margin buffer to be applied to the account. Numeric values represented as a percentage (i.e 50 will be 50%) // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_buffer = 46; // Defines the percentage value by with the margin value needs to rise vefore a margin call or refund is made // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_tolerance = 47; // This is ACH Account numner associated to the iBROKER account number. Field is used within Options Reporting // Optional // Maximum size 20 google.protobuf.StringValue ach_account = 48; // Field for adding external reference number to the iBROKER account // Optional // Maximum size 20 google.protobuf.StringValue external_reference = 49; // ETO Agreement level for the account. Defines the type of trading allowed by each account. // Optional // Maximum size 4 google.protobuf.StringValue eto_agreement_level = 50; // Flag to indicate that the account is a Margin account // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.BoolValue margin_account = 51; // Flag to indicate that the account uses specific cover // Optional // Maximum size 1 google.protobuf.BoolValue specific_cover = 52; // Flag to indicate that the account is a Portfolio account // Optional // Maximum size 1 google.protobuf.BoolValue portfolio_holding = 53; // The maximum tolerance for Margin // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_tolerance_ceiling = 54; // Margin Calculation Method for the account // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue margin_calc_method = 55; //Margin premiumbuff percentage for the option account //Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue premium_buffer = 56; //Margin risk buff percentage for the option account //Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue risk_buffer = 57; // The first client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_1 = 58; // The second client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_2 = 59; // The third client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_3 = 60; // The fourth client associated with the equity account // Optional // Maximum size 8 google.protobuf.StringValue client_number_4 = 61; // The date/time the equity acocunt was created fincleartech.ibroker.DateTimeValue entry_date_time = 62; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 63; google.protobuf.StringValue gl_category_code = 64; } message CreateOptionsAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // iBROKER Account Number // Maximum size 8 google.protobuf.StringValue account_number = 2; } message GetOptionsAccountRequest { google.protobuf.StringValue account_number = 1; } message GetOptionsAccountResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // Flag indicating if option account is active //Mandatory //Field size 1 google.protobuf.BoolValue current = 2; // The account name of the equity account is known as // Mandatory // Maximum size 200 google.protobuf.StringValue account_name = 3; // Any title associated with the option account // Optional // Maximu size 60 google.protobuf.StringValue account_title = 4; // The surname of the option account // Mandatory // Maximum size 60 google.protobuf.StringValue surname = 5; // The given name of the option account // Mandatory // Maximum size 60 google.protobuf.StringValue given_name = 6; // Any salutation associated with the option 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 option 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 option 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 option account // Optional // Maximum size 255 google.protobuf.StringValue password = 11; // A series of single character codes the option 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 option account. // Optional // Maximum size 20 google.protobuf.StringValue business_phone = 14; // The private contact telephone number for the option account. // Optional // Maximum size 20 google.protobuf.StringValue private_phone = 15; // The fax telephone number for the option account. // Optional // Maximum size 20 google.protobuf.StringValue fax = 16; // The mobile telephone number for the option account. // Optional // Maximum size 20 google.protobuf.StringValue mobile_phone = 17; // Identifies if the account currently has notes allocated aginst it. google.protobuf.BoolValue notes_present = 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 //Optional //Maximum size 80 Address mail_address = 22; // The account name used for any registrations of issue sponsored stock // Mandatory // Maximum size 350 google.protobuf.StringValue registration_account_name = 23; // The designation used for any registrations of issue sponsored stock // Optional // Maximum size 35 google.protobuf.StringValue registration_designation = 24; // The addressee used for any registrations of issue sponsored stock // Optional // Maximum size 80 google.protobuf.StringValue registration_addressee = 25; // Registration address structure Address registration_address = 26; // The country code which the address is located // Available options as defined in iBROKER. // Optional // Maximum Size 2 google.protobuf.StringValue country_code = 27; // The code for the adviser allocated to the option account // Available options as defined in iBROKER. // Mandatory // Maximum size 5 google.protobuf.StringValue adviser_code = 28; // A quick access reference key for the option account // Mandatory // Maximum size 6 google.protobuf.StringValue account_code = 29; // The branch that is allocated to each option account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue branch = 30; // The department that is allocated to each option account. // Available options as defined in iBROKER. // Mandatory // Maximum size 4 google.protobuf.StringValue department = 31; // Identifies if the equity account is regarded as a bad debt //Optional google.protobuf.BoolValue bad_debt = 32; // 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 = 33; // Identifies if the equity account is permitted to short sell //Optional google.protobuf.BoolValue allow_short_sell = 34; // Identifies if the registration address should be used when printing contract notes replacing the mailing address //Optional google.protobuf.BoolValue include_registration_address = 35; // 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 = 36; // An external identifier that can be used when accessing an equity account // Optional // Maximum size 8 google.protobuf.StringValue alternate_account_number = 37; // Identifies if the standard trust processing is included for the equity account google.protobuf.BoolValue trust = 38; // 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 = 39; // Indicates where Billing is applicable for the account exempt or waived // Optional // Maximum size 4 google.protobuf.StringValue default_event_action = 40; // The email address of the equity account // Optional // Maximum size 100 google.protobuf.StringValue email_address = 41; // Purpose for which the email address is used // Mandatory if the email address is entered // Maximum size 1 google.protobuf.StringValue email_purpose = 42; // Indicates whether the account has authority to send holding Advise details //Optional google.protobuf.BoolValue hold_det_authority = 43; // Indicates the bank details will default from the account for the settlement account (HIN) //Optional google.protobuf.BoolValue hold_det_default = 44; // Indicates if interest is paid for the option account //Optional google.protobuf.BoolValue interest_paid = 45; // Indicates whether the account can lodge paperless collateral // Optional google.protobuf.BoolValue paperless_collateral = 46; // Indicates the margin buffer to be applied to the account. Numeric values represented as a percentage (i.e 50 will be 50%) // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_buffer = 47; // Defines the percentage value by with the margin value needs to rise vefore a margin call or refund is made // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_tolerance = 48; // Field for adding external reference number to the iBROKER account // Optional // Maximum size 20 google.protobuf.StringValue ach_account = 49; // ETO Agreement level for the account. Defines the type of trading allowed by each account. // Optional // Maximum size 4 google.protobuf.StringValue external_reference = 50; // Flag to indicate that the account is a Margin account // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue eto_agreement_level = 51; // Flag to indicate that the account is a Margin account // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.BoolValue margin_account = 52; // Flag to indicate that the account uses specific cover // Optional // Maximum size 1 google.protobuf.BoolValue specific_cover = 53; // Flag to indicate that the account is a Portfolio account // Optional // Maximum size 1 google.protobuf.BoolValue portfolio_holding = 54; // The maximum tolerance for Margin // Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue margin_tolerance_ceiling = 55; // Margin Calculation Method for the account // Available options as defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue margin_calc_method = 56; //Margin premiumbuff percentage for the option account //Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue premium_buffer = 57; //Margin risk buff percentage for the option account //Optional // Maximum size 8,4 fincleartech.ibroker.NumberValue risk_buffer = 58; // The first client associated with the client // Mandatory // Maximum size 8 google.protobuf.StringValue client_number_1 = 59; // The second client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_2 = 60; // The third client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_3 = 61; // The fourth client associated with the client // Optional // Maximum size 8 google.protobuf.StringValue client_number_4 = 62; // The entry date/time the trading account was created fincleartech.ibroker.DateTimeValue entry_date_time = 63; // The database user ID who created the trading account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 64; google.protobuf.BoolValue include_in_trust = 65; google.protobuf.StringValue derivative_external_ref = 66; google.protobuf.StringValue gl_category_code = 67; } message CreateContactRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Contact Name //Mandatory //Masxium size 60 google.protobuf.StringValue name = 4; // Flag indicating if record is active // Optional //Maximum size 1 google.protobuf.BoolValue current = 5; // Telephone number for the contact // Optional //Maximum size 20 google.protobuf.StringValue telephone_number = 6; // Description of the reason for this contact //Optional //Maximum size 60 google.protobuf.StringValue reason = 7; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 8; } message CreateContactResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue account_contact_number = 2; } message UpdateContactRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // system generated no. // Optional //Maximum size 8 google.protobuf.StringValue account_contact_number = 3; // Contact Name //Mandatory //Masxium size 60 google.protobuf.StringValue name = 4; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 5; // Telephone number for the contact // Optional //Maximum size 20 google.protobuf.StringValue telephone_number = 6; // Description of the reason for this contact //Optional //Maximum size 60 google.protobuf.StringValue reason = 7; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 8; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 9; } message UpdateContactResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetContactRequest { google.protobuf.StringValue account_number = 1; google.protobuf.StringValue account_contact_number = 2; } message GetContactResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue name = 2; // Flag indicating if record is active // Maximum size 1 // Mandatory google.protobuf.BoolValue current = 3; // Description of the reason for this contact //Optional //Maximum size 60 google.protobuf.StringValue telephone_number = 4; // Description of the reason for this contact //Optional //Maximum size 60 google.protobuf.StringValue reason = 5; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 6; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 7; } message CreateIssuerResidencyRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Issuer Code for the Residency indicator // Mandatory // Maximum size 6 google.protobuf.StringValue issuer_code = 3; // Residency flag - values D - Domestic or F - Foreign // Optional // Maximum size 1 google.protobuf.StringValue residency = 4; // Flag indicating if the record is current or non current // Optional google.protobuf.BoolValue current = 5; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 6; } message CreateIssuerResidencyResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message UpdateIssuerResidencyRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Issuer Code for the Residency indicator // Mandatory // Maximum size 6 google.protobuf.StringValue issuer_code = 3; // Residency flag - values D - Domestic or F - Foreign // Optional // Maximum size 1 google.protobuf.StringValue residency = 4; // Flag indicating if the record is current or non current // Optional google.protobuf.BoolValue current = 5; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 6; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 7; } message UpdateIssuerResidencyResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetIssuerResidencyRequest { google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Issuer Code for the Residency indicator // Mandatory // Maximum size 6 google.protobuf.StringValue issuer_code = 3; } message GetIssuerResidencyResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue residency = 2; google.protobuf.BoolValue current = 3; fincleartech.ibroker.DateTimeValue entry_date_time = 4; google.protobuf.StringValue user_id = 5; } message UpdateAccountTypeRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // iBROKER Account Type // Available values as per defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue account_type = 3; //iBROKER Account Sub Type // Available values as per defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue account_sub_type = 4; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 5; } message UpdateAccountTypeResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetAccountTypeRequest { google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; } message GetAccountTypeResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue account_type = 3; google.protobuf.StringValue account_sub_type = 4; fincleartech.ibroker.DateTimeValue entry_date_time = 5; } message CreateAccountDocumentRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // iBROKER Document Code. Available values as per defined in iBROKER // Mandatory // Maximum size 10 google.protobuf.StringValue document_code = 3; // Current status of document. Available values as per defined in iBROKER // Example N - New, E - Exempt, R - Received // Mandatory // Fize size 1 google.protobuf.StringValue document_status = 4; // The date/time the record status was updated to S. fincleartech.ibroker.DateTimeValue sent_date = 5; // The date/time the record status was updated to R fincleartech.ibroker.DateTimeValue received_date = 6; // User added reference no. to document record // Optional // Maximum size 15 google.protobuf.StringValue reference = 7; // User defined notes to be stored against the document code // Optional // Maximum size 100 google.protobuf.StringValue notes = 8; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 9; // Indicates if the record is current or non-current // Mandatory google.protobuf.BoolValue current = 10; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 11; // iBROKER system generated document code sequence number fincleartech.ibroker.NumberValue document_code_sequence = 12; } message CreateAccountDocumentResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue account_document_number = 2; } message UpdateAccountDocumentRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account document code sequence no. // Mandatory // Maximum size 9 google.protobuf.StringValue account_document_number = 2; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 3; // iBROKER Document Code. Available values as per defined in iBROKER // Mandatory // Maximum size 10 google.protobuf.StringValue document_code = 4; // Current status of document. Available values as per defined in iBROKER // Example N - New, E - Exempt, R - Received // Mandatory // Fize size 1 google.protobuf.StringValue document_status = 5; // The date/time the record status was updated to S fincleartech.ibroker.DateTimeValue sent_date = 6; // The date/time the record status was updated to R fincleartech.ibroker.DateTimeValue received_date = 7; // User added reference no. to document record // Optional // Maximum size 15 google.protobuf.StringValue reference = 8; // User defined notes to be stored against the document code // Optional // Maximum size 100 google.protobuf.StringValue notes = 9; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 10; // Indicates if the record is current or non-current // Mandatory google.protobuf.BoolValue current = 11; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 12; } message AccountDocument { // iBROKER Account document code sequence no. // Mandatory // Maximum size 9 google.protobuf.StringValue account_document_number = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // iBROKER Document Code. Available values as per defined in iBROKER // Mandatory // Maximum size 10 google.protobuf.StringValue document_code = 3; // Current status of document. Available values as per defined in iBROKER // Example N - New, E - Exempt, R - Received // Mandatory // Fize size 1 google.protobuf.StringValue document_status = 4; // The date/time the record status was updated to S fincleartech.ibroker.DateTimeValue sent_date = 5; // The date/time the record status was updated to R fincleartech.ibroker.DateTimeValue received_date = 6; // User added reference no. to document record // Optional // Maximum size 15 google.protobuf.StringValue reference = 7; // User defined notes to be stored against the document code // Optional // Maximum size 100 google.protobuf.StringValue notes = 8; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 9; // Indicates if the record is current or non-current // Mandatory google.protobuf.BoolValue current = 10; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 11; } message UpdateAccountDocumentResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetAccountDocumentsRequest { google.protobuf.StringValue account_number = 1; } message GetAccountDocumentsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; repeated AccountDocument account_document = 2; } message UpdateAccountMiscDataRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Code used in iBROKER. Available values as per defined in iBROKER // Optional // Maximum size 15 google.protobuf.StringValue publication_code = 3; // password if wish to be recorded for client validation // Mandatory // Maximum size 255 google.protobuf.StringValue password = 4; google.protobuf.StringValue occupation_code = 5; google.protobuf.StringValue telephone_number = 6; google.protobuf.BoolValue remove_portfolio_short_sell = 7; google.protobuf.StringValue default_register = 8; google.protobuf.StringValue common_custodian = 9; google.protobuf.StringValue gl_category_code = 10; fincleartech.ibroker.NumberValue parent_code = 11; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 12; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 13; } message UpdateAccountMiscDataResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetAccountMiscDataRequest { google.protobuf.StringValue account_number = 2; } message GetAccountMiscDataResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue publication_code = 2; google.protobuf.StringValue password = 3; google.protobuf.StringValue occupation_code = 4; google.protobuf.StringValue telephone_number = 5; google.protobuf.BoolValue remove_portfolio_short_sell = 6; google.protobuf.StringValue default_register = 7; google.protobuf.StringValue common_custodian = 8; google.protobuf.StringValue gl_category_code = 9; fincleartech.ibroker.NumberValue parent_code = 10; fincleartech.ibroker.DateTimeValue entry_date_time = 11; google.protobuf.StringValue user_id = 12; } message UpdateSettlementParamsRequest { // 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 // Mandatory google.protobuf.StringValue account_number = 2; // Country of residency for the iBROKER account // Available options as defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue country_of_residency = 3; // Settlement Method for the iBROKER account. // Available options as defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue settlement_method = 4; // Indicates if stock is permitted to be part settled for the iBROKER account // Optional google.protobuf.BoolValue part_settle = 5; // FX code indicates the currency for the client’s settlements to be posted in. // Available options as defined in iBROKER // Mandatory // Maximum size 3 google.protobuf.StringValue fx_code = 6; // This is only a narrative and has no impact on processing. The value in this field will display in Financial Enquiry screens // Optional // Maximum size 10,2 fincleartech.ibroker.NumberValue credit_limit = 7; // Lodgement Advice flag. // Optional google.protobuf.BoolValue lodgement_advice = 8; // Flag indicates if stock is to be auto scrip contra'd for iBROKER account // Optional // Maximum size 1 google.protobuf.BoolValue auto_scrip_contra = 9; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue buy_settlement_days = 10; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue sell_settlement_days = 11; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue fail_settlement_days = 12; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 14; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 15; } message UpdateSettlementParamsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetSettlementParamsRequest { google.protobuf.StringValue account_number = 1; } message GetSettlementParamsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // Country of residency for the iBROKER account // Available options as defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue country_of_residency = 3; // Settlement Method for the iBROKER account. // Available options as defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue settlement_method = 4; // Indicates if stock is permitted to be part settled for the iBROKER account // Optional google.protobuf.BoolValue part_settle = 5; // FX code indcates the currency for the clien'ts settlements to be posted in. // Available options as defined in iBROKER // Mandatory // Maximum size 3 google.protobuf.StringValue fx_code = 6; // This is only a narrative and has no impact on processing. The value in this field will display in Financial Enquiry screens // Optional // Maximum size 10,2 fincleartech.ibroker.NumberValue credit_limit = 7; // Lodgement Advice flag. // Optional google.protobuf.BoolValue lodgement_advice = 8; // Flag indicates if stock is to be auto scrip contra'd for iBROKER account // Optional // Maximum size 1 google.protobuf.BoolValue auto_scrip_contra = 9; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue buy_settlement_days = 10; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue sell_settlement_days = 11; // Number of default settlement days. Set to 2 // Mandatory // Maximum size 2 fincleartech.ibroker.NumberValue fail_settlement_days = 12; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 14; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 15; } message UpdateSubSystemsRequest { // 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 // Mandatory google.protobuf.StringValue account_number = 2; // Indactesif account is option account // Mandatory google.protobuf.BoolValue options = 3; // Indicates if account is a margin lending account // Mandatory google.protobuf.BoolValue margin_account = 4; // Indcates if client has funds on deposit // Mandatory google.protobuf.BoolValue fund_on_deposit = 5; // Indicatesif the account is a sponsored account // Mandatory google.protobuf.BoolValue sponsored = 6; // Indicates if account is a portfolio account.If Market Type = OPT value must be Y. // Mandatroy google.protobuf.BoolValue portfolio = 7; // Indicates if account is a nominee client // Mandatroy google.protobuf.BoolValue nominee_account = 8; // Settlement Account (HIN) that belongs to the iBROKER account. // Optional // Maximum size 10 google.protobuf.StringValue settlement_account = 9; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 10; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 11; } message UpdateSubSystemsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message UpdateContractNoteDefaultsRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Set to Y If a client requires reference number to be provided by them when placing an order. // Mandatory google.protobuf.BoolValue order = 3; // Flag indiacting if partial allocation of orders is permitted // Mandatory google.protobuf.BoolValue partial_order = 4; // Stamp Duty Type of the Account. // Available options as per defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue stamp_duty_type = 5; // GST type for the account // Available options as per defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue gst_type = 6; // If set to Y, the unit price will be adjusted to incorporate the charges calculation. // contract notes produced will show nett details // Mandatory // Maximum size 1 google.protobuf.BoolValue show_nett = 7; // used on contract notes for price rounding. Value values 4 or 6. fincleartech.ibroker.NumberValue price_accuracy = 8; // If short sell trades and normal sell transfer are booked to the one order, a seperate contract note will be generated for the short sell portion. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_short_sell = 9; // If a seperate contract note is to be produced per trade booked to the order, set value to Y. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_trades = 10; // If set to Y, an individual contract note will be produced for each 'as princial' booking. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_as_principal = 11; // If the flag is set to Y, all bookings will be consolidated and shown as one line, at the average price. // Mandatory // Maximum size 1 google.protobuf.BoolValue consolidated_booking = 12; // Used only if licensed for brokerage class. // Optional // Maximum size 3 google.protobuf.StringValue default_brokerage_class = 13; // If the firm charges adminstration fee, the charge scale or percentrage pertaining to the client is entered. If not charged leave blank. // Optional // Maximum size 8 google.protobuf.StringValue admin_fee_code = 14; // if entered remarks will show on all contract notes produced for the client. // Optional // Maximum size 40 google.protobuf.StringValue remarks = 15; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 16; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 17; } message UpdateContractNoteDefaultsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetContractNoteDefaultsRequest { google.protobuf.StringValue account_number = 1; } message GetContractNoteDefaultsResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; // iBROKER Account Number // Maximum size 8 // Mandatory google.protobuf.StringValue account_number = 2; // Set to Y If a client requires reference number to be provided by them when placing an order. // Mandatory google.protobuf.BoolValue order = 3; // Flag indiacting if partial allocation of orders is permitted // Mandatory google.protobuf.BoolValue partial_order = 4; // Stamp Duty Type of the Account. // Available options as per defined in iBROKER // Mandatory // Maximum size 1 google.protobuf.StringValue stamp_duty_type = 5; // GST type for the account // Available options as per defined in iBROKER // Optional // Maximum size 1 google.protobuf.StringValue gst_type = 6; // If set to Y, the unit price will be adjusted to incorporate the charges calculation. // contract notes produced will show nett details // Mandatory // Maximum size 1 google.protobuf.BoolValue show_nett = 7; // used on contract notes for price rounding. Value values 4 or 6. fincleartech.ibroker.NumberValue price_accuracy = 8; // If short sell trades and normal sell transfer are booked to the one order, a seperate contract note will be generated for the short sell portion. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_short_sell = 9; // If a seperate contract note is to be produced per trade booked to the order, set value to Y. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_trades = 10; // If set to Y, an individual contract note will be produced for each 'as princial' booking. // Mandatory // Maximum size 1 google.protobuf.StringValue sep_as_principal = 11; // If the flag is set to Y, all bookings will be consolidated and shown as one line, at the average price. // Mandatory // Maximum size 1 google.protobuf.BoolValue consolidated_booking = 12; // Used only if licensed for brokerage class. // Optional // Maximum size 3 google.protobuf.StringValue default_brokerage_class = 13; // If the firm charges adminstration fee, the charge scale or percentrage pertaining to the client is entered. If not charged leave blank. // Optional // Maximum size 8 google.protobuf.StringValue admin_fee_code = 14; // Description of admin fee code if entered google.protobuf.StringValue admin_fee_description = 15; // if entered remarks will show on all contract notes produced for the client. // Optional // Maximum size 40 google.protobuf.StringValue remarks = 16; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 17; // The database user ID who created the record // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 18; } message UpdateProtectReasonRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // Settlement Account (HIN) protection reason is to be applied to // Mandatory // Maximum size 10 google.protobuf.StringValue settlement_account = 2; // Paticipnat id of the settlement account (HIN) // Mandatory // Maximum size 5 google.protobuf.StringValue participant_id = 3; // Protection Reason to be applied to settlement account (HIN) // Available options defined in iBROKER // Optional // Maximum size 3 google.protobuf.StringValue reason = 4; // Indicator to advise if the Settlement Account belongs to a Margin Lending Account // Mandatory google.protobuf.BoolValue margin_account = 5; // The database user ID who created the equity account // Mandatory // Maximum size 18 google.protobuf.StringValue user_id = 6; // The date/time the record was created fincleartech.ibroker.DateTimeValue entry_date_time = 7; } message UpdateProtectReasonResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; } message GetProtectReasonRequest { // Settlement Account (HIN) protection reason is to be applied to // Mandatory // Maximum size 10 google.protobuf.StringValue settlement_account = 1; // Paticipnat id of the settlement account (HIN) // Mandatory // Maximum size 5 google.protobuf.StringValue participant_id = 2; } message GetProtectReasonResponse { // Response Status. fincleartech.ibroker.ResponseStatus status = 1; google.protobuf.StringValue reason = 2; google.protobuf.StringValue description = 3; fincleartech.ibroker.DateTimeValue entry_date_time = 4; } message CloseAccountRequest { // A universally unique identifier for this request. Used for idempotency and correlation with asynchronous notifications. google.protobuf.StringValue request_id = 1; // iBROKER Account Number // Mandatory // Maximum size 8 google.protobuf.StringValue account_number = 2; // Description to be used when creating closing Portfolio Transaction for Option Account // Optional // Maximum size 80 google.protobuf.StringValue portfolio_transaction_details = 3; } message CloseAccountResponse { fincleartech.ibroker.ResponseStatus status = 1; } service IBrokerAccountsService { // Maintain financial settlement details rpc CreateFinancialSettlementDetails (CreateFinancialSettlementDetailsRequest) returns (CreateFinancialSettlementDetailsResponse); rpc UpdateFinancialSettlementDetails (UpdateFinancialSettlementDetailsRequest) returns (UpdateFinancialSettlementDetailsResponse); rpc GetFinancialSettlementDetails (GetFinancialSettlementDetailsRequest) returns (GetFinancialSettlementDetailsResponse); // Maintain distribution details rpc CreateDistributionDetails (CreateDistributionDetailsRequest) returns (CreateDistributionDetailsResponse); rpc UpdateDistributionDetails (UpdateDistributionDetailsRequest) returns (UpdateDistributionDetailsResponse); rpc GetDistributionDetails (GetDistributionDetailsRequest) returns (GetDistributionDetailsResponse); // Maintain client communication details rpc CreateClientCommunicationDetails (CreateClientCommunicationDetailsRequest) returns (CreateClientCommunicationDetailsResponse); rpc UpdateClientCommunicationDetails (UpdateClientCommunicationDetailsRequest) returns (UpdateClientCommunicationDetailsResponse); rpc GetClientCommunicationDetails (GetClientCommunicationDetailsRequest) returns (GetClientCommunicationDetailsResponse); // Maintain account communication details rpc CreateAccountCommunicationDetails (CreateAccountCommunicationDetailsRequest) returns (CreateAccountCommunicationDetailsResponse); rpc UpdateAccountCommunicationDetails (UpdateAccountCommunicationDetailsRequest) returns (UpdateAccountCommunicationDetailsResponse); rpc GetAccountCommunicationDetails (GetAccountCommunicationDetailsRequest) returns (GetAccountCommunicationDetailsResponse); // Maintain clients rpc CreateClient (CreateClientRequest) returns (CreateClientResponse); rpc UpdateClient (UpdateClientRequest) returns (UpdateClientResponse); rpc GetClient (GetClientRequest) returns (GetClientResponse); // 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 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 (CreateOptionsAccountRequest) returns (CreateOptionsAccountResponse); rpc GetOptionsAccount (GetOptionsAccountRequest) returns (GetOptionsAccountResponse); // Create a new Settlement Account (HIN) associated with an existing iBroker Account rpc CreateSettlementAccount(CreateSettlementAccountRequest) returns (CreateSettlementAccountResponse); rpc GetSettlementAccount(GetSettlementAccountRequest) returns (GetSettlementAccountResponse); // Maintain standing settlement instructions for an account rpc CreateAccountSettlementInstruction(CreateAccountSettlementInstructionRequest) returns (CreateAccountSettlementInstructionResponse); rpc UpdateAccountSettlementInstruction(UpdateAccountSettlementInstructionRequest) returns (UpdateAccountSettlementInstructionResponse); rpc GetAccountSettlementInstructions (GetAccountSettlementInstructionsRequest) returns (GetAccountSettlementInstructionsResponse); // Maintain contacts rpc CreateContact(CreateContactRequest) returns (CreateContactResponse); rpc UpdateContact(UpdateContactRequest) returns (UpdateContactResponse); rpc GetContact(GetContactRequest) returns (GetContactResponse); // Maintain issuer residency rpc CreateIssuerResidency (CreateIssuerResidencyRequest) returns (CreateIssuerResidencyResponse); rpc UpdateIssuerResidency (UpdateIssuerResidencyRequest) returns (UpdateIssuerResidencyResponse); rpc GetIssuerResidency (GetIssuerResidencyRequest) returns (GetIssuerResidencyResponse); // Maintain account types rpc UpdateAccountType (UpdateAccountTypeRequest) returns (UpdateAccountTypeResponse); rpc GetAccountType (GetAccountTypeRequest) returns (GetAccountTypeResponse); // Maintain account documents rpc CreateAccountDocument (CreateAccountDocumentRequest) returns (CreateAccountDocumentResponse); rpc UpdateAccountDocument (UpdateAccountDocumentRequest) returns (UpdateAccountDocumentResponse); rpc GetAccountDocuments (GetAccountDocumentsRequest) returns (GetAccountDocumentsResponse); // Maintain account miscellaneous data rpc UpdateAccountMiscData (UpdateAccountMiscDataRequest) returns (UpdateAccountMiscDataResponse); rpc GetAccountMiscData (GetAccountMiscDataRequest) returns (GetAccountMiscDataResponse); // Maintain settlement parameters rpc UpdateSettlementParams (UpdateSettlementParamsRequest) returns (UpdateSettlementParamsResponse); rpc GetSettlementParams (GetSettlementParamsRequest) returns (GetSettlementParamsResponse); // Maintain sub systems rpc UpdateSubSystems (UpdateSubSystemsRequest) returns (UpdateSubSystemsResponse); // Maintain contract note defaults rpc UpdateContractNoteDefaults (UpdateContractNoteDefaultsRequest) returns (UpdateContractNoteDefaultsResponse); rpc GetContractNoteDefaults (GetContractNoteDefaultsRequest) returns (GetContractNoteDefaultsResponse); // Maintain the protect reason rpc UpdateProtectReason (UpdateProtectReasonRequest) returns (UpdateProtectReasonResponse); rpc GetProtectReason (GetProtectReasonRequest) returns (GetProtectReasonResponse); // Close an account rpc CloseAccount (CloseAccountRequest) returns (CloseAccountResponse); }