WAPI – Zálohový účet

Tento článek přináší informace o těchto požadavcích:

• account-list – seznam pohybů na zálohovém účtu
• credit-info – informace o aktuálním zůstatku kreditu

---

account-list

Použijte account-list požadavek pro získání seznamu pohybů na zálohovém účtu ve vybraném období.

Parametry

• date_from – počáteční datum vypsaných pohybů ve formátu YYYY-MM-DD
• date_to – koncové datum vypsaných pohybů ve formátu YYYY-MM-DD

Návratové hodnoty

• 1000 – OK
• 3004 – neplatný vstup – chybí datum od a do
• 3005 – neplatný vstup – neplatná data

Data odpovědi

Požadavek vrací tyto informace:

• ID – identifikátor pohybu
• typ – typ (platba nebo vklad)
• num – číslo objednávky
• description
• amount
• bill_num – číslo faktury
• bill_date – datum faktury
• blokováno – blokovaný kredit
• created_date – datum a čas požadavku

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "account-list",
    "clTRID": "your ID",
    "data": {
      "date_from": "YYYY-MM-DD",
      "date_to": "YYYY-MM-DD"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "account-list",
    "data": {
      "XXXX": {
        "ID": "XXXX (account movement ID)",
        "type": "payment or deposit",
        "num": "order number",
        "description": "description",
        "amount": "amount",
        "bill_num": "",
        "bill_date": "",
        "blocked": 0,
        "created_date": "date and time of request"
      }
    }
  }
}

---

credit-info

Použijte credit-info požadavek pro zjištění aktuálního zůstatku kreditu na zálohovém účtu.

Parametry

Tento požadavek nemá žádné parametry.

Návratové hodnoty

• 1000 – OK

Data odpovědi

• amount – zůstatek zálohového účtu
• currency – měna zálohového účtu

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "credit-info",
    "clTRID": "your ID",
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "credit-info",
    "data": {
      "amount": "account balance",
      "currency": "currency code"
    }
  }
}