Skip to content
Nawigacja

Pobierz fakturę OSS

Zakres: api:invoices:read. id może być identyfikatorem liczbowym albo uuid.

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

Autoryzacja

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

Path parameters

  • id
    string
    wymagane

    Liczbowe id albo uuid rekordu.

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

    Kraj konsumenta (ISO alpha-2).

    pattern: ^[A-Z]{2}$
  • client_email
    wymagane

    One of the following:

    • string
    • null
  • client_name
    wymagane

    One of the following:

    • string
    • null
  • client_first_name
    wymagane

    One of the following:

    • string
    • null
  • client_last_name
    wymagane

    One of the following:

    • string
    • null
  • client_street
    wymagane

    One of the following:

    • string
    • null
  • client_street_number
    wymagane

    One of the following:

    • string
    • null
  • client_flat_number
    wymagane

    One of the following:

    • string
    • null
  • client_post_code
    wymagane

    One of the following:

    • string
    • null
  • client_city
    wymagane

    One of the following:

    • string
    • null
  • service_date
    string
    wymagane
    format: date
  • issue_date
    string
    wymagane
    format: date
  • payment_date
    wymagane

    One of the following:

    • string
    • null
  • service_type
    wymagane

    Np. electronic.

    One of the following:

    • string
    • null
  • service_place_primary
    wymagane

    Dowód lokalizacji konsumenta, np. adres IP.

    One of the following:

    • string
    • null
  • service_place_secondary
    wymagane

    One of the following:

    • string
    • null
  • currency
    string
    wymagane
  • seller_signature
    string
    wymagane
  • recipient_signature
    string
    wymagane
  • notes
    wymagane

    One of the following:

    • string
    • null
  • 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
  • advance_price
    integer
    wymagane

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

    format: int64
  • sale_type
    wymagane

    merchandise albo service; null na starszych fakturach.

    One of the following:

    • string
    • null
  • services
    array of
    object
    wymagane
    • id
      integer
      wymagane
      format: int64
    • unit
      wymagane

      One of the following:

      • string
      • null
    • quantity
      number
      wymagane
      format: double
    • name
      string
      wymagane
    • 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
    • unit_net_price
      integer
      wymagane

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

      format: int64
    • additional_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
    • tax_rate
      number
      wymagane

      Stawka VAT kraju konsumenta, w procentach.

      format: double
    • flat_rate_tax_symbol
      opcjonalne

      Występuje tylko u ryczałtowców.

      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

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