Table of Contents

Class OlbbVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll

Account - Account Transfer

[AttTable("Olbb", 20230118)]
[AttTableVOInfo(typeof(OlbbAttInfo))]
[AttTableGama(Gamas.Corporate)]
[AttTableProducts(new Products[] { Products.TESOURARIA })]
[AttTableFlags(new TableFlags[] { TableFlags.MasterEntity, TableFlags.UseInternalRef, TableFlags.TableForJorge, TableFlags.UseDimensions })]
public class OlbbVO : BusinessVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
OlbbVO

Properties

ContaDestinoVO

Conta de Destino

[AttExternalCollection(typeof(BlVO), new string[] { "bl.noconta", "contado2" })]
public BlVO ContaDestinoVO { get; }

Property Value

BlVO

Remarks

Data type BlVO.

Field not sent to the frontend.

ContaOrigemVO

Conta de Origem

[AttExternalCollection(typeof(BlVO), new string[] { "bl.noconta", "contado1" })]
public BlVO ContaOrigemVO { get; }

Property Value

BlVO

Remarks

Data type BlVO.

Field not sent to the frontend.

Ols

The treasury movement created in OL

[AttExternalCollection(typeof(List<OlVO>))]
public List<OlVO> Ols { get; }

Property Value

List<OlVO>

approvedByName

The name of person who approve the document

[AttLenght(100)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttGama(Gamas.Advanced)]
public string approvedByName { get; set; }

Property Value

string

approvedByStamp

The stamp of person who approve the document

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

Property Value

string

approvedDate

The date when was approved

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttGama(Gamas.Advanced)]
public DateTime approvedDate { get; set; }

Property Value

DateTime

approvedHour

The hour when was approved

[AttLenght(8)]
[AttFieldType(AttFieldType.InputTypes.time, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttGama(Gamas.Advanced)]
public string approvedHour { get; set; }

Property Value

string

blDestinationLabelField

From BlVO.labelField

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

Property Value

string

blOriginLabelField

From BlVO.labelField

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

Property Value

string

bldestsupplytype

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

Property Value

string

blorisupplytype

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

Property Value

string

cheque

Número do Documento.

[AttLenght(15)]
[AttMandatory]
[AttLogInfo(0)]
public string cheque { get; set; }

Property Value

string

Remarks

Length 15.

contado1

Número Interno de Conta Bancária de Saida.

[AttLenght(4)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttMandatory]
public int contado1 { get; set; }

Property Value

int

Remarks

Length 4.

contado2

Número Interno de Conta Bancária de Entrada.

[AttLenght(4)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttMandatory]
public int contado2 { get; set; }

Property Value

int

Remarks

Length 4.

descricao

Description.

[AttLenght(60)]
[AttMandatory]
[AttList]
public string descricao { get; set; }

Property Value

string

Remarks

Length 60.

Required field.

Research field.

Field available in the basic search results list.

diaplano

Dia da data de contabilização.

[AttLenght(2)]
[AttHidden(HiddenParameter = new string[] { "ge_usacontabilidade" }, HiddenParameterValue = new object[] { false })]
public int diaplano { get; set; }

Property Value

int

Remarks

Data type Numeric.

Length 2.

dilnoplano

Nº lançamento no Diário de contabilização.

[AttLenght(10)]
[AttHidden(HiddenParameter = new string[] { "ge_usacontabilidade" }, HiddenParameterValue = new object[] { false })]
public int dilnoplano { get; set; }

Property Value

int

Remarks

Data type Numeric.

Length 10.

dinoplano

Diário de contabilização.

[AttLenght(50)]
[AttHidden(HiddenParameter = new string[] { "ge_usacontabilidade" }, HiddenParameterValue = new object[] { false })]
public string dinoplano { get; set; }

Property Value

string

Remarks

Data type String.

Length 50.

documento

Documento.

[AttLenght(20)]
[AttLogInfo(1)]
public string documento { get; set; }

Property Value

string

Remarks

Length 20.

dostamp

Field of connection to table DO.

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

Property Value

string

Remarks

Length 25.

Field of connection to table DO - Accounting Documents.

dplano

Accounting date document.

[AttFieldType(AttFieldType.InputTypes.date)]
[AttHidden(HiddenParameter = new string[] { "ge_usacontabilidade" }, HiddenParameterValue = new object[] { false })]
public DateTime dplano { get; set; }

Property Value

DateTime

Remarks

Data type DateTime.

Non Duplicable Field.

dvalor

Data Valor.

[AttLenght(1)]
[AttFieldType(AttFieldType.InputTypes.date, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttList]
public DateTime dvalor { get; set; }

Property Value

DateTime

Remarks

Campo de Pesquisa.

Field available in the basic search results list.

evalor

Source account output value (contado1)

[AttLenght(19, 6)]
[AttMandatory]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
[AttList]
public decimal evalor { get; set; }

Property Value

decimal

Remarks

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

Required field.

Research field.

Field available in the basic search results list.

isSEPAfileSentToBank

Indicate if the SEPA file was sent to bank

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public bool isSEPAfileSentToBank { get; set; }

Property Value

bool

madein

[AttLenght(30)]
public string madein { get; set; }

Property Value

string

moedaDestino

Moeda

Moeda da Conta Bancária de Entrada .

[AttLenght(3)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public string moedaDestino { get; set; }

Property Value

string

Remarks

Length 3 .

EUR, USD, GBP

moedaOrigem

Moeda

Moeda da Conta Bancária de Saída .

[AttLenght(3)]
public string moedaOrigem { get; set; }

Property Value

string

Remarks

Length 3 .

EUR, USD, GBP

olbbstamp

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

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

Property Value

string

Remarks

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

Length 25.

ollocal1

Exit Account.

[AttLenght(50)]
public string ollocal1 { get; set; }

Property Value

string

Remarks

Length 50.

Filling Required.

ollocal2

Incoming Account.

[AttLenght(50)]
public string ollocal2 { get; set; }

Property Value

string

Remarks

Length 50.

Filling Required.

plano

Indica se o documento está contabilizado.

[AttHidden(HiddenParameter = new string[] { "ge_usacontabilidade" }, HiddenParameterValue = new object[] { false })]
public bool plano { get; set; }

Property Value

bool

Remarks

Data type Boolean.

refInt

Referência interna

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 .

taxaDeCambio

Exchange Rate between the Currencies of the two accounts (origin and destination).

[AttLenght(19, 6)]
[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public decimal taxaDeCambio { get; set; }

Property Value

decimal

Remarks

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

Required field.

Research field.

Field available in the basic search results list.

valorContaDestino

Valor de entrada na conta de destino

[AttLenght(19, 6)]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public decimal valorContaDestino { get; set; }

Property Value

decimal

Remarks

Length total de 19, em que 12 são para as unidades e 6 para as decimais.

Preenchimento Obrigatório.

Campo de Pesquisa.

Field available in the basic search results list.

valorContaDestinoMoeda

Foreign currency entry amount in the target account.

[AttLenght(19, 6)]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public decimal valorContaDestinoMoeda { get; set; }

Property Value

decimal

Remarks

Length total de 19, em que 12 são para as unidades e 6 para as decimais.

Required field.

Research field.

Field available in the basic search results list.

valorm

Valor de saída em moeda estrangeira, da conta de origem (contado1)

[AttLenght(19, 6)]
[AttMinValue(0)]
[AttFieldType(AttFieldType.InputTypes.currency, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.syncOnChange })]
public decimal valorm { get; set; }

Property Value

decimal

Remarks

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

Required field.

Research field.

Field available in the basic search results list.

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

GetSepaFields()

SepaFields GetSepaFields()

Returns

SepaFields

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

data

Data.

[AttLenght(1)]
[AttMandatory]
[AttLogInfo(2)]
[AttFieldType(AttFieldType.InputTypes.date)]
[AttList]
DateTime data { get; set; }

Returns

DateTime

Remarks

Required field.

Research field.

Field available in the basic search results list.

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

isApproved

Field to know if the document was approved

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttGama(Gamas.Advanced)]
[AttList(Inactive = true)]
bool isApproved { get; set; }

Returns

bool

isDocNeedsApproval

We use this field to know if the document needs approval

[AttFieldType(new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
[AttGama(Gamas.Advanced)]
[AttList(Inactive = true)]
bool isDocNeedsApproval { get; set; }

Returns

bool

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

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