Dokumentacja API - ifirma.pl


Lista faktur


Pobranie listy faktur możliwe jest poprzez wysłanie żądania GET na adres:

https://www.ifirma.pl/iapi/faktury.json?{parametry}

Klucz autoryzacji: FAKTURA

Pobranie listy pro form odbywa się poprzez wysłanie żądania GET na adres:

https://www.ifirma.pl/iapi/proformy.json?{parametry}

Klucz autoryzacji: FAKTURA

W obu przypadkach dostępne są następujące parametry:

  • związane z filtrowaniem listy:
    • dataOd parametr wymagany – data początkowa okresu objętego listą; format YYYY-MM-DD
    • dataDo – data końcowa okresu objętego listą; format YYYY-MM-DD; jeśli parametr nie zostanie podany, to zostaną pobrane dokumenty z okresu 30 dni od daty podanej w parametrze dataOd
    • kwotaOd – minimalna wartość dokumentu
    • kwotaDo – maksymalna wartość dokumentu
    • kontrahent – identyfikator kontrahenta
    • typ – typ faktury, zgodnie z wykazem zamieszczonym poniżej
    • status – status dokumentu, dostępne:
      • przeterminowane – dokumenty nieopłacone, których termin płatności minął
      • nieoplacone – dokumenty nieopłacone, których termin płatności nie upłynął
      • oplaconeCzesciowo – dokumenty opłacone w części, których termin płatności nie upłynął
      • oplacone – dokumenty opłacone w całości

      można podać kilka statusów oddzielając je przecinkiem, np. „nieoplacone,oplaconeCzesciowo”

  • związane ze stronicowaniem listy
    • strona – domyślnie 1
    • iloscNaStronie – domyślnie 20

Dostępne typy faktur:

  • prz_faktura_kraj – faktura sprzedaży krajowej;
  • prz_faktura_wysylka – faktura sprzedaży wysyłkowej;
  • prz_faktura_paragon – faktura do paragonu;
  • prz_faktura_wys_ter_kraj – faktura wysyłkowa z terytorium kraju / krajowa z ceną w walucie obcej;
  • prz_faktura_szczeg_obow – faktura krajowa ze szczególnym obowiązkiem podatkowym;
  • prz_faktura_met_kasowa – faktura krajowa do szczególnej metody kasowej;
  • prz_faktura_odwr_obciaz – faktura z odwrotnym obciążeniem;
  • prz_faktura_odwr_obciaz_budowa – usługi budowlane świadczone przez podwykonawcę (odwrotne obciążenie);
  • prz_faktura_budowa – faktura na usługi budowlane;
  • prz_dostawa_ue_towarow – wewnątrzunijna dostawa towarów;
  • prz_eksport_towarow – eksport towarów;
  • prz_eksport_dost_uslug_ue – świadczenie usług dla podatników VAT-UE w trybie art. 28b;
  • prz_eksport_dost_uslug_nie_ue – świadczenie usług poza terytorium kraju;
  • prz_faktura_zal – faktura zaliczkowa;
  • prz_faktura_kon – faktura końcowa;
  • prz_faktura_wyposaz – faktura sprzedaży wyposażenia;
  • prz_faktura_sr_trwaly – faktura sprzedaży środka trwałego;
  • prz_rachunek_kraj – rachunek sprzedaży krajowej;
  • prz_rachunek_zagr – rachunek w walucie obcej / wewnątrzwspólnotowe świadczenie usług (rachunek);
  • prz_rachunek_sr_trwaly – rachunek sprzedaży środka trwałego;
  • prz_rachunek_wyposaz – rachunek sprzedaży wyposażenia.

W odpowiedzi zostaje zwrócony obiekt response zawierający kod wiadomości mówiący o poprawności wykonania żądania, ewentualną informację o błędzie oraz listę odnalezionych faktur:


{
    "response": {
        "Kod": 0,
        "Informacja": "",
        "Wynik": [
            {
                "KontrahentNazwa": "Przykładowa spółka cywilna s.c.",
                "IdentyfikatorKontrahenta": "PrzykladowaSC",
                "NIPKontrahenta": "8556425858",
                "DataWystawienia": "2017-12-05",
                "PelnyNumer": "58/12/2018",
                "Brutto": 3200.20,
                "FakturaId": 32566241,
                "Rodzaj": "prz_faktura_kraj",
                "Waluta": "PLN",
                "Zaplacono": 0,
                "TerminPlatnosci": "2017-12-19",
                "CzyWyslano": false,
            }
        ]
    }
}

Przykładowe żądania:

  1. Wszystkie faktury wystawione w styczniu 2018:
  2. https://www.ifirma.pl/iapi/faktury.json?dataOd=2018-01-01&dataDo=2018-01-31
  3. Wszystkie faktury przeterminowane wystawione w grudniu 2017 o wartości minimum 100 zł:
    https://www.ifirma.pl/iapi/faktury.json?dataOd=2017-12-01&dataDo=2017-12-31&kwotaOd=100.00&status=przeterminowane


Copyright 2001-2018 ifirma.pl