InvoiceDigitizer - informacje podstawowe o interfejsie programowym dostępu do systemu.
Data wydania: 2016-11-14
Dotyczy wersji systemu: 2.3.x.x i nowsze
Informacje podstawowe o interfejsie programowym dostępu do systemu.
Dostęp do usług systemu InvoiceDigitizer realizowany jest poprzez klasę CentralServiceClient znajdującą się w bibliotece Arhat.InvoiceDigitizer.Central.
Plik biblioteki Arhat.InvoiceDigitizer.Central znajduje się w katalogu instalacji systemu - zazwyczaj jest to katalog: C:\Program Files (x86)\ARHAT\InvoiceDigitizer.
Powołanie instancji klasy:
CentralServiceClient client = new CentralServiceClient(address, endpoint);
Wartości address i endpoint znajdują się w pliku konfiguracyjnym dowolnej aplikacji klienckiej, np. w Weryfikatorze, i odpowiadają wartościom CentralServiceAddress i CentralServiceEndpoint,
przykładowo: "https://ofd-win10pro64:9030" i "CentralService".
Ustawienie parametrów obiektu
client.User = "<nazwa_użytkownika>";
client.Password = "<hasło_użytkownika>";
client.AppVersion = "<wersja_systemu>";
// ten atrybut nie występuje w starszych wersjach systemu, a jeśli jest, to powinien przyjąć wartość np. "2.3.2.3"
Wywołanie funkcji
CentralResponse<BoxInfoList> res = client.GetBoxInfoListToExport(new BoxInfoParameters(box.Id)
{
LoadBox = true,
LoadInvoiceInfoList = true,
LoadCustomer = true,
});
Uwaga:
- parametry wyszukiwania paczek BoxInfoParameters obsługują tylko jeden identyfikator paczki, pomimo że może być lista identyfikatorów,
- klasa CentralResponse obudowuje tylko dane pochodzące z Centrali o właściwości Success, Message, Error i Result, zawierających informacje o prawidłowości wywołania metod.
Wydobycie danych właściwych
BoxInfoList info = res.Result[0];
Pobranie informacji o kliencie (LoadCustomer = true) umożliwi określenie nazwy klienta biura księgowego, np:
Przeglądanie struktury obiektów
- biura:
CentralResponse<Office> offices = client.GetOfficeList();
- foldery:
CentralResponse<Folder> folders = client.GetFolderListByOfficeId(Guid aOfficeId);
CentralResponse<Folder> folders = client.GetFolderListByFolderId(Guid aFolderId);
- paczki:
CentralResponse<Box> boxes = client.GetBoxListByOfficeId(Guid aOfficeId);
CentralResponse<Box> boxes = client.GetBoxListByFolderId(Guid aFolderId);
Mapowania nazw pomiędzy plikiem wymiany a strukturą danych
Plik wymiany danych | Struktury danych interfejsu dostępu do systemu |
Eksport | BoxInfoList |
ListaPaczek | List<BoxInfo> InfoList |
Paczka | BoxInfo |
Paczka/Info | Box Box |
ListaFaktur | List<InvoiceInfo> InvoiceInfoList |
Faktura | InvoiceInfo |
Faktura/Info | Invoice Invoice |
Faktura/Wlasciwosci | InvoiceData InvoiceData |
ListaElementow | List<InvoiceValue> InvoiceValueList |
ElementFaktury | InvoiceValue |