Referencia de la Clase Sage.ES.BankingCloud.BcEsBankingCloudManager

Banking cloud manager for spanish Sage50 and Sage200 products. Más...

Diagrama de herencias de Sage.ES.BankingCloud.BcEsBankingCloudManager
Sage.ES.BankingCloud.IBcEsBankingCloudManager

Métodos públicos

 BcEsBankingCloudManager (BcEsManagerSettings bcEsManagerSettings)
 Constructor of banking cloud manager for spanish Sage500 and Sage200 products. 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...
 
bool GetOrganizationObject (out object bcEsOrganisation)
 Get organization object with all the 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 the fields info. Más...
 
bool GetCompanyField (string fieldname, out object fieldvalue)
 Get a company field value. Más...
 
bool GetCompaniesObjects (out List< object > listCompanies)
 Get list of companies objects corresponding to companies that belong to an organization. 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 info of a existing company. Más...
 
bool GetBanks (out List< object > listBanks, bool direct=true, bool indirect=false, string country="")
 Get list of 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 the 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 the fields info. 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 a serie of concrete fields bank account like status, bankId, lasTransactionID, dataProvider, authAlwaysRequired, accountIdentifier, requestedStartDate. Más...
 
bool GetBankAccountField (string bankAccountID, string fieldname, out object fieldvalue)
 Get a bank account field value. Más...
 
bool GetBankAccountsObjects (out List< object > listBankAccounts)
 Get list of bank accounts objects corresponding to banks accounts that belong to a organization and company. Más...
 
bool UpdateBankAccount (string bankAccountID, BcEsBankAccount bcEsBankAccount, bool modePatch=true, bool modePut=false)
 Update info of a existing bank account. Más...
 
bool UpdateBankAccountWithFields (string bankAccountID, Dictionary< string, string > fieldsBankAccount, bool modePatch=true, bool modePut=false)
 Update a existing bank account where the bank account data to update 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 GetBankAccountTransactions (string bankAccountID, out object bankTransactions, int transStartIndex=0, int transEndIndex=0, bool scheduledTask=false)
 Get bank account transactions interval from a transaction start index to a transaction end index. 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...
 
- Métodos públicos heredados desde Sage.ES.BankingCloud.IBcEsBankingCloudManager
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 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 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 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...
 

Propiedades

BcEsManagerSettings Settings [get, set]
 Bankingcloud manager settings object. Más...
 
string ErrorMessage [get, set]
 Error message if anything goes wrong. Más...
 
- Propiedades heredados desde Sage.ES.BankingCloud.IBcEsBankingCloudManager
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

Banking cloud manager for spanish Sage50 and Sage200 products.

Definición en la línea 90 del archivo BcManager.cs.

Documentación del constructor y destructor

◆ BcEsBankingCloudManager()

Sage.ES.BankingCloud.BcEsBankingCloudManager.BcEsBankingCloudManager ( BcEsManagerSettings  bcEsManagerSettings)
inline

Constructor of banking cloud manager for spanish Sage500 and Sage200 products.

Parámetros
bcEsManagerSettingsManager settings object with the configuration to apply.

Definición en la línea 139 del archivo BcManager.cs.

Documentación de las funciones miembro

◆ DeleteBankAccount()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.DeleteBankAccount ( string  bankAccountID)
inline

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

Parámetros
bankAccountIDBank account ID to remove.
Devuelve
Return true if the DeleteBankAccount process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1827 del archivo BcManager.cs.

◆ GetBankAccountConcreteData()

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

Get a serie of concrete fields bank account like status, bankId, lasTransactionID, dataProvider, authAlwaysRequired, accountIdentifier, requestedStartDate.

Parámetros
bankAccountIDBank account ID from which want to get the information.
statusOut parameter, bank account status on banking cloud platform: "active", "pending", "invalid", "cancelled", "authRequired"
bankIDOut parameter, the unique identifier of the bank this bank account belongs to.
lastTransactionIDOut parameter, The most recent transaction Id received from the bank for this account.
dataProviderOut parameter, the data provider type that is to be used when obtaining bank data for this account: "direct" or "indirect".
authAlwaysRequiredOut 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.
accountIdentifierOut parameter, the real-world account number for the bank account.
requestedStartDateOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1372 del archivo BcManager.cs.

◆ GetBankAccountField()

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

Get a bank account field value.

Parámetros
bankAccountIDBank account ID from which want to get the information.
fieldnameFieldname of bankaccount from which want to get the value, be carefull, case sensitive.
fieldvalueOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1459 del archivo BcManager.cs.

◆ GetBankAccountObject()

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

Get bank account object with all the fields info.

Parámetros
bankAccountIDBank account ID from which want to get the information.
bcEsBankAccountOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1293 del archivo BcManager.cs.

◆ GetBankAccountsObjects()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetBankAccountsObjects ( out List< object >  listBankAccounts)
inline

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

Parámetros
listBankAccountsOut 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.

Definición en la línea 1550 del archivo BcManager.cs.

◆ GetBankAccountTransactions()

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

Get bank account transactions interval from a transaction start index to a transaction end index.

Parámetros
bankAccountIDBank account ID to get the transactions.
bankTransactionsOut parameter, bank transactions object where to put the information obtained.
transStartIndexIndex of the first transaction to get. Parameter optional, if not declared assume first transaction from the requestedStartDate bank account.
transEndIndexIndex of the last transaction to get. Parameter optional, if not declared assume last transaction existing.
scheduledTaskIf 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1953 del archivo BcManager.cs.

◆ GetBankField()

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

Get a bank field value.

Parámetros
bankIDBank ID from which want to get the information.
fieldnameFieldname of bank from which want to get the value, be carefull, case sensitive.
fieldvalueOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1211 del archivo BcManager.cs.

◆ GetBankObject()

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

Get bank object with all the fields info.

Parámetros
bankIDBank ID in the banking cloud platform to get te info.
bcEsBankOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1154 del archivo BcManager.cs.

◆ GetBanks()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetBanks ( out List< object >  listBanks,
bool  direct = true,
bool  indirect = false,
string  country = "" 
)
inline

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

Parámetros
listBanksOut parameter, banks list where to put the information obtained.


Parámetros
directReturns direct banks.
indirectReturns indirect banks.

///

Parámetros
country3 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.

Definición en la línea 1073 del archivo BcManager.cs.

◆ GetCompaniesObjects()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetCompaniesObjects ( out List< object >  listCompanies)
inline

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

Parámetros
listCompaniesCompanies 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.

Definición en la línea 842 del archivo BcManager.cs.

◆ GetCompanyField()

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

Get a company field value.

Parámetros
fieldnameFieldname of company from which want to get the value, be carefull, case sensitive.
fieldvalueOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 758 del archivo BcManager.cs.

◆ GetCompanyObject()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetCompanyObject ( out object  bcEsCompany)
inline

Get company object with all the fields info.

Parámetros
bcEsCompanyOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 693 del archivo BcManager.cs.

◆ GetMetaData()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetMetaData ( out object  bcEsMetaData)
inline

Get object with useful metada about the Banking Cloud service.

Parámetros
bcEsMetaDataOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 2114 del archivo BcManager.cs.

◆ GetOrganizationField()

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

Get a organisation field value.

Parámetros
fieldnameFieldname of organization from which want to get the value, be carefull, case sensitive.
fieldvalueOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 611 del archivo BcManager.cs.

◆ GetOrganizationObject()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.GetOrganizationObject ( out object  bcEsOrganisation)
inline

Get organization object with all the fields info.

Parámetros
bcEsOrganisationOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 554 del archivo BcManager.cs.

◆ ManualSigningKeyRefresh()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.ManualSigningKeyRefresh ( )
inline

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

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

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

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 428 del archivo BcManager.cs.

◆ PostBankSuggestion()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.PostBankSuggestion ( BcEsBankSuggestion  bcEsBankSuggestion)
inline

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

Parámetros
bcEsBankSuggestionObject 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 2164 del archivo BcManager.cs.

◆ PostNewCompany()

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

Create a new company within in a existing organization.

Parámetros
bcEsCompanyObject BcEsCompany definition to post, only the field 'name' is required, the fields not declared will be remain null.
newCompanyIDOut parameter, new company ID assigned.
Devuelve
Return true if the PostNewCompany process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 900 del archivo BcManager.cs.

◆ ReAuthBankAccount()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.ReAuthBankAccount ( string  bankAccountID)
inline

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

Parámetros
bankAccountIDBank 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".

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 482 del archivo BcManager.cs.

◆ SetupNewBankAccount() [1/2]

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.SetupNewBankAccount ( out string  bankAccountID)
inline

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

Parámetros
bankAccountIDOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 256 del archivo BcManager.cs.

◆ SetupNewBankAccount() [2/2]

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

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

Parámetros
organizationIDOut parameter, organization ID created where has been done the setup the new bank account.
companyIDOut paramter, company ID created where has been done the setup the new bank account.
bankAccountIDOut parameter, the bank account ID created.
emailAdminOut 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 330 del archivo BcManager.cs.

◆ UpdateBankAccount()

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

Update info of a existing bank account.

Parámetros
bankAccountIDBank account ID to update.
bcEsBankAccountBank account object with the info to update.
modePatchUpdate mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePutUpdate 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 PutBankAccount process ends successfully, false otherwise. If false take a look to .ErrorMessage property.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 1617 del archivo BcManager.cs.

◆ UpdateBankAccountWithFields()

bool Sage.ES.BankingCloud.BcEsBankingCloudManager.UpdateBankAccountWithFields ( string  bankAccountID,
Dictionary< string, string >  fieldsBankAccount,
bool  modePatch = true,
bool  modePut = false 
)
inline

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

Parámetros
bankAccountIDBank account ID to update.
fieldsBankAccountDictionary string,string with the fields and values of bank account to update.
modePatchUpdate mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePutUpdate 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.

Definición en la línea 1722 del archivo BcManager.cs.

◆ UpdateCompany()

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

Update info of a existing company.

Parámetros
bcEsCompanyCompany object with the data to update.
modePatchUpdate mode: patch, to update specific fields only (without the need to pass the full object, just only what you're changing.)
modePutUpdate 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.

Implementa Sage.ES.BankingCloud.IBcEsBankingCloudManager.

Definición en la línea 969 del archivo BcManager.cs.

Documentación de propiedades

◆ ErrorMessage

string Sage.ES.BankingCloud.BcEsBankingCloudManager.ErrorMessage
getset

Error message if anything goes wrong.

Definición en la línea 205 del archivo BcManager.cs.

◆ Settings

BcEsManagerSettings Sage.ES.BankingCloud.BcEsBankingCloudManager.Settings
getset

Bankingcloud manager settings object.

Definición en la línea 187 del archivo BcManager.cs.


La documentación para esta clase fue generada a partir del siguiente fichero: