Dokumentacja

Faktury korygujące

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

Definicja

Obiekt CorrectiveInvoice zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
number integer Tylko do odczytu ID Faktury Korygującej
corrected_invoice_number string Nie Numer faktury korygowanej. Domyślnie generowany na podstawie Następny numer faktury
corrected_invoice_date string Nie Data faktury korygowanej
confirmation string Nie Otrzymaliśmy podpisaną fakturę true lub false
currency string Nie Waluta: THB, USD, AUD, HKD, CAD, NZD, SGD, EUR, HUF, CHF, GBP, UAH, JPY, CZK, DKK, ISK, NOK, SEK, HRK, RON, BGN, TRY, LTL, LVL, PHP, MXN, ZAR, BRL, MYR, RUB, IDR, KRW, CNY, INR, LTL, domyślnie PLN.
paid_price integer Nie Zapłacono w gorszach.
notes string Nie Uwagi
payment_method string Nie Metoda płatności:
  • transfer - Przelew
  • cash - Gotówka
  • card - Karta płatnicza
  • barter - Barter
  • check - Czek
  • bill_of_sale - Weksel
  • delivery - Za pobraniem
  • compensation - Kompensata
  • accredited - Akredytywa
  • paypal - PayPal
  • payu - PayUl
  • other - Inny
recipient_signature string Nie Imię i nazwisko Odbiorcy
seller_signature string Nie Imię i nazwisko Sprzedawcy
invoice_date string Nie Data wystawienia w formacie RRRR-MM-DD
sale_date string Nie Data sprzedaży w formacie RRRR-MM-DD
confirmation_date string Nie Data podpisania w formacie RRRR-MM-DD
status string Nie Status:
  • draft - Szkic
  • sent - Wysłana
  • printed - Wydrukowana
  • paid - Opłacona
payment_date string Nie Termin zapłaty w formacie RRRR-MM-DD
net_price integer Nie Razem netto w groszach
tax_price integer Nie Wartość VAT w groszach
gross_price integer Nie Razem brutto w groszach
client_id integer Nie ID klienta (jeśli istnieje)
client_company_name string Nie Nazwa firmy klienta (jeśli klient nie istnieje)
client_street string Nie Ulica klienta (jeśli klient nie istnieje)
client_city string Nie Miasto klienta (jeśli klient nie istnieje)
client_post_code string Nie Kod pocztowy klienta (jeśli klient nie istnieje)
client_tax_code string Nie NIP klienta (jeśli klient nie istnieje)
client_country string Nie Kraj klienta (jeśli klient nie istnieje)
check_duplicate_number boolean Nie Czy sprawdzać duplikacje numeru faktury true lub false
bank_name string Nie Nazwa banku, dotyczy faktur z przelewem
bank_account string Nie Nr konta bankowego, dotyczy faktur z przelewem.
swift string Nie Nr Swift, dotyczy faktur z przelewem
sale_type string Dla klientów zagranicznych. Rodzaj sprzedaży:
  • service - Usługa
  • merchandise - Towar
invoice_date_kind string Nie Rodzaj daty na fakturze:
  • sale_date - Data sprzedaży
  • service_date - Data wykonania usługi
  • cargo_date - Data zakończenia dostawy towarów
services array of Services Tak Lista pozycji na fakturze (i link do services)

Services

Obiekt service zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
group string Tak Id grupy produktów, musi być taki sam dla produktu przed i po korekcie
tax_symbol string Tak Stawka VAT (lista obsługiwanych stawek)
correction string Nie Zaznaczamy, czy produkt z danej grupy jest koretką, czy wpisem korygowanym true lub false
name string Nie Nazwa
unit string Nie Jednostka
quantity integer Nie Ilość
unit_net_price integer Nie Cena netto za sztukę w groszach
net_price integer Nie Wartość netto w groszach
gross_price integer Tylko do odczytu Wartość brutto w groszach
tax_price integer Nie Wartość podatku VAT w groszach
symbol string Nie symbol PKWiU

Listowanie faktur

GET /v3/corrective_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 invoice_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/corrective_invoices.json

Przykładowa odpowiedź

{
"metainfo": {
    "count": 1,
    "total_count": 4,
    "next": "https://api.infakt.pl/api/v3/corrective_invoices.json?offset=10",
    "previous": "https://api.infakt.pl/api/v3/corrective_invoices.json?offset=0"
},
"entities": [
  {
    "id":16,
    "number":"1/04/2013",
    "corrected_invoice_number":"1/KOR/2013",
    "corrected_invoice_date": "2013-04-12",
    "confirmation": false,
    "confirmation_date": "",
    "currency":"PLN",
    "paid_in_cents":1230,
    "notes":"",
    "kind":"vat",
    "payment_method":"cash",
    "recipient_signature":"",
    "seller_signature":"Michal Wisniewski",
    "invoice_date":"2013-04-12",
    "sale_date":"2013-04-12",
    "status":"draft",
    "payment_date":"2013-04-26",
    "total_net_price_in_cents":1000,
    "total_tax_amount_in_cents":230,
    "total_gross_price_in_cents":1230,
    "client_id":8,
    "client_company_name":"HSK Group",
    "client_street":"Pawia 3",
    "client_city":"Warszaw",
    "client_post_code":"00-920",
    "client_tax_code":"4218067785",
    "client_country":"PL",
    "bank_name": "",
    "bank_account": "",
    "services": [
      {
        "id":1609,
        "group": "123",
        "correction" true,
        "name":"Produkt",
        "tax_rate":"23",
        "unit":"szt.",
        "quantity":"1.0",
        "unit_net_price": 12300,
        "net_price": 12300,
        "gross_price": 15129,
        "tax_price": 2829,
        "symbol":""
      },
      {
        "id":1608,
        "group": "123",
        "correction" false,
        "name":"Produkt",
        "tax_rate":"23",
        "unit":"szt.",
        "quantity":"1.0",
        "unit_net_price":1000,
        "net_price":1000,
        "gross_price":1230,
        "tax_price":230,
        "symbol":""
      }
    ]
  }
]
}

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/corrective_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/corrective_invoices/42.json
          

Przykładowa odpowiedź

{
"id":16,
"number":"1/04/2013",
"corrected_invoice_number":"1/KOR/2013",
"corrected_invoice_date": "2013-04-12",
"confirmation": false,
"confirmation_date": "",
"currency":"PLN",
"paid_in_cents":1230,
"notes":"",
"kind":"vat",
"payment_method":"cash",
"recipient_signature":"",
"seller_signature":"Jan Kowalski",
"invoice_date":"2013-04-12",
"sale_date":"2013-04-12",
"status":"draft",
"payment_date":"2013-04-26",
"total_net_price_in_cents":1000,
"total_tax_amount_in_cents":230,
"total_gross_price_in_cents":1230,
"client_id":8,
"client_company_name":"inFakt Sp. z o.o.",
"client_city": "Kraków",
"client_post_code": "30-549",
"client_tax_code": "9452121681",
"client_country": "PL",
"client_tax_code":"4218067785",
"bank_name": "",
"bank_account": "",
"services": [
  {
    "id":1609,
    "group": "123",
    "correction" true,
    "name":"Produkt",
    "tax_rate":"23",
    "unit":"szt.",
    "quantity":"1.0",
    "unit_net_price":2000,
    "net_price":2000,
    "gross_price":2460,
    "tax_price":460,
    "symbol":""
  },
  {
    "id":1608,
    "group": "123",
    "correction" false,
    "name":"Produkt",
    "tax_rate":"23",
    "unit":"szt.",
    "quantity":"1.0",
    "unit_net_price":1000,
    "net_price":1000,
    "gross_price":1230,
    "tax_price":230,
    "symbol":""
  }
]
}

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/corrective_invoices.json

Tworzenie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
  -d '{"corrective_invoice":{"payment_method":"transfer", "bank_account": "70102010130000010200026526", "services":[{"name": "Przykładowa Usługa", "gross_price":6623 }]}}' \
  https://api.infakt.pl/v3/corrective_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 faktury korygującej

PUT /v3/corrective_invoices/{id}.json

Aktualizacja

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d '{"corrective_invoice":{"payment_method":"cash"}}' \
  https://api.infakt.pl/v3/corrective_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 faktury korygującej

DELETE /v3/corrective_invoices/{id}.json

Usuwanie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
    -X DELETE \
    https://api.infakt.pl/v3/corrective_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
POST /v3/corrective_invoices/{id}/paid.json
Parametr Typ danych Wymagany Opis
paid_date string Nie Data opłacenia

Oznaczenie fakury jako zapłacona

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
  -d '{"paid_date":"2014-06-05"}' \
  https://api.infakt.pl/v3/corrective_invoices/42/paid.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
204 Zwracany po poprawnym opłaceniu faktury.
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Pobranie faktury w formacie pdf

GET /v3/corrective_invoices/{id}/pdf.json
Parametr Typ danych Wymagany Opis
document_type string Tak Rodzaj dokumentu:
  • original_copy - Orginał i Kopia
  • original - Orginał
  • copy - Kopia
  • original_duplicate - Duplikat orginału
  • copy_duplicate - Duplikat kopii
  • duplicate - Duplikat
  • regular - Bez adnotacji
  • double_regular - 2 Bez adnotacji
locale string Nie Język dokumentu: pl - Polski, en - Angielski, pe - polsko - angielski

Pobranie faktury w formacie pdf

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/corrective_invoices/42/pdf.json?document_type=original&locale=pl
W odpowiedzi zostaje zwrócona faktura w formie pliku PDF. Pobranie faktury jako PDF powoduje zmianę statustu faktury na "Wydrukowano".

Oznaczenie fakury jako podpisana

POST /v3/corrective_invoices/{id}/sign.json
Parametr Typ danych Wymagany Opis
confirmation_date string Nie Data podpisania

Oznaczenie fakury jako podpisania

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
  -d '{"confirmation_date":"2014-06-05"}' \
  https://api.infakt.pl/v3/corrective_invoices/42/sign.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
204 Zwracany po poprawnym podpisaniu faktury.
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.
comments powered by Disqus