Dokumentacja

Faktury MOSS – deprecated

Zarządzanie fakturami MOSS należącymi do użytkownika.

System MOSS obowiązuje do dnia 2021-07-01. Po tym dniu obowiązuje system OSS.

Definicja

Obiekt MossInvoice zawiera następujące klucze:

ParametrTyp danychWymaganyOpis
idintegerTylko do odczytuID Faktury MOSS
numberstringNieNumer faktury MOSS. Domyślnie generowany na podstawie Następny numer faktury MOSS
countrystringNieKraj klienta (pole alpha_2 z listy obsługiwanych krajów)
client_emailstringNieAdres e-mail klienta
client_namestringNieNazwa klienta
client_streetstringNieUlica klienta
client_postal_codestringNieKod pocztowy klienta
client_citystringNieMiasto klienta
service_datestringNieData świadczenia usługi RRRR-MM-DD
issue_datestringNieData wystawienia faktury RRRR-MM-DD
payment_datestringNieData płatności RRRR-MM-DD
service_namestringNieNazwa usługi
tax_ratestringTakStawka VAT
net_priceintegerNieWartość netto w groszach
tax_priceintegerNieWartość VAT w groszach
gross_priceintegerNieRazem brutto w groszach
advance_priceintegerNieWartość zaliczek w groszach
additional_priceintegerNieWartość kosztów zmieniających w groszach
service_typestringTakRodzaj usługi:
  • electronic – Usługa elektroniczna
  • broadcasting – Usługa nadawcza
  • telecommunications – Usługa telekomunikacyjna
service_place_primarystringTakSposób ustalenia miejsca świadczenia usługi
service_place_secondarystringNieSposób ustalenia miejsca świadczenia usługi
currencystringTakWaluta
recipient_signaturestringNieImię i nazwisko Odbiorcy
seller_signaturestringNieImię i nazwisko Sprzedawcy
commentsstringNieUwagi
check_duplicate_numberbooleanNieCzy sprawdzać duplikacje numeru faktury true lub false
flat_rate_tax_symbolstringW przypadku korzystania z ryczałtu ewidencjonowanegoDostępne stawki: 2, 3, 5.5, 8.5, 17, 20

Listowanie faktur MOSS

GET /v3/moss_invoices.json

Akcja listowania zwraca odpowiedź zawierającą tablicę obiektów pod kluczem entities oraz informacje pomocnicze dotyczące stronicowania. Domyślne sortowanie dla zwracanej tablicy odbywa się malejąco przy użyciu pola issue_date.

Dodatkowo, na zbiorze danych można wykonywać nastepujące operacje:

Przykład akcji listowania:

Przykład curl

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/moss_invoices.json

Przykładowa odpowiedź

{
  "metainfo": {
      "count": 10,
      "total_count": 10,
      "next": "https://api.infakt.pl/api/v3/moss_invoices.json?offset=10",
      "previous": "https://api.infakt.pl/api/v3/moss_invoices.json?offset=0"
  },
  "entities": [{
    "id": 42,
    "number": "4/04/2021",
    "currency": "EUR",
    "additional_price": 0,
    "comments": ""
    ...
  }, {
    "id": 43,
    "number": "5/04/2021",
    "currency": "EUR",
    "additional_price": 0,
    "comments": ""
    ...
  }]
}

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
401Brak autoryzacji lub uprawnień do danego zasobu

Podgląd

GET /v3/moss_invoices/{id}.json

Dodatkowo, na zbiorze danych można wykonywać nastepujące operacje:

Przykład curl

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
https://api.infakt.pl/v3/moss_invoices/42.json
          

Przykładowa odpowiedź

{
"id": 4,
"number": "1/MOSS/04/2021",
"country": "AT",
"client_email": "",
"client_name": "",
"client_street": "",
"client_postal_code": "",
"client_city": "",
"service_date": "2021-04-19",
"issue_date": "2021-04-19",
"payment_date": "2021-04-19",
"service_name": "",
"tax_rate": 20,
"net_price": 9000,
"advance_price": 0,
"additional_price": 0,
"tax_price": 1800,
"gross_price": 10800,
"service_type": "electronic",
"service_place_primary": "Foo",
"service_place_secondary": "",
"currency": "EUR",
"seller_signature": "Sprzedawca",
"recipient_signature": "Odbiorca",
"comments": "Uwagi"
}

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
401Brak autoryzacji lub uprawnień do danego zasobu
404Zasób nie został odnaleziony

Tworzenie

POST /v3/moss_invoices.json

Tworzenie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
  -d '{"moss_invoice": {
    "country":"AT",
    "service_type":"electronic",
    "currency":"EUR",
    "tax_rate":"20.0",
    "service_place_primary":"IP: 127.0.0.1"
  }}' \
  https://api.infakt.pl/v3/moss_invoices.json

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
201Zasób został poprawnie utworzony
422Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Aktualizacja

PUT /v3/moss_invoices/{id}.json

Aktualizacja

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d '{"moss_invoice":{"currency":"EUR"}}' \
  https://api.infakt.pl/v3/moss_invoices/42.json

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
422Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Usuwanie

DELETE /v3/moss_invoices/{id}.json

Usuwanie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
    -X DELETE \
    https://api.infakt.pl/v3/moss_invoices/42.json

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
204Zwracany po poprawnym usunięciu zasobu.
401Brak autoryzacji lub uprawnień do danego zasobu

Następny numer faktury MOSS

GET /v3/moss_invoices/next_number.json

Następny numer faktury jest nadawany na podstawie daty wystawienia faktury. W procesie wyboru kolejnego numeru faktury są brane pod uwagę tylko faktury z danego miesiąca.

ParametrTyp danychWymaganyOpis
datestringNieData wystawienia

Pobranie następnego numeru faktury

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
    https://api.infakt.pl/v3/moss_invoices/next_number.json

Przykładowa odpowiedź

{
  "next_number": "5/MOSS/04/2021",
  "invoice_date": "2021-04-05",
}

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
204Zwracany po poprawnym usunięciu zasobu.
401Brak autoryzacji lub uprawnień do danego zasobu

Pobranie faktury MOSS w formacie pdf

GET /v3/moss_invoices/{id}/pdf.json
ParametrTyp danychWymaganyOpis
localestringNieJęzyk dokumentu: pl – Polski, en – Angielski

Pobranie faktury MOSS w formacie pdf

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/moss_invoices/42/pdf.json?locale=pl
W odpowiedzi zostaje zwrócona faktura w formie pliku PDF.

Wysłanie faktury MOSS via email

POST /v3/moss_invoices/{id}/deliver_via_email.json

Przy wysyłce dokumentu pocztą elektroniczną, można podać adres email, na który będzie wysłana faktura. W przypadku, gdy nie zostanie podany – faktura zostanie wysłana na adres email Klienta.

ParametrTyp danychWymaganyOpis
recipientstringNieAdres email odbiorcy
send_copybooleanNieCzy wysłać na adres email właściciela konta?
localestringNieJęzyk dokumentu: pl – Polski, en – Angielski

Wysłanie faktury via email

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -X POST
  https://api.infakt.pl/v3/moss_invoices/42/deliver_via_email.json

Możliwe kody odpowiedzi:

Kod odpowiedziOpis
202Faktura została przekazana do wysłania
422Zwracany wraz z informacją o błędach w przypadku problemów przy wysyłce.