Interface of Banking Cloud ES Manager (for BcEsBankingCloudManager object). Más...

Diagrama de herencias de Sage.ES.BankingCloud.IBcEsBankingCloudManager

Métodos públicos
bool	GetOrganizationObject (out object bcEsOrganisation)
	Get organization object with all fields info. Más...

bool	GetOrganizationField (string fieldname, out object fieldvalue)
	Get a organisation field value. Más...

bool	GetCompanyObject (out object bcEsCompany)
	Get company object with all fields info. Más...

bool	GetCompaniesObjects (out System.Collections.Generic.List< object > listCompanies)
	Get list of companies objects corresponding to companies that belong to an organization. Más...

bool	GetCompanyField (string fieldname, out object fieldvalue)
	Get a company field value. Más...

bool	PostNewCompany (BcEsCompany bcEsCompany, out string newCompanyID)
	Create a new company within in a existing organization. Más...

bool	UpdateCompany (BcEsCompany bcEsCompany, bool modePatch=true, bool modePut=false)
	Update company info. Más...

bool	GetBanks (out System.Collections.Generic.List< object > listBanks, bool direct=true, bool indirect=false, string country="")
	Get banks available for connect. By default only direct bank dataprovider are shown. Más...

bool	GetBankObject (string bankID, out object bcEsBank)
	Get bank object with all fields info. Más...

bool	GetBankField (string bankID, string fieldname, out object fieldvalue)
	Get a bank field value. Más...

bool	GetBankAccountObject (string bankAccountID, out object bcEsBankAccount)
	Get bank account object with all fields info. Más...

bool	GetBankAccountField (string bankAccountID, string fieldname, out object fieldvalue)
	Get a bank account field value. Más...

bool	GetBankAccountConcreteData (string bankAccountID, out string status, out string bankID, out int lastTransactionID, out string dataProvider, out bool authAlwaysRequired, out string accountIdentifier, out DateTime? requestedStartDate)
	Get some fields info from a bank account like status, bankId, lasTransactionID, dataProvider, authAlwaysRequired, accountIdentifier, requestedStartDate Más...

bool	GetBankAccountsObjects (out System.Collections.Generic.List< object > listBankAccounts)
	Get list of bank accounts objects corresponding to banks accounts that belong to a organization and company. Más...

bool	GetBankAccountTransactions (string bankAccountID, out object bankTransactions, int transStartIndex=0, int transEndIndex=0, bool scheduledTask=false)
	Get bank account transactions from a transaction index until another transaction index. Más...

bool	UpdateBankAccount (string bankAccountID, BcEsBankAccount bcEsBankAccount, bool modePatch=true, bool modePut=false)
	Update a existing bank account. Más...

bool	UpdateBankAccountWithFields (string bankAccountID, System.Collections.Generic.Dictionary< string, string > fieldsBankAccount, bool modePatch=true, bool modePut=false)
	Update a existing bank account where the bank account data is in a fields and values list. Más...

bool	DeleteBankAccount (string bankAccountID)
	Delete (disconnect) a bank account from the banking cloud platform. Más...

bool	GetMetaData (out object bcEsMetaData)
	Get object with useful metada about the banking cloud service. Más...

bool	PostBankSuggestion (BcEsBankSuggestion bcEsBankSuggestion)
	Request support for a bank be added to the banking cloud service. Más...

bool	SetupNewBankAccount (out string bankAccountID)
	Setup a new bank account in a existing organization and company. Más...

bool	SetupNewBankAccount (out string organizationID, out string companyID, out string bankAccountID, out string emailAdmin)
	Setup a new bank account in a new organization and company. Más...

bool	ManualSigningKeyRefresh ()
	Launch the manual key refresh process for obtain a new signing key. Más...

bool	ReAuthBankAccount (string bankAccountID)
	Launch the reauthentication process of a bank account for enter the credentials to access the bank accounts on the bank's website. Más...

Propiedades
string	ErrorMessage `[get, set]`
	Error message if occurrs. Más...

BcEsManagerSettings	Settings `[get, set]`
	Object settings for configure the manager. Más...

Descripción detallada

Interface of Banking Cloud ES Manager (for BcEsBankingCloudManager object).

Definición en la línea 31 del archivo IBcEsManager.cs.

Documentación de las funciones miembro

◆ DeleteBankAccount()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.DeleteBankAccount ( string bankAccountID )

Delete (disconnect) a bank account from the banking cloud platform.

Parámetros

bankAccountID Bank account ID to remove.

Devuelve: Return true if the DeleteBankAccount process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankAccountConcreteData()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankAccountConcreteData	(	string	bankAccountID,
		out string	status,
		out string	bankID,
		out int	lastTransactionID,
		out string	dataProvider,
		out bool	authAlwaysRequired,
		out string	accountIdentifier,
		out DateTime?	requestedStartDate
	)

Get some fields info from a bank account like status, bankId, lasTransactionID, dataProvider, authAlwaysRequired, accountIdentifier, requestedStartDate

Parámetros

bankAccountID	Bank account ID from which want to get the information.
status	Out parameter, bank account status on banking cloud platform: "active", "pending", "invalid", "cancelled", "authRequired"
bankID	Out parameter, the unique identifier of the bank this bank account belongs to.
lastTransactionID	Out parameter, The most recent transaction Id received from the bank for this account.
dataProvider	Out parameter, the data provider type that is to be used when obtaining bank data for this account: "direct" or "indirect".
authAlwaysRequired	Out parameter, used to inform the consuming product if a bank requires authenentication each time in order for us to obtain transactions. Typically if the bank data is obtained indirect and the bank uses MFA. When this is true the consuming app should call the indirectAuth endpoint to authorise banking cloud to get new transactions from there bank.
accountIdentifier	Out parameter, the real-world account number for the bank account.
requestedStartDate	Out parameter, date the customer has specified that they would like to start getting transactions from.

Devuelve: Return true if the GetBankAGetBankAccountConcreteData process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankAccountField()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankAccountField	(	string	bankAccountID,
		string	fieldname,
		out object	fieldvalue
	)

Get a bank account field value.

Parámetros

bankAccountID	Bank account ID from which want to get the information.
fieldname	Fieldname of bankaccount from which want to get the value, be carefull, case sensitive.
fieldvalue	Out parameter, the value of the field want to get.

Devuelve: Return true if the GetBankAccountField process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankAccountObject()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankAccountObject	(	string	bankAccountID,
		out object	bcEsBankAccount
	)

Get bank account object with all fields info.

Parámetros

bankAccountID	Bank account ID from which want to get the information.
bcEsBankAccount	Out parameter, bank account object where to put the information obtained.

Devuelve: Return true if the GetBankAccountObject process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankAccountsObjects()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankAccountsObjects ( out System.Collections.Generic.List< object > listBankAccounts )

Get list of bank accounts objects corresponding to banks accounts that belong to a organization and company.

Parámetros

listBankAccounts Out parameter, bank account list where to put the information obtained.

Devuelve: Return true if the GetBankAccountsObjects process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

◆ GetBankAccountTransactions()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankAccountTransactions	(	string	bankAccountID,
		out object	bankTransactions,
		int	transStartIndex = `0`,
		int	transEndIndex = `0`,
		bool	scheduledTask = `false`
	)

Get bank account transactions from a transaction index until another transaction index.

Parámetros

bankAccountID	Bank account ID to get the transactions.
bankTransactions	Out parameter, bank transactions object where to put the information obtained.
transStartIndex	Index of the first transaction to get, parameter optional, if not declared it is assumed first transaction from the requestedStartDate bank account.
transEndIndex	Index of the last transaction to get, parameter optional, if not declared it is assumed last transaction existing.
scheduledTask	If the download of transactions is called in a scheduled task context. If so, if the account is in a reauth state ot the signingkey requires a refresh can't continue and return error. If the parameter is not declared assume the download is not executed in a scheduled task context.

Devuelve: Return true if the GetBankAccountTransactions process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankField()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankField	(	string	bankID,
		string	fieldname,
		out object	fieldvalue
	)

Get a bank field value.

Parámetros

bankID	Bank ID from which want to get the information.
fieldname	Fieldname of bank from which want to get the value, be carefull, case sensitive.
fieldvalue	Out parameter, the value of the field want to get.

Devuelve: Return true if the GetBankField process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBankObject()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBankObject	(	string	bankID,
		out object	bcEsBank
	)

Get bank object with all fields info.

Parámetros

bankID	Bank ID in the banking cloud platform to get te info.
bcEsBank	Out parameter, bank object where to put the information obtained.

Devuelve: Return true if the GetBankObject process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetBanks()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetBanks	(	out System.Collections.Generic.List< object >	listBanks,
		bool	direct = `true`,
		bool	indirect = `false`,
		string	country = `""`
	)

Get banks available for connect. By default only direct bank dataprovider are shown.

Parámetros

listBanks Out parameter, banks list where to put the information obtained.

Parámetros

direct	Returns direct banks.
indirect	Returns indirect banks.

///

Parámetros

country 3 d�git country code, optional parameter by default empty. In these case the country is obtained from regional configuration on operating system.

Devuelve: Return true if the GetBanks process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

◆ GetCompaniesObjects()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetCompaniesObjects ( out System.Collections.Generic.List< object > listCompanies )

Get list of companies objects corresponding to companies that belong to an organization.

Parámetros

listCompanies Companies list within organizataion ID passed as first parameter.

Devuelve: Return true if the GetCompaniesObjects process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

◆ GetCompanyField()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetCompanyField	(	string	fieldname,
		out object	fieldvalue
	)

Get a company field value.

Parámetros

fieldname	Fieldname of company from which want to get the value, be carefull, case sensitive.
fieldvalue	Out parameter, the value of the field want to get.

Devuelve: Return true if the GetCompanyField process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetCompanyObject()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetCompanyObject ( out object bcEsCompany )

Get company object with all fields info.

Parámetros

bcEsCompany Out parameter, company object where to put the information obtained.

Devuelve: Return true if the GetCompanyObject process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetMetaData()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetMetaData ( out object bcEsMetaData )

Get object with useful metada about the banking cloud service.

Parámetros

bcEsMetaData Out parameter, metadata object where to put the information obtained.

Devuelve: Return true if the GetMetaData process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetOrganizationField()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetOrganizationField	(	string	fieldname,
		out object	fieldvalue
	)

Get a organisation field value.

Parámetros

fieldname	Fieldname of organization from which want to get the value, be carefull, case sensitive.
fieldvalue	Out parameter, the value of the field want to get.

Devuelve: Return true if the GetOrganizationField process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ GetOrganizationObject()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.GetOrganizationObject ( out object bcEsOrganisation )

Get organization object with all fields info.

Parámetros

bcEsOrganisation Out parameter, organisation object where to put the information obtained.

Devuelve: Return true if the GetOrganization process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ ManualSigningKeyRefresh()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.ManualSigningKeyRefresh ( )

Launch the manual key refresh process for obtain a new signing key.

Required when the signing key stored in the integration product applicacion are invalid.

Devuelve: Return true if the manual signing key refresh end ups successful, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ PostBankSuggestion()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.PostBankSuggestion ( BcEsBankSuggestion bcEsBankSuggestion )

Request support for a bank be added to the banking cloud service.

Parámetros

bcEsBankSuggestion Object BcEsBankSuggestion definition with the bank suggestion to post.

Devuelve: Return true if the PostBankSuggestion process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ PostNewCompany()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.PostNewCompany	(	BcEsCompany	bcEsCompany,
		out string	newCompanyID
	)

Create a new company within in a existing organization.

Parámetros

bcEsCompany	Object BcEsCompany definition to post, only the field 'name' is required, the fields not declared will be remain null.
newCompanyID	Out parameter, new company ID assigned.

Devuelve: Return true if the PostNewCompany process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ ReAuthBankAccount()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.ReAuthBankAccount ( string bankAccountID )

Launch the reauthentication process of a bank account for enter the credentials to access the bank accounts on the bank's website.

Parámetros

bankAccountID Bank account ID to re-authenticate.

Devuelve: Return true if the reauthentication ends successful, false otherwise. If false take a look to .ErrorMessage property.

You may have to call this method, for example, if the user has changed their credentials in the bank. The signing key is not changing in this process. For call this method is required that state of the bank acoount are "authRequired".

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ SetupNewBankAccount() [1/2]

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.SetupNewBankAccount ( out string bankAccountID )

Setup a new bank account in a existing organization and company.

Parámetros

bankAccountID Out parameter, represents the bank account ID created.

Devuelve: Return true if the setup new bank account process ends successful, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ SetupNewBankAccount() [2/2]

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.SetupNewBankAccount	(	out string	organizationID,
		out string	companyID,
		out string	bankAccountID,
		out string	emailAdmin
	)

Setup a new bank account in a new organization and company.

Parámetros

organizationID	Out parameter, organization ID created where has been done the setup the new bank account.
companyID	Out paramter, company ID created where has been done the setup the new bank account.
bankAccountID	Out parameter, the bank account ID created.
emailAdmin	Out parameter, email address for the administrator of this created organization.

Devuelve: Return true if the setup new bank account process ends successful, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ UpdateBankAccount()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.UpdateBankAccount	(	string	bankAccountID,
		BcEsBankAccount	bcEsBankAccount,
		bool	modePatch = `true`,
		bool	modePut = `false`
	)

Update a existing bank account.

Parámetros

bankAccountID	Bank account ID to update.
bcEsBankAccount	Bank account object with the info to update.
modePatch	Update mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePut	Update mode: put, to update the full BcEsBankAccount (pass the full object to Banking Cloud, fields not declared will update to null value)

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

◆ UpdateBankAccountWithFields()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.UpdateBankAccountWithFields	(	string	bankAccountID,
		System.Collections.Generic.Dictionary< string, string >	fieldsBankAccount,
		bool	modePatch = `true`,
		bool	modePut = `false`
	)

Update a existing bank account where the bank account data is in a fields and values list.

Parámetros

bankAccountID	Bank account ID to update.
fieldsBankAccount	Dictionary string,string with the fields and values of bank account to update.
modePatch	Update mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePut	Update mode: put, to update the full BcEsBankAccount (pass the full object to Banking Cloud, fields not declared will update to null value)

Devuelve: Return true if the UpdateBankAccountWithFields process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

◆ UpdateCompany()

bool Sage.ES.BankingCloud.IBcEsBankingCloudManager.UpdateCompany	(	BcEsCompany	bcEsCompany,
		bool	modePatch = `true`,
		bool	modePut = `false`
	)

Update company info.

Parámetros

bcEsCompany	Company object with the data to update.
modePatch	Update mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePut	Update mode: put, to update the full BcEsCompany (pass the full object to Banking Cloud, fields not declared will update to null value)

Devuelve: Return true if the UpdateCompany process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementado en Sage.ES.BankingCloud.BcEsBankingCloudManager.

Documentación de propiedades

◆ ErrorMessage

string Sage.ES.BankingCloud.IBcEsBankingCloudManager.ErrorMessage

getset

Error message if occurrs.

Definición en la línea 39 del archivo IBcEsManager.cs.

◆ Settings

BcEsManagerSettings Sage.ES.BankingCloud.IBcEsBankingCloudManager.Settings

getset

Object settings for configure the manager.

Definición en la línea 46 del archivo IBcEsManager.cs.

La documentación para este interfaz fue generada a partir del siguiente fichero:

C:/Agent/_work/5/s/sage.ew/Sage.ES.BankingCloud/Interfaces/IBcEsManager.cs

Métodos públicos

Propiedades

Descripción detallada

Documentación de las funciones miembro

◆ DeleteBankAccount()

◆ GetBankAccountConcreteData()

◆ GetBankAccountField()

◆ GetBankAccountObject()

◆ GetBankAccountsObjects()

◆ GetBankAccountTransactions()

◆ GetBankField()

◆ GetBankObject()

◆ GetBanks()

◆ GetCompaniesObjects()

◆ GetCompanyField()

◆ GetCompanyObject()

◆ GetMetaData()

◆ GetOrganizationField()

◆ GetOrganizationObject()

◆ ManualSigningKeyRefresh()

◆ PostBankSuggestion()

◆ PostNewCompany()

◆ ReAuthBankAccount()

◆ SetupNewBankAccount() [1/2]

◆ SetupNewBankAccount() [2/2]

◆ UpdateBankAccount()

◆ UpdateBankAccountWithFields()

◆ UpdateCompany()

Documentación de propiedades

◆ ErrorMessage

◆ Settings