|
|
Funkcje WebAPI
Prezentujeny poniżej zestaw funkcji WebAPI. Funkcje te będą
rozwijane i wzbogacane o zgłaszane przez Państwa potrzeby. Wychodzimy bowiem z
założenia, że nawet najbardziej rozbudowany serwis nie zawsze spełni
wymagania użytkownika. Dlatego funkcje te mają pomagać tym programistom, którzy
zechcą zintegrować swoje oprogramowanie z serwisem MojaDobraFirma i tym samym
wzbogacić jego funkcjonalność. Jesteśmy otwarci na propozycje rozwoju
przedstawionej poniżej fukcjonalności - prosimy o pomysły nowych funkcji.
Jak uruchomić funkcje WebAPI
Dostęp do funkcji WebAPI serwisu
www.MojaDobraFirma.pl aktywuje się następująco:
- Logujemy się do serwisu (jeśli zdefiniowano, że z serwisu korzysta wielu
operatorów, musi to być operator z uprawnieniami administratora)
- Wybieramy: Administracja -> WebAPI
- Wprowadzamy login i hasło dla operatora(programu) który bedzie korzystał z
WebAPI
Jak zakończyć dostęp do funkcji WebAPI
Zakończenie dostępu do funkcji WebAPI uzyskujemy po "wyczyszczeniu" loginu i
hasła do funkcji WebAPI w serwisie.
Technologia
Funkcje WebAPI napisane są w technologii Microsoft
ASP.Net z wykorzystanie protokołu i usług sieciowych SOAP
i dostępne są pod adresem
https://www.MojaDobraFirma.pl/WebAPI.asmx,
a dokument WSDL
https://www.MojaDobraFirma.pl/WebAPI.asmx?WSDL
|
|
|
|
Obiekty WebAPI
|
|
|
|
public class MDFRodzajZdarzVAT {
// Kod rodzaju zdarzenia VAT
// Wykaz dopuszczalnych rodzajów zdarzeń VAT podaje funkcja MDFRodzajeZdarzenVAT
public string kodRodzajuZdarzVAT
// Opis rodzaju zdarzenia VAT
public string opis
}
|
|
|
|
public class MDFRejestr
{
// Symbol rejestru sprzedaży
// Wykaz założonych rejestrów sprzedaży podaje funkcja MDFDajRejestryFaktur
public string rejestr
// Nazwa rejestru
public string nazwa
// Czy numeracja miesięczna (jeśli nie, to roczna)
public bool numeracjaMiesieczna
// Cztery cyfry oznaczające kolejne człony drukowane jako numer faktury:
// 1 - numer faktury
// 2 - symbol rejestru
// 3 - miesiąc
// 4 - rok
// 0 - człon nie występuje
// i tak 2134 oznacza numer faktury np. SP/423/3/2014
public string formatNumeru
// Znak rozdzielający człony numeru faktury
public string rozdzielenie
// Powiązanie rejestru z rodzajem zdarzenia VAT
// czyli ze sposobem księgowania i prezentacji wartości na deklaracji VAT7
// Wykaz dopuszczalnych rodzajów zdarzeń VAT podaje funkcja MDFRodzajeZdarzenVAT
public string rodzZdarzVAT
}
}
|
|
|
|
public class MDFKontrahent {
// Unikalny identyfikator kontrahenta w słowniku (max. 64 znaki)
public string Identyfikator
// Pełna nazwa kontrahenta
public string NazwaPelna
// Adres kontrahenta: ulica, nr domu, nr lokalu
public string Ulica_NrDomu
// Kod pocztowy, miejscowość kontrahenta
public string Kod_Miejscowosc
// NIP kontrahenta
public string NIP
// Adres e-mail kontrahenta
public string Email
// Zawiera zwrotną informację o błędach
public string Error
}
|
|
|
|
public class MDFFaktura {
// Wartość zgodna ze słownikiem założonym w serwisie MojaDobraFirma.pl.
// Wykaz założonych rejestrów: DajRejestryFaktur
public string rejestr
// Nr faktury
public Nullable<int> nrFaktury
// Rok sprzedaży (rok do którego zaksięgować w PKPiR)
public Nullable<int> rokSprzedazy
//Miesiac sprzedaży (miesiąc do którego zaksięgować w PKPiR)
public Nullable<int> miesSprzedazy
// Opcja: Data sprzedaży
public Nullable<DateTime> dataSprzedazy
// Data wystawienia faktury
public Nullable<DateTime> dataWystawienia
// Sposób zapłaty
public string sposobZaplaty
// Opcja: Termin zapłaty
public Nullable<DateTime> terminZaplaty
// Osoba wystawiająca fakturę
public string wystawil
// Opcja: Osoba odbierająca fakturę
public string odbiera
// Miejsce wystawienia faktury
public string miejsceWystawienia
// Nasze konto bankowe
public string kontoBankowe
// Jeśli wypełnione to dopisanie do słownika kontrahentów w serwisie MojaDobraFirma.pl
public string platnikNazwaSkrIdentyfikator
// Jeśli płatnik o podanym identyfikatorze był w serwisie można nie wypełniać
public string platnikNazwa
// Jeśli płatnik o podanym identyfikatorze był w serwisie można nie wypełniać
public string platnikUlica
// Jeśli płatnik o podanym identyfikatorze był w serwisie można nie wypełniać
public string platnikMiejscowosc
// Jeśli płatnik o podanym identyfikatorze był w serwisie można nie wypełniać
public string platnikNIP
// Czy faktura została już zapłacona
public Nullable<bool> zaplacono
// Uwagi do umieszczenia na wydruku faktury
public string uwagiNaFakturze
// PLN, EUR, USD, ...
public string waluta
// ile PLN za (jednostkę * jednPrzelicz) waluty
public Nullable<decimal> kursWaluty
// Kurs za ile jednostek waluty
public Nullable<int> jednPrzelicz
// Zgodnie z wartościami podanymi przez MDFRodzajeZdarzeńVAT. Np.
sprzedaż krajowa=SpKraj
public string kodRodzajuZdarzVAT
// Tablica pozycji fakturowanych
public MDFPozycjaFaktury[] pozycje
}
|
|
|
|
public class MDFPozycjaFaktury
{
// Pozycja na fakturze - przedmiot sprzedaży
public string pozycjaFakturowana
// Jednostka miary
public string jm
// Ilość sprzedana (max. 3 miejsca dziesiętne)
public Nullable<decimal> ilosc
// Cena sprzedaży (w walucie faktury)
public Nullable<decimal> cena
// Czy cena sprzedaży jest ceną brutto
public Nullable<bool> cenaBrutto
// Stawka (procent VAT)
public Nullable<double> procentVAT
// Czy pozycja zwolniona z VAT (wtedy procent VAT = 0)
public Nullable<bool> zwolniona
// Czy pozycja nie podlega VAT (wtedy procent VAT = 0)
public Nullable<bool> niePodlegaVAT
// Dla stawki vat różnej od podstawowej
public string SWW
// Wartość netto pozycji (w walucie faktury)
public Nullable<decimal> wartNetto
// Wartość VAT pozycji (w walucie faktury)
public Nullable<decimal> wartVAT
// Wartość brutto pozycji (w walucie faktury)
public Nullable<decimal> wartBrutto
}
|
|
|
|
Funkcje(metody) WebAPI
|
|
|
|
MDFRodzajZdarzVAT[] MDFRodzajeZdarzenVAT(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI)
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
wynik:
tablica obiektów MDFRodzajZdarzeniaVAT
|
|
|
|
MDFKontrahent MDFDajKontrahenta(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, string KontrahentIdentyfikator)
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
KontrahentIdentyfikator - identyfikator kontrahenta w serwisie www.MojaDobraFirma.pl
wynik:
jeśli kontrahent istnieje - obiekt klasy MDFKontrahent
jeśli brak kontrahenta wynikiem jest obiekt pusty,
jeśli wystąpiły błędy (np. błędne hasło) - opis błędu jest w MDFKontrahent.Error
|
|
|
|
MDFKontrahent[] MDFDajKontrahentow(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI)
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
wynik:
tablica obiektów MDFKontrahent
jeśli wystąpiły błędy (np. błędne hasło) - opis błędu jest w pierwszym(zerowym) obiekcie tablicy
|
|
|
|
string MDFDopiszModyfikujKontrahenta(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, MDFKontrahent Kontrahent)
funkcja sprawdza, czy istnieje kontrahent o podanym identyfikatorze
i w zależności od wyniku dopisuje nowego kontrahenta lub aktualizuje istniejącego
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
Kontrahent - obiekt z danymi o kontrahencie
wynik:
string pusty lub informacja o błędzie
|
|
|
|
string MDFUsunKontrahenta(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, string KontrahentIdentyfikator)
funkcja usuwa z serwisu kontrahent o podanym identyfikatorze
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
KontrahentIdentyfikator - identyfikator usuwanego kontrahenta
wynik:
string pusty lub informacja o błędzie
|
|
|
|
MDFRejestr[] MDFDajRejestryFaktur(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI)
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
wynik:
tablica obiektów MDFRejestr
|
|
|
|
MDFFaktura[] MDFDajFakturyWystawioneWMiesiacu(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, int miesiac, int rok, string rejestr)
Zwraca tablicę faktur wystawionych z wskazanego rejestru sprzedaży
i z wskazanego miesiąca/roku sprzedaży
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
miesiac - miesiąc sprzedaży
rok - rok sprzedaży
rejestr - rejestr sprzedazy
wynik:
tablica obiektów MDFFaktura
|
|
|
|
string MDFZapamiętajFakture(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, MDFFaktura faktura)
funkcja dopisuje do serwisu nową fakturę
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
faktura - dopisywana faktura
wynik:
string pusty lub informacja o błędzie
|
|
|
|
string MDFUsunFakture(string UserDoSerwisu, string PasswordDoSerwisu,
string UserAPI, string PasswordAPI, int miesiac, int rok, string rejestr, int nrFaktury)
gdzie:
UserDoSerwisu - login użytkownika serwisu www.MojaDobraFirma.pl
PasswordDoSerwisu - hasło użytkownika serwisu www.MojaDobraFirma.pl
UserAPI - login do funcji WebAPI
PasswordAPI - hasło do funkcji WebAPI
miesiac - miesiąc sprzedaży
rok - rok sprzedaży
rejestr - rejestr sprzedazy
nrFaktury - numer usuwanej faktury
wynik:
informacja o błędzie
|
|