Skip to content
Nawigacja

Pobierz miesiąc KPiR

Zakres: api:accounting:read. Wpisy KPiR z jednego miesiąca.

GET
https://api.sandbox-infakt.pl/v3/books/{id}.json

Autoryzacja

  • ApiKey
    opcjonalne
    API key in header
  • Token
    opcjonalne
    API key in header

Path parameters

  • id
    integer
    wymagane
    format: int64

Query parameters

  • fields
    opcjonalne
    string

    Zawężenie pól: nazwy pól API rozdzielone przecinkami, np. id,company_name; id jest zwykle dodawane. Odpowiedź zawiera wtedy tylko te pola, więc nie odpowiada pełnemu schematowi. Pola wyliczane, a nie zapisywane, mogą kończyć się błędem 500; operacja je wymienia.

Odpowiedzi

200

Sukces

JSON
  • id
    integer
    wymagane
    format: int64
  • period
    string
    wymagane
    format: date
  • date
    string
    wymagane

    To samo co period.

    format: date
  • period_name
    string
    wymagane
  • company
    object
    wymagane
    • name
      string
      wymagane
    • taxid
      string
      wymagane
    • full_address
      string
      wymagane
  • transfered
    object
    wymagane

    Sumy przeniesione z poprzednich miesięcy.

    • income_cargo_services
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • income_others
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • income_summary
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_cargo_material
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_incidental
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_salary
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_others
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_sum
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_research
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
  • lines
    array of
    object
    wymagane
    • income_cargo_services
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • income_others
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • income_summary
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_cargo_material
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_incidental
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_salary
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_others
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_sum
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • expense_research
      integer
      wymagane

      Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.

      format: int64
    • ordinal
      wymagane

      One of the following:

      • integer
      • null
    • date
      wymagane

      One of the following:

      • string
      • null
    • number
      wymagane

      One of the following:

      • string
      • null
    • client_name
      wymagane

      One of the following:

      • string
      • null
    • client_address
      wymagane

      One of the following:

      • string
      • null
    • description
      wymagane

      One of the following:

      • string
      • null

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

403

Brak uprawnień, limit planu dla tej akcji (limit) albo zawieszone konto.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

404

Nie znaleziono zasobu.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

406

Ścieżka nie kończy się na .json.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.
JSON
  • error
    opcjonalne

    Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.

    One of the following:

    • string
    • array<string>
    • object
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • limit
    opcjonalne
    string

    Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.

  • type
    opcjonalne
    redirect
    or
    email_not_confirmed
  • url
    opcjonalne
    string
  • action_url
    opcjonalne
    string

Type to search…

↑↓ wybór↵ otwórzEsc zamyka