Skip to content
Nawigacja

Wyślij fakturę marża do KSeF

Zakres: api:invoices:write.

POST
https://api.sandbox-infakt.pl/v3/margin_invoices/{uuid}/send_to_ksef.json

Autoryzacja

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

Path parameters

  • uuid
    string
    wymagane
    format: uuid

Query parameters

  • allow_correction
    opcjonalne
    boolean

    Potwierdź akcję, która skoryguje złożone deklaracje (zamknięty okres księgowy). Bez tego takie żądania zwracają 422 z errors.allow_correction albo errors.locked_accounting, gdy plan nie pozwala na korekty (wtedy ta flaga jest ignorowana). Można też podać w treści żądania.

Treść żądania JSON optional

  • inform_via_email
    opcjonalne
    object

    Zapisuje opcje wysyłki e-mailem, tak jak save_email_data. Nieprawidłowe opcje dają 422.

    • recipient
      opcjonalne
      string

      Adresy rozdzielone przecinkami; domyślnie e-mail klienta.

    • print_type
      opcjonalne
      original
      or
      copy
      or
      original_copy
      or
      original_duplicate
      or
      copy_duplicate
      or
      duplicate
      +2 more
      default: "regular"
    • locale
      opcjonalne
      pl
      or
      en
      or
      pe
      default: "pl"
    • send_copy
      opcjonalne
      boolean

      Wyślij kopię do właściciela konta.

      default: false
    • content
      opcjonalne
      string

      Treść wiadomości.

    • send_to_ksef
      opcjonalne
      boolean
      default: false
    • send_via_email
      opcjonalne
      boolean
      default: false
    • quick_payments
      opcjonalne
      boolean
      default: false

Odpowiedzi

200

Sukces

JSON
  • request_uuid
    wymagane

    null dla faktur odrzuconych przed wysyłką.

    One of the following:

    • string
    • null
  • invoice_uuid
    wymagane

    One of the following:

    • Uuid
    • null
  • invoice_kind
    wymagane

    One of the following:

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

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

422

Akcja odrzucona.
JSON
  • errors
    opcjonalne

    Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.

    One of the following:

    • object
    • string
  • error
    opcjonalne

    One of the following:

    • string
    • array<string>
    • object

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