Skip to content
Nawigacja

Pobierz listę faktur kosztowych z KSeF

Zakres: api:invoices:read. Faktury kosztowe wystawione na konto w KSeF.

GET
https://api.sandbox-infakt.pl/v3/ksef2/import/costs.json

Autoryzacja

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

Query parameters

  • q[invoice_date_gteq]
    opcjonalne
    string
    format: date
  • q[invoice_date_lteq]
    opcjonalne
    string
    format: date
  • offset
    opcjonalne
    integer
    format: int32 · default: 0
  • limit
    opcjonalne
    integer
    format: int32 · default: 20
  • order
    opcjonalne
    Asc
    or
    Desc

    Asc albo Desc.

    default: "Desc"

Odpowiedzi

200

Sukces

JSON
  • entities
    array of
    object
    wymagane
    • ksef_number
      string
      wymagane
    • invoice_number
      wymagane

      One of the following:

      • string
      • null
    • invoice_kind
      wymagane

      One of the following:

      • string
      • null
    • invoice_date
      wymagane

      One of the following:

      • string
      • null
    • client_name
      wymagane

      One of the following:

      • string
      • null
    • client_tax_code
      wymagane

      One of the following:

      • string
      • null
    • seller_name
      wymagane

      One of the following:

      • string
      • null
    • seller_tax_code
      wymagane

      One of the following:

      • string
      • null
    • gross_price
      wymagane

      One of the following:

      • Money
      • null
    • net_price
      wymagane

      One of the following:

      • Money
      • null
    • tax_price
      wymagane

      One of the following:

      • Money
      • null
    • currency
      wymagane

      One of the following:

      • string
      • null
    • schema_version
      wymagane

      Wersja schemy FA, np. 1-0E.

      One of the following:

      • string
      • null
    • created_at
      wymagane

      Czas przyjęcia faktury przez KSeF.

      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

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

422

Odrzucone przez usługę integracji z KSeF, np. brak aktywnej integracji.
JSON
  • result
    error
    wymagane
  • data
    null
    wymagane
  • _meta
    object
    wymagane
    • code
      integer
      wymagane
      format: int32
    • reason
      string
      wymagane
    • message
      string
      wymagane
    • errors
      wymagane

      One of the following:

      • object
      • null

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