Skip to content
Nawigacja

Pobierz listę kosztów

Zakres: api:costs:read. Koszty, skany dokumentów i dowody wewnętrzne, od najnowszej daty wystawienia. Przy offset i limit wartość offset musi być wielokrotnością limit albo limit - 1; w przeciwnym razie 400.

GET
https://api.sandbox-infakt.pl/v3/documents/costs.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.

  • order
    opcjonalne
    issue_date desc
    or
    issue_date asc
    or
    received_date desc
    or
    received_date asc
    or
    due_date desc
    or
    due_date asc
    +14 more

    Kolumna sortowania i kierunek małymi literami. Domyślnie issue_date desc. Bez kierunku albo z kierunkiem wielkimi literami obowiązuje kolejność domyślna. Dokumenty bez wartości trafiają na koniec dla każdej kolumny poza created_at i currency.

  • q[created_at_gteq]
    opcjonalne
    string
    format: date
  • q[created_at_lteq]
    opcjonalne
    string
    format: date
  • q[issue_date_gteq]
    opcjonalne
    string
    format: date
  • q[issue_date_lteq]
    opcjonalne
    string
    format: date
  • q[received_date_gteq]
    opcjonalne
    string
    format: date
  • q[received_date_lteq]
    opcjonalne
    string
    format: date
  • q[due_date_gteq]
    opcjonalne
    string
    format: date
  • q[due_date_lteq]
    opcjonalne
    string
    format: date
  • q[accounted_at_date_gteq]
    opcjonalne
    string

    Data zaksięgowania; skany dokumentów są pomijane.

    format: date
  • q[accounted_at_date_lteq]
    opcjonalne
    string

    Data zaksięgowania; skany dokumentów są pomijane.

    format: date
  • q[seller_name_i_cont]
    opcjonalne
    string
  • q[seller_tax_code_i_cont]
    opcjonalne
    string
  • q[number_i_cont]
    opcjonalne
    string
  • q[description_i_cont]
    opcjonalne
    string
  • q[net_in_cents_gteq]
    opcjonalne
    integer

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

    format: int64
  • q[net_in_cents_lteq]
    opcjonalne
    integer

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

    format: int64
  • q[gross_in_cents_gteq]
    opcjonalne
    integer

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

    format: int64
  • q[gross_in_cents_lteq]
    opcjonalne
    integer

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

    format: int64
  • q[currency_in][]
    opcjonalne
    array of
    string

    Kody walut, np. EUR.

  • q[kind_in][]
    opcjonalne
    array of
    string
  • q[category_in][]
    opcjonalne
    array of
    string

    Nazwy kategorii kosztu, np. Paliwo.

  • q[category_i_cont]
    opcjonalne
    string

    Fragment nazwy kategorii kosztu.

  • q[document_type_in][]
    opcjonalne
    array of
    string

    Skany dokumentów są pomijane.

  • q[source_eq]
    opcjonalne
    string
  • q[with_attachments_eq]
    opcjonalne
    boolean
  • q[with_notes_eq]
    opcjonalne
    boolean
  • q[search_input]
    opcjonalne
    string

    Szuka jednocześnie w nazwie sprzedawcy, NIP-ie, numerze i opisie.

  • q[document_statuses_symbol_in][]
    opcjonalne
    array of
    string

    Symbole statusów z statuses[].symbol; dokument musi mieć wszystkie. Płatność: paid, unpaid, partial_payment, in_progress, payment_not_applicable. Księgowanie: cost_accounted, autox_accounted, cost_not_accounted, cost_rejected, to_clarify, cost_accounting_not_applicable.

  • q[payment_document_statuses_symbol_in][]
    opcjonalne
    array of
    string

    Symbole statusów płatności; dokument musi mieć którykolwiek z nich (łączone przez OR z cost_accounting_document_statuses_symbol_in).

  • q[cost_accounting_document_statuses_symbol_in][]
    opcjonalne
    array of
    string

    Symbole statusów księgowania; dokument musi mieć którykolwiek z nich (łączone przez OR z payment_document_statuses_symbol_in).

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
    • uuid
      string
      wymagane
      format: uuid
    • number
      wymagane

      One of the following:

      • string
      • null
    • net_price
      wymagane

      One of the following:

      • Money
      • null
    • gross_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
    • accounted_at
      wymagane

      One of the following:

      • string
      • null
    • issue_date
      wymagane

      One of the following:

      • string
      • null
    • received_date
      wymagane

      One of the following:

      • string
      • null
    • due_date
      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
    • seller_bank_account
      wymagane

      One of the following:

      • string
      • null
    • description
      wymagane

      One of the following:

      • string
      • null
    • added_by
      string
      wymagane
    • category
      wymagane

      Nazwa kategorii kosztu.

      One of the following:

      • string
      • null
    • kind
      cost
      or
      document_scan
      or
      internal_evidence
      or
      health_fee_evidence
      or
      work_fund_evidence
      wymagane
    • notes_count
      wymagane

      One of the following:

      • integer
      • null
    • newest_note
      wymagane

      One of the following:

      • DocumentNote
        • kind
          string
          wymagane
        • content
          string
          wymagane
        • created_by
          wymagane

          One of the following:

          • string
          • null
        • author_first_name
          wymagane

          One of the following:

          • string
          • null
        • author_last_name
          wymagane

          One of the following:

          • string
          • null
        • author_avatar
          wymagane

          One of the following:

          • string
          • null
        • created_at
          string
          wymagane
      • null
    • duplicated
      boolean
      wymagane
    • created_at
      string
      wymagane

      Znacznik czasu ze strefą czasową.

    • source
      wymagane

      One of the following:

      • string
      • null
    • reconciliation_id
      wymagane

      One of the following:

      • integer
      • null
    • statuses
      array of
      object
      wymagane
      • symbol
        string
        wymagane
      • name
        string
        wymagane
      • group
        string
        wymagane
    • attachments
      opcjonalne
      array of
      object

      Tylko w odpowiedzi get.

      • file_name
        string
        wymagane
      • file_url
        string
        wymagane

        Tymczasowy link, który wyświetla plik w przeglądarce; ważny 5 minut.

      • download_url
        string
        wymagane

        Tymczasowy link do pobrania pliku; ważny 5 minut.

      • document_scan_uuid
        wymagane

        One of the following:

        • Uuid
        • null
      • kind_id
        wymagane

        One of the following:

        • integer
        • null
    • related_internal_note
      opcjonalne

      Tylko w odpowiedzi get.

      One of the following:

      • InternalNoteReference
        • number
          string
          wymagane
        • url
          string
          wymagane
      • null
    • notes
      opcjonalne
      array of
      object

      Tylko w odpowiedzi get.

      • kind
        string
        wymagane
      • content
        string
        wymagane
      • created_by
        wymagane

        One of the following:

        • string
        • null
      • author_first_name
        wymagane

        One of the following:

        • string
        • null
      • author_last_name
        wymagane

        One of the following:

        • string
        • null
      • author_avatar
        wymagane

        One of the following:

        • string
        • null
      • created_at
        string
        wymagane
    • related_exchange_differences_internal_evidences
      opcjonalne
      array of
      object

      Tylko w odpowiedzi get.

      • id
        integer
        wymagane
        format: int64
      • number
        string
        wymagane
      • uuid
        string
        wymagane
        format: uuid
  • count
    integer
    wymagane
    format: int32
  • total_count
    wymagane

    One of the following:

    • integer
    • null
  • current_page
    integer
    wymagane
    format: int32
  • pages
    wymagane

    One of the following:

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