Dokumentacja API - ifirma.pl


Kwestionariusz osobowy pracownika


Poprzez API ifirma.pl możliwe jest zarządzanie kwestionariuszami osobowymi dla pracowników. Możliwe jest:

Pobranie kwestionariusza osobowego

Możliwe jest pobranie kwestionariusza osobowego pracownika na podstawie identyfikatora kwestionariusza.

Pobranie kwestionariusza w formacie JSON
Adres URL: https://www.ifirma.pl/iapi/kwestionariusz/find/{ticket}.json
Typ żądania: GET
Klucz autoryzacji: abonent

Pobranie kwestionariusza w formacie PDF
Adres URL: https://www.ifirma.pl/iapi/kwestionariusz/find/{ticket}.pdf
Typ żądania: GET
Klucz autoryzacji: abonent

gdzie jako ticket należy wstawić identyfikator kwestionariusza, np.:

https://www.ifirma.pl/iapi/kwestionariusz/find/rM0e7SS6i2uLV7591FsH.json
https://www.ifirma.pl/iapi/kwestionariusz/find/rM0e7SS6i2uLV7591FsH.pdf

Wysłanie kwestionariusza odobowego do pracownika

Na wskazany w żądaniu adres e-mail zostanie przesłany kwestionariusz osobowy.
Jednocześnie na koncie użytkownika zostanie utworzony nowy pracownik ze statusem przesłano kwestionariusz.

Żądanie
Adres URL: https://www.ifirma.pl/iapi/kwestionariusz/send.json
Typ żądania: POST
Format żądania: JSON
Klucz autoryzacji: abonent

Struktura JSON żądania:

Nazwa w JSON Typ danych Wartości Wymagane Opis
Email String >= 1 znak;
<= 65 znaków
T Adres e-mail, na który zostanie przesłany kwestionariusz osobowy
Imie String >= 1 znak;
<= 30 znaków
T Imię odbiorcy kwestionariusza
Nazwisko String >= 1 znak;
<= 50 znaków
T Nazwisko odbiorcy kwestionariusza
OsobaWspolpracujaca Boolean T Pracownikowi dodanemu z wartością true nie będą naliczane składki FGŚP
Telefon String <= 16 znaków N

Przykładowa zawartość żądania (JSON):

{
  "Email": "andrzej@krzywy.pl";
  "OsobaWspolpracujaca": false;
  "Imie": "Andrzej";
  "Nazwisko": "Krzywy";
  "Telefon": "608255998";
}

W odpowiedzi zwracany jest kod wiadomości mówiący o poprawności wykonania żądania oraz identyfikator kwestionariusza.

Zapisanie kwestionariusza osobowego pracownika

W oparciu o przesłane dane, na koncie użytkownika zostanie utworzony nowy pracownik ze statusem kwestionariusz wypełniony

Żądanie
Adres URL: https://www.ifirma.pl/iapi/kwestionariusz.json
Typ żądania: POST
Format żądania: JSON
Klucz autoryzacji: abonent

Struktura JSON żądania:

Nazwa w JSON Typ danych Wartości Wymagane Opis
OsobaWspolpracujaca Boolean T Pracownikowi dodanemu z wartością true nie będą naliczane składki FGŚP
Email String >= 1 znak;
<= 65 znaków
T
Telefon String <= 16 znaków N Numer telefonu
Imie String >= 1 znak;
<= 30 znaków
T
DrugieImie String <= 30 znaków N
Nazwisko String >= 1 znak;
<= 50 znaków
T
PESEL String 11 znaków T/N Pole wymagane, jeśli obywatelstwo polskie
DataUrodzenia String Format: DD-MM-RRRR N Numer telefonu odbiorcy kwestionariusza
Plec String M (mężczyzna);
K (kobieta)
T
RodzajDokumentuTozsamości String DOWOD_OSOBISTY (dla dowodu osobistego);
PASZPORT (dla paszportu)
N Rodzaj dowodu tożsamości pracownika
SeriaNumerDowoduTozsamosci String <= 20 znaków N Seria i numer wybranego dokumentu tożsamości
Obywatelstwo String np. Polskie T
MiejsceRezydencjiPolska Boolean T Wartość TRUE oznacza, że pracownik jest rezydentem polskim
UrzadSkarbowyKod String kod urzędu skarbowego T Tabela: Urzędy skarbowe
KodNFZ String kod oddziału NFZ N Tabela: Oddziały NFZ
KontoBankowe String 26 znaków N Numer konta bankowego pracownika
NazwaBanku String <= 50 znaków N Nazwa banku, w któym założone jest konto bankowe
TypUkonczonejSzkolyId String Identyfikator rodzaju szkoły N Tabela: Rodzaj szkoły
StazPracy Integer N Staż pracy pracownika liczony w latach
AdresZameldowania Nie wypełniać, jeśli pracownik nie posiada adresu zameldowania
Ulica String <= 50 znaków T
NumerDomu String <= 10 znaków T
NumerLokalu String <= 10 znaków N
AdresZagraniczny Boolean T Wartość TRUE znosi walidację na polski kod pocztowy
KodPocztowy String <= 16 znaków T Walidacja na polski kod pocztowy w zależności od wartości pola AdresZagraniczny
Miejscowosc String <= 50 znaków T
Poczta String <= 50 znaków T
Gmina String <= 50 znaków T
Powiat String <= 50 znaków T
Wojewodztwo String np. dolnośląskie T
Kraj String np. Niemcy T/N Pole obowiązkowe, jeśli adres jest zagraniczny
AdresZamieszkania
Ulica String <= 50 znaków T
NumerDomu String <= 10 znaków T
NumerLokalu String <= 10 znaków N
AdresZagraniczny Boolean T Wartość TRUE znosi walidację na polski kod pocztowy
KodPocztowy String <= 16 znaków T Walidacja na polski kod pocztowy w zależności od wartości pola AdresZagraniczny
Miejscowosc String <= 50 znaków T
Poczta String <= 50 znaków T
Gmina String <= 50 znaków T
Powiat String <= 50 znaków T
Wojewodztwo String np. dolnośląskie T
Kraj String np. Niemcy T/N Pole obowiązkowe, jeśli adres jest zagraniczny
AdresKorespondencyjny
Ulica String <= 50 znaków T
NumerDomu String <= 10 znaków T
NumerLokalu String <= 10 znaków N
AdresZagraniczny Boolean T Wartość TRUE znosi walidację na polski kod pocztowy
KodPocztowy String <= 16 znaków T Walidacja na polski kod pocztowy w zależności od wartości pola AdresZagraniczny
Miejscowosc String <= 50 znaków T
Poczta String <= 50 znaków T
Kraj String np. Niemcy T/N Pole obowiązkowe, jeśli adres jest zagraniczny
Oświadczenia Treść oświadczenia
ZatrudnienieRodzimyZaklad Boolean T Oświadczam, że jestem pracownikiem zatrudnionym w rodzimym zakładzie pracy
ZatrudnienieInnyZaklad Boolean T Oświadczam, że jestem zatrudniony na podstawie umowy o pracę w innym zakładzie pracy
MinimalneWynagrodzenie Boolean T Osiągam co najmniej minimalne wynagrodzenie brutto
ZleceniobiorcaSpeleczneZdrowotne Boolean T Oświadczam, że jestem zleceniobiorcą zgłoszonym do ubezpieczenia społecznego i zdrowotnego
ZleceniobiorcaTylkoZdrowotne Boolean T Oświadczam, że jestem zleceniobiorcą zgłoszonym do ubezpieczenia zdrowotnego
Rencista Boolean T Oświadczam, że jestem rencistą
Emeryt Boolean T Oświadczam, że jestem emerytem
Student Boolean T Oświadczam, że jestem studentem lub uczniem szkoły ponadpodstawowej do 26 roku życia
DzialanoscGospodarcza Boolean T Oświadczam, że jestem osobą prowadzącą działalność gospodarczą
PodlegaKRUS Boolean T Oświadczam, że jestem osobą podlegającą ubezpieczeniu w KRUS
BrakTytuluUbezpieczenia Boolean T Oświadczam, że jestem osobą nie posiadającą żadnego tytułu do ubezpieczeń
Bezrobotny Boolean T Oświadczam, że jestem osobą pozostającą w rejestrze bezrobotnych
Niepelnosprawny Boolean T Oświadczam, że posiadam orzeczenie o stopniu niepełnosprawności
StopienNiepelnosprawnosciID String Identyfikator stopnia niepełnosprawności T Tabela: Stopnie niepełnosprawności

Przykładowa zawartość żądania (JSON):

{
  "OsobaWspolpracujaca": false,
  "Email": "andrzej@krzywy.pl",
  "Imie": "Andrzej",
  "DrugieImie": "Maria",
  "Nazwisko": "Krzywy",
  "PESEL": "65063011212",
  "DataUrodzenia": "30-06-1965",
  "Plec": "M",
  "RodzajDowoduTozsamosci": "DOWOD_OSOBISTY",
  "SeriaNumerDowoduTozsamosci": "AIT123432",
  "Obywatelstwo": "Polskie",
  "MiejsceRezydencjiPolska": true,
  "UrzadSkarbowyKod": "0202",
  "KodNFZ": "15R",
  "KontoBankowe": "26105014451000002276470461",
  "NazwaBanku": "ING",
  "TypUkonczonejSzkolyId": 1,
  "StazPracy": 0,
  "AdresZameldowania": {
    "KodPocztowy": "51-314",
    "Miejscowosc": "Wrocław",
    "NumerDomu": "21",
    "NumerLokalu": "21",
    "Poczta": "Wrocław",
    "Ulica": "Grabiszyńska",
    "Kraj": "Polska",
    "AdresZagraniczny": false,
    "Gmina": "m. wrocław",
    "Powiat": "Wrocław",
    "Wojewodztwo": "Dolnośląskie"
  },
  "Oswiadczenia": {
    "ZatrudnienieRodzimyZaklad": false,
    "ZatrudnienieInnyZaklad": false,
    "MinimalneWynagrodzenie": false,
    "ZleceniobiorcaSpoleczneZdrowotne": false,
    "ZleceniobiorcaTylkoZdrowotne": false,
    "Rencista": false,
    "Emeryt": false,
    "Student": false,
    "DzialalnoscGospodarcza": false,
    "PodlegaKRUS": false,
    "BrakTytuluUbezpieczenia": false,
    "Bezrobotny": false,
    "Niepelnosprawny": false,
    "StopienNiepelnosprawnosciId": "0"
  }
}

W odpowiedzi zwracany jest kod wiadomości mówiący o poprawności wykonania żądania oraz identyfikator kwestionariusza.


Copyright 2001-2018 ifirma.pl