Manual de

Produto
PeTExchange

Soluções Pssst! e Tlim

v8.0

Versão 1.0
novembro 2013
(última atualização em 15.11.2013)
 Índice
Índice............................................................................................................................ 2

Introdução .................................................................................................................... 4

Classe de serviços ......................................................................................................... 4

Estrutura geral das classes de entidades ....................................................................... 4

Tipos de entidades ...................................................................................................... 5

Entidades limitadas ..................................................................................................... 5

Entidades tendencialmente grandes ............................................................................... 5

Entidades existentes ................................................................................................... 6

Artigos ...................................................................................................................... 6

Artigos por Cliente ...................................................................................................... 6

Códigos de Barras (Tlim) .............................................................................................. 7

Documentos ............................................................................................................... 7

Linhas do Documento ............................................................................................... 7

Entidades .................................................................................................................. 8

Famílias ..................................................................................................................... 9

Ingredientes............................................................................................................... 9

Liquidações ................................................................................................................ 9

Linhas da Liquidação............................................................................................... 10

Meios de Pagamento ................................................................................................. 10

Mesas ..................................................................................................................... 11

Movimentos de Caixa................................................................................................. 11

Observações ............................................................................................................ 12

Operadores .............................................................................................................. 12

Pedidos ................................................................................................................... 13

Linhas do pedido .................................................................................................... 13

Salas ...................................................................................................................... 13

Taxas de IVA ............................................................................................................ 13

Tipos de Documentos ................................................................................................ 14

Tipos de Liquidações ................................................................................................. 15

Métodos e funções disponíveis .................................................................................. 16

Delete ..................................................................................................................... 17

GetItemsByClient ...................................................................................................... 17

GetNext ................................................................................................................... 17

GetSpecificItem ........................................................................................................ 17

LoadItems ............................................................................................................... 17

SendItem, SendItems ................................................................................................ 18

StartReading ............................................................................................................ 18
Filtros.......................................................................................................................... 19

Filtros Disponíveis .................................................................................................... 19

Exemplo de utilização .................................................................................................. 20

Introdução
O PeTExchange tem como objetivo tornar mais fácil a comunicação entre os programas Pssst!
ou Tlim e um módulo externo, permitindo uma troca de dados bidirecional.

A sua utilização faz-se através da classe clsExchange. Para que a comunicação possa ocorrer, a
aplicação Pssst! ou Tlim deve estar em execução, local ou remotamente.

A DLL PeTExchange é distribuída pelo setup da aplicação POS Integrator.

Classe de serviços
A DLL fornece como base de acesso aos dados a classe clsExchange. Essa classe disponibiliza
uma série de propriedades que dão acesso às várias classes de dados.

A classe clsExchange tem as seguintes propriedades:

 IPAddress – Propriedade de preenchimento obrigatório. Indica o endereço onde se
encontra a aplicação Pssst! ou Tlim.
 PageSize – Número de registos a serem carregados de uma única vez. Por defeito, o
valor dessa propriedade é 100.
 <Entidade> - Cada uma das entidades a serem apresentadas mais abaixo tem uma
propriedade correspondente.

Estrutura geral das classes de

entidades
As classes que disponibilizam dados dividem-se em dois grupos: as entidades tendencialmente
grandes e as entidades que tem um número limitado de itens.

Algumas classes possuem duas ou três versões de acesso aos dados. Quanto maior a versão,
maior a quantidade de dados preenchidos. As versões são identificadas na tabela de entidades
existente neste documento.

As classes existentes têm os seguintes métodos de acesso:

 Leitura
o GetSpecificItem – Lê um único item, baseado no valor da chave passada como
parâmetro.
o LoadItems – Carrega uma coleção de itens. Para coleções grandes, os itens
podem ser filtrados.

Envio 1
o SendItem – Envia um item
o SendItems – Envia uma coleção de itens
 Eliminação 2
o Delete – Elimina um item
Todos os métodos tem como um dos parâmetros uma string identificada como msg, que retorna
uma mensagem de erro, caso ocorra.

1 Disponível apenas para as seguintes entidades: Artigos, Códigos de Barras,

Artigos por Cliente, Documentos, Entidades, Famílias, Ingredientes, Pedidos,
Taxas e Operadores

2 Disponível apenas para as seguintes entidades: Artigos, Códigos de Barras,

Artigos por Cliente, Documentos, Entidades, Famílias, Ingredientes e
Operadores
Tipos de entidades
Entidades limitadas

São entidades que possuem um número de registos limitado, isto é, que não devem crescer ou
que devem crescer em um número muito reduzido.

A leitura destas entidades é feita toda de uma única vez, isto é, ao ser feito o pedido de leitura
de um item, toda a coleção de itens é disponibilizada em memória.

Fazem parte deste grupo:

 Artigos por Cliente
 Famílias
 Ingredientes
 Meios de pagamento
 Mesas
 Observações
 Operadores
 Salas
 Taxas de IVA
 Tipos de documentos
 Tipos de liquidações

Entidades tendencialmente grandes

São entidades que devem crescer de forma muito acentuada com o tempo.

Fazem parte deste grupo:

 Artigos
 Códigos de barras
 Documentos
 Entidades
 Fluxos de caixa
 Liquidações
 Pedidos

As entidades deste grupo tem, para além dos métodos citados anteriormente, mais dois
métodos complementares:
 GetNext
 StartReading
Por se tratarem de coleções que podem ter muitos registos, o PetExchange fornece uma
paginação automática de registos. Uma página é definida como um conjunto de 100 registos
(valor este que pode ser alterado através da propriedade PageSize). Para iniciar a paginação é
preciso fazer uma chamada ao método StartReading da classe. Esse método não retorna
nenhuma estrutura de dados, apenas indica que vai ser iniciada a leitura de dados. A partir de
então, para cada registo a ser lido, basta fazer uma chamada à função GetNext. A paginação
passa a ser controlada pelo PeTExchange, isto é, mesmo que exista um número de registos
superior ao tamanho da página, basta continuar a chamada à função GetNext. Quando não
houver mais registos, a função GetNext retorna o valor Nothing.
Entidades existentes
Abaixo seguem as tabelas com as entidades disponibilizadas. A coluna versão, quando
existente, indica a partir de qual versão a propriedade é disponibilizada (preenchida).

Artigos
clsBEArticle
Propriedade Descrição Versão
Code Código do Artigo 1
Description Designação 1
Price Preço 1 1
Unit Unidade de Medida 1
TaxID Taxa de IVA 1
FamilyCode Código da família 1
BarCode Código de Barras 1
PrinterLabelNumber Número da impressora 2
ScaleID Identificador de escala 2
IngredientsID Código da lista de ingredientes 2
BatchCode Lote 2
ValidityDays Validade em dias 2
ValidityDays2 Validade em dias 2 2
FixedTare Tara fixa 2
WeightDiscount Percentagem de desconto em peso 2
QuantityDefault Quantidade por defeito 2
QuantityMinimum Peso mínimo 2
QuantityMaximum Peso máximo 2
HasButton Artigo tem botão 2
Description2 Designação 2 3
Price2 Preço 2 3
Price3 Preço 3 3
Price4 Preço 4 3
ObservationsAmount Número de observações 3
Discount Desconto 3
SingleObservation Permitir uma única observação 3
ConfirmPrice Confirmar preço 3
ConfirmQuantity Confirmar quantidade 3
Stock Stock real 3

Artigos por Cliente

clsBEClientArticle
Propriedade Descrição
ClientID Código do cliente
ArticleOrder Ordem do artigo
ArticleCode Código do artigo
Description Descrição da associação
Price Preço
Discount Desconto
TransactionArticleCode Código interno
Códigos de Barras (Tlim)
clsBEBarCode
Propriedade Descrição
ArticleCode Código do artigo
BarCodeIndex Ordem do código de barras
BarCode Código de barras
Description Designação
Quantity Quantidade de artigos

Documentos
clsBEDocument
Propriedade Descrição Versão
DocumentType Tipo do documento 1
DocumentNumber Número do documento 1
LineCount Número de linhas 1
VendorCode Código do vendedor 1
TerminalID Terminal 1
DocumentDate Data do documento 1
DiscountTotal Desconto total 1
TotalAmount Total com taxas 1
Lines Linhas do documento 1
SystemDate Data de criação do documento 2
DueDate Data de vencimento 2
UserID Utilizador 2
Reference Referência opcional 2
Emitted Indica se o documento foi emitido 2
Deleted Indica se o documento foi eliminado 2
EntityCode Código da entidade 2
EntityName Nome da entidade 2
EntityTaxID Número fiscal da entidade 2
Taxes Lista de taxas do documento 2
TotalTaxAmount Valor total de taxas 2
SubTotal Total sem taxas e sem descontos 2
NetTotal Total sem taxas 2
Hash Assinatura digital 2
HashShortReference Assinatura digital 2
Certificate Identificador de certificação 2
KeyVersion Versão (certificação) 2
ExternalDocNumber Número do documento externo 2

Linhas do Documento
clsBEDocumentLine
DocumentType Tipo do documento 1
DocumentNumber Número do documento 1
LineNumber Número da linha 1
ArticleCode Código do Artigo 1
Price Preço 1
Quantity Quantidade 1
Total Valor total 1
UserID Operador 2
Description Descrição 2
Unit Unidade 2
TaxIncluded IVA incluído 2
QuantityDecimalPlaces Casas decimais usadas na quantidade 2
TaxPercentage Percentagem de IVA 2
TaxGroup Código do IVA 2
PercentageDiscount1 Desconto percentual 1 2
Discount1 Valor do desconto 1 2
PercentageDiscount2 Desconto percentual 2 2
Discount2 Valor do desconto 2 2
ExemptionReason Motivos de isenção 2
OriginalDocumentType Tipo do documento original 2
OriginalDocumentSeries Série do documento original 2
OriginalDocumentNumber Número do documento original 2
OriginalDocumentDate Data do documento original 2

Entidades
clsBEEntity
Propriedade Descrição
EntityType Cliente ou fornecedor

Deve obedecer a um dos seguintes valores:

Valor Descrição
etClient Cliente
etSupplier Fornecedor

Code Código
FirstName Primeiro nome
SecondName Apelido
Address Morada
City Cidade
ZIPCode Código postal
County Localidade
Profession Profissão
BusinessZone Zona
FiscalID Número de contribuinte
PhoneNumber Telefone
MobileNumber Telemóvel
FaxNumber Fax
eMail e-mail
BirthDate Data de nascimento
ClassificationID Classe
ClassificationDescription Descrição da classe
PaymentTermsID Condições de pagamento
PaymentTermsDescription Descrição das condições de pagamento
PaymentDelay Prazo
DefaultPriceLevel Linha de preço
Discount Desconto comercial
LineDiscount Desconto da linha
CountryID Identificador do país
BusinessID Identificador do negócio
ManufacturerID1 Identificador – Produtor 1
ManufacturerID2 Identificador – Produtor 2
ManufacturerID3 Identificador – Produtor 3
Balance Saldo da conta corrente
DebitLimit Limite de débito
CardBalance Saldo do cartão pré pago
Observations Observações
Disabled Inativo

Famílias
clsBEFamily
Propriedade Descrição Versão
FamilyCode Código 1
FamilyName Descrição 1
ImageRelativePath Imagem 2
TaxGroupID Grupo 2
Department Departamento 2

Ingredientes
clsBEIngredient
Propriedade Descrição
IngredientListID Código da lista de ingredientes
Description Descrição da lista de ingredientes
Ingredients Lista de ingredientes separados por vírgulas

Liquidações
clsBELiquidation
Propriedade Descrição
DocumentType Tipo do documento
Number Número do documento
LineCount Número de linhas
TerminalID Terminal
DocumentDate Data do documento
SystemDate Data de criação
ProcessDate Data de processamento
UserID Operador
Reference Referência
Emitted Emitido
Deleted Apagado
Processed Processado
EntityCode Código da entidade
EntityName Nome da entidade
EntityTaxID Número fiscal da entidade
TotalTaxAmount Valor total das taxas
SubTotal Valor total antes de taxas e descontos
DiscountTotal Desconto total
Retainable Valor sujeito a retenção
RetainedTotal Valor total retido
TotalAmount Valor total incluindo taxas
Lines Linhas da Liquidação

Linhas da Liquidação
clsBELiquidationLine
DocumentType
DocumentNumber
LineNumber
OriginalDocumentType
OriginalDocumentNumber
OriginalDocumentDate
OriginalDocumentDueDate
OriginalDocumentDescription
OriginalDocumentReference
TransactionType
DocumentTotal
PendingValue
LiquidatedValue
DiscountPercentage
DiscountTotal
AmountTransfered
TotalTaxValue
TotalRetainableValue
RetainedTotal
Tipo do documento
Número do documento
Número da linha
Tipo do documento original
Número do documento original
Data do documento original
Data de vencimento do documento original
Descrição do documento original
Referência do documento original
Tipo do movimento (crédito/débito)
Valor total
Valor pendente
Valor liquidado
Desconto percentual
Desconto total
Valor transferido para conta
Valor total de IVA
Valor sujeito a retenção
Valor total retido

Meios de Pagamento
clsBEPaymentMethod
Propriedade Descrição
Code Código
Description Descrição
Exchange Câmbio
PaymentType Tipo de pagamento

Deve obedecer a um dos seguintes valores:

Valor Descrição
ptHidden Escondido
ptReceiveOnly Apenas recebimentos
ptReceiveAndPay Recebimentos e pagamentos
Mesas
clsBETable
Propriedade Descrição
RoomID Código da sala
TableNumber Número da mesa
TableState Estado da mesa

Deve obedecer a um dos seguintes valores:

Valor Descrição
tsVacant Livre
tsReserved Reservada
tsOccupied Ocupada

NumberOfCustomers Número de clientes

Movimentos de Caixa
clsBECashFlow
Propriedade Descrição
CashFlowDate Data do movimento
Number Número do movimento
PaymentMethod Modo de pagamento

Deve obedecer a um dos seguintes valores:

Valor Descrição
cpNone Nenhum
cpCash Numerário
cpDebitCard Cartão de débito
cpCreditCard Cartão de crédito
cpCheck Cheque
cpPreDatedCheck Cheque pré datado
cpClientAccount Valor em conta
cpMoneyCard Cartão / Cheque brinde
cpPointsCard Cartão de pontos

UserID Utilizador
EventType Tipo de evento

Deve obedecer a um dos seguintes valores:

Valor Descrição
ctNone Nenhum
ctOpen Abertura de caixa
ctEntry Entrada de caixa
ctExit Saída de caixa
ctClose Fecho de caixa
ctDocumentReference Movimento
ctLiquidationReference Liquidação
Value Valor
DocumentType Tipo do documento
DocumentNumber Número do documento
Observations Observações
DocumentClass Classe do documento

Deve obedecer a um dos seguintes valores:

Valor Descrição
cdNoDocument Nenhum documento associado
cdRegularDocument Movimento
cdLiquidation Liquidação

Observações
clsBEObservation
Propriedade Descrição
ObservationID Código
Observation Descrição
OnlyAppliesToArticles Usar só como observação/artigo

Operadores
clsBEUser
Propriedade Descrição
UserID Código
Name Nome
PIN Código de Acesso
IsAdministrator Administrador
CanChangePrices Permite alterar preço dos artigos
ArticleDeletion Permissão para remover artigos das contas

Deve obedecer a um dos seguintes valores:

Valor Descrição
adCantRemove Não pode remover
adCanRemoveInordinate Apenas correções
adCanRemoveAny Qualquer artigo

CanSellWithoutPrice Permite registar artigos sem preços

CanCloseAccount Permite fechar contas
BlockTableTransfer Bloquear transferências entre mesas
BlockArticleTransfer Bloquear transferências parciais entre mesas
Pedidos
clsBETableList
Propriedade Descrição Versão
ListID Código do pedido 1
ListObjectID Código interno do pedido 1
NumberOfItems Quantidade de artigos 1
ListDate Data 1
Terminal Terminal 1
UserID Operador 1
CustomerID Código do cliente 1
Total Valor total 1
Lines Lista com as linhas do pedido 1

Linhas do pedido
clsBETableListLine
ListID Código da lista 1
LineID Código da linha 1
Article Artigo 1
Description Descrição 1
UnitPrice Preço unitário 1
Quantity Quantidade 1
TotalAmount Valor total 1
Observations Observações 1
UnitName Descrição da unidade 2
QuantityDecimalPlaces Casas decimais da quantidade 2
Discount1 Desconto 1 2
Discount2 Desconto 2 2
UserID Operador 2

Salas
clsBERoom
Propriedade Descrição
RoomID Código
Name Designação
NumberOfTables Número de mesas
DefaultPriceLevel Nível de preços

Taxas de IVA
clsBETax
Propriedade Descrição
TaxID Código
TaxPercentage Taxa
TaxDescription Descrição
Tipos de Documentos
clsBEDocumentType
Propriedade Descrição Versão
Code Código 1
Description Descrição 1
LegalTypeCode Tipo do documento (SAF-T) 1
Series Série 1
TargetEntityType Documento para cliente/fornecedor 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
etClient Cliente
etSupplier Fornecedor

CashFlowType Movimento do caixa 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
ftNone Não movimenta
ftInput Entrada
ftOutput Saída

StockFlowType Movimento de stock 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
ftNone Não movimenta
ftInput Entrada
ftOutput Saída

MovementType Movimento da conta corrente 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
mtNone Não movimenta
mtCredit Crédito
mtDebit Débito

LegalName Descrição do documento (SAF-T) 2

MaxAmount Valor máximo permitido 2
ShortDescription Descrição abreviada (para listagens) 2
FooterRows Linhas extras 2
NoTax Considerar IVA não incluído 2
OpenDrawer Abertura de gaveta 2
ShowPaymentInterface Mostrar janela de pagamento 2
SummarizeByGroups Imprimir artigos por grupos 2
ConfirmPrint Confirmar antes de imprimir 2
PrintTaxSummary Imprimir resumo do IVA 2
PrintForEachArticle Imprimir ticket dos artigos 2
AskExternalDocNumber Referenciar documento original 2
IncludeObservations Imprimir observações dos artigos 2
PrintComplements Imprimir complementos/lotes 2
PrintExtraParameters Processa parâmetros extras 2
PrintTaxArticle Referenciar artigo 35 do CIVA 2
HasTaxFlow Movimento financeiro 2
AskForTargetID Introdução dos dados do cliente 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
tdNo Não
tdYes Sim
tdMandatory Obrigatório

PrintTargetDetail Impressão dos dados do cliente 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
pdNone Não imprimir
pdBasic Básico
pdFull Completo

DefaultPrintDescription Impressão base 2

DefaultPrintTemplate Ficheiro da impressão base 2
DefaultNumberOfCopies Vias da impressão base 2
DefaultPrinter Impressora base 2
SecondaryPrintDescription Impressão alternativa 2
SecondaryPrintTemplate Ficheiro da impressão alternativa 2
SecondaryNumberOfCopies Vias da impressão alternativa 2
SecondaryPrinter Impressora alternativa 2
ArticlesTicketID Tipo de etiqueta a imprimir 2
ChecksTicketID Tipo de etiqueta para cheques 2
BarcodeLayout Código de barras 2
ConfirmDate Confirmação de data 2

Deve obedecer a um dos seguintes valores:

Valor Descrição
dcNo Não
dcYes Sim
dcYesterday Anterior

Tipos de Liquidações
clsBELiquidationType
Propriedade Descrição
Code Código
Description Descrição
LegalTypeCode Tipo do documento (SAF-T)
Series Série
TargetEntityType Documento para cliente/fornecedor

Deve obedecer a um dos seguintes valores:

Valor Descrição
etClient Cliente
etSupplier Fornecedor

CashFlowType Movimento do caixa

Deve obedecer a um dos seguintes valores:

Valor Descrição
ftNone Não movimenta
ftInput Entrada
ftOutput Saída

MovementType Movimento da conta corrente

Deve obedecer a um dos seguintes valores:

Valor Descrição
mtNone Não movimenta
mtCredit Crédito
mtDebit Débito

LegalName Descrição do documento (SAF-T)

ShortDescription Descrição abreviada (para listagens)
OpenDrawer Abertura de gaveta
ConfirmPrint Confirmar antes de imprimir
PrintTargetDetail
Deve obedecer a um dos seguintes valores:
Valor Descrição
pdNone Não imprimir
pdBasic Básico
pdFull Completo

DefaultPrintDescription Impressão base

DefaultPrintTemplate Ficheiro da impressão base
DefaultNumberOfCopies Vias da impressão base
DefaultPrinter Impressora base
SecondaryPrintDescription Impressão alternativa
SecondaryPrintTemplate Ficheiro da impressão alternativa
SecondaryNumberOfCopies Vias da impressão alternativa
SecondaryPrinter Impressora alternativa

Métodos e funções disponíveis

 Os métodos de acesso a dados, através da classe clsExchange, estão resumidos nas
tabelas abaixo:

Delete
Entidade Parâmetros
Entidades válidas 1 <Code>, msg

Parâmetro Descrição
<Code> Código da entidade
msg Mensagem a ser preenchida em caso de erro

GetItemsByClient
Entidade Parâmetros
Artigos por cliente Client, msg

Parâmetro Descrição
Client Código do cliente
msg Mensagem a ser preenchida em caso de erro

GetNext
Entidade Parâmetros
Entidades tendencialmente msg
grandes

Parâmetro Descrição
msg Mensagem a ser preenchida em caso de erro

GetSpecificItem
Entidade Parâmetros
Todas as entidades, com exceção <Code>, msg
de Artigos por Cliente

Parâmetro Descrição
<Code> Código da entidade
msg Mensagem a ser preenchida em caso de erro

LoadItems
Entidade Parâmetros
Artigos msg, Parameters
Códigos de Barras
Movimentos de caixa
Pedidos
Artigos por Cliente msg, ForceReload
Famílias
Ingredientes
Meios de Pagamento
Observações
Operadores
Salas
Taxas
Tipos de Documentos
Tipos de Liquidações
Documentos <Code>, msg, parameters

Parâmetro Descrição
Msg Mensagem a ser preenchida em caso de erro
Parameters Conjunto de filtros e valores
ForceReload Faz com que os dados sejam novamente lidos. Se tiver o valor false,
são usados os dados em memória
<Code> Código da entidade

SendItem, SendItems
Entidade Parâmetros
Pedido Msg, Terminal, <Code>
Documento TableList, TemplateDocument, PaymentMethod, Amount, msg
Demais entidades Msg, <Code>, OverlapItems

Parâmetro Descrição
msg Mensagem a ser preenchida em caso de erro
Terminal Número do terminal a registar no pedido
<Code> Código da entidade
OverlapItems Parâmetro opcional – se true indica que o item será sobreposto no
destino (Pssst! ou Tlim) caso já exista. Por defeito, é false.
TableList Mesa ou pedido
TemplateDocument Documento modelo
PaymentMethod Método de pagamento
Amount Valor

StartReading
Entidade Parâmetros
Documentos <type>, Msg, <code>
Entidades
Liquidações
Demais entidades Msg, <code>
tendencialmente grandes

Parâmetro Descrição
<type> Tipo da entidade
msg Mensagem a ser preenchida em caso de erro
 <Code> Parâmetro opcional, com o código da primeira entidade a ser
carregada

Filtros
Os filtros apenas estão disponíveis para as coleções tendencialmente grandes.

Os filtros são passados como parâmetro do método LoadItems das entidades e são opcionais. Ao
serem usados, devem obedecer ao seguinte formato:

LoadItems (msg, <filtro_1>, <valor_1>, <filtro_2>, <valor_2>, …, <filtro_n>, <valor_n>)

Abaixo alguns exemplos de como carregar entidades com filtros:

Ex.1: Carregar todos os artigos da família “01“

Set myArticles = objExchange.Articles.LoadItems (msg, afFamily, "01")

Ex. 2: Carregar movimentos de caixa do mês de outubro de 2013, do tipo entrada de caixa:

Set myFlows = objExchange.CashFlow.LoadItems (msg, cfFromDate, "2013-10-01", cfToDate,

“2013-10-31”, cfEventType, ctEntry)

Filtros Disponíveis

Entidade Valor Descrição

Artigos afFamily Família
afBarCode Código de Barras
Código de Barras bfArticle Código do Artigo
Movimentos de Caixa cfFromDate Data inicial
cfToDate Data final
cfEventType Evento (deve obedecer a um dos
eventos existentes – ver
propriedade EventType)
cfDocType Tipo de documento
cfDocNumberEquals Número do Documento
cfDocNumberEqualsOrGreater Número do Documento Inicial
cfLiquidationType Tipo do Documento de Liquidação
cfLiquidationNumberEquals Número de Documento de
Liquidação
cfLiquidationNumberEqualsOrGreater Número inicial de Documento de
Liquidação
Documentos dfFromDate Data inicial
dfToDate Data final
dfEntity Entidade
dfDocumentNumberEquals Número do Documento
dfDocumentNumberEqualsOrGreater Número do Documento Inicial
Entidades efEntityCodeEquals Código da entidade
efEntityCodeEqualsOrGreater Código da entidade igual ou maior
Liquidações lfFromDate Data inicial
lfToDate Data final
lfEntity Entidade
 lfDocNumberEquals Número do Documento
lfDocNumberEqualsOrGreater Número do Documento Inicial
Pedidos lfFromDate Data inicial
lfToDate Data final
lfCustomer Cliente
lfTable Mesa / Lista

Exemplo de utilização
Abaixo segue uma pequena demonstração de como fazer a leitura e escrita de dados (código VB6)

Dim msg As String

Dim objExchange As clsExchange
Dim objArt As clsBEArticle
Dim objArts As clsBEArticles
Dim objDoc As clsBEDocument

' Instanciação da classe principal

Set objExchange = New clsExchange

' Propriedade obrigatória com o endereço da aplicação Pssst! ou Tlim

objExchange.IPAddress = "PssstComputer"

' Inicia leitura de artigos com paginação

objExchange.Articles.StartReading msg

' Leitura de todos os artigos existentes com paginação automática

' Le o primeiro artigo
Set objArt = objExchange.Articles.GetNext(msg)

Do
If Not objArt Is Nothing Then
' Verifica se ocorreu algum erro
If Len(msg) > 0 Then
MsgBox msg
Else
' Adiciona a descrição do artigo à uma ListBox
lstExemplo.AddItem objArt.Description
End If
 Set objArt = objExchange.Articles.GetNext(msg) ' Le o artigo seguinte
Else
If Len(msg) > 0 Then ' Verifica se ocorreu algum erro
MsgBox msg
End If
End If
Loop While Not objArt Is Nothing

lstExemplo.Clear

' Leitura de todos os artigos sem paginação

Set objArts = objExchange.Articles.LoadItems(msg)

' Adiciona a descrição do artigo à uma ListBox

For Each objArt In objArts
lstExemplo.AddItem objArt.Description
Next

lstExemplo.Clear

' Leitura de todos os artigos da família '01'

Set objArts = objExchange.Articles.LoadItems(msg, afFamily, "01")

' Adiciona a descrição do artigo à uma ListBox

For Each objArt In objArts
lstExemplo.AddItem objArt.Description
Next

' Criação de um novo artigo

Set objArt = New clsBEArticle
objArt.Code = "TEMP001"
objArt.Description = "Refrigerante"
objArt.TaxID = 23
objArt.BarCode = "123456789"

If objExchange.Articles.SendItem(msg, objArt) Then

MsgBox "Artigo criado com sucesso."
Else
MsgBox msg
End If

' Definição do preço do artigo criado anteriormente

' ATENÇÃO: A alteração de dados significa uma recriação do item
' Assim sendo, o código abaixo está errado. Ao não preencher a propriedade
' Description, por exemplo, o artigo passará a ter uma descrição vazia.
'----------------------------------------------------------------------------
'Set objArt = New clsBEArticle
'objArt.Code = "TEMP001"
'objArt.Price = 1.1
'objExchange.Articles.SendItem msg, objArt, True
'----------------------------------------------------------------------------
' A forma correta de se fazer a alteração é a seguinte:
Set objArt = objExchange.Articles.GetSpecificItem("TEMP001", msg)
If Not objArt Is Nothing Then
objArt.Price = 1.1

' É preciso definir o parâmetro OverlapItems como true. Caso contrário, o

' artigo não será alterado por já existir.
If objExchange.Articles.SendItem(msg, objArt, True) Then
MsgBox "Artigo alterado com sucesso."
Else
MsgBox msg
End If
Else
MsgBox msg
End If

' Eliminação do artigo TEMP001

If objExchange.Articles.Delete("TEMP001", msg) Then
MsgBox "Artigo eliminado com sucesso."
Else
MsgBox msg
End If

' Fechar o pedido da mesa 4 com a criação de uma fatura simplificada, paga
' com um valor de 10 euros em numerário
Set objDoc = New clsBEDocument
objDoc.DocumentType = 1

If objExchange.Documents.SendItem(4, objDoc, cpCash, 10, msg) Then

MsgBox "Documento criado com sucesso."
Else
MsgBox msg
End If
Set objDoc = Nothing

Set objExchange = Nothing