Table of Contents

Class FtWS

Namespace
PHCWS
Assembly
PHCWS.dll

Invoice Document Services (FtVO).

[WebService(Namespace = "http://www.phcgo.net/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[DesignerGenerated]
public class FtWS : PHCTypedWS<FtVO>, IComponent, IDisposable, IServiceProvider
Inheritance
FtWS

Remarks

Through this service we can manage several features related to the entity invoice documents and other associated entities such as the entity FiVO that represents a line of a invoice document. .

The available features will be common to several entities, such as the creation, modification, query, and delete, and other specific of the entity in question. .

Methods

DeleteProcess(ProcessID) 

[WebMethod]
public PHCResult DeleteProcess(ProcessID taskId)

Parameters

Nome Tipo Descrição
taskId ProcessID

Returns

PHCResult

ExecuteProcess(bool, ProcessVO<FtBillingConfig>) 

[WebMethod]
public PHCResult ExecuteProcess(bool useAsync, ProcessVO<FtBillingConfig> task)

Parameters

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

Returns

PHCResult

GetLots(int, int, string, string, string)

Obtains a list of Lots of a given Reference, ordered by its method of recovery (FIFO, FEFO or LIFO). This methods is suitable to be used with Sale Entity

[WebMethod]
public PHCResult GetLots(int offset, int limit, string expression, string ftstamp, string fistamp)

Parameters

Nome Tipo Descrição
offset int
limit int
expression string
ftstamp string
fistamp string

Returns

PHCResult

PreviewProcess(ProcessVO<FtBillingConfig>) 

[WebMethod]
public PHCResult PreviewProcess(ProcessVO<FtBillingConfig> task)

Parameters

Nome Tipo Descrição
task ProcessVO<FtBillingConfig>

Returns

PHCResult

PreviewProcessLines(string, ProcessVO<FtBillingConfig>) 

[WebMethod]
public PHCResult PreviewProcessLines(string stampID, ProcessVO<FtBillingConfig> task)

Parameters

Nome Tipo Descrição
stampID string
task ProcessVO<FtBillingConfig>

Returns

PHCResult

SynchronizeProcess(ProcessVO<FtBillingConfig>) 

[WebMethod]
public PHCResult SynchronizeProcess(ProcessVO<FtBillingConfig> task)

Parameters

Nome Tipo Descrição
task ProcessVO<FtBillingConfig>

Returns

PHCResult

addNewFTRDsByCC(string, int, int, List<string>)

Adds new lines from the CcVO.

[WebMethod]
public PHCResult addNewFTRDsByCC(string IdFtStamp, int no, int estab, List<string> ccstamps)

Parameters

Nome Tipo Descrição
IdFtStamp string

Identifies the FtVO that owns the lines that you want to add, matches the stored value in the field ftstamp of FtVO.
no int

Identifies the ClVO, corresponds to the no.
estab int

Identifies the branch of the ClVO, corresponds to the field estab.
ccstamps List<string>

It is a list of identifiers of the current accounts of customers who want to add, each list item is the value stored in the field ccstamp of FtrdVO.

Returns

PHCResult

A PHCResult containing the FtVO on the property
result, or MessageVO on the property messages produced by the server in this process.

Remarks

The update is stored in memory, the final recording in the database should be done by the service 'Save'.

anularDocumento(string, string, bool)

Cancels an FtVO.

[WebMethod]
public PHCResult anularDocumento(string ftStamp, string nullifyReason, bool runWarningRules)

Parameters

Nome Tipo Descrição
ftStamp string

Identifies the document to be cancelled, corresponds to the value kept in the FtStamp the document.
nullifyReason string
runWarningRules bool

Indicates whether to run the 'warning' user / system rules when recording. Are rules that must be rendered as answer questions of the type Yes / No. If the user responds Yes to all of them, we should call this method again with this parameter to False.

There is another set of user/system rules which are considered as fatal type of rules, which always run regardless of the value of this parameter, for example the rule that does not allow to save the document with the same number of other existing in the database. .

Returns

PHCResult

PHCResult containing the FtVO on the property result, or MessageVO on the property messages produced by the server in this process.

Remarks

Cancels the FtVO, marking its anulada with the value True. .

A cancelled document tax reasons, will continue to exist in the database with all its lines and totals. Only movements that the document originated when it was created, for example stock transactions or customer balances updates, reset as the document does not exist and have been deleted from the database. .

calculateInvoiceAmounts(FtVO)

Calculates invoice totals.

[WebMethod]
public PHCResult calculateInvoiceAmounts(FtVO itemVO)

Parameters

Nome Tipo Descrição
itemVO FtVO

Identifies which the FtVO to calculate.

Returns

PHCResult

A PHCResult containing the FtVO on the property result, or MessageVO on the property messages produced by the server in this process.

calculateLineAmounts(FtVO, string)

Calculates invoice line totals and returns that line.

[WebMethod]
public PHCResult calculateLineAmounts(FtVO itemFt, string fiStamp)

Parameters

Nome Tipo Descrição
itemFt FtVO

Identifies which the FtVO.
fiStamp string

Identifies the FiVO to calculate.

Returns

PHCResult

A PHCResult containing the FiVO on the property result, or MessageVO on the property messages produced by the server in this process.

cancelDocumentAtDate(string, string, bool, DateTime)

Cancels a document at a given date.

[WebMethod]
public PHCResult cancelDocumentAtDate(string ftStamp, string nullifyReason, bool runWarningRules, DateTime nullifyDate)

Parameters

Nome Tipo Descrição
ftStamp string
nullifyReason string
runWarningRules bool
nullifyDate DateTime

Returns

PHCResult

generateReferenciaMultibanco(string)

Manually generates the ATM reference in itsFtVO.

[WebMethod]
public PHCResult generateReferenciaMultibanco(string IdFtStamp)

Parameters

Nome Tipo Descrição
IdFtStamp string

Identifies the FtVO you want to upgrade, corresponds to the stored value in the field ftstamp of FtVO.

Returns

PHCResult

A PHCResult containing the FtVO on the property
result, or MessageVO on the property messages produced by the server in this process.

Remarks

The update is stored in memory, the final recording in the database should be done by the service 'Save'.

getClientByNif(FtVO) 

[WebMethod]
public PHCResult getClientByNif(FtVO itemFt)

Parameters

Nome Tipo Descrição
itemFt FtVO

Returns

PHCResult

This operation has no return.

getCodes4041List()

Get codes 4041 for invoices

[WebMethod]
public PHCResult getCodes4041List()

Returns

PHCResult

getFullIssuedDocument(string)

Get full issued Document for POS with refund information

[WebMethod]
public PHCResult getFullIssuedDocument(string issuedDocumentStamp)

Parameters

Nome Tipo Descrição
issuedDocumentStamp string

Returns

PHCResult

getInvoiceRefundHistory(string)

Get The History of Refunds

[WebMethod]
public PHCResult getInvoiceRefundHistory(string ftstamp)

Parameters

Nome Tipo Descrição
ftstamp string

stamp of invoice

Returns

PHCResult

Returns the List of resumed History of Invoice's refunds

getNewRefundDoc(string, List<FiVO>, int)

Get a new Refund document

[WebMethod]
public PHCResult getNewRefundDoc(string originFtStamp, List<FiVO> refundProducts, int creditNoteNdoc)

Parameters

Nome Tipo Descrição
originFtStamp string

stamp of original invoice
refundProducts List<FiVO>

List of invoice's lines
creditNoteNdoc int

Returns

PHCResult

Returns a new instance of Refunding document

newPaymentConditions(string, PaymentConditionVO)

Calculate new payment method depending on the options specified in the PaymentConditions.

[WebMethod]
public PHCResult newPaymentConditions(string IdFtStamp, PaymentConditionVO PaymentConditions)

Parameters

Nome Tipo Descrição
IdFtStamp string

Identifies the FtVO you want to upgrade, corresponds to the value stored in the field ftstamp of FtVO.
PaymentConditions PaymentConditionVO

Indicates new payment terms that we want to apply to the document.

Returns

PHCResult

A PHCResult containing the FtVO on the property Result, or MessageVO on the property messages produced by the server in this process.

Remarks

The update is stored in memory, the final recording in the database should be done by the service 'Save'.

runValidationsFileImportLines(FtVO, string, List<ImportSampleVO>, bool)

Validações na importação do ficheiro csv

[WebMethod]
public PHCResult runValidationsFileImportLines(FtVO itemVO, string fileName, List<ImportSampleVO> rowsCsv, bool haveHeaders)

Parameters

Nome Tipo Descrição
itemVO FtVO
fileName string
rowsCsv List<ImportSampleVO>
haveHeaders bool

Returns

PHCResult

signDocument(string)

Signs or Finish an invoice document.

[WebMethod]
public PHCResult signDocument(string ftstamp)

Parameters

Nome Tipo Descrição
ftstamp string

Identifies which the FtVO to sign.

Returns

PHCResult

A PHCResult containing the FtVO on the property result, or MessageVO on the property messages produced by the server in this process.

Remarks

Digitally Sign or Finalize an invoice document.

useCouponInFt(string, int, int, string)

Add a Coupon to FT payments

[WebMethod]
public PHCResult useCouponInFt(string IdFtStamp, int no, int estab, string couponReference)

Parameters

Nome Tipo Descrição
IdFtStamp string
no int
estab int
couponReference string

Returns

PHCResult