Dokumentacja

Faktury MOSS

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

Definicja

Obiekt MossInvoice zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
id integer Tylko do odczytu ID Faktury MOSS
number string Nie Numer faktury MOSS. Domyślnie generowany na podstawie Następny numer faktury MOSS
country string Nie Kraj klienta (pole alpha_2 z listy obsługiwanych krajów)
client_email string Nie Adres e-mail klienta
client_name string Nie Nazwa klienta
client_street string Nie Ulica klienta
client_post_code string Nie Kod pocztowy klienta
client_city string Nie Miasto klienta
service_date string Nie Data świadczenia usługi RRRR-MM-DD
issue_date string Nie Data wystawienia faktury RRRR-MM-DD
payment_date string Nie Data płatności RRRR-MM-DD
service_name string Nie Nazwa usługi
tax_rate string Tak Stawka VAT
net_price integer Nie Wartość netto w groszach
tax_price integer Nie Wartość VAT w groszach
gross_price integer Nie Razem brutto w groszach
advance_price integer Nie Wartość zaliczek w groszach
additional_price integer Nie Wartość kosztów zmieniających w groszach
service_type string Tak Rodzaj usługi:
  • electronic - Usługa elektroniczna
  • broadcasting - Usługa nadawcza
  • telecommunications - Usługa telekomunikacyjna
service_place_primary string Tak Sposób ustalenia miejsca świadczenia usługi
service_place_secondary string Nie Sposób ustalenia miejsca świadczenia usługi
currency string Tak Waluta
recipient_signature string Nie Imię i nazwisko Odbiorcy
seller_signature string Nie Imię i nazwisko Sprzedawcy
comments string Nie Uwagi
check_duplicate_number boolean Nie Czy sprawdzać duplikacje numeru faktury true lub false
flat_rate_tax_symbol string W przypadku korzystania z ryczałtu ewidencjonowanego Dostę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/05/2014",
    "currency": "EUR",
    "additional_price": 0,
    "comments": ""
    ...
  }, {
    "id": 43,
    "number": "5/05/2014",
    "currency": "EUR",
    "additional_price": 0,
    "comments": ""
    ...
  }]
}

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
401 Brak 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/12/2014",
"country": "AT",
"client_email": "",
"client_name": "",
"client_street": "",
"client_postal_code": "",
"client_city": "",
"service_date": "2014-12-19",
"issue_date": "2014-12-19",
"payment_date": "2014-12-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 odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
401 Brak autoryzacji lub uprawnień do danego zasobu
404 Zasó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 odpowiedzi Opis
201 Zasób został poprawnie utworzony
422 Zwracany 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 odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
422 Zwracany 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 odpowiedzi Opis
204 Zwracany po poprawnym usunięciu zasobu.
401 Brak 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.

Parametr Typ danych Wymagany Opis
date string Nie Data 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/06/2015",
  "invoice_date": "2015-06-05",
}

Możliwe kody odpowiedzi:

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

Pobranie faktury MOSS w formacie pdf

GET /v3/moss_invoices/{id}/pdf.json
Parametr Typ danych Wymagany Opis
locale string Nie Ję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.

Parametr Typ danych Wymagany Opis
recipient string Nie Adres email odbiorcy
send_copy boolean Nie Czy wysłać na adres email właściciela konta?
locale string Nie Ję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 odpowiedzi Opis
202 Faktura została przekazana do wysłania
422 Zwracany wraz z informacją o błędach w przypadku problemów przy wysyłce.
comments powered by Disqus