Dokumentacja

Księga przychodów i rozchodów

Podgląd zestawienia Księgi Przychodów i Rozchodów użytkownika.

Definicja

Obiekt Book zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
period string Tylko do odczytu Data okresu
period_name string Tylko do odczytu Nazwa okresu
income_price integer Tylko do odczytu Przychód w groszach
expenses_price integer Tylko do odczytu Koszty w groszach
profit_price integer Tylko do odczytu Dochód w groszach
status string Tylko do odczytu Status:
  • draft – Szkic
  • printed – Wydrukowana

Listowanie

GET /v3/books.json

Akcja listowania zwraca odpowiedź zawierającą tablicę obiektów pod kluczem entities oraz informacje pomocnicze dotyczące stronicowania.

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

Przykładowa odpowiedź

{
    "metainfo": {
        "count": 6,
        "total_count": 6,
        "next": "https://api.infakt.pl/api/v3/books.json?offset=10",
        "previous": "https://api.infakt.pl/api/v3/books.json?offset=0"
    },
    "entities": [
        {
          "id": 42,
          "period": "2022-01-01",
          "period_name": "Styczeń 2022",
          "income_price": 0,
          "expenses_price": 0,
          "profit_price": 0,
          "status": "draft"
        },
        {
          "id": 43,
          "period": "2022-02-01",
          "period_name": "Luty 2022",
          "income_price": 0,
          "expenses_price": 0,
          "profit_price": 0,
          "status": "draft"
         },
         ...
    ]
}

Możliwe kody odpowiedzi:

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

Podgląd

GET /v3/books/{id}.json

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

Obiekt Book dla podglądu zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
period string Tylko do odczytu Data okresu
date string Tylko do odczytu Data
period_name string Tylko do odczytu Nazwa okresu
company
Parametr Typ danych Wymagany Opis
name string Tylko do odczytu Nazwa firmy
taxid string Tylko do odczytu NIP
full_address string Tylko do odczytu Adres
transfered – z przeniesienia
Parametr Typ danych Wymagany Opis
income_cargo_services integer Tylko do odczytu Wartość sprzedanych towarów i usług w groszach
income_others integer Tylko do odczytu Pozostałe przychody w groszach
income_summary integer Tylko do odczytu Razem przychód w groszach
expense_cargo_material integer Tylko do odczytu Zakup towarów handlowych i materiałów wg. cen zakupu w groszach
expense_incidental integer Tylko do odczytu Koszty uboczne zakupu w groszach
expense_salary integer Tylko do odczytu Wynagrodzenia w gotówce i naturze w groszach
expense_others integer Tylko do odczytu Pozostałe wydatki w groszach
expense_sum integer Tylko do odczytu Razem wydatki w groszach
expense_research integer Tylko do odczytu Koszty działalności badawczo-rozwojowej w groszach *
* Dla KPiR przed kwietniem 2016 wartość będzie zerowa.
lines
Parametr Typ danych Wymagany Opis
ordinal string Tylko do odczytu Liczba porządkowa
date string Tylko do odczytu Data zdarzenia gospodarczego
number string Tylko do odczytu Nr dowodu księgowego
client_name string Tylko do odczytu Imię i nazwisko (firma)
client_address string Tylko do odczytu Adres
description string Tylko do odczytu Opis zdarzenia gospodarczego
income_cargo_services integer Tylko do odczytu Wartość sprzedanych towarów i usług w groszach
income_others integer Tylko do odczytu Pozostałe przychody w groszach
income_summary integer Tylko do odczytu Razem przychód w groszach
expense_cargo_material integer Tylko do odczytu Zakup towarów handlowych i materiałów wg. cen zakupu w groszach
expense_incidental integer Tylko do odczytu Koszty uboczne zakupu w groszach
expense_salary integer Tylko do odczytu Wynagrodzenia w gotówce i naturze w groszach
expense_others integer Tylko do odczytu Pozostałe wydatki w groszach
expense_sum integer Tylko do odczytu Razem wydatki w groszach
expense_research integer Tylko do odczytu Koszty działalności badawczo-rozwojowej w groszach *
* Dla KPiR przed kwietniem 2016 wartość będzie zerowa.

Przykład curl

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

Przykładowa odpowiedź

{
    "id": 42,
    "period": "2022-01-01",
    "date": "2022-01-01",
    "period_name": "Styczeń 2022",
    "company": {
        "name": "inFakt Sp. z o.o.",
        "taxid": "9452121681",
        "full_address": "Szlak 49, 31-153 Kraków"
    },
    "transfered": {
        "income_cargo_services": 0,
        "income_others": 0,
        "income_summary": 0,
        "expense_cargo_material": 0,
        "expense_incidental": 0,
        "expense_salary": 0,
        "expense_others": 0,
        "expense_sum": 0,
        "expense_research": 0
    },
    "lines": [
        {
            "ordinal": 1,
            "date": "2014-04-01",
            "number": "FV 1/04/2016",
            "client_name": "inFakt Sp. z o.o.",
            "client_address": "ul. Szlak 49, 31-153 Kraków",
            "description": "usługi księgowe",
            "income_cargo_services": 0,
            "income_others": 0,
            "income_summary": 0,
            "expense_cargo_material": 0,
            "expense_incidental": 0,
            "expense_salary": 0,
            "expense_others": 14900,
            "expense_sum": 14900,
            "expense_research": 0
       }
    ]
}

Możliwe kody odpowiedzi:

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