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:

ParametrTyp danychWymaganyOpis
periodstringTylko do odczytuData okresu
period_namestringTylko do odczytuNazwa okresu
income_priceintegerTylko do odczytuPrzychód w groszach
expenses_priceintegerTylko do odczytuKoszty w groszach
profit_priceintegerTylko do odczytuDochód w groszach
statusstringTylko do odczytuStatus:
  • 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 odpowiedziOpis
204Zwracany po poprawnym usunięciu zasobu.
401Brak 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:

ParametrTyp danychWymaganyOpis
periodstringTylko do odczytuData okresu
datestringTylko do odczytuData
period_namestringTylko do odczytuNazwa okresu
company
ParametrTyp danychWymaganyOpis
namestringTylko do odczytuNazwa firmy
taxidstringTylko do odczytuNIP
full_addressstringTylko do odczytuAdres
transfered – z przeniesienia
ParametrTyp danychWymaganyOpis
income_cargo_servicesintegerTylko do odczytuWartość sprzedanych towarów i usług w groszach
income_othersintegerTylko do odczytuPozostałe przychody w groszach
income_summaryintegerTylko do odczytuRazem przychód w groszach
expense_cargo_materialintegerTylko do odczytuZakup towarów handlowych i materiałów wg. cen zakupu w groszach
expense_incidentalintegerTylko do odczytuKoszty uboczne zakupu w groszach
expense_salaryintegerTylko do odczytuWynagrodzenia w gotówce i naturze w groszach
expense_othersintegerTylko do odczytuPozostałe wydatki w groszach
expense_sumintegerTylko do odczytuRazem wydatki w groszach
expense_researchintegerTylko do odczytuKoszty działalności badawczo-rozwojowej w groszach *
* Dla KPiR przed kwietniem 2016 wartość będzie zerowa.
lines
ParametrTyp danychWymaganyOpis
ordinalstringTylko do odczytuLiczba porządkowa
datestringTylko do odczytuData zdarzenia gospodarczego
numberstringTylko do odczytuNr dowodu księgowego
client_namestringTylko do odczytu Imię i nazwisko (firma)
client_addressstringTylko do odczytuAdres
descriptionstringTylko do odczytuOpis zdarzenia gospodarczego
income_cargo_servicesintegerTylko do odczytuWartość sprzedanych towarów i usług w groszach
income_othersintegerTylko do odczytuPozostałe przychody w groszach
income_summaryintegerTylko do odczytuRazem przychód w groszach
expense_cargo_materialintegerTylko do odczytuZakup towarów handlowych i materiałów wg. cen zakupu w groszach
expense_incidentalintegerTylko do odczytuKoszty uboczne zakupu w groszach
expense_salaryintegerTylko do odczytuWynagrodzenia w gotówce i naturze w groszach
expense_othersintegerTylko do odczytuPozostałe wydatki w groszach
expense_sumintegerTylko do odczytuRazem wydatki w groszach
expense_researchintegerTylko do odczytuKoszty 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 odpowiedziOpis
204Zwracany po poprawnym usunięciu zasobu.
401Brak autoryzacji lub uprawnień do danego zasobu