Table of Contents

Class UtilitariosWS

Namespace
PHCWS
Assembly
PHCWS.dll

Management services that represent Utilities.

[WebService(Namespace = "http://www.phcgo.net/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[DesignerGenerated]
public class UtilitariosWS : PHCGenericWS, IComponent, IDisposable, IServiceProvider
Inheritance
UtilitariosWS

Methods

BankBalanceInquiry(int, string) 

[WebMethod]
public PHCResult BankBalanceInquiry(int noconta, string usStamp)

Parameters

Nome Tipo Descrição
noconta int
usStamp string

Returns

PHCResult

DelSessionErrors() 

[WebMethod]
public PHCResult DelSessionErrors()

Returns

PHCResult

DelSqlProfiler() 

[WebMethod]
public PHCResult DelSqlProfiler()

Returns

PHCResult

DownloadGenericLog() 

[WebMethod]
public PHCResult DownloadGenericLog()

Returns

PHCResult

DownloadSqlLog() 

[WebMethod]
public PHCResult DownloadSqlLog()

Returns

PHCResult

EndAPIOperation()

Ends the current API operation

[WebMethod]
public PHCResult EndAPIOperation()

Returns

PHCResult

ExportAccountingDiagnostic(int, List<DiagnosticResultVO>) 

[WebMethod]
public PHCResult ExportAccountingDiagnostic(int year, List<DiagnosticResultVO> diagnosis)

Parameters

Nome Tipo Descrição
year int
diagnosis List<DiagnosticResultVO>

Returns

PHCResult

ExportData(List<object>, string, List<string>, string, List<string>, List<string>, List<int>) 

[WebMethod]
public PHCResult ExportData(List<object> records, string contentType, List<string> ColumnFields, string entityName, List<string> fieldsTypes, List<string> titles, List<int> sizes)

Parameters

Nome Tipo Descrição
records List<object>
contentType string
ColumnFields List<string>
entityName string
fieldsTypes List<string>
titles List<string>
sizes List<int>

Returns

PHCResult

ExportDocument(List<object>, string, List<string>, string, List<string>, List<string>, List<int>, OrientationTypes, bool) 

[WebMethod]
public PHCResult ExportDocument(List<object> records, string contentType, List<string> ColumnFields, string entityName, List<string> fieldsTypes, List<string> titles, List<int> sizes, OrientationTypes orientationType, bool shouldAddEntityName)

Parameters

Nome Tipo Descrição
records List<object>
contentType string
ColumnFields List<string>
entityName string
fieldsTypes List<string>
titles List<string>
sizes List<int>
orientationType OrientationTypes
shouldAddEntityName bool

Returns

PHCResult

ExportLogRecord(string, List<LogRecordVO>, int) 

[WebMethod]
public PHCResult ExportLogRecord(string contentType, List<LogRecordVO> records, int orientationType)

Parameters

Nome Tipo Descrição
contentType string
records List<LogRecordVO>
orientationType int

Returns

PHCResult

ExportPayrollDiagnostic(PayrollDiagnosticConfig, List<DiagnosticResultVO>) 

[WebMethod]
public PHCResult ExportPayrollDiagnostic(PayrollDiagnosticConfig config, List<DiagnosticResultVO> diagnosis)

Parameters

Nome Tipo Descrição
config PayrollDiagnosticConfig
diagnosis List<DiagnosticResultVO>

Returns

PHCResult

ExportTsqlRecord(string, List<TSqlRecordVO>, int) 

[WebMethod]
public PHCResult ExportTsqlRecord(string contentType, List<TSqlRecordVO> records, int orientationType)

Parameters

Nome Tipo Descrição
contentType string
records List<TSqlRecordVO>
orientationType int

Returns

PHCResult

ExportUserLogin(string, List<UserLoginVO>, int) 

[WebMethod]
public PHCResult ExportUserLogin(string contentType, List<UserLoginVO> records, int orientationType)

Parameters

Nome Tipo Descrição
contentType string
records List<UserLoginVO>
orientationType int

Returns

PHCResult

GetAccMovInquiry(int, DateTime, string) 

[WebMethod]
public PHCResult GetAccMovInquiry(int noconta, DateTime endDate, string usStamp)

Parameters

Nome Tipo Descrição
noconta int
endDate DateTime
usStamp string

Returns

PHCResult

GetAccountingSaft(GetSaftVO) 

[WebMethod]
public PHCResult GetAccountingSaft(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

Returns

PHCResult

GetActiveLogins() 

[WebMethod]
public PHCResult GetActiveLogins()

Returns

PHCResult

GetClosedDate() 

[WebMethod]
public PHCResult GetClosedDate()

Returns

PHCResult

GetFxdfStartWith(string) 

[WebMethod]
public PHCResult GetFxdfStartWith(string key)

Parameters

Nome Tipo Descrição
key string

Returns

PHCResult

GetIntegratedSaft(GetSaftVO) 

[WebMethod]
public PHCResult GetIntegratedSaft(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

Returns

PHCResult

GetSaftPurchases(GetSaftVO) 

[WebMethod]
public PHCResult GetSaftPurchases(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

Returns

PHCResult

GetSessionErrors(LogFilterVO) 

[WebMethod]
public PHCResult GetSessionErrors(LogFilterVO filter)

Parameters

Nome Tipo Descrição
filter LogFilterVO

Returns

PHCResult

GetSqlProfiler(LogFilterVO) 

[WebMethod]
public PHCResult GetSqlProfiler(LogFilterVO filter)

Parameters

Nome Tipo Descrição
filter LogFilterVO

Returns

PHCResult

OpenBalance(OpeningBalanceConfig, string) 

[WebMethod]
[AttSyncLock("errors.business.openingbalance.YearAlreadyBeingOpen")]
public PHCResult OpenBalance(OpeningBalanceConfig config, string file)

Parameters

Nome Tipo Descrição
config OpeningBalanceConfig
file string

Returns

PHCResult

PreviewAccountMovementsTransfer(AccountMovementsTransferConfig) 

[WebMethod]
public PHCResult PreviewAccountMovementsTransfer(AccountMovementsTransferConfig config)

Parameters

Nome Tipo Descrição
config AccountMovementsTransferConfig

Returns

PHCResult

PreviewAccountingDiagnostic(ProcessVO<AccountingDiagnosticConfig>) 

[WebMethod]
public PHCResult PreviewAccountingDiagnostic(ProcessVO<AccountingDiagnosticConfig> task)

Parameters

Nome Tipo Descrição
task ProcessVO<AccountingDiagnosticConfig>

Returns

PHCResult

QuickLookUpdate()

Reindexação da Procura Rápida

[WebMethod]
public PHCResult QuickLookUpdate()

Returns

PHCResult

RemoveFxdfByKey(string, bool) 

[WebMethod]
public PHCResult RemoveFxdfByKey(string key, bool isToRefreshMenu)

Parameters

Nome Tipo Descrição
key string
isToRefreshMenu bool

Returns

PHCResult

RemoveLogin(UserLoginVO) 

[WebMethod]
public PHCResult RemoveLogin(UserLoginVO loginItem)

Parameters

Nome Tipo Descrição
loginItem UserLoginVO

Returns

PHCResult

RunAccountingDiagnostic(int) 

[WebMethod]
public PHCResult RunAccountingDiagnostic(int year)

Parameters

Nome Tipo Descrição
year int

Returns

PHCResult

RunAccountingDiagnosticProcess(bool, ProcessVO<AccountingDiagnosticConfig>) 

[WebMethod]
public PHCResult RunAccountingDiagnosticProcess(bool useAsync, ProcessVO<AccountingDiagnosticConfig> task)

Parameters

Nome Tipo Descrição
useAsync bool
task ProcessVO<AccountingDiagnosticConfig>

Returns

PHCResult

SetDefaultIntegration(bool) 

[WebMethod]
public PHCResult SetDefaultIntegration(bool defaultIntegration)

Parameters

Nome Tipo Descrição
defaultIntegration bool

Returns

PHCResult

SetIncrementOnFxdf(string, bool) 

[WebMethod]
public PHCResult SetIncrementOnFxdf(string key, bool isToRefreshMenu)

Parameters

Nome Tipo Descrição
key string
isToRefreshMenu bool

Returns

PHCResult

SqlStudioRunCommand(SqlStudioVO) 

[WebMethod]
public PHCResult SqlStudioRunCommand(SqlStudioVO command)

Parameters

Nome Tipo Descrição
command SqlStudioVO

Returns

PHCResult

SwitchOnSqlProfiler() 

[WebMethod]
public PHCResult SwitchOnSqlProfiler()

Returns

PHCResult

TransferAccountMovements(AccountMovementsTransferConfig) 

[WebMethod]
public PHCResult TransferAccountMovements(AccountMovementsTransferConfig config)

Parameters

Nome Tipo Descrição
config AccountMovementsTransferConfig

Returns

PHCResult

addfxengineapplist(string) 

[WebMethod]
public PHCResult addfxengineapplist(string applicationID)

Parameters

Nome Tipo Descrição
applicationID string

Returns

PHCResult

apagarlogsservidor(int)

Deletes logs from the server of the last numeroDias days.

[WebMethod]
public PHCResult apagarlogsservidor(int numeroDias)

Parameters

Nome Tipo Descrição
numeroDias int

Number of days of log we want to delete.

Returns

PHCResult

PHCRESULT containing a list with a ValorVO, where the property valor will be "OK" if successful, or error messages produced by this process.

This error messages could be:.

errors.Business.Utilitarios.NaoConseguiApagarLogs.

checkConfigBo()

Checks if there are Internal documents configuration where the field SAF-T type is empty.

[WebMethod]
public PHCResult checkConfigBo()

Returns

PHCResult

PHCResult containing a logical value on the property ScalarResult, indicating whether or not there are still files settings not completed as regards the SAF-T so that the application can warn the user about this situation at the time is generated the full SAF-T-PT file for audits of AT

Remarks

With the Law 382/2012 became possible to include files in the internal tags SourceDocuments – MovementOfGoods e SourceDocuments – WorkingDocuments

delAuditByFilter(QueryVO)

Delete the activity log list about who created, viewed, changed or deleted each record.

[WebMethod]
public PHCResult delAuditByFilter(QueryVO query)

Parameters

Nome Tipo Descrição
query QueryVO

Identifies the log list filter.

Returns

PHCResult

PHCResult containing a list of FxlogAuditVO objects or error messages produced by this query process.

deletefxengineapplist(string) 

[WebMethod]
public PHCResult deletefxengineapplist(string appfxenginestamp)

Parameters

Nome Tipo Descrição
appfxenginestamp string

Returns

PHCResult

deletemanyfxengineapplist(List<string>) 

[WebMethod]
public PHCResult deletemanyfxengineapplist(List<string> appfxenginestamps)

Parameters

Nome Tipo Descrição
appfxenginestamps List<string>

Returns

PHCResult

fixBancos() 

[WebMethod]
public PHCResult fixBancos()

Returns

PHCResult

fixClientes() 

[WebMethod]
public PHCResult fixClientes()

Returns

PHCResult

fixFornecedores() 

[WebMethod]
public PHCResult fixFornecedores()

Returns

PHCResult

fixStock(SlUpdateOptions) 

[WebMethod]
public PHCResult fixStock(SlUpdateOptions options)

Parameters

Nome Tipo Descrição
options SlUpdateOptions

Returns

PHCResult

getAuditByFilter(QueryVO)

Get the activity log list about who created, viewed, changed or deleted each record.

[WebMethod]
public PHCResult getAuditByFilter(QueryVO query)

Parameters

Nome Tipo Descrição
query QueryVO

Identifies the log list filter.

Returns

PHCResult

PHCResult containing a list of FxlogAuditVO objects or error messages produced by this query process.

getInventario(GetInventarioVO) 

[WebMethod]
public PHCResult getInventario(GetInventarioVO getInventarioVO)

Parameters

Nome Tipo Descrição
getInventarioVO GetInventarioVO

Returns

PHCResult

getSaft(GetSaftVO)

Exports the SAF-T-PT file with information on the company tax data.

[WebMethod]
public PHCResult getSaft(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

It contains the data required for the production of SAF-T-PT File

Returns

PHCResult

PHCResult containing a ScalarResult, whose property StringResult indicates the location of SAF-T-PT file in XML.

Remarks

Export to an XML file, a file with information about the fiscal data of the company, called SAF-T-PT.

getSaftAutoFact(GetSaftVO)

getSaftAutoFact(GetSaftVO)

Export SAF-T-PT file for Auto-invoicing.

[WebMethod]
public PHCResult getSaftAutoFact(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

It contains the data required for the production of SAF-T-PT File

Returns

PHCResult

PHCResult containing a ScalarResult, whose property stringResult indicates the location of SAF-T-PT file in XML.

Remarks

Export to an XML file, a file with information about the fiscal data of the company, called SAF-T-PT.

Auto-invoicing The Auto-invoicing consists of being the client to issue invoices in lieu of its suppliers.

When there is Auto-invoicing agreement, where the supplier is required SAF-T-PT file must be the client company who issues invoices that should generate its file.

getSaft(GetSaftVO)

getSaftGuias(GetSaftVO)

Export SAF-T-PT file with information about Transport Slips.

[WebMethod]
public PHCResult getSaftGuias(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

It contains the data required for the production of SAF-T-PT File

Returns

PHCResult

PHCResult containing a ScalarResult, whose property stringResult indicates the location of SAF-T-PT file in XML.

Remarks

Export to an XML file, a file uwith information about Transport Slips.

getServiceMailDomain()

Retorna o domínio de e-mail que é utilizado pelo Service no envio de Newsletters

[WebMethod]
public PHCResult getServiceMailDomain()

Returns

PHCResult

Um PHCResult contendo um ScalarResult, cuja propriedade stringResult indica o domínio de e-mail que deverá ser utilizado.

getSupportRequests(string)

Retorna o numero de pedidos de suport

[WebMethod]
public PHCResult getSupportRequests(string supportServiceUrl)

Parameters

Nome Tipo Descrição
supportServiceUrl string

Returns

PHCResult

getSystemInformation()

Permite obter váriada informação acerca do estado actual do sistema.

[WebMethod]
public PHCResult getSystemInformation()

Returns

PHCResult

Um PHCResult contendo um SystemInfoVO com informação acerca do estado actual do sistema.

getThirdPartyInformation(string)

Obtém informações de terceiros através de uma requisição ao sistema.

[WebMethod]
public PHCResult getThirdPartyInformation(string language)

Parameters

Nome Tipo Descrição
language string

Returns

PHCResult

Um PHCResult contendo os dados obtidos ou mensagens de erro decorrentes da execução deste método.

Exceptions

Exception

Lança uma exceção que será capturada e convertida em um PHCResult.

getdadose1()

Consult the CAE of the company that authenticated to the application.

[WebMethod]
public PHCResult getdadose1()

Returns

PHCResult

PHCRESULT containing a E1VO with the company's CAE.

gete1cae()

Consult the company information that authenticated to the application.

[WebMethod]
public PHCResult gete1cae()

Returns

PHCResult

Um PHCRESULT containing a E1VO with the company information.

getfxengineapplist() 

[WebMethod]
public PHCResult getfxengineapplist()

Returns

PHCResult

importSaftDT(string)

Import for the application the return of AT resulting communication via SAF-T transport slips.

[WebMethod]
public PHCResult importSaftDT(string fileName)

Parameters

Nome Tipo Descrição
fileName string

SAF-T-PT Filename to import into the application.

Returns

PHCResult

PHCResult containing a list of Messages with the information of the fields imported.

Remarks

Import the answer file the statement of transport slips to the AT, so that the respective documents are marked with the code returned by AT and so can be correctly printed.

reAuthenticateApp()

Efectua o restart da aplicação efecutando nova autenticação

[WebMethod]
public PHCResult reAuthenticateApp()

Returns

PHCResult

Um PHCResult vazio que indica que a aplicação iniciou o restart ou mensagens de erro decorrentes da execução deste método.

restartApp()

Efectua o restart da aplicação

[WebMethod]
public PHCResult restartApp()

Returns

PHCResult

Um PHCResult vazio que indica que a aplicação iniciou o restart ou mensagens de erro decorrentes da execução deste método.

runimport(string, string, bool)

Import a CSV file and creates new records of the entity defined in parameter entityName.

[WebMethod]
public PHCResult runimport(string fileName, string entityName, bool @virtual)

Parameters

Nome Tipo Descrição
fileName string

Data file name of the CSV file to import into the application.
entityName string

Entity name for the type of data to be imported, can be for example: "CL", "FL", etc.
virtual bool

Allows you to indicate that the import runs in virtual mode.

This parameter was included from version 201208, and simulates the import running all existing business rules for the corresponding entity, but without creating the records in the database, so the user can initially simulate the import and see if some of the lines contained in the CSV file have syntax errors or validation errors of business rules, correct them and then, when you think that everything is correct, execute again this method but now sending the value FALSE this parameter. .

Returns

PHCResult

PHCResult containing the property result a list of ValorVO, or in the property messages a list of MessageVO that in this case would be a signal that something is wrong and was not predicted in the import process, such as an internal error code. .

.

The ValorVO object will contain the result of the import process of the CSV file sent. Contains a list of messages where the description can be corresponding to an error or a successful outcome, differentiation is made by property isMsgError. .

ThelineNumber property indicates the CSV file line number counting already with the header to which the message relates. .

Remarks

Each line of the file will produce a new record of the entity given in the parameterentityName.

.

Date fields should come in dd-mm-yyyy format, for example 11-24-1966.

Logical fields must come with TRUE or FALSE content as desired.

The file should come with the values separated by semicolons. In case of texts with a semicolon, you can place text in quotation marks.

Numeric fields should not have the thousands separator. The decimal separator must be a comma.

savedadose1(E1VO)

Insert a company in the database.

[WebMethod]
public PHCResult savedadose1(E1VO e1)

Parameters

Nome Tipo Descrição
e1 E1VO

Company to insert in the database.

Returns

PHCResult

PHCRESULT containing the saved record, or error messages produced by this process.

Remarks

Record a company in the database, depending on the property E1VO.Operation do E1VO.

This company is defined by parameter e1.

sendEmail(EmailVO)

Envia um email

[WebMethod]
public PHCResult sendEmail(EmailVO email)

Parameters

Nome Tipo Descrição
email EmailVO

Returns

PHCResult

Um PHCResult contendo um ScalarResult, cuja propriedade stringResult indica o domínio de e-mail que deverá ser utilizado.

validateSAFT(GetSaftVO)

Validate SAF-T-PT information.

[WebMethod]
public PHCResult validateSAFT(GetSaftVO switche)

Parameters

Nome Tipo Descrição
switche GetSaftVO

It contains the data required for the production of SAF-T-PT File

Returns

PHCResult

PHCResult