Dokumentacja API - ifirma.pl


Rejestrowanie wpłat do faktur


Dodanie wpłaty do dokumentu odbywa się poprzez przesłanie żądania POST na adres:

https://www.ifirma.pl/iapi/faktury/wplaty/{typ_faktury}/{numer_faktury}.json

Klucz autoryzacji: FAKTURA

Jako typ_faktury należy podstawić typ faktury, do której będzie rejestrowana wpłata. 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_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.

Jako numer_faktury należy podać numer faktury, do której będzie rejestrowana wpłata w formacie ze slashem („/”) zamienionym na znak podkreślenia („_”). Czyli np. dla faktury o numerze 32/03/2018 należy podać 32_03_2018.
Wyjątek stanowi faktura końcowa (prz_faktura_kon), której numer wraz ze slashem należy zakodować w base64.

W obu przypadkach, jako numer_faktury można wskazać identyfikator faktury.

Format żądania

Przesyłane żądanie jest zestawem danych o wpłacie w formacie przedstawionym poniżej

Nazwa w JSON Typ danych Wartości Wymagane Opis
Kwota Number >= 0.00;
<= pozostała wartość do zapłaty faktury
T Kwota wpłaty za fakturę.
Dodatkowo, dla faktur w walucie obcej i do szczególnej metody kasowej:
Data String Format: RRRR-MM-DD;
>= data wystawienia faktury wcześniejszej
T Data otrzymania wpłaty.
Dodatkowo, dla faktur w walucie obcej:
KwotaPln Number >= 0.00 N/T* Wartość wpłaty w PLN.

* – pole wymagane, gdy wpłata w PLN

Kurs Number >= 0.00 N/T* Kurs waluty dla wpłaty w walucie obcej

* – pole wymagane, gdy wpłata w PLN w walucie obcej.

Przykłady

  1. Dodanie wpłaty w wysokości 40 zł do faktury sprzedaży krajowej o numerze 752/2018.
  2. Żądanie przesyłane na adres:

    https://ifirma.pl/iapi/faktury/wplaty/prz_faktura_kraj/752_2018.json

    Treść żądania:

    {
        "Kwota": 40
    }
    
  3. Dodanie wpłaty otrzymanej 17 lutego 2018 roku, w wysokości 18 zł do faktury do szczególnej metody kasowej o numerze 258/02/2018.
  4. Żądanie przesyłane na adres:

    https://ifirma.pl/iapi/faktury/wplaty/prz_faktura_met_kasowa/258_02_2018.json

    Treść żądania:

    {
        "Kwota": 40,
        "Data": "2018-02-17"
    }
    
  5. Dodanie wpłaty otrzymanej 12 marca 2018 roku, w wysokości 56 euro do faktury eksportu towarów o numerze 17/03/2018 wystawionej w euro. Zastosowany kurs waluty to 4,1251.
  6. Żądanie przesyłane na adres:

    https://ifirma.pl/iapi/faktury/wplaty/prz_eksport_towarow/17_03_2018.json

    Treść żądania:

    {
        "Kwota": 56,
        "Data": "2018-03-12",
        "Kurs": 4.1251
    }
    
  7. Dodanie wpłaty otrzymanej 12 marca 2018 roku, w wysokości 200 zł do faktury eksportu towarów o numerze 17/03/2018 wystawionej w euro. Po przeliczeniu wartość wpłaty wynosi 48,48 euro.
  8. Żądanie przesyłane na adres:

    https://ifirma.pl/iapi/faktury/wplaty/prz_eksport_towarow/17_03_2018.json

    Treść żądania:

    {
        "Kwota": 48.48,
        "Data": "2018-03-12",
        "KwotaPln": 200
    }
    


Copyright 2001-2018 ifirma.pl