Objekt TKAPDocument

Pomocí objektu TKAPDocument lze ve skriptovacím programovacím jazyku pracovat s příjmovými i dodacími doklady. Objekt je dostupný pouze ve skladovém programu. Při vytvoření nové instance objektu se otevřou tabulky SKLADKAR, SKLADZAS a MEMO a pomocí těchto tabulek pak program zjišťuje požadované informace. Doporučujeme proto nevytvářet současně mnoho instancí třídy TKAPDocument a v případě, že se objekty již nevyužívají, tak je uvolnit.

Objekt TKAPDocument

TKAPDocument = class
   property Sklad: word;  {doklady lze evidovat pouze v aktuálním skladu; načíst lze ale i doklady z jiných skladů}
   property Prijem: Boolean; {vlastnosti Prijem a Typ dokladu jsou pouze pro čtení - lze je nastavit pomocí SetDocType}
   property Rok : integer; { Vlastnost Rok odpovídá roku z data odeslání dokladu }
   property TypDokladu : byte;
   property CisloDokladu: longint;
   property Vaha: byte;  {pouze pro čtení}
   property UcetniMesic: byte;
   property DatumOdeslano: TDateTime;
   property Jmeno: String;
   property Jmeno2: String;
   property Ulice: String;
   property Mesto: String;
   property PSC: String;
   property Ucet: String;
   property Banka: String;
   property KonstantniSymbol: String;
   property VariabilniSymbol: String;
   property SpecifickySymbol: String;
   property CisloDL: String;
   property CisloObjednavky: String;
   property DatumObjednavky: TDateTime;
   property DatumPrijato: TDateTime;
   property DatumZaplaceno: TDateTime; {Vlastnosti DatumZaplaceno a Zaplaceno se aktualizují pomocí AddPayment}
   property Zadano: TDateTime; {pouze pro čtení}
   property DatumZdanPlneni: TDateTime;
   property Priznaky : word;
   property Uhrada : byte;
   property PocetTisku : byte; {pouze pro čtení}
   property PocetOprav : byte; {pouze pro čtení}
   property FaktBankUcet : byte;
   property Splatnost : word;
   property CisloBankVypisu: word;
   property Stredisko : word;
   property Podnik : byte;
   property ICO: String;
   property DIC: String;
   property Zakazka: String;
   property Vystavil: String;
   property Celkem: Double; {pouze pro čtení}
   property Zaplaceno: Double; {Vlastnosti DatumZaplaceno a Zaplaceno se aktualizují pomocí AddPayment}
   property Mena: String;
   property Kurz: Double;
   property Sleva: Double;
   property ProcPenale: Double;
   property PocetPalet : Double;
   property CasZadano : TDateTime; {pouze pro čtení}
   property PosledniZmena : TDateTime; {pouze pro čtení}
   property Preprava : String;
   property Poznamka : String;
   property PASIdObj      : longint;
   property Bonus         : Double;
   property ExtID         : String;
   property IndivCena     : String;
   property ID            : String;
   property Vyskladnil    : String;
   property StavExpedice  : byte;
   property DatExpedice   : TDateTime;
   property TypDopravy    : byte;
   property Priznaky2     : longint;
   property Priznaky3     : word;
   property CenovePasmo   : byte {TTypCeny};
   property DocType: TKAPDocType;  {pouze pro čtení - odkazuje na automaticky vytvořený objekt popisující typ dokladu}
   property Memo1         : TStringList;
   property Memo2         : TStringList;
   property MemoExp       : TStringList;
   property LastError: String; {pouze pro čtení}
   property RaiseExcept: Boolean; {true=při výskytu chyby se vyvolá výjimka; false=chyby se zapisují jen do LastError (výchozí) }
   property IgnoreRights  : Boolean; {určuje, zda jsou při evidování dokladu ignorována některá omezení daná přístupovými právy}
   property AutoNumber    : Boolean; {automatické číslování dokladu}
   property UpdatePrices  : Boolean; {automatická aktualizace cen při přidání položky pomocí AddDocItem}
   property DeliveryNo    : word; { číslo dodávky pro nové operace }
   property DeliveryDate  : TDateTime; { datum dodávky pro nové operace }
   property AutoDeliveryNo: Boolean; { určuje, zda číslo dodávky bude určeno automaticky nebo na základě vlastností DeliveryNo a DeliveryDate }
   property Items[Index: integer]: TKAPDocItem;  {pole objektů zpřístupňující jednotlivé operace dokladu}
   constructor Create(UpdatePrices: Boolean);
   destructor Destroy;
   procedure ClearLastError;
   function InitNewDocument(Prijem: Boolean; TypDokladu: byte): Boolean;
   function SetDocType(Prijem: Boolean; TypDokladu: byte): Boolean;
   function SetPartner(ICO: String): Boolean;
   function LoadDocHeaderFromDataset(Dataset: TDataset): Boolean;
   function LoadDocItemsFromDataset(Dataset: TDataset; var ErrorOnRow: longint): Boolean;
   procedure AddPayment(PaymentDate: TDateTime; Payment : Double);
   procedure ClearItems;
   procedure DeleteItem(Index: longint);
   function ItemsCount: longint;
   function AddDocItem(ProductCode: string; Quantity, Price, VATtotal: Double): Boolean;
   function LoadDocumentByDocNo(Sklad: word; Prijem: Boolean; Rok : Word; TypDokladu : byte;
                                CisloDokladu: longint; LoadItems: Boolean): Boolean;
   function GetCPYIndexesFromExchangeFile(FileName, Fields: String; GetCPYDoc, GetCPYReadedDoc: Boolean): TClientDataset;
   function LoadDocumentFromExchangeFile(FileName, ProtocolFileName: String; IndexCPY: longint;
                     ReadDocHeader, ReadDocMemo1, ReadBarCodes, ReadNewProducts, UpdateProducts, UpdatePurchasePrices, DeleteCPY: Boolean; LogText: String): Boolean;
   function SaveDocumentToExchangeFile(FileName: String;
                     SaveRecommendedPrices, SaveBarCodes, SaveLocations, SaveDocMemo1 : Boolean; LogText: String) : longint;
   function SaveDocumentHeaderToClientDataset(Fields: String): TDataset; {vrací objekt TClientDataset}
   function CheckItemsBeforeSave(var ErrItemNo: longint): Boolean;
   function SaveDocument: Boolean;
 end;

Funkce	Popis
constructor Create(UpdatePrices: Boolean)	Parametr UpdatePrices určuje, zda mají být ceny v dokladu počítány automaticky se zohledněním individuálních cen odběratele/dodavatele nebo budou určeny skriptem při přidávání jednotlivých položek. Vytvořené objekty nezapomeňte uvolnit pomocí metody Free.
procedure InitNewOrder	Reinicializuje objekt pro zpracování nové objednávky (tj. vynuluje se objednávka, smažou se požadavky i poznámky k objednávce). Tuto metoda se volá automaticky v rámci vytvoření objektu TKAPOrder.
function SetCustomer(ICO: String): Boolean	Podle údaje IČO dohledá zákazníka a naplní hlavičku objednávky podle fakturačního místa z adresy. Pokud odběratel není nalezen, tak je odběratel v objednávce vynulován. Podle zákazníka jsou určeny i individuální ceny pro případ automatické aktualizace cen. Funkce vrací true, pokud je zákazník nalezen.
function LoadOrderHeaderFromDataset(Dataset: TDataset): Boolean	Funkce načte z tabulky určené parametrem Dataset hlavičku objednávky. Struktura vstupní tabulky (jména polí) musí odpovídat struktuře tabulky SkladOBJ ze skladového programu. Pokud tabulka obsahuje pole MEMOA nebo MEMOB, tak jsou informace z tohoto pole přeneseny do vlastností MemoA, popř. MemoB (typu StringList). Pole EMAIL, RESPPERSON, PHONE, GUID, FAX, MOBILE, CONTACTEMAIL, SENDINFO jsou uložena ve formátu JménoPole=Hodnota do údaje MemoI. Pokud je ve vstupní tabulce definováno pole Mena a toto pole obsahuje cizí měnu, tak je automaticky dohledán v kurzovém lístku kurz a nastaví se příznaky pro používání cizí měny. Při přidávání položek jsou pak ceny uváděny v cizí měně.
function LoadOrderItemsFromDataset(Dataset: TDataset; var ErrorOnRow: longint): Boolean	Funkce načte z tabulky určené parametrem Dataset položky objednávky. Jména polí mohou být následující: Autokod nebo GUID (nepovinné jednoznačné označení záznamu), Kod nebo ProductCode (kód zboží z tabulky skladových karet), Pocet nebo Quantity (objednaný počet MJ), BaleniX nebo QuantityP (objednaný počet balení - důležité pro výpočet vázaných obalů; pokud pole není definováno, tak se počet balení určí automaticky), Cena nebo Price (cena bez DPH za MJ; pokud je nastavena automatická aktualizace cen, tak se toto pole ignoruje), Identifik nebo Comment (nepovinné pole, max. 30 znakový komentář k položce). Pokud některá položka objednávky nejde importovat, tak je do údaje ErrorOnRow uloženo pořadové číslo řádku, kde nastala chyba (od 1). Předchozí řádky zůstávají načteny.
procedure ClearItems	Tato procedura vymaže seznam položek objednávky.
procedure DeleteItem(Index: integer)	Tato procedura vymaže jednu položku objednávky (číslováno od 0).
function ItemsCount: integer	Funkce vrací počet položek objednávky.
property Items(Index: integer): TKAPOrderItem	Funkce vrací objekt typu TKAPOrderItem umožňující číst a měnit hodnoty jedné položky objednávky.
function AddOrderItem(Kod: String; Pocet, PocetBal: Double; AutoPocetBal: Boolean; Cena: Double; Identifikace: String): Boolean	Funkce přidá jednu položku objednávky. Krta určená kódem zboží musí existovat v seznamu skladových karet, počet musí být nenulový. Pokud je nastavena automatická aktualizace cen, tak se parametr Cena ignoruje a cena je určena automaticky programem se zohledněním individuální ceny odběratele. Pokud je parametr AutoPocetBal nastaven na true, tak se parametr PocetBal ignouje a počet balení je určen automaticky.
function LoadOrderByOrderNo(Sklad: word; Prijem: Boolean; CisloObjednavky: longint; LoadItems: Boolean): Boolean	Funkce načte z databáze objednávku určenou číslem skladu a číslem objednávky. Parametr Prijem nastavte na false (čili požadavky); Pokud údaj Sklad bude mít hodnotu 0, tak se použije aktuální číslo skladu. Parametr LoadItems určuje, zda načtou i položky objednávky. Funkce vrací true, pokud je objednávka nalezena a načtena.
function LoadOrderByGUID(GUID: AnsiString; LoadItems: Boolean): Boolean	Funkce dohledá GUID a pokud je nalezen, tak načte odpovídající objednávku. GUID se ukládá jen pro externí objednávky a je uložen ve formě textu GUID=hodnota v tabulce MEMO ve vazbě na danou objednávku. Pro použití této funkce je nutné mít aktuální (rozšířenou) verzi indexů pro tabulku MEMO.
function SaveOrder: Boolean	Funkce uloží hlavičku objednávky (u nových objednávek přidělí číslo dle číselné řady požadavků), položky a poznámky uložené v MemoA, memoB a MemoI. Pokud je vrácena hodnota true, tak je objednávka uložena do databáze. Může se ale stát, že se uloží objednávka s položkami, ale poznámky se nepodaří uložit (podrobnosti je v tomto případě možné zjistit z pole LastError). Pokud je vrácena hodnota false, tak se objednávku nepovedlo uložit (a není uložena ani hlavička, ani položky). Ukládat lze jen nové objednávky nebo objednávky, které byly kompletně načteny včetně požadavků.

Viz příklad Příklady PASCAL

Objekt TKAPDocItem

TKAPDocItem = class
   constructor Create;   {objekt není možné přímo vytvářet - k objektu se lze dostat pomocí TKAPOrder.Items[Index] }
   property ProductCode: string; {Kód zboží}
   property Quantity: Double; {Počet MJ}
   property Price: Double; {Cena za MJ bez DPH}
   property VATTotal: Double; {celková hodnota DPH za danou operaci}
   property VATPercent: Double; {Procento DPH}
   property QuantitySold: Double; {jen pro čtení - počet kusů vydaný z dané nákupní operace}
   property PurchasePrice: Double; {Nákupní cena - pro vydané dobropisy}
   property DeliveryNumber: word; {číslo dodávky}
   property DeliveryDate: longint; {datum dodávky}
   property Flags: word; {jen pro čtení - příznaky operace}
 end;