Nastavení způsobu platby dokladu
POST
/api/v2/docs/{id}/paymentKdyž pošlete payment s hodnotou cash, card nebo bank, doklad dostane tento způsob platby. Opakované volání se stejnou hodnotou nic dalšího nemění.
Když payment chybí, tělo je prázdné nebo hodnota není jedna z podporovaných, způsob platby se přepne na další v pořadí cash, card, bank a zpět na cash. Doklad s jiným způsobem platby přejde na cash. Každé takové volání stav znovu změní, proto pro předvídatelný výsledek posílejte konkrétní hodnotu.
Odpověď obsahuje výsledný způsob platby v poli payment.
Autentizace a oprávnění
Vyžaduje API token: Bearer v hlavičce nebo URL token.
Parametry
Parametry cesty
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
id | integer | ano | ID dokladu vaší firmy. | 1 |
Tělo požadavku
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
payment | enum | ne | cash (hotovost), card (karta) nebo bank (převod). Bez platné hodnoty se způsob platby přepne na další v pořadí. | bank |
Příklad požadavku
curl
curl -X POST 'https://www.elpokladny.cz/api/v2/docs/1/payment' \
-H 'Authorization: Bearer elp_live_example.example_secret' \
-H 'Content-Type: application/json' \
--data-raw '{
"payment": "bank"
}'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/docs/1/payment');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array (
0 => 'Authorization: Bearer elp_live_example.example_secret',
1 => 'Content-Type: application/json',
),
CURLOPT_POSTFIELDS => '{
"payment": "bank"
}',
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;javascript
const response = await fetch("https://www.elpokladny.cz/api/v2/docs/1/payment", {
"method": "POST",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret",
"Content-Type": "application/json"
},
"body": "{\n \"payment\": \"bank\"\n}"
});
const data = await response.json();Ukázkové odpovědi
Změna provedena (HTTP 200)
application/json
{
"status": "success",
"payment": "bank"
}
Doklad nenalezen (HTTP 404)
application/json
{
"status": "error",
"error": "not-found"
}
Neplatné JSON (HTTP 400)
application/json
{
"status": "error",
"message": "Neplatný JSON."
}
Možné chyby
| HTTP | Kdy | Podoba |
|---|---|---|
| 401 | Chybí nebo je neplatný API token. | status-message |
| 403 | API token se použil z IP adresy, která není u přístupu povolená, nebo je přístup odepřen. | status-message |
| 404 | Doklad s tímto ID neexistuje, je smazaný, nebo patří jiné firmě. | status-error |
| 400 | Tělo požadavku není platný JSON. | status-message |