Skip to content
Nawigacja

Pobierz listę składek ZUS

Zakres: api:accounting:read. Składki na ubezpieczenia społeczne, zdrowotne i Fundusz Pracy, od najpóźniejszego terminu płatności. Dla wspólnika spółki obsługiwanej przez księgowość inFakt elementy mają uproszczony kształt CompanyInsuranceFee.

GET
https://api.sandbox-infakt.pl/v3/insurance_fees.json

Autoryzacja

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

Query parameters

  • page
    opcjonalne
    integer

    Numer strony liczony od 1; ignorowany, gdy wysłany jest offset.

    format: int32 · default: 1
  • per_page
    opcjonalne
    integer

    Liczba wyników na stronę przy page. Serwer jej nie ogranicza.

    format: int32 · default: 10
  • offset
    opcjonalne
    integer

    Indeks pierwszego wyniku (liczba pomijanych encji).

    format: int32
  • limit
    opcjonalne
    integer

    Liczba wyników na stronę przy offset; domyślnie 10, ignorowana bez offset. Większość list bez błędu obniża wartości powyżej 100 do 100.

    format: int32
  • pagination_without_total
    opcjonalne
    boolean

    Pomiń liczenie; metainfo.total_count przyjmuje wartość null.

  • 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.

  • order
    opcjonalne
    string

    Sortowanie: <pole> albo <pole> desc, gdzie <pole> to pole elementu listy, np. payment_date desc. Unikaj pól, które mogą być null lub nie występują w części elementów.

Odpowiedzi

200

Sukces

JSON
  • metainfo
    object
    wymagane
    • count
      integer
      wymagane

      Liczba encji na tej stronie.

      format: int32
    • total_count
      wymagane

      Liczba pasujących encji; null, gdy pagination_without_total=true.

      One of the following:

      • integer
      • null
    • next
      string
      wymagane

      Bezwzględny URL następnej strony w postaci offset/limit.

    • previous
      string
      wymagane

      Bezwzględny URL poprzedniej strony w postaci offset/limit.

  • entities
    array of
    object
    wymagane
    • id
      integer
      wymagane
      format: int64
    • uuid
      string
      wymagane
      format: uuid
    • period
      string
      wymagane
      format: date
    • period_name
      string
      wymagane
    • correction
      boolean
      wymagane
    • correction_counter
      integer
      wymagane
      format: int32
    • payment_date
      string
      wymagane
      format: date
    • social_amount_price
      integer
      wymagane

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

      format: int64
    • health_amount_price
      integer
      wymagane

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

      format: int64
    • work_amount_price
      integer
      wymagane

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

      format: int64
    • social_amount_paid
      integer
      wymagane

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

      format: int64
    • health_amount_paid
      integer
      wymagane

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

      format: int64
    • work_amount_paid
      integer
      wymagane

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

      format: int64
    • sum_amount_price
      integer
      wymagane

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

      format: int64
    • real_pay
      integer
      wymagane

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

      format: int64
    • show_payment_option
      boolean
      wymagane
    • status
      unpaid
      or
      paid
      or
      partially_paid
      or
      not_applicable
      or
      draft
      or
      printed
      +2 more
      wymagane
    • annual_settlement_amount_price
      integer
      wymagane

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

      format: int64
    • annual_settlement_amount_paid
      integer
      wymagane

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

      format: int64
    • show_annual_settlement
      boolean
      wymagane
    • automatically_paid
      boolean
      wymagane
    • automatically_paid_on
      wymagane

      One of the following:

      • string
      • null
    • social_account_number
      opcjonalne
      string

      Tylko w podglądzie.

    • health_account_number
      opcjonalne
      string

      Tylko w podglądzie.

    • work_account_number
      opcjonalne
      string

      Tylko w podglądzie.

    • holidays
      opcjonalne
      boolean

      Obecne, gdy na koncie włączono wakacje od ZUS.

    • extensions
      opcjonalne
      object

      Tylko w podglądzie.

      • payments
        object
        wymagane

        Płatność online podatku w aplikacji inFakt.

        • enabled
          boolean
          wymagane

          true, gdy podatek można teraz zapłacić online.

        • reason
          opcjonalne
          string

          Powód niedostępności płatności online, np. Płatność w trakcie przetwarzania; tylko przy enabled: false.

        • webview
          opcjonalne
          object

          Przy enabled: true.

          • pid
            string
            wymagane

            Identyfikator płatności bez znaczenia dla klienta API.

        • pid
          opcjonalne
          string

          Przy enabled: true.

        • amount
          opcjonalne
          integer

          Kwota do zapłaty; przy enabled: true.

          format: int64
        • fee
          opcjonalne
          integer

          Opłata za płatność; przy enabled: true.

          format: int64

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

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