Table of Contents

Class AvencaVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll

Recurring Invoice

[AttTable("Avenca", 20201209)]
[AttTableVOInfo(typeof(AvencaAttInfo))]
[AttTableGama(Gamas.Grow)]
[AttTableProducts(new Products[] { Products.VENDAS })]
[AttTableFlags(new TableFlags[] { TableFlags.MasterEntity, TableFlags.UseInternalRef, TableFlags.FullTextSearchable, TableFlags.TableForJorge, TableFlags.UseDimensions })]
public class AvencaVO : BusinessVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
AvencaVO

Properties

BlDDVO

É uma refência à entidade Contas de Tesouraria para débito direto

[AttExternalCollection(typeof(BlVO), new string[] { "bl.noconta", "contadodd" })]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT, languages.es_ES })]
public BlVO BlDDVO { get; }

Property Value

BlVO

Remarks

Este campo é uma colecção externa

ClVO

[AttExternalCollection(typeof(ClVO), new string[] { "cl.no", "no", "cl.estab", "estab" })]
public ClVO ClVO { get; }

Property Value

ClVO

GetFieldStampName

Use only field name without table name

public override string GetFieldStampName { get; }

Property Value

string

GetStampValue

public override string GetStampValue { get; }

Property Value

string

SepaMandateVO

É uma refência a entidade Mandatos SEPA

[AttExternalCollection(typeof(SepaMandateVO), new string[] { "sepamandate.sepamandatestamp", "sepamandatestamp" })]
[AttEntityAvailable(typeof(SepaMandateVO))]
public SepaMandateVO SepaMandateVO { get; }

Property Value

SepaMandateVO

Remarks

Este campo é uma colecção externa

TaxRetentionVO

[AttExternalCollection(typeof(TaxRetentionVO))]
public TaxRetentionVO TaxRetentionVO { get; }

Property Value

TaxRetentionVO

TpVO

É uma refência a entidade Condições de Pagamento

[AttExternalCollection(typeof(TpVO), new string[] { "tp.tpstamp", "tpstamp" })]
public TpVO TpVO { get; }

Property Value

TpVO

Remarks

Este campo é uma colecção externa

avencais

Colecção das linhas do documento.

[AttCollection(typeof(AvencaiVO))]
public List<AvencaiVO> avencais { get; set; }

Property Value

List<AvencaiVO>

Remarks

This field is a collection of type List (Of AvencaiVO).

FiVO

avencastamp

Single registration field, used to link others to this entity.

[AttLenght(25)]
public string avencastamp { get; set; }

Property Value

string

Remarks

This field uniquely identifies the record (primary key by default).

Length 25.

blDDLabelField

From BlVO.labelField

[AttVirtualField]
[AttHidden]
public string blDDLabelField { get; set; }

Property Value

string

clstamp

[AttVirtualField]
[AttHidden]
public string clstamp { get; set; }

Property Value

string

contadodd

Bank Account Internal No. for Direct Debit

[AttLenght(4)]
[AttEntityAvailable(typeof(BlVO))]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT, languages.es_ES })]
public int contadodd { get; set; }

Property Value

int

Remarks

Length 4.

descm

Disc. Total in Currency.

[AttLenght(19, 6)]
public decimal descm { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

ebasei

Tax Base.

[AttVirtualField]
public decimal ebasei { get; set; }

Property Value

decimal

Remarks

Total before VAT.

Virtual field.

edescc

Trade Discounts.

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public decimal edescc { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

estab

Number that identifies the customer Branch.

[AttLenght(6)]
[AttGama(Gamas.Advanced)]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttList(Inactive = true)]
public int estab { get; set; }

Property Value

int

Remarks

Length 6.

From what range of software this field is available: Max.

etiliqdc

Total before discounts.

[AttVirtualField]
[AttLenght(19, 6)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public decimal etiliqdc { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

Virtual field.

etotal

Total value of the recurring invoice in Euros.

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttList]
public decimal etotal { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

etotalivarec

Surcharge VAT in Euros.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal etotalivarec { get; }

Property Value

decimal

Remarks

Virtual field.

ettiliq

Net Total in Euros.

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public decimal ettiliq { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

ettiva

Total VAT in euros.

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public decimal ettiva { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

evirs

Income tax deduction in Euros.

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public decimal evirs { get; set; }

Property Value

decimal

Remarks

Lenght of 19, where the units are 12 and decimals are 6.

fno

Recurring Invoice number.

[AttPrimaryKey]
[AttLenght(10)]
[AttLogInfo(0)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttList]
public decimal fno { get; set; }

Property Value

decimal

Remarks

This field is primary key.

Length 10.

Non Duplicable Field.

idiom

Idiom Field

[AttLenght(25)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttGama(Gamas.Advanced)]
public string idiom { get; set; }

Property Value

string

inactiva

Identifies whether this recurring invoice is inactive.

[AttIndex(new string[] { "inactiva", "periodicidadeid", "periodo" }, new string[] { "avencastamp", "validi", "validf", "usaavencaantecipada" })]
[AttList]
public bool inactiva { get; set; }

Property Value

bool

ivaBase1

First VAT line - Base.

[AttVirtualField]
public decimal ivaBase1 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaBase2

Second VAT line - Base.

[AttVirtualField]
public decimal ivaBase2 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaBase3

Third VAT line - Base.

[AttVirtualField]
public decimal ivaBase3 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaBase4

4º line - VAT base

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaBase4 { get; }

Property Value

decimal

ivaBase5

5º line - VAT base

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaBase5 { get; }

Property Value

decimal

ivaBase6

6º line - VAT base

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaBase6 { get; }

Property Value

decimal

ivaTaxa1

First VAT line - Rate.

[AttVirtualField]
public decimal ivaTaxa1 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxa2

Second VAT line - Rate

[AttVirtualField]
public decimal ivaTaxa2 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxa3

Third VAT line - Rate.

[AttVirtualField]
public decimal ivaTaxa3 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxa4

4º line - VAT rate

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaTaxa4 { get; }

Property Value

decimal

ivaTaxa5

5º line - VAT rate

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaTaxa5 { get; }

Property Value

decimal

ivaTaxa6

6º line - VAT rate

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaTaxa6 { get; }

Property Value

decimal

ivaTaxaRec1

First surcharge line - Rate.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec1 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxaRec2

Second surcharge line - Rate.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec2 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxaRec3

Third surcharge line - Rate.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec3 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaTaxaRec4

4º line - VAT surcharge rate

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec4 { get; }

Property Value

decimal

ivaTaxaRec5

5º line - VAT surcharge rate

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec5 { get; }

Property Value

decimal

ivaTaxaRec6

6º line - VAT surcharge rate

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaTaxaRec6 { get; }

Property Value

decimal

ivaValor1

First VAT line - VAT Amount.

[AttVirtualField]
public decimal ivaValor1 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValor2

Second VAT line - VAT Amount.

[AttVirtualField]
public decimal ivaValor2 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValor3

Third VAT line - VAT Amount.

[AttVirtualField]
public decimal ivaValor3 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValor4

4º line - VAT amount

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaValor4 { get; }

Property Value

decimal

ivaValor5

5º line - VAT amount

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaValor5 { get; }

Property Value

decimal

ivaValor6

6º line - VAT amount

[AttVirtualField]
[AttLenght(19, 6)]
public decimal ivaValor6 { get; }

Property Value

decimal

ivaValorRec1

First surcharge line - Amount.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec1 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValorRec2

Second surcharge line - Amount.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec2 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValorRec3

Third surcharge line - Amount.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec3 { get; }

Property Value

decimal

Remarks

Virtual field.

ivaValorRec4

4º line - VAT surcharge amount.

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec4 { get; }

Property Value

decimal

ivaValorRec5

5º line - VAT surcharge amount.

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec5 { get; }

Property Value

decimal

ivaValorRec6

6º line - VAT surcharge amount.

[AttVirtualField]
[AttLenght(19, 6)]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.es_ES })]
public decimal ivaValorRec6 { get; }

Property Value

decimal

no

Recurring Invoice number.

[AttLenght(10)]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttList]
public decimal no { get; set; }

Property Value

decimal

Remarks

Length 10.

nome

Customer name.

[AttLenght(100)]
[AttMandatory]
[AttLogInfo(2)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttList]
public string nome { get; set; }

Property Value

string

Remarks

Length 55.

ollocaldd

Bank Account for Direct Debit.

[AttLenght(50)]
[AttEntityAvailable(typeof(SepaMandateVO))]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT, languages.es_ES })]
public string ollocaldd { get; set; }

Property Value

string

Remarks

Length 50.

periodicidadeDesc

[AttLenght(50)]
[AttLocale(typeof(AvencaAttInfo), new string[] { "[Avenca].[periodicidadeid]" })]
public string periodicidadeDesc { get; set; }

Property Value

string

periodicidadeid

Recurrence internal number.

[AttLenght(1)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttMandatory]
public AvencaBiz.Periodicidade periodicidadeid { get; set; }

Property Value

AvencaBiz.Periodicidade

Remarks

Field not available for the user.

periodo

Number of Occurrences.

[AttLenght(3)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttMinValue(1)]
public int periodo { get; set; }

Property Value

int

Remarks

Length 3.

refInt

Internal reference.

Contains the value of the user's internal reference that created the record.

[AttLenght(50)]
[AttEntityAvailable(typeof(RefInternaVO))]
[AttList(Inactive = true)]
public string refInt { get; set; }

Property Value

string

Remarks

Length 50.

resumo

Summary. Name of recurring invoice.

[AttLenght(60)]
[AttMandatory]
[AttLogInfo(1)]
[AttList]
public string resumo { get; set; }

Property Value

string

Remarks

Length 60.

retentiontax

[AttLenght(6, 2)]
[AttFieldType(AttFieldType.InputTypes.percentage)]
[AttVirtualField]
public decimal retentiontax { get; set; }

Property Value

decimal

sepamandatedesign

Name of SEPA associated Mandate.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT, languages.es_ES })]
[AttEntityAvailable(typeof(SepaMandateVO))]
public string sepamandatedesign { get; set; }

Property Value

string

Remarks

Virtual field.

sepamandatestamp

Connection field to SEPA authorisation (SEPAMANDATE).

[AttEntityAvailable(typeof(SepaMandateVO))]
[AttLenght(25)]
public string sepamandatestamp { get; set; }

Property Value

string

Remarks

Length 25.

Foreign Key field to another table.

taxasIVA

Colecção das diversas taxas de I.V.A. presentes no documento.

[AttCollection(typeof(AvencaTxIvaVO))]
public List<AvencaTxIvaVO> taxasIVA { get; set; }

Property Value

List<AvencaTxIvaVO>

Remarks

This field is a collection of type List (Of AvencaTxIvaVO).

FtTxIvaVO

temAutorizacaoPS2ativa

Indicates if this customer has an active PS2 authorization.

[AttVirtualField]
[AttHidden]
public bool temAutorizacaoPS2ativa { get; set; }

Property Value

bool

Remarks

Virtual field.

textoCertificacao

Text with certification number for Reports.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT, languages.pt_AO })]
public string textoCertificacao { get; set; }

Property Value

string

Remarks

Virtual field.

textoCertificacaoParcialDemo

Certificação: Texto Parcial - Base de dados de demonstração

[AttVirtualField]
public string textoCertificacaoParcialDemo { get; set; }

Property Value

string

Remarks

This field does not physically exist in the database. Its value results from a calculation expression with the help of other fields of the entity. Is provided in order to hide the complexity of calculating the value thus providing in a simple way.

Due to the nature of their calculation the field is not available to be included in queries, but to be included in listings or reports. Another feature is that this field by being virtual will never appear in the collection Campos Modificadosof the entity itself.

textoCertificacaoParcialNaoServeFactura

Certification: Partial Text - Not a VAT invoice

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT })]
public string textoCertificacaoParcialNaoServeFactura { get; set; }

Property Value

string

Remarks

Virtual field.

textoCertificacaoParcialNomeSoftware

Certification: Partial Text - Software Name.

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT })]
public string textoCertificacaoParcialNomeSoftware { get; set; }

Property Value

string

Remarks

Virtual field.

textoCertificacaoParcialNumeroCertificacao

Certification: Partial Text - Certification Number

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT })]
public string textoCertificacaoParcialNumeroCertificacao { get; set; }

Property Value

string

Remarks

Virtual field.

textoCertificacaoParcialProcessadoPor

Certification: Partial Text - Processed by

[AttVirtualField]
[AttCountryDepending(CountryDependingType.E1, new languages[] { languages.pt_PT })]
public string textoCertificacaoParcialProcessadoPor { get; set; }

Property Value

string

Remarks

Virtual field.

tpdesc

Description of Payment Terms.

[AttLenght(55)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange, AttFieldType.FieldFlags.NotEditLoop })]
public string tpdesc { get; set; }

Property Value

string

Remarks

Length 55.

tpstamp

Connection field to Payment Term (TP).

[AttForeignKey(CanDuplicate = true, ForeignType = typeof(TpVO), HiddenField = false)]
[AttLenght(25)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange, AttFieldType.FieldFlags.NotEditLoop })]
public string tpstamp { get; set; }

Property Value

string

Remarks

Length 25.

Foreign Key field to another table.

usaDD

Indicates whether this recurring invoice uses Direct Debits.

[AttVirtualField]
[AttHidden]
public bool usaDD { get; set; }

Property Value

bool

Remarks

Direct Debits use in this context means that your Payment Terms uses Payment Method: Debit Account.

Virtual field.

usaIRS

Indicates if it is used the Person Income Tax.

[AttVirtualField]
[AttHidden]
public bool usaIRS { get; set; }

Property Value

bool

Remarks

Virtual field.

usaRecargoIva

Indicates if document use uses surcharge VAT.

[AttVirtualField]
[AttHidden]
public bool usaRecargoIva { get; }

Property Value

bool

Remarks

Virtual field.

Field not available to the user.

usaavencaantecipada

Uses pre-posting recurring invoice

[AttLenght(1)]
public bool usaavencaantecipada { get; set; }

Property Value

bool

Remarks

Lenght 1.

validf

Due date.

[AttFieldType(AttFieldType.InputTypes.date, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public DateTime validf { get; set; }

Property Value

DateTime

Remarks

Example: aaaa-mm-dd

validi

Issue Date.

[AttMandatory]
[AttFieldType(AttFieldType.InputTypes.date)]
public DateTime validi { get; set; }

Property Value

DateTime

Remarks

Example:aaaa-mm-dd

vencimentoAvencas

Collection of messages with the sample dates of due recurring invoices.

[AttVirtualField]
[AttHidden]
public List<MessageVO> vencimentoAvencas { get; set; }

Property Value

List<MessageVO>

Remarks

Virtual field.

Field not available for the user.

Methods

SetStampValue(string)

public override void SetStampValue(string stampID)

Parameters

Nome Tipo Descrição
stampID string