Číselné řady

Operace ve skupině Číselné řady.

Základní URLhttps://api.damedoklad.cz/v1Přihlášení Chyby a limity Konvence

GET/v1/series
POST/v1/series
GET/v1/series/{id}
PATCH/v1/series/{id}
DEL/v1/series/{id}
GET/v1/series/{id}/gaps

Seznam: číselné řady

GET/v1/series

List number series. Every issued document takes its number from one, per accounting period

Nástroj MCP: list-series

Parametry dotazu

periodIdstring

Only series of this accounting period.

documentTypestring

For example invoice, proforma, credit_note, delivery_note, received_invoice.

limitintegermin 1max 500

offsetintegermin 0max 9007199254740991

searchstringmax 200 chars

Odpověď · 200

dataobject[]povinné

object"series"povinné

idstringpovinné

namestringpovinné

documentTypestringpovinné

prefixstringpovinné

includeYearstringpovinné

padintegerpovinné

nextNumberintegerpovinné

periodIdstringpovinné

periodNamestringpovinné

isDefaultbooleanpovinné

isSystembooleanpovinné

isActivebooleanpovinné

previewstringpovinné

totalinteger

Rows that match, on all pages.

hasMorebooleanpovinné

More rows follow. Ask again with offset + the number of rows received.

GET/v1/series

curl https://api.damedoklad.cz/v1/series \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY"

const response = await fetch('https://api.damedoklad.cz/v1/series', {
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.damedoklad.cz/v1/series",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
)
data = response.json()

Vytvoření: číselná řada

POST/v1/series

Create a number series for a document type and accounting period

Nástroj MCP: create-series

Tělo požadavku

namestringmax 80 chars

prefixstringpovinnémax 8 chars

includeYear"yyyy" | "yy" | "none"

padintegermin 3max 6

nextNumberintegermin 1max 999999

periodIdstring

ID of the period. Find it with list-periods.

isDefaultboolean

isActiveboolean

Odpověď · 201

idstringpovinné

namestringpovinné

documentTypestringpovinné

prefixstringpovinné

includeYearstringpovinné

padintegerpovinné

nextNumberintegerpovinné

periodIdstringpovinné

periodNamestringpovinné

isDefaultbooleanpovinné

isSystembooleanpovinné

isActivebooleanpovinné

previewstringpovinné

POST/v1/series

curl -X POST https://api.damedoklad.cz/v1/series \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "documentType": "issued_invoice",
  "prefix": "string"
}'

const response = await fetch('https://api.damedoklad.cz/v1/series', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "documentType": "issued_invoice",
    "prefix": "string"
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    "https://api.damedoklad.cz/v1/series",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
    json={
        "documentType": "issued_invoice",
        "prefix": "string"
    },
)
data = response.json()

Detail: číselná řada

GET/v1/series/{id}

Get a number series, with a preview of the next number

Nástroj MCP: get-series

Parametry v cestě

idstringpovinné

Odpověď · 200

idstringpovinné

namestringpovinné

documentTypestringpovinné

prefixstringpovinné

includeYearstringpovinné

padintegerpovinné

nextNumberintegerpovinné

periodIdstringpovinné

periodNamestringpovinné

isDefaultbooleanpovinné

isSystembooleanpovinné

isActivebooleanpovinné

previewstringpovinné

GET/v1/series/{id}

curl https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY"

const response = await fetch('https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL', {
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
)
data = response.json()

Úprava: číselná řada

PATCH/v1/series/{id}

Update a number series. Numbers already issued do not change

Nástroj MCP: update-series

Parametry v cestě

idstringpovinné

Tělo požadavku

namestringmax 80 chars

prefixstringmax 8 chars

includeYear"yyyy" | "yy" | "none"

padintegermin 3max 6

nextNumberintegermin 1max 999999

isDefaultboolean

isActiveboolean

Odpověď · 200

idstringpovinné

namestringpovinné

documentTypestringpovinné

prefixstringpovinné

includeYearstringpovinné

padintegerpovinné

nextNumberintegerpovinné

periodIdstringpovinné

periodNamestringpovinné

isDefaultbooleanpovinné

isSystembooleanpovinné

isActivebooleanpovinné

previewstringpovinné

PATCH/v1/series/{id}

curl -X PATCH https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pekárna U Lípy s.r.o.",
  "prefix": "string",
  "includeYear": "yyyy"
}'

const response = await fetch('https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Pekárna U Lípy s.r.o.",
    "prefix": "string",
    "includeYear": "yyyy"
  }),
});
const data = await response.json();

import os
import requests

response = requests.patch(
    "https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
    json={
        "name": "Pekárna U Lípy s.r.o.",
        "prefix": "string",
        "includeYear": "yyyy"
    },
)
data = response.json()

Smazání: číselná řada

DELETE/v1/series/{id}

Delete a number series that has not issued any number

Nevratná operaceTato operace se nedá vrátit. MCP klienti se před ní ptají na potvrzení.

Nástroj MCP: delete-series

Parametry v cestě

idstringpovinné

Odpověď · 200

idstringpovinné

deletedbooleanpovinné

DELETE/v1/series/{id}

curl -X DELETE https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY"

const response = await fetch('https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.delete(
    "https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
)
data = response.json()

Detail: mezery, číselná řada

GET/v1/series/{id}/gaps

Find gaps in the numbers a series has issued. Tax documents should run without gaps

Nástroj MCP: get-series-gaps

Parametry v cestě

idstringpovinné

Odpověď · 200

idstringpovinné

fromintegerpovinné

tointegerpovinné

missinginteger[]povinné

usedinteger[]povinné

GET/v1/series/{id}/gaps

curl https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL/gaps \
  -H "Authorization: Bearer $DAMEDOKLAD_API_KEY"

const response = await fetch('https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL/gaps', {
  headers: {
    Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.damedoklad.cz/v1/series/obj_2n9F4kT7wQ1xYz0aBcDeFgHiJkL/gaps",
    headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"},
)
data = response.json()