Nastavení uhrazenosti dokladu
POST
/api/v2/docs/{id}/paidKdyž tělo obsahuje paid, doklad dostane požadovaný stav uhrazenosti. Opakované volání se stejnou hodnotou nic dalšího nemění.
Když paid chybí nebo je tělo prázdné, aktuální stav se přepne na opačný a každé další volání ho přepne znovu. Pro předvídatelný výsledek proto posílejte true nebo false.
Úspěšná odpověď obsahuje jen status, výsledný stav nevrací. Aktuální uhrazenost zjistíte ve výpisu dokladů.
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 |
|---|---|---|---|---|
paid | boolean | ne | true pro uhrazeno, false pro neuhrazeno. Bez tohoto pole se stav přepne na opačný. | 1 |
Příklad požadavku
curl
curl -X POST 'https://www.elpokladny.cz/api/v2/docs/1/paid' \
-H 'Authorization: Bearer elp_live_example.example_secret' \
-H 'Content-Type: application/json' \
--data-raw '{
"paid": true
}'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/docs/1/paid');
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 => '{
"paid": true
}',
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;javascript
const response = await fetch("https://www.elpokladny.cz/api/v2/docs/1/paid", {
"method": "POST",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret",
"Content-Type": "application/json"
},
"body": "{\n \"paid\": true\n}"
});
const data = await response.json();Ukázkové odpovědi
Změna provedena (HTTP 200)
application/json
{
"status": "success"
}
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 |