Interface IAccountingIntegration

Namespace

PHCBusinessLayer

Assembly

PHCBusinessLayer.dll

Documents integrated in accounting should implement this interface in order to retain info about accounting movements [DO]

public interface IAccountingIntegration

Properties

ADate

Acconting Date

DateTime ADate { get; set; }

Property Value

DateTime

Accounted

Mark document as accounted

bool Accounted { get; set; }

Property Value

bool

DocArchivalNumber

ID: Journal + Period + DocNumber

string DocArchivalNumber { get; set; }

Property Value

string

DocumentDescription

Label of the accounting document (DC)

string DocumentDescription { get; set; }

Property Value

string

DocumentId

Id of the accounting document (DC)

decimal DocumentId { get; set; }

Property Value

decimal

IntegrationErrors

Reported messages from accounting integration process

string IntegrationErrors { get; set; }

Property Value

string

IsAccounting

Is true if the document is in integrating process

bool IsAccounting { get; set; }

Property Value

bool

JournalDescription

Journal label (DI).

string JournalDescription { get; set; }

Property Value

string

JournalId

Journal code (DI).

decimal JournalId { get; set; }

Property Value

decimal

Row

BusinessVO Row { get; }

Property Value

BusinessVO

Year

Year of Integration (PCY).

int Year { get; set; }

Property Value

int

Methods

CanIntegrate()

Returns true if integration is available

bool CanIntegrate()

Returns

bool

CleanIntegrationErrors()

Cleans the accounting integration errors

void CleanIntegrationErrors()

GetIntegrationConfig(int)

Returns a specific accounting integration config if is setted on series of document otherwise returns nothing

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()

Mostly used on document configurations It retrieves the permission to integrated document of a given nature

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>