SaldeoSMART — obsługa, integracje

API SaldeoSMART umożliwia import i eksport dokumentów wraz z metadanymi.¹ Poniżej znajdziesz zakres integracji, przebieg wymiany danych i wskazówki dotyczące diagnozowania błędów połączenia.
Podstawowa wymiana dokumentów opiera się na 2 operacjach: document.add służy do importu, a document.list do eksportu².

Czym jest saldeo API i do czego służy?

API SaldeoSMART łączy program z innym systemem. Interfejs obejmuje także dane modułu kadrowego oraz bazy firm.³

Jakie dane i operacje obsługuje API SaldeoSMART?

Przez API można odczytać dane dokumentów, faktur sprzedaży, kontrahentów i wyciągów bankowych. To, jakie informacje otrzymasz, zależy od rodzaju danych³.

Tabela pokazuje zakres odczytu dla poszczególnych rodzajów danych. Centrum pomocy SaldeoSMART wyróżnia 6 kategorii danych dostępnych do pobrania przez API³.

Dane w tabeli: 3

Jak połączyć API SaldeoSMART z własnym systemem?

Połączenie z własnym systemem zacznij od uwierzytelnienia i powiązania pól danych, a następnie przetestuj wymianę. Żądanie uwierzytelniają 2 parametry HTTP: username i req_sig; token API nie jest przesyłany².

• Dokumentacja API SaldeoSMART opisuje przygotowanie żądań. Skonfiguruj na jej podstawie klienta integracji.
• Mapowanie danych przypisuje pola systemu zewnętrznego do pól integracji. Przygotuj je przed przesłaniem danych.
• Test połączenia polega na wysłaniu żądania i sprawdzeniu otrzymanej odpowiedzi.

Czy API SaldeoSMART odpowiada potrzebom planowanej integracji?

API sprawdzi się w danej integracji, jeśli udostępnia dane potrzebne do wymaganych operacji. Porównaj pola systemu docelowego z zakresem odczytu w tabeli. Dane przypisane do konkretnej firmy oceń osobno.
Jeśli integracja wymaga innych pól lub operacji, jej zakres trzeba ocenić odrębnie³.

Jak sprawdzić działanie API i zdiagnozować błędy integracji?

Diagnostykę zacznij od żądania i odpowiedzi, potem prześledź przepływ danych w systemie docelowym. Kod błędu 4302 wskazuje, że użytkownik podany przy uwierzytelnianiu nie istnieje albo jest zablokowany².

• Żądanie API sprawdź pod kątem adresu, uwierzytelnienia i przekazanych parametrów.
• Odpowiedź API porównaj z oczekiwaną strukturą i zapisz komunikat błędu.
• Mapowanie pól sprawdź, jeśli odpowiedź zawiera dane, których system docelowy nie zapisuje.

O przydatności integracji decydują dostępne dane oraz wynik testowego żądania. Dane muszą odpowiadać zadaniu, które ma wykonać system docelowy.
Żądanie invoice.list wymaga 5 parametrów: username, req_id, req_sig, company_program_id oraz policy².

Dostęp do API SaldeoSMART i wymiana danych między systemami

API SaldeoSMART pozwala wymieniać dokumenty i dane z systemem finansowo-księgowym. Interfejs API-XML udostępnia także operacje document.list_recognized i document.search.⁴

Tabela zestawia metody HTTP dla 2 operacji pobierania danych.⁴

Tabela porównuje 3 polityki pobierania dokumentów pod względem zakresu wyniku i okresu dodania. Polityka LAST_10_DAYS obejmuje dokumenty dodane w ciągu ostatnich 10 dni⁵.

Dane w tabeli: 4,5

Jak przesyłać dokumenty i dane księgowe między SaldeoSMART a innym systemem?

Operację API dobierz do rodzaju dokumentu i kierunku przesyłania. Przy imporcie przez document.add plik nie powinien przekraczać około 70 MB ze względu na limit parametrów żądania².

• Import dokumentu wymaga przypisania pól dokumentu i jego metadanych do pól systemu docelowego.
• Eksport dokumentów wymaga ustawienia polityki pobierania zgodnej z potrzebnym zakresem.
• Odpowiedź API porównaj z danymi zapisanymi w systemie finansowo-księgowym.

Operacja i polityka pobierania decydują o tym, które dokumenty trafią do dalszego przetwarzania.
Dla document.list opisano 3 polityki: SALDEO, LAST_10_DAYS i LAST_10_DAYS_OCRED⁶.

Aktualizacja interfejsu

API SaldeoSMART udostępnia informacje o pochodzeniu dokumentu, metodzie płatności i historii zmian. Pola odpowiedzi rozróżniają źródło dodania dokumentu oraz użytkownika, który go dodał.

• CREATE_SOURCE w operacji document.list wskazuje źródło dodania dokumentu, a ADDED_BY_USER_ID identyfikuje użytkownika, który go dodał.⁷
• IS_MPP w odpowiedzi document.list oznacza metodę podzielonej płatności na dokumencie.⁴
• Historia zmian dokumentu ma format XML. Zawiera identyfikator dokumentu, datę zmiany, zmienione pole oraz jego wartość przed zmianą i po niej.⁸

Historię zmian może pobrać wyłącznie administrator BK z pakietem Ekspert.⁸ Lista identyfikatorów może obejmować maksymalnie 50 dokumentów.⁸ Maksymalny przedział dat wynosi 7 dni.⁸

Najczęściej zadawane pytania

Czy API pobiera kontrahentów i wyciągi bankowe wspólnie dla wszystkich firm?

Nie. Listy kontrahentów i wyciągów bankowych są pobierane osobno dla każdej firmy.

Jakie parametry są wymagane przy wywołaniu invoice.list?

Żądanie invoice.list wymaga parametrów username, req_id, req_sig, company_program_id oraz policy.

Czy CREATE_SOURCE i ADDED_BY_USER_ID wskazują tę samą informację?

Nie. CREATE_SOURCE określa źródło dodania dokumentu, a ADDED_BY_USER_ID identyfikuje użytkownika, który go dodał.

Jakie ograniczenia dotyczą pobierania historii zmian dokumentów?

Historię może pobrać administrator BK z pakietem Ekspert. Lista może obejmować maksymalnie 50 dokumentów, a przedział dat nie może przekraczać 7 dni.