Table of Contents

Class PayrollPaymentVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll

Payroll payment

[AttTable("PayrollPayment", 20221011)]
[AttTableVOInfo(typeof(PayrollPaymentAttInfo))]
[AttTableProducts(new Products[] { Products.Payroll })]
[AttTableOrderBy("[PayrollPayment].[code]")]
[AttTableFlags(new TableFlags[] { TableFlags.MasterEntity, TableFlags.TableForJorge })]
public class PayrollPaymentVO : BusinessVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
PayrollPaymentVO

Properties

Address

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

Property Value

string

BlVO

[AttExternalCollection(typeof(BlVO), new string[] { "[Bl].[noconta]", "[PayrollPayment].[blaccount]" })]
public BlVO BlVO { get; }

Property Value

BlVO

CategoryPurposeCodeSALA

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

Property Value

string

CompanyName

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

Property Value

string

CompanyTaxesTotal

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

Property Value

decimal

CompanyZipCode

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

Property Value

string

ControlSum

[AttVirtualField]
[AttHidden]
public decimal ControlSum { get; set; }

Property Value

decimal

Country

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

Property Value

string

DateTime

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

Property Value

string

DebtorAccount

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

Property Value

string

DebtorBIC

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

Property Value

string

DeductionsTotal

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

Property Value

decimal

EarningsTotal

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

Property Value

decimal

MsgId

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

Property Value

string

NumberOfTransactions

[AttVirtualField]
[AttHidden]
public int NumberOfTransactions { get; set; }

Property Value

int

OcVO

[AttExternalCollection(typeof(OcVO), new string[] { "[Oc].[olcodigo]", "[PayrollPayment].[olcode]" })]
public OcVO OcVO { get; }

Property Value

OcVO

OrganizationId

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

Property Value

string

PaymentConfigVO

[AttExternalCollection(typeof(PaymentConfigVO), new string[] { "[PaymentConfig].[PaymentConfigStamp]", "[PayrollPayment].[paymentconfigstamp]" })]
public PaymentConfigVO PaymentConfigVO { get; }

Property Value

PaymentConfigVO

PaymentInformationId

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

Property Value

string

PaymentMethodTRF

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

Property Value

string

PaymentTypeDescription

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

Property Value

string

RequestedExecutionDate

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

Property Value

string

SEPACode

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

Property Value

string

TownName

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

Property Value

string

XmlnsXsi

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

Property Value

string

adjustamount

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.currency)]
public decimal adjustamount { get; set; }

Property Value

decimal

bankentity

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

Property Value

string

blaccount

Bank account.

[AttLenght(4)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public int blaccount { get; set; }

Property Value

int

bldescription

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

Property Value

string

blmoeda

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

Property Value

string

blnib

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

Property Value

string

blsupplytype

[AttVirtualField]
[AttLenght(1)]
[AttProducts(new Products[] { Products.Accounting })]
[AttDynamicIntegrationValue(typeof(SupplyTypeVO))]
public string blsupplytype { get; }

Property Value

string

code

ID.

[AttLenght(40)]
[AttLogInfo(0)]
[AttPrimaryKey]
[AttList(Hidden = true)]
public string code { get; set; }

Property Value

string

description

Payment description.

[AttLenght(400)]
[AttList]
[AttLogInfo(1)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public string description { get; set; }

Property Value

string

employeestamp

Employee connection (for exit payslip)

[AttLenght(25)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public string employeestamp { get; set; }

Property Value

string

oldescription

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

Property Value

string

olstamp

Tresury movement connection (movimento de tesouraria).

[AttLenght(25)]
[AttForeignKey(ForeignType = typeof(OlVO))]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public string olstamp { get; set; }

Property Value

string

paymentconfigdescription

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

Property Value

string

paymentconfigstamp

Payment config connection.

[AttLenght(25)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public string paymentconfigstamp { get; set; }

Property Value

string

paymentlines

[AttCollection(typeof(PaymentLineVO))]
public List<PaymentLineVO> paymentlines { get; set; }

Property Value

List<PaymentLineVO>

paymentlinestotal

[AttCollection(typeof(PaymentLineTotalVO))]
public List<PaymentLineTotalVO> paymentlinestotal { get; set; }

Property Value

List<PaymentLineTotalVO>

paymentoptions

Fixed value for payment options in account variables

[AttVirtualField]
[AttLenght(1)]
public int paymentoptions { get; }

Property Value

int

payrollpaymentstamp

Stamp.

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

Property Value

string

retention

Fixed value for retention variables

[AttVirtualField]
[AttLenght(1)]
public int retention { get; }

Property Value

int

staffoperation

Fixed value for staff operation variables

[AttVirtualField]
[AttLenght(1)]
public int staffoperation { get; }

Property Value

int

transactiondate

Payment date.

[AttList]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public DateTime transactiondate { get; set; }

Property Value

DateTime

tresurymov

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

Property Value

string

value

Paid value.

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

Property Value

decimal

Explicit Interface Implementations

CanIntegrate()

Returns true if integration is available

bool CanIntegrate()

Returns

bool

CleanIntegrationErrors()

Cleans the accounting integration errors

void CleanIntegrationErrors()

GetIntegrationConfig(int)

Get Accounting configuration if exists

PHCResult GetIntegrationConfig(int year)

Parameters

Nome Tipo Descrição
year int

Returns

PHCResult

GetPendingIntegrationsCommands(int)

PHCCmdSql GetPendingIntegrationsCommands(int year = 0)

Parameters

Nome Tipo Descrição
year int

Returns

PHCCmdSql

HasAccountingIntegration()

Check for permission to integrate document

bool HasAccountingIntegration()

Returns

bool

LogIntegrationErrors(List<MessageVO>)

Logs the accounting integration errors

void LogIntegrationErrors(List<MessageVO> errorMessages)

Parameters

Nome Tipo Descrição
errorMessages List<MessageVO>

accounted

Mark document as accounted

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
bool accounted { get; set; }

Returns

bool

adate

Accounting Date

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
DateTime adate { get; set; }

Returns

DateTime

docarchivalnumber

ID: Journal + Period + DocNumber

[AttLenght(30)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
string docarchivalnumber { get; set; }

Returns

string

documentdescription

Description of the document type (DC)

[AttFieldType(AttFieldType.InputTypes.memo, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
string documentdescription { get; set; }

Returns

string

documentid

Id of the accounting document (DC)

[AttLenght(6)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
decimal documentid { get; set; }

Returns

decimal

integrationErrors

Accounting integrations message errors

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
string integrationErrors { get; set; }

Returns

string

isaccounting

Is true if the document is in integrating process

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
bool isaccounting { get; set; }

Returns

bool

journaldescription

Description of the journal (DI)

[AttLenght(200)]
[AttFieldType(AttFieldType.InputTypes.string, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
string journaldescription { get; set; }

Returns

string

journalid

Journal code (DI).

[AttLenght(6)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
decimal journalid { get; set; }

Returns

decimal

olcode

Tresury code (código de tesouraria).

[AttLenght(12)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
string olcode { get; set; }

Returns

string

year

Year of Document (PCY).

[AttLenght(4)]
[AttFieldType(AttFieldType.InputTypes.integer, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttProducts(new Products[] { Products.Accounting })]
int year { get; set; }

Returns

int