Skip to content
Nawigacja

Pobierz listę faktur wewnętrznych

Zakres: api:invoices:read.

GET
https://api.sandbox-infakt.pl/v3/internal_invoices.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>, <pole> asc albo <pole> desc z nazwą pola API, np. name desc. Pole, po którym nie da się sortować, jest ignorowane bez błędu.

  • q[number_eq]
    opcjonalne
    string
  • q[invoice_date_gteq]
    opcjonalne
    string
    format: date
  • q[invoice_date_lteq]
    opcjonalne
    string
    format: date

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
    • number
      string
      wymagane
    • kind
      vat
      or
      proforma
      or
      margin
      or
      advance
      or
      correction
      or
      margin_correction
      +5 more
      wymagane
    • transaction_kind_symbol
      string
      wymagane

      Zobacz GET /transaction_kinds.json.

    • invoice_date
      string
      wymagane
      format: date
    • net_price
      integer
      wymagane

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

      format: int64
    • tax_price
      integer
      wymagane

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

      format: int64
    • gross_price
      integer
      wymagane

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

      format: int64
    • status
      draft
      or
      sent
      or
      printed
      or
      unpaid
      or
      paid
      or
      scheduled
      wymagane
    • notes
      wymagane

      One of the following:

      • string
      • null
    • services
      array of
      object
      wymagane
      • name
        string
        wymagane

        Zawsze BRAK.

      • tax_symbol
        string
        wymagane
      • net_price
        integer
        wymagane

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

        format: int64
      • vat_price
        integer
        wymagane

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

        format: int64
      • gross_price
        integer
        wymagane

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

        format: int64
    • ksef_data
      wymagane

      One of the following:

      • InvoiceKsefData
        • request_uuid
          wymagane

          null dla faktur odrzuconych przed wysyłką.

          One of the following:

          • string
          • null
        • ksef_number
          wymagane

          Numer KSeF nadany po przyjęciu.

          One of the following:

          • string
          • null
        • status
          pending
          or
          sent
          or
          success
          or
          error
          or
          cancelled
          or
          rejected
          wymagane

          rejected tylko w odpowiedziach zbiorczych, dla dokumentów, których w ogóle nie wysłano.

        • status_description
          wymagane

          One of the following:

          • string
          • null
        • timestamps
          object
          wymagane
          • request_created_at
            string
            wymagane
          • request_finished_at
            wymagane

            One of the following:

            • string
            • null
      • null
    • third_party_addresses
      array of
      object
      wymagane
      • id
        integer
        wymagane
        format: int64
      • company_name
        wymagane

        One of the following:

        • string
        • null
      • tax_id
        wymagane

        One of the following:

        • string
        • null
      • street
        wymagane

        One of the following:

        • string
        • null
      • building_number
        wymagane

        One of the following:

        • string
        • null
      • door_number
        wymagane

        One of the following:

        • string
        • null
      • post_code
        wymagane

        One of the following:

        • string
        • null
      • city
        wymagane

        One of the following:

        • string
        • null
      • country_code
        wymagane

        One of the following:

        • CountryCode
        • null
      • role_code
        wymagane

        Kod roli podmiotu trzeciego w KSeF; zobacz ThirdPartyAddressInput.role_code.

        One of the following:

        • string
        • null
      • internal_identifier
        wymagane

        One of the following:

        • string
        • null
    • related_exchange_differences_internal_evidences
      array of
      object
      wymagane
      • id
        integer
        wymagane
        format: int64
      • number
        string
        wymagane
      • uuid
        string
        wymagane
        format: uuid
    • parent_invoice_data
      opcjonalne
      null

      Tylko w odpowiedzi get; zawsze null.

400

Nieprawidłowe parametry wyszukiwania (q[...]); na niektórych endpointach także nieprawidłowe parametry stronicowania.
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

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

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