Wyślij fakturę zaliczkową e-mailem

Zakres: api:invoices:write. 422 ze status: failure, gdy nie udało się wysłać e-maila.

POST

https://api.sandbox-infakt.pl/v3/advance_invoices/{uuid}/deliver_via_email.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 required

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
Domyślnie pierwszy rodzaj wydruku dostępny dla dokumentu.
locale
opcjonalne
pl
or
en
or
pe
Domyślnie pierwszy język dostępny dla dokumentu.
send_copy
opcjonalne
boolean
Wyślij kopię do właściciela konta. Domyślnie zgodnie z ustawieniem powiadomień konta.
content
opcjonalne
string
Treść wiadomości. Domyślnie szablon e-maila z ustawień konta.
activate_quick_payment
opcjonalne
boolean
Aktywuj link do szybkiej płatności przed wysłaniem. Przy false, gdy szybkie płatności są dostępne dla faktury, istniejący link do płatności jest usuwany.

default: false
overwrite_email
opcjonalne
boolean
Zapisz recipient jako e-mail kontrahenta.

default: true

Example request

{
  "recipient": "ksiegowosc@example.com"
}

Odpowiedzi

202

Przyjęto do przetwarzania

JSON

uuid
string
wymagane
Uuid dokumentu; dla nieznalezionego uuid wartość taka, jak wysłano.
number
string
wymagane
"" dla nieznalezionego uuid.
status
success
or
failure
wymagane

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

E-mail niewysłany (status: failure) albo nieprawidłowe parametry (error według pól).

JSON

One of the following:

DocumentActionResult
- uuid
  string
  wymagane
  Uuid dokumentu; dla nieznalezionego uuid wartość taka, jak wysłano.
- number
  string
  wymagane
  "" dla nieznalezionego uuid.
- status
  success
  or
  failure
  wymagane
}
IncomeActionErrorBody
- 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

curl --request POST \ --url https://api.sandbox-infakt.pl/v3/advance_invoices/9bdc76fd-7a02-42ec-a4a3-42bc867b9a9f/deliver_via_email.json \ --header 'Content-Type: application/json' \ --header 'X-inFakt-ApiKey: <X-inFakt-ApiKey>' \ --data ' { "recipient": "ksiegowosc@example.com" } '