Špecifikácia pre systém LoyalMan

LoyalMan je nový vernostný systém, ktorý vie pracovať v zdieľanom režime naprieč rôznymi geograficky oddelenými prevádzkami zákazníka s úlohou spojiť poberateľov zliav a bonusov do jednotného centrálne manažovaného celku. Svoju funkcionalitu ponúka jednak pomocou prehľadného grafického rozhrania pre poberateľov zliav a administrátorov systému, tak ako pomocou API rozhrania sprístupneného pre systémy ako je: hotelový recepčný systém (napr. HORES, reštauračný systém (FoodMAN) a firemné ekonomické systémy tzv. ERP systémy (napríklad SAP). Tento dokument reprezentuje funčnú špecifikáciu, návrh API a návrh UI Tento dokument obsahuje technickú špecifikáciu diela a popisuje jednotlivé funkcie a štruktúry používane v rámci procesov ukázaných v návrhu dizajnu. Funkcionalita opisuje nasledovné celky:

  1. Autorizácia
  • možnosť prihlásiť a odhlásiť používateľa pre každú rolu.
  1. Role používateľov - Systém definuje 3 základné role, kde každá rola má svoje špecifické oprávnenia. Používateľ musí mať priradenú rola a tá priamo ovplyvňuje s čim používateľ môže pracovať a aké operácie môže vykonávať. Role sú nasledovné:
  • Zákazník - Používateľ s touto rolou môže využívať nasledovné možnosti systému: čerpanie zliav, bonusu, kreditu a predplatených produktov a úprava svojho vlastného profilu.
  • Obsluha - Používateľ s touto rolou môže vykonávať operácie nad používateľmi s rolou Zákazník: priradzovanie Zákazníka k účtu, načerpávanie zliav, kreditov, bonusov a predplatených produktov, storno získaných benefitov, vytváranie nových Zákazníkov, prezeranie aktuálnych zliav a akcií.
  • Administrátor systému - Používateľ s touto rolou má prístup k manažmentu Zákazníkov, Obsluhy, Balíčkov zliav, Predplatených produktov, Akcií, Peňaženiek, Voucherov a Transakcií. Zároveň môže vidieť všetky dáta uložené v systéme
  1. Používatelia
  • Možnosť pridania nového používateľa s ľubovoľnou rolou
  • Možnosť tlače informovaného súhlasu
  • Možnosť zobrazenia informácii o používateľovi, editovania, možnosť jeho blokovania, či zmazania
  • Možnosť zobrazenia a filtrovania používateľov
  • Možnosť exportu údajov
  • V rámci prekryvu z ostatnými službami umožňuje:
    • Nastavenie balíčkov služieb pre používateľa (popísané neskôr)
    • Zobraziť informácii o balíčkoch zliav, ktoré ma asociované
    • Zobraziť a filtrovať nad transakciami
    • Manuálne vykonať transakciu (po dostatočných oprávneniach)
    • Spravovať a prezerať svoje peňaženky v danej mene, ktorá mu je priradená
    • Priradiť kartu (zatiaľ nepriradenú) v dvoch módoch:
      • Zákazník sa neskôr sám zaregistruje pomocou webovej aplikácie - Proces spočíva vo vygenerovaní kódu LoyalMANom a vytlačení informácii pre používateľa. Na základe nich sa registruje sám na webe.
      • Obsluha – V tomto prípade ho zakladá iný používateľ, kde však musí mať od používateľa podpísaný súhlas so spracovaním údajov.
  1. Balíčky zliav Balíčky, sú skupiny výhod, operácii a vlastností, ktoré sa prideľujú Zákazníkom. Zákazník môže následne pre nejakú svoju kartu obmedziť využívanie vybraných balíčkov, ktoré ma priradené. Pri výpočte zliav sa tieto balíčky kombinujú na základe konkrétne zvolenej stratégie a môžu sa skladať z nasledovných vlastností:

  • Zľava

    • Percentuálna (výška zľavy je určená %)
    • Cenová hladina (výška zľavy je nastavená cenovou hladinou, všetky položky na účte sa automaticky prestavia do nastavenej cenovej hladiny, alebo cenníku
    • Parametrická (výška zľavy je nastavená špeciálne podľa požiadaviek používateľa), napr.:
      • Dátum a čas, kedy sa môže zľava uplatniť
      • Druhy platieb, pri ktorých sa má zľava uplatniť
      • Zľava podľa výšky účtu (pri rôznej výške účtu môže byť uplatňovaná iná zľava)
      • Počet účtov, či suma za definované obdobie

  • Bonus a kredit - časť práve zaplateného účtu sa môže Zákazníkovi pripočítať na jeho peňaženky nastaveným koeficientom ako bonus, alebo kredit. V oboch prípadoch môže využiť používateľ kredit a bonus na platbu ďalšieho účtu podľa definovaných pravidiel. Balíčky definujú spôsoby načerpávania a čerpania v pomocou pravidiel:

    • Dátum a čas, kedy sa môžu uplatniť
    • Druhy platieb, pri ktorých sa môžu uplatniť
    • Skupiny a produkty, pri ktorých sa môžu uplatniť
    • Type: absolútne, s koeficientom, percentuálne
  1. Predplatené produkty - predplatený produkt je konkrétny produkt z kasy, ktorý mi dobije N bodov na účet. Tu je možné nastaviť koeficient koľko daný produkt nabíja a zároveň dalšie pravidlo, ktorý produkt koľko bodov stojí. Ak má Zákazník dostatočný počet bodov, tak sa produktu nastaví nulová cena.
  2. Akcie - akcie sú udalosti, ktoré za stanovených štruktúrovaných podmienok umožnia hocikomu, či držiteľovi karty čerpať extra výhody. Akcie sa dajú priradiť jednotlivým Zákazníkom na základe ich balíkov, či ich vlastností uložených v systéme. Parametre, ktoré je možné nastaviť akcii sú pre neregistrovaných členov rovnaké ako pre Zľavy v Balíčkoch zliav a pre registrovaných sú pre všetky možnosti z Balíčkov zliav.
  3. Peňaženky - systém uchováva Zákazníkom kredity, bonusy a predplatené produkty v ich peňaženkách. Systém podporuje vytváranie peňaženiek na ktoré sú potom viazané pravidlá pre kredity a bonusy.
  4. Vouchery a kupóny - vouchery a kupóny slúžia pre jednoduchý prístup k akciám, ktoré nie sú pre širokú verejnosť. Teda akcia sa aplikuje len po zadaní kódu.
  • Voucher: kód, ktorý poskytuje výhodu jednorázovo komukoľvek (za e-mailovú adresu). Vyžaduje sa však jednoduchá registrácia Zákazníka za účelom získania (ak už Zákazník nie je zaregistrovaný).
  • Kupóny: číselné kódy, ktoré podobne ako Voucher poskytujú Zákazníkom výhodu. Je však možné použiť tento kupón opakovane.
  1. Karty - karta je v systéme entita, na ktorú sa aplikujú balíčky služieb Zákazníka opísané vyššie. Jeden zákazník môže mať rozdielne balíčky na kartách, no peňaženky sa medzi kartami zdieľajú
  2. Transakcie - Transakcie sú všetky historické operácie v systéme spojené so Zákazníkmi a operáciami nad nimi
  3. História - Zoznam všetkých zmien v systéme
Contact

MPI Consulting, s.r.o.

office@mpi.sk

API Endpoints
https://127.0.0.1:8000/graphql
Headers
# API token je vygenerovaný po prihlásení, posielaný v každej hlavičke.
Authorization: Bearer <token>
Version

1.0.0

Grafický návrh aplikácie

Návrh UX a UI pokrývajúci rozdielne sa správajúce časti: LoyalMAN dizajn.

Technická realizácia diela

LoyalMAN systém je vytvorený ako klient server aplikácia, kde časť s ktorou interaguje používateľ je vytvorená ako single page aplikácia (SPA) v technológii React.js a aplikačná logika je vytvorená v jazyku Python vo verzii 3.8 za pomocou aplikačného rámca Django. Samotné API pre komunikáciu je popísane v tomto dokumente. Aplikačný server je realizovaný pomocou UWSGI a NGINX a je prevádzkovaný na dodávanom virtuálnom serveri založenom na systéme FreeBSD podporujúci prevádzku na virtualizačných technológiách VMware a Hyper-V. Pre nasadzovanie aplikácie sa používa riešenie od Fabric a chyby aplikácie sú sledované pomocou služby Sentry.

Dátový model

Dáta aplikácie sú ukladané v relačnej databáze, aby bolo možné zaručiť reštrikcie pre procesy definované v zadaní. Samotný návrh databázy pokrývajúci všetky obmedzenia je prístupný na nasledovnom linku: LoyalMAN PostgreSQL. Ďalšou dôležitou vlastnosťou databázy vychádzajúcej zo zadania je replikácia. Táto replikácia je zabezpečená pomocou rozšírenia pg_auto_failover, kde sa synchronizujú dáta medzi lokálnou inštaláciou a webovou verziou umožňujúcou prístup k dátam cez webové rozhranie. Táto synchronizácia sa deje automaticky na pozadí a teda nie je potrebný zásah používateľa.

Queries

cardCode

Description

Dotaz vracajúci náhodné číslo karty, ktoré ešte nie je v systéme.

Response

Returns a String

Example

Query
query cardCode {
  cardCode
}
Response
{"data": {"cardCode": "xyz789"}}
Queries

cards

Description

Dotaz vracajúci zoznam kariet.

Response

Returns a CardTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
status - String
code - String
companyName - String
createdAt - DateTime
createdGt - DateTime
createdGte - DateTime
createdLt - DateTime
createdLte - DateTime
expiresAt - DateTime
expiresGt - DateTime
expiresLt - DateTime
discountPackage - String
hideCode - Boolean
any - String

Example

Query
query cards(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $status: String,
  $code: String,
  $companyName: String,
  $createdAt: DateTime,
  $createdGt: DateTime,
  $createdGte: DateTime,
  $createdLt: DateTime,
  $createdLte: DateTime,
  $expiresAt: DateTime,
  $expiresGt: DateTime,
  $expiresLt: DateTime,
  $discountPackage: String,
  $hideCode: Boolean,
  $any: String
) {
  cards(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    status: $status,
    code: $code,
    companyName: $companyName,
    createdAt: $createdAt,
    createdGt: $createdGt,
    createdGte: $createdGte,
    createdLt: $createdLt,
    createdLte: $createdLte,
    expiresAt: $expiresAt,
    expiresGt: $expiresGt,
    expiresLt: $expiresLt,
    discountPackage: $discountPackage,
    hideCode: $hideCode,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CardTypeEdgeFragment
    }
    pdfUrl
    xlsxUrl
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "abc123",
  "after": "abc123",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "status": "xyz789",
  "code": "xyz789",
  "companyName": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "createdGt": "2007-12-03T10:15:30Z",
  "createdGte": "2007-12-03T10:15:30Z",
  "createdLt": "2007-12-03T10:15:30Z",
  "createdLte": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "expiresGt": "2007-12-03T10:15:30Z",
  "expiresLt": "2007-12-03T10:15:30Z",
  "discountPackage": "abc123",
  "hideCode": true,
  "any": "xyz789"
}
Response
{
  "data": {
    "cards": {
      "pageInfo": PageInfo,
      "edges": [CardTypeEdge],
      "pdfUrl": "abc123",
      "xlsxUrl": "xyz789"
    }
  }
}
Queries

cashiers

Description

Dotaz vracajúci zoznam pripojených kás.

Response

Returns a CashierTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String

Example

Query
query cashiers(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String
) {
  cashiers(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CashierTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "xyz789"
}
Response
{
  "data": {
    "cashiers": {
      "pageInfo": PageInfo,
      "edges": [CashierTypeEdge]
    }
  }
}
Queries

changeHistories

Description

Dotaz vracajúci zoznam historických zmien.

Response

Returns a ChangeHistoryTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
entityType - String
entity - String
field - String
valueBefore - String
valueAfter - String
description - String
creator - String
any - String

Example

Query
query changeHistories(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $entityType: String,
  $entity: String,
  $field: String,
  $valueBefore: String,
  $valueAfter: String,
  $description: String,
  $creator: String,
  $any: String
) {
  changeHistories(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    entityType: $entityType,
    entity: $entity,
    field: $field,
    valueBefore: $valueBefore,
    valueAfter: $valueAfter,
    description: $description,
    creator: $creator,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ChangeHistoryTypeEdgeFragment
    }
    pdfUrl
    xlsxUrl
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "entityType": "abc123",
  "entity": "abc123",
  "field": "xyz789",
  "valueBefore": "abc123",
  "valueAfter": "abc123",
  "description": "xyz789",
  "creator": "abc123",
  "any": "abc123"
}
Response
{
  "data": {
    "changeHistories": {
      "pageInfo": PageInfo,
      "edges": [ChangeHistoryTypeEdge],
      "pdfUrl": "abc123",
      "xlsxUrl": "abc123"
    }
  }
}
Queries

companies

Description

Dotaz vracajúci zoznam firiem.

Response

Returns a CompanyTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String

Example

Query
query companies(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String
) {
  companies(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CompanyTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "abc123",
  "first": 987,
  "last": 987,
  "record": "xyz789"
}
Response
{
  "data": {
    "companies": {
      "pageInfo": PageInfo,
      "edges": [CompanyTypeEdge]
    }
  }
}
Queries

currencies

Description

Dotaz vracajúci zoznam mien.

Response

Returns a CurrencyTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
name - String
code - String
any - String

Example

Query
query currencies(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $name: String,
  $code: String,
  $any: String
) {
  currencies(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    name: $name,
    code: $code,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CurrencyTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 987,
  "last": 987,
  "record": "abc123",
  "name": "abc123",
  "code": "abc123",
  "any": "abc123"
}
Response
{
  "data": {
    "currencies": {
      "pageInfo": PageInfo,
      "edges": [CurrencyTypeEdge]
    }
  }
}
Queries

discountPackages

Description

Dotaz vracajúci zoznam zľavových balíčkou.

Response

Returns a DiscountPackageTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
voucher - String
status - String
packageType - String
any - String

Example

Query
query discountPackages(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $voucher: String,
  $status: String,
  $packageType: String,
  $any: String
) {
  discountPackages(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    voucher: $voucher,
    status: $status,
    packageType: $packageType,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...DiscountPackageTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "abc123",
  "first": 987,
  "last": 123,
  "record": "xyz789",
  "voucher": "xyz789",
  "status": "xyz789",
  "packageType": "abc123",
  "any": "xyz789"
}
Response
{
  "data": {
    "discountPackages": {
      "pageInfo": PageInfo,
      "edges": [DiscountPackageTypeEdge]
    }
  }
}
Queries

discounts

Description

Dotaz vracajúci zoznam zliav.

Response

Returns a DiscountTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
discountPackage - String
sale - String
any - String

Example

Query
query discounts(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $discountPackage: String,
  $sale: String,
  $any: String
) {
  discounts(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    discountPackage: $discountPackage,
    sale: $sale,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...DiscountTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 987,
  "record": "abc123",
  "discountPackage": "xyz789",
  "sale": "xyz789",
  "any": "xyz789"
}
Response
{
  "data": {
    "discounts": {
      "pageInfo": PageInfo,
      "edges": [DiscountTypeEdge]
    }
  }
}
Queries

externalGroups

Description

Dotaz vracajúci zoznam skupín z externého systemu.

Response

Returns an ExternalGroupConnection

Arguments
Name Description
record - Int
name - String
category - String
sourceType - ExternalSourceEnum
sourceId - String
before - String
after - String
first - Int
last - Int

Example

Query
query externalGroups(
  $record: Int,
  $name: String,
  $category: String,
  $sourceType: ExternalSourceEnum,
  $sourceId: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  externalGroups(
    record: $record,
    name: $name,
    category: $category,
    sourceType: $sourceType,
    sourceId: $sourceId,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ExternalGroupEdgeFragment
    }
  }
}
Variables
{
  "record": 987,
  "name": "xyz789",
  "category": "abc123",
  "sourceType": "FOODMAN",
  "sourceId": "xyz789",
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "externalGroups": {
      "pageInfo": PageInfo,
      "edges": [ExternalGroupEdge]
    }
  }
}
Queries

externalPayments

Description

Dotaz vracajúci zoznam platidiel z externého systemu.

Response

Returns an ExternalPaymentConnection

Arguments
Name Description
code - String
name - String
sourceType - ExternalSourceEnum
sourceId - String
before - String
after - String
first - Int
last - Int

Example

Query
query externalPayments(
  $code: String,
  $name: String,
  $sourceType: ExternalSourceEnum,
  $sourceId: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  externalPayments(
    code: $code,
    name: $name,
    sourceType: $sourceType,
    sourceId: $sourceId,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ExternalPaymentEdgeFragment
    }
  }
}
Variables
{
  "code": "abc123",
  "name": "xyz789",
  "sourceType": "FOODMAN",
  "sourceId": "abc123",
  "before": "abc123",
  "after": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "externalPayments": {
      "pageInfo": PageInfo,
      "edges": [ExternalPaymentEdge]
    }
  }
}
Queries

externalProducts

Description

Dotaz vracajúci zoznam produktov z externého systemu.

Response

Returns an ExternalProductConnection

Arguments
Name Description
name - String
code - Int
groupId - Int
sourceId - String
sourceType - ExternalSourceEnum
before - String
after - String
first - Int
last - Int

Example

Query
query externalProducts(
  $name: String,
  $code: Int,
  $groupId: Int,
  $sourceId: String,
  $sourceType: ExternalSourceEnum,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  externalProducts(
    name: $name,
    code: $code,
    groupId: $groupId,
    sourceId: $sourceId,
    sourceType: $sourceType,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ExternalProductEdgeFragment
    }
  }
}
Variables
{
  "name": "xyz789",
  "code": 123,
  "groupId": 123,
  "sourceId": "abc123",
  "sourceType": "FOODMAN",
  "before": "abc123",
  "after": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "externalProducts": {
      "pageInfo": PageInfo,
      "edges": [ExternalProductEdge]
    }
  }
}
Queries

holders

Description

Dotaz vracajúci zoznam majiteľov kariet.

Response

Returns a HolderTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
any - String

Example

Query
query holders(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $any: String
) {
  holders(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...HolderTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "any": "xyz789"
}
Response
{
  "data": {
    "holders": {
      "pageInfo": PageInfo,
      "edges": [HolderTypeEdge]
    }
  }
}
Queries

operations

Description

Dotaz vracajúci zoznam operácii.

Response

Returns an OperationTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
name - String
any - String

Example

Query
query operations(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $name: String,
  $any: String
) {
  operations(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    name: $name,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...OperationTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 987,
  "record": "xyz789",
  "name": "abc123",
  "any": "abc123"
}
Response
{
  "data": {
    "operations": {
      "pageInfo": PageInfo,
      "edges": [OperationTypeEdge]
    }
  }
}
Queries

organisations

Description

Dotaz vracajúci zoznam organizácii.

Response

Returns an OrganisationTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
name - String

Example

Query
query organisations(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $name: String
) {
  organisations(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    name: $name
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...OrganisationTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "name": "abc123"
}
Response
{
  "data": {
    "organisations": {
      "pageInfo": PageInfo,
      "edges": [OrganisationTypeEdge]
    }
  }
}
Queries

packageRules

Description

Dotaz vracajúci zoznam pravidiel pre balík.

Response

Returns a PackageRuleTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
wallet - String
discountPackage - String
sale - String
any - String

Example

Query
query packageRules(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $wallet: String,
  $discountPackage: String,
  $sale: String,
  $any: String
) {
  packageRules(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    wallet: $wallet,
    discountPackage: $discountPackage,
    sale: $sale,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...PackageRuleTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "abc123",
  "after": "abc123",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "wallet": "abc123",
  "discountPackage": "abc123",
  "sale": "xyz789",
  "any": "abc123"
}
Response
{
  "data": {
    "packageRules": {
      "pageInfo": PageInfo,
      "edges": [PackageRuleTypeEdge]
    }
  }
}
Queries

permissions

Description

Dotaz vracajúci zoznam privilégii.

Response

Returns a PermissionTypeConnection

Arguments
Name Description
before - String
after - String
first - Int
last - Int
record - String
role - String

Example

Query
query permissions(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $role: String
) {
  permissions(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    role: $role
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...PermissionTypeEdgeFragment
    }
  }
}
Variables
{
  "before": "xyz789",
  "after": "xyz789",
  "first": 987,
  "last": 987,
  "record": "abc123",
  "role": "xyz789"
}
Response
{
  "data": {
    "permissions": {
      "pageInfo": PageInfo,
      "edges": [PermissionTypeEdge]
    }
  }
}
Queries

products

Description

Dotaz vracajúci predplatené produkty.

Response

Returns a ProductPrepaymentTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
name - String
company - String
cashier - String
createdAt - DateTime
createdGt - DateTime
createdGte - DateTime
createdLt - DateTime
createdLte - DateTime
expiresAt - DateTime
expiresGt - DateTime
expiresLt - DateTime
expiresGte - DateTime
expiresLte - DateTime
hideCode - Boolean
transactionsFromDate - Date
transactionsToDate - Date
any - String

Example

Query
query products(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $name: String,
  $company: String,
  $cashier: String,
  $createdAt: DateTime,
  $createdGt: DateTime,
  $createdGte: DateTime,
  $createdLt: DateTime,
  $createdLte: DateTime,
  $expiresAt: DateTime,
  $expiresGt: DateTime,
  $expiresLt: DateTime,
  $expiresGte: DateTime,
  $expiresLte: DateTime,
  $hideCode: Boolean,
  $transactionsFromDate: Date,
  $transactionsToDate: Date,
  $any: String
) {
  products(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    name: $name,
    company: $company,
    cashier: $cashier,
    createdAt: $createdAt,
    createdGt: $createdGt,
    createdGte: $createdGte,
    createdLt: $createdLt,
    createdLte: $createdLte,
    expiresAt: $expiresAt,
    expiresGt: $expiresGt,
    expiresLt: $expiresLt,
    expiresGte: $expiresGte,
    expiresLte: $expiresLte,
    hideCode: $hideCode,
    transactionsFromDate: $transactionsFromDate,
    transactionsToDate: $transactionsToDate,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...ProductPrepaymentTypeEdgeFragment
    }
    pdfUrl
    xlsxUrl
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 987,
  "last": 123,
  "record": "xyz789",
  "name": "xyz789",
  "company": "abc123",
  "cashier": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "createdGt": "2007-12-03T10:15:30Z",
  "createdGte": "2007-12-03T10:15:30Z",
  "createdLt": "2007-12-03T10:15:30Z",
  "createdLte": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "expiresGt": "2007-12-03T10:15:30Z",
  "expiresLt": "2007-12-03T10:15:30Z",
  "expiresGte": "2007-12-03T10:15:30Z",
  "expiresLte": "2007-12-03T10:15:30Z",
  "hideCode": true,
  "transactionsFromDate": "2007-12-03",
  "transactionsToDate": "2007-12-03",
  "any": "abc123"
}
Response
{
  "data": {
    "products": {
      "pageInfo": PageInfo,
      "edges": [ProductPrepaymentTypeEdge],
      "pdfUrl": "xyz789",
      "xlsxUrl": "abc123"
    }
  }
}
Queries

sales

Description

Dotaz vracajúci zoznam zliav.

Response

Returns a SaleTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
voucherId - String
status - String
saleType - String
companyName - String
any - String

Example

Query
query sales(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $voucherId: String,
  $status: String,
  $saleType: String,
  $companyName: String,
  $any: String
) {
  sales(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    voucherId: $voucherId,
    status: $status,
    saleType: $saleType,
    companyName: $companyName,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SaleTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "xyz789",
  "after": "abc123",
  "first": 987,
  "last": 987,
  "record": "xyz789",
  "voucherId": "abc123",
  "status": "abc123",
  "saleType": "xyz789",
  "companyName": "xyz789",
  "any": "abc123"
}
Response
{
  "data": {
    "sales": {
      "pageInfo": PageInfo,
      "edges": [SaleTypeEdge]
    }
  }
}
Queries

settings

Description

Dotaz vracajúci nastavenia systému.

Response

Returns a SettingTypeConnection

Arguments
Name Description
before - String
after - String
first - Int
last - Int
record - String
name - String

Example

Query
query settings(
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $name: String
) {
  settings(
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    name: $name
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SettingTypeEdgeFragment
    }
  }
}
Variables
{
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "name": "abc123"
}
Response
{
  "data": {
    "settings": {
      "pageInfo": PageInfo,
      "edges": [SettingTypeEdge]
    }
  }
}
Queries

transactions

Description

Dotaz vracajúci zoznam translakcií.

Response

Returns a TransactionTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
transaction - Float
transactionType - String
transactionGt - Float
transactionLt - Float
currency - String
operationName - String
walletId - String
walletName - String
userWalletId - String
createdAt - Date
createdGt - Date
createdLt - Date
userId - String
creatorId - String
userFullName - String
creatorFullName - String
voucherName - String
organisation - String
cashierName - String
source - String
work - String
identification - String
userEmail - String
creatorEmail - String
fromDate - Date
toDate - Date
any - String

Example

Query
query transactions(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $transaction: Float,
  $transactionType: String,
  $transactionGt: Float,
  $transactionLt: Float,
  $currency: String,
  $operationName: String,
  $walletId: String,
  $walletName: String,
  $userWalletId: String,
  $createdAt: Date,
  $createdGt: Date,
  $createdLt: Date,
  $userId: String,
  $creatorId: String,
  $userFullName: String,
  $creatorFullName: String,
  $voucherName: String,
  $organisation: String,
  $cashierName: String,
  $source: String,
  $work: String,
  $identification: String,
  $userEmail: String,
  $creatorEmail: String,
  $fromDate: Date,
  $toDate: Date,
  $any: String
) {
  transactions(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    transaction: $transaction,
    transactionType: $transactionType,
    transactionGt: $transactionGt,
    transactionLt: $transactionLt,
    currency: $currency,
    operationName: $operationName,
    walletId: $walletId,
    walletName: $walletName,
    userWalletId: $userWalletId,
    createdAt: $createdAt,
    createdGt: $createdGt,
    createdLt: $createdLt,
    userId: $userId,
    creatorId: $creatorId,
    userFullName: $userFullName,
    creatorFullName: $creatorFullName,
    voucherName: $voucherName,
    organisation: $organisation,
    cashierName: $cashierName,
    source: $source,
    work: $work,
    identification: $identification,
    userEmail: $userEmail,
    creatorEmail: $creatorEmail,
    fromDate: $fromDate,
    toDate: $toDate,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...TransactionTypeEdgeFragment
    }
    detailedUserPdfUrl
    detailedUserXlsxUrl
    summaryUserPdfUrl
    summaryUserXlsxUrl
    detailedDatePdfUrl
    detailedDateXlsxUrl
    summaryDatePdfUrl
    summaryDateXlsxUrl
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "abc123",
  "first": 123,
  "last": 987,
  "record": "xyz789",
  "transaction": 123.45,
  "transactionType": "xyz789",
  "transactionGt": 987.65,
  "transactionLt": 123.45,
  "currency": "abc123",
  "operationName": "abc123",
  "walletId": "abc123",
  "walletName": "abc123",
  "userWalletId": "abc123",
  "createdAt": "2007-12-03",
  "createdGt": "2007-12-03",
  "createdLt": "2007-12-03",
  "userId": "abc123",
  "creatorId": "xyz789",
  "userFullName": "abc123",
  "creatorFullName": "xyz789",
  "voucherName": "xyz789",
  "organisation": "abc123",
  "cashierName": "abc123",
  "source": "abc123",
  "work": "xyz789",
  "identification": "abc123",
  "userEmail": "xyz789",
  "creatorEmail": "abc123",
  "fromDate": "2007-12-03",
  "toDate": "2007-12-03",
  "any": "xyz789"
}
Response
{
  "data": {
    "transactions": {
      "pageInfo": PageInfo,
      "edges": [TransactionTypeEdge],
      "detailedUserPdfUrl": "abc123",
      "detailedUserXlsxUrl": "xyz789",
      "summaryUserPdfUrl": "abc123",
      "summaryUserXlsxUrl": "xyz789",
      "detailedDatePdfUrl": "abc123",
      "detailedDateXlsxUrl": "xyz789",
      "summaryDatePdfUrl": "abc123",
      "summaryDateXlsxUrl": "xyz789"
    }
  }
}
Queries

userWallets

Description

Dotaz vracajúci zoznam peňaženiek používatľov.

Response

Returns a UserWalletTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
id - UUID
deletedAt - DateTime
updatedAt - DateTime
createdAt - DateTime
balance - Int
wallet - ID
user - String
record - String
status - String
role - String
organisation - String
organisationName - String
packageName - String
packages - String
any - String
balanceToDate - Date
walletBalanceGte - Float
walletBalanceLte - Float

Example

Query
query userWallets(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $id: UUID,
  $deletedAt: DateTime,
  $updatedAt: DateTime,
  $createdAt: DateTime,
  $balance: Int,
  $wallet: ID,
  $user: String,
  $record: String,
  $status: String,
  $role: String,
  $organisation: String,
  $organisationName: String,
  $packageName: String,
  $packages: String,
  $any: String,
  $balanceToDate: Date,
  $walletBalanceGte: Float,
  $walletBalanceLte: Float
) {
  userWallets(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    id: $id,
    deletedAt: $deletedAt,
    updatedAt: $updatedAt,
    createdAt: $createdAt,
    balance: $balance,
    wallet: $wallet,
    user: $user,
    record: $record,
    status: $status,
    role: $role,
    organisation: $organisation,
    organisationName: $organisationName,
    packageName: $packageName,
    packages: $packages,
    any: $any,
    balanceToDate: $balanceToDate,
    walletBalanceGte: $walletBalanceGte,
    walletBalanceLte: $walletBalanceLte
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...UserWalletTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 987,
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "balance": 987,
  "wallet": 4,
  "user": "abc123",
  "record": "xyz789",
  "status": "abc123",
  "role": "xyz789",
  "organisation": "abc123",
  "organisationName": "xyz789",
  "packageName": "abc123",
  "packages": "abc123",
  "any": "abc123",
  "balanceToDate": "2007-12-03",
  "walletBalanceGte": 123.45,
  "walletBalanceLte": 987.65
}
Response
{
  "data": {
    "userWallets": {
      "pageInfo": PageInfo,
      "edges": [UserWalletTypeEdge]
    }
  }
}
Queries

users

Description

Dotaz vracajúci zoznam používateľov.

Response

Returns a UserTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
lastLogin - DateTime
groups - [ID]
userPermissions - [ID]
id - UUID
deletedAt - DateTime
updatedAt - DateTime
createdAt - DateTime
personalNumb - Int
username - String
name - String
surname - String
gender - String
status - String
statusMessage - String
email - String
phoneNumber - String
address - String
job - String
perpetuation - Int
infMail - Boolean
infApprove - Boolean
isActive - Boolean
isSuperuser - Boolean
password - String
company - ID
organisation - String
work - String
validTill - Date
record - String
age - Float
packageName - String
packages - String
productPrepaymentName - String
productPrepayments - String
walletBalance - Float
walletBalanceGt - Float
walletBalanceGte - Float
walletBalanceLt - Float
walletBalanceLte - Float
walletType - String
hasCards - Boolean
nonzeroUsers - Boolean
card - String
any - String
fullName - String
role - String
minAmount - Float
transactionsFromDate - Date
transactionsToDate - Date
balanceFromDate - Date
balanceToDate - Date
hideCode - Boolean

Example

Query
query users(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $lastLogin: DateTime,
  $groups: [ID],
  $userPermissions: [ID],
  $id: UUID,
  $deletedAt: DateTime,
  $updatedAt: DateTime,
  $createdAt: DateTime,
  $personalNumb: Int,
  $username: String,
  $name: String,
  $surname: String,
  $gender: String,
  $status: String,
  $statusMessage: String,
  $email: String,
  $phoneNumber: String,
  $address: String,
  $job: String,
  $perpetuation: Int,
  $infMail: Boolean,
  $infApprove: Boolean,
  $isActive: Boolean,
  $isSuperuser: Boolean,
  $password: String,
  $company: ID,
  $organisation: String,
  $work: String,
  $validTill: Date,
  $record: String,
  $age: Float,
  $packageName: String,
  $packages: String,
  $productPrepaymentName: String,
  $productPrepayments: String,
  $walletBalance: Float,
  $walletBalanceGt: Float,
  $walletBalanceGte: Float,
  $walletBalanceLt: Float,
  $walletBalanceLte: Float,
  $walletType: String,
  $hasCards: Boolean,
  $nonzeroUsers: Boolean,
  $card: String,
  $any: String,
  $fullName: String,
  $role: String,
  $minAmount: Float,
  $transactionsFromDate: Date,
  $transactionsToDate: Date,
  $balanceFromDate: Date,
  $balanceToDate: Date,
  $hideCode: Boolean
) {
  users(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    lastLogin: $lastLogin,
    groups: $groups,
    userPermissions: $userPermissions,
    id: $id,
    deletedAt: $deletedAt,
    updatedAt: $updatedAt,
    createdAt: $createdAt,
    personalNumb: $personalNumb,
    username: $username,
    name: $name,
    surname: $surname,
    gender: $gender,
    status: $status,
    statusMessage: $statusMessage,
    email: $email,
    phoneNumber: $phoneNumber,
    address: $address,
    job: $job,
    perpetuation: $perpetuation,
    infMail: $infMail,
    infApprove: $infApprove,
    isActive: $isActive,
    isSuperuser: $isSuperuser,
    password: $password,
    company: $company,
    organisation: $organisation,
    work: $work,
    validTill: $validTill,
    record: $record,
    age: $age,
    packageName: $packageName,
    packages: $packages,
    productPrepaymentName: $productPrepaymentName,
    productPrepayments: $productPrepayments,
    walletBalance: $walletBalance,
    walletBalanceGt: $walletBalanceGt,
    walletBalanceGte: $walletBalanceGte,
    walletBalanceLt: $walletBalanceLt,
    walletBalanceLte: $walletBalanceLte,
    walletType: $walletType,
    hasCards: $hasCards,
    nonzeroUsers: $nonzeroUsers,
    card: $card,
    any: $any,
    fullName: $fullName,
    role: $role,
    minAmount: $minAmount,
    transactionsFromDate: $transactionsFromDate,
    transactionsToDate: $transactionsToDate,
    balanceFromDate: $balanceFromDate,
    balanceToDate: $balanceToDate,
    hideCode: $hideCode
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...UserTypeEdgeFragment
    }
    userListPdfUrl
    userListXlsxUrl
    balancePdfUrl
    balanceXlsxUrl
    collectPdfUrl
    collectXlsxUrl
    cardPdfUrl
    cardXlsxUrl
    productPrepaymentsPdfUrl
    productPrepaymentsXlsxUrl
    productPrepaymentsTransactionsPdfUrl
    productPrepaymentsTransactionsXlsxUrl
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "lastLogin": "2007-12-03T10:15:30Z",
  "groups": [4],
  "userPermissions": [4],
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "personalNumb": 987,
  "username": "abc123",
  "name": "abc123",
  "surname": "xyz789",
  "gender": "abc123",
  "status": "abc123",
  "statusMessage": "xyz789",
  "email": "xyz789",
  "phoneNumber": "abc123",
  "address": "xyz789",
  "job": "xyz789",
  "perpetuation": 123,
  "infMail": true,
  "infApprove": false,
  "isActive": false,
  "isSuperuser": false,
  "password": "xyz789",
  "company": "4",
  "organisation": "xyz789",
  "work": "abc123",
  "validTill": "2007-12-03",
  "record": "abc123",
  "age": 987.65,
  "packageName": "xyz789",
  "packages": "abc123",
  "productPrepaymentName": "xyz789",
  "productPrepayments": "xyz789",
  "walletBalance": 987.65,
  "walletBalanceGt": 123.45,
  "walletBalanceGte": 987.65,
  "walletBalanceLt": 123.45,
  "walletBalanceLte": 123.45,
  "walletType": "xyz789",
  "hasCards": true,
  "nonzeroUsers": true,
  "card": "abc123",
  "any": "abc123",
  "fullName": "abc123",
  "role": "xyz789",
  "minAmount": 123.45,
  "transactionsFromDate": "2007-12-03",
  "transactionsToDate": "2007-12-03",
  "balanceFromDate": "2007-12-03",
  "balanceToDate": "2007-12-03",
  "hideCode": false
}
Response
{
  "data": {
    "users": {
      "pageInfo": PageInfo,
      "edges": [UserTypeEdge],
      "userListPdfUrl": "xyz789",
      "userListXlsxUrl": "xyz789",
      "balancePdfUrl": "abc123",
      "balanceXlsxUrl": "xyz789",
      "collectPdfUrl": "abc123",
      "collectXlsxUrl": "abc123",
      "cardPdfUrl": "xyz789",
      "cardXlsxUrl": "xyz789",
      "productPrepaymentsPdfUrl": "abc123",
      "productPrepaymentsXlsxUrl": "xyz789",
      "productPrepaymentsTransactionsPdfUrl": "abc123",
      "productPrepaymentsTransactionsXlsxUrl": "abc123"
    }
  }
}
Queries

viewer

Response

Returns a UserType

Example

Query
query viewer {
  viewer {
    id
    deletedAt
    updatedAt
    createdAt
    lastLogin
    userPermissions {
      ...PermissionTypeConnectionFragment
    }
    personalNumb
    username
    name
    surname
    gender
    status
    statusMessage
    email
    phoneNumber
    address
    job
    profilePic
    perpetuation
    infMail
    infApprove
    isActive
    isSuperuser
    password
    company {
      ...CompanyTypeFragment
    }
    organisation {
      ...OrganisationTypeFragment
    }
    extraData
    work
    validTill
    logs {
      ...LogEntryTypeFragment
    }
    createdDiscountPackages {
      ...DiscountPackageTypeConnectionFragment
    }
    createdWallets {
      ...WalletTypeConnectionFragment
    }
    userWallets {
      ...UserWalletTypeConnectionFragment
    }
    holders {
      ...HolderTypeConnectionFragment
    }
    myCards {
      ...CardTypeConnectionFragment
    }
    createdCards {
      ...CardTypeConnectionFragment
    }
    sales {
      ...SaleTypeConnectionFragment
    }
    createdSales {
      ...SaleTypeConnectionFragment
    }
    createdProductPrepayments {
      ...ProductPrepaymentTypeConnectionFragment
    }
    productPrepaymentsUsers {
      ...ProductPrepaymentUserTypeFragment
    }
    createdVouchers {
      ...VoucherTypeConnectionFragment
    }
    myTransactions {
      ...TransactionTypeConnectionFragment
    }
    createdTransactions {
      ...TransactionTypeConnectionFragment
    }
    userDiscountPackages {
      ...UserDiscountPackageTypeFragment
    }
    createdRegistrationCodes {
      ...RegistrationCodeTypeFragment
    }
    tokens {
      ...TokenTypeFragment
    }
    changes {
      ...ChangeHistoryTypeConnectionFragment
    }
    changedStatuses {
      ...ChangeHistoryTypeConnectionFragment
    }
    dinerGroups {
      ...DinerGroupTypeFragment
    }
    diners {
      ...DinerTypeFragment
    }
    record
    fullName
    role
    permissions
    cardCount
  }
}
Response
{
  "data": {
    "viewer": {
      "id": 4,
      "deletedAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "createdAt": "2007-12-03T10:15:30Z",
      "lastLogin": "2007-12-03T10:15:30Z",
      "userPermissions": PermissionTypeConnection,
      "personalNumb": 123,
      "username": "abc123",
      "name": "abc123",
      "surname": "abc123",
      "gender": "MALE",
      "status": "ACTIVE",
      "statusMessage": "xyz789",
      "email": "abc123",
      "phoneNumber": "abc123",
      "address": "xyz789",
      "job": "abc123",
      "profilePic": "abc123",
      "perpetuation": 123,
      "infMail": true,
      "infApprove": false,
      "isActive": true,
      "isSuperuser": true,
      "password": "abc123",
      "company": CompanyType,
      "organisation": OrganisationType,
      "extraData": GenericScalar,
      "work": "xyz789",
      "validTill": "2007-12-03",
      "logs": [LogEntryType],
      "createdDiscountPackages": DiscountPackageTypeConnection,
      "createdWallets": WalletTypeConnection,
      "userWallets": UserWalletTypeConnection,
      "holders": HolderTypeConnection,
      "myCards": CardTypeConnection,
      "createdCards": CardTypeConnection,
      "sales": SaleTypeConnection,
      "createdSales": SaleTypeConnection,
      "createdProductPrepayments": ProductPrepaymentTypeConnection,
      "productPrepaymentsUsers": [
        ProductPrepaymentUserType
      ],
      "createdVouchers": VoucherTypeConnection,
      "myTransactions": TransactionTypeConnection,
      "createdTransactions": TransactionTypeConnection,
      "userDiscountPackages": [UserDiscountPackageType],
      "createdRegistrationCodes": [RegistrationCodeType],
      "tokens": [TokenType],
      "changes": ChangeHistoryTypeConnection,
      "changedStatuses": ChangeHistoryTypeConnection,
      "dinerGroups": [DinerGroupType],
      "diners": [DinerType],
      "record": "abc123",
      "fullName": "xyz789",
      "role": "xyz789",
      "permissions": GenericScalar,
      "cardCount": 987
    }
  }
}
Queries

voucherCodes

Description

Dotaz vracajúci zoznam zľavových kódov.

Response

Returns a VoucherCodeTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
available - Boolean

Example

Query
query voucherCodes(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $available: Boolean
) {
  voucherCodes(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    available: $available
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...VoucherCodeTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["abc123"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "abc123",
  "available": false
}
Response
{
  "data": {
    "voucherCodes": {
      "pageInfo": PageInfo,
      "edges": [VoucherCodeTypeEdge]
    }
  }
}
Queries

vouchers

Description

Dotaz vracajúci zoznam voucherov.

Response

Returns a VoucherTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
status - String
used - Float
usedGt - Float
usedLt - Float
capacity - Float
capacityGt - Float
capacityLt - Float
sale - String
user - String
any - String

Example

Query
query vouchers(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $status: String,
  $used: Float,
  $usedGt: Float,
  $usedLt: Float,
  $capacity: Float,
  $capacityGt: Float,
  $capacityLt: Float,
  $sale: String,
  $user: String,
  $any: String
) {
  vouchers(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    status: $status,
    used: $used,
    usedGt: $usedGt,
    usedLt: $usedLt,
    capacity: $capacity,
    capacityGt: $capacityGt,
    capacityLt: $capacityLt,
    sale: $sale,
    user: $user,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...VoucherTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "abc123",
  "first": 123,
  "last": 987,
  "record": "abc123",
  "status": "xyz789",
  "used": 123.45,
  "usedGt": 123.45,
  "usedLt": 987.65,
  "capacity": 987.65,
  "capacityGt": 123.45,
  "capacityLt": 123.45,
  "sale": "abc123",
  "user": "xyz789",
  "any": "xyz789"
}
Response
{
  "data": {
    "vouchers": {
      "pageInfo": PageInfo,
      "edges": [VoucherTypeEdge]
    }
  }
}
Queries

wallets

Description

Dotaz vracajúci zoznam peňaženiek.

Response

Returns a WalletTypeConnection

Arguments
Name Description
orderBy - [String]
before - String
after - String
first - Int
last - Int
record - String
discountPackage - String
walletType - String
any - String

Example

Query
query wallets(
  $orderBy: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $record: String,
  $discountPackage: String,
  $walletType: String,
  $any: String
) {
  wallets(
    orderBy: $orderBy,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    record: $record,
    discountPackage: $discountPackage,
    walletType: $walletType,
    any: $any
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...WalletTypeEdgeFragment
    }
  }
}
Variables
{
  "orderBy": ["xyz789"],
  "before": "abc123",
  "after": "xyz789",
  "first": 123,
  "last": 123,
  "record": "xyz789",
  "discountPackage": "xyz789",
  "walletType": "abc123",
  "any": "xyz789"
}
Response
{
  "data": {
    "wallets": {
      "pageInfo": PageInfo,
      "edges": [WalletTypeEdge]
    }
  }
}

Mutations

cancelTransaction

Description

Mutácia pre zrušenie konkrétnej transakcie alebo skupiny transakcíi, ktoré boli vykonané (napríklad storno účtu).

Response

Returns a CancelTransactionMutate

Arguments
Name Description
data - CancelTransactionInput!

Example

Query
mutation cancelTransaction($data: CancelTransactionInput!) {
  cancelTransaction(data: $data) {
    transactions {
      ...TransactionTypeFragment
    }
    metadata
  }
}
Variables
{"data": CancelTransactionInput}
Response
{
  "data": {
    "cancelTransaction": {
      "transactions": [TransactionType],
      "metadata": GenericScalar
    }
  }
}
Mutations

card

Description

Mutácia slúži na definíciu kariet na ktoré sú asociované balíčky zliav. Tieto karty su priradzované zákazníkom.

Response

Returns a CardMutate

Arguments
Name Description
data - CardInput!

Example

Query
mutation card($data: CardInput!) {
  card(data: $data) {
    card {
      ...CardTypeFragment
    }
  }
}
Variables
{"data": CardInput}
Response
{"data": {"card": {"card": [CardType]}}}
Mutations

company

Description

Mutácia slúži na definovanie spoločností a ich základných nastavení systéme.

Response

Returns a CompanyMutate

Arguments
Name Description
data - SetupCompanyInput!

Example

Query
mutation company($data: SetupCompanyInput!) {
  company(data: $data) {
    currencies {
      ...CurrencyTypeFragment
    }
    countries {
      ...CountryTypeFragment
    }
    company {
      ...CompanyTypeFragment
    }
  }
}
Variables
{"data": SetupCompanyInput}
Response
{
  "data": {
    "company": {
      "currencies": [CurrencyType],
      "countries": [CountryType],
      "company": CompanyType
    }
  }
}
Mutations

consumerActivate

Response

Returns a ConsumerActivateMutate

Arguments
Name Description
data - ConsumerActivateInput!

Example

Query
mutation consumerActivate($data: ConsumerActivateInput!) {
  consumerActivate(data: $data) {
    consumer {
      ...UserTypeFragment
    }
  }
}
Variables
{"data": ConsumerActivateInput}
Response
{"data": {"consumerActivate": {"consumer": UserType}}}
Mutations

consumerParagon

Response

Returns a ConsumerParagonMutate

Arguments
Name Description
data - ConsumerParagonInput!

Example

Query
mutation consumerParagon($data: ConsumerParagonInput!) {
  consumerParagon(data: $data) {
    registrationCode {
      ...RegistrationCodeTypeFragment
    }
  }
}
Variables
{"data": ConsumerParagonInput}
Response
{
  "data": {
    "consumerParagon": {
      "registrationCode": RegistrationCodeType
    }
  }
}
Mutations

currenciesCreate

Description

Mutácia slúži na pridávanie systémových mien.

Response

Returns a CurrencyCreateMutate

Arguments
Name Description
data - CurrenciesCreateInput!

Example

Query
mutation currenciesCreate($data: CurrenciesCreateInput!) {
  currenciesCreate(data: $data) {
    currencies {
      ...CurrencyTypeFragment
    }
  }
}
Variables
{"data": CurrenciesCreateInput}
Response
{
  "data": {
    "currenciesCreate": {"currencies": [CurrencyType]}
  }
}
Mutations

currenciesDelete

Description

Mutácia slúži na zmazanie systémových mien.

Response

Returns a CurrencyDeleteMutate

Arguments
Name Description
data - CurrencyDeleteInput!

Example

Query
mutation currenciesDelete($data: CurrencyDeleteInput!) {
  currenciesDelete(data: $data) {
    currencies {
      ...CurrencyTypeFragment
    }
  }
}
Variables
{"data": CurrencyDeleteInput}
Response
{
  "data": {
    "currenciesDelete": {"currencies": [CurrencyType]}
  }
}
Mutations

currenciesUpdate

Description

Mutácia slúži na menenie systémových mien.

Response

Returns a CurrencyUpdateMutate

Arguments
Name Description
data - CurrenciesUpdateInput!

Example

Query
mutation currenciesUpdate($data: CurrenciesUpdateInput!) {
  currenciesUpdate(data: $data) {
    currencies {
      ...CurrencyTypeFragment
    }
  }
}
Variables
{"data": CurrenciesUpdateInput}
Response
{
  "data": {
    "currenciesUpdate": {"currencies": [CurrencyType]}
  }
}
Mutations

deleteMultipleCards

Description

Mutácia slúži na hromadné zrušenie kariet.

Response

Returns a DeleteMultipleCardsMutate

Arguments
Name Description
data - DeleteMultipleCardsInput!

Example

Query
mutation deleteMultipleCards($data: DeleteMultipleCardsInput!) {
  deleteMultipleCards(data: $data) {
    cards {
      ...CardTypeFragment
    }
  }
}
Variables
{"data": DeleteMultipleCardsInput}
Response
{"data": {"deleteMultipleCards": {"cards": [CardType]}}}
Mutations

deleteMultipleUsers

Description

Mutácia slúži na hromadné mazanie používateľov.

Response

Returns a DeleteMultipleUsersMutate

Arguments
Name Description
data - DeleteMultipleUsersInput!

Example

Query
mutation deleteMultipleUsers($data: DeleteMultipleUsersInput!) {
  deleteMultipleUsers(data: $data) {
    users {
      ...UserTypeFragment
    }
  }
}
Variables
{"data": DeleteMultipleUsersInput}
Response
{"data": {"deleteMultipleUsers": {"users": [UserType]}}}
Mutations

discount

Description

Mutácia slúži na definíciu jednotlivých pravidiel zľavy.

Response

Returns a DiscountMutate

Arguments
Name Description
data - DiscountInput!

Example

Query
mutation discount($data: DiscountInput!) {
  discount(data: $data) {
    discount {
      ...DiscountTypeFragment
    }
  }
}
Variables
{"data": DiscountInput}
Response
{"data": {"discount": {"discount": DiscountType}}}
Mutations

discountPackage

Description

Mutácia slúži na definovanie zľavových balíčkov.

Response

Returns a DiscountPackageMutate

Arguments
Name Description
data - DiscountPackageInput!

Example

Query
mutation discountPackage($data: DiscountPackageInput!) {
  discountPackage(data: $data) {
    discountPackage {
      ...DiscountPackageTypeFragment
    }
  }
}
Variables
{"data": DiscountPackageInput}
Response
{
  "data": {
    "discountPackage": {
      "discountPackage": DiscountPackageType
    }
  }
}
Mutations

holder

Description

Mutácia slúži na manažovanie držiteľov kariet.

Response

Returns a HolderMutate

Arguments
Name Description
data - HolderInput!

Example

Query
mutation holder($data: HolderInput!) {
  holder(data: $data) {
    holder {
      ...HolderTypeFragment
    }
  }
}
Variables
{"data": HolderInput}
Response
{"data": {"holder": {"holder": HolderType}}}
Mutations

importer

Response

Returns an ImporterMutate

Arguments
Name Description
data - ImporterInput!

Example

Query
mutation importer($data: ImporterInput!) {
  importer(data: $data) {
    fileName
  }
}
Variables
{"data": ImporterInput}
Response
{
  "data": {
    "importer": {"fileName": "abc123"}
  }
}
Mutations

operation

Description

Mutácia slúži na definovanie operácii, ktoré sa dajú v sytéme vykonávať.

Response

Returns an OperationMutate

Arguments
Name Description
data - OperationInput!

Example

Query
mutation operation($data: OperationInput!) {
  operation(data: $data) {
    operation {
      ...OperationTypeFragment
    }
  }
}
Variables
{"data": OperationInput}
Response
{"data": {"operation": {"operation": OperationType}}}
Mutations

organisation

Response

Returns an OrganisationMutate

Arguments
Name Description
data - OrganisationInput!

Example

Query
mutation organisation($data: OrganisationInput!) {
  organisation(data: $data) {
    organisation {
      ...OrganisationTypeFragment
    }
  }
}
Variables
{"data": OrganisationInput}
Response
{
  "data": {
    "organisation": {"organisation": OrganisationType}
  }
}
Mutations

packageRule

Description

Mutácia slúži na definovanie pravidiel pre balíčky zliav.

Response

Returns a PackageRuleMutate

Arguments
Name Description
data - PackageRuleInput!

Example

Query
mutation packageRule($data: PackageRuleInput!) {
  packageRule(data: $data) {
    packageRule {
      ...PackageRuleTypeFragment
    }
  }
}
Variables
{"data": PackageRuleInput}
Response
{
  "data": {
    "packageRule": {"packageRule": PackageRuleType}
  }
}
Mutations

packageStrategist

Description

Mutácia slúži na zistenie dostupých zliav pre používateľa s kartou.

Response

Returns a PackageStrategistMutate

Arguments
Name Description
data - TransactionInput!

Example

Query
mutation packageStrategist($data: TransactionInput!) {
  packageStrategist(data: $data) {
    package {
      ...PackageStrategyTypeFragment
    }
  }
}
Variables
{"data": TransactionInput}
Response
{
  "data": {
    "packageStrategist": {"package": PackageStrategyType}
  }
}
Mutations

productPrepayment

Description

Mutácia slúži na definovanie balíkov predplatených produktov.

Response

Returns a ProductPrepaymentMutate

Arguments
Name Description
data - ProductPrepaymentInput!

Example

Query
mutation productPrepayment($data: ProductPrepaymentInput!) {
  productPrepayment(data: $data) {
    productPrepayment {
      ...ProductPrepaymentTypeFragment
    }
  }
}
Variables
{"data": ProductPrepaymentInput}
Response
{
  "data": {
    "productPrepayment": {
      "productPrepayment": ProductPrepaymentType
    }
  }
}
Mutations

productPrepaymentUser

Description

Mutácia slúži na priradzovanie predplatených produktov používateľom.

Response

Returns a ProductPrepaymentUserMutate

Arguments
Name Description
data - ProductPrepaymentUserInput!

Example

Query
mutation productPrepaymentUser($data: ProductPrepaymentUserInput!) {
  productPrepaymentUser(data: $data) {
    productPrepaymentUser {
      ...ProductPrepaymentUserTypeFragment
    }
  }
}
Variables
{"data": ProductPrepaymentUserInput}
Response
{
  "data": {
    "productPrepaymentUser": {
      "productPrepaymentUser": ProductPrepaymentUserType
    }
  }
}
Mutations

productRule

Description

Mutácia slúži na definovanie pravidiel pre predplatené produkty.

Response

Returns a ProductRuleMutate

Arguments
Name Description
data - ProductRuleInput!

Example

Query
mutation productRule($data: ProductRuleInput!) {
  productRule(data: $data) {
    productRule {
      ...ProductRuleTypeFragment
    }
  }
}
Variables
{"data": ProductRuleInput}
Response
{
  "data": {
    "productRule": {"productRule": ProductRuleType}
  }
}
Mutations

refreshToken

Response

Returns a Refresh

Arguments
Name Description
token - String!

Example

Query
mutation refreshToken($token: String!) {
  refreshToken(token: $token) {
    token
    payload
  }
}
Variables
{"token": "abc123"}
Response
{
  "data": {
    "refreshToken": {
      "token": "abc123",
      "payload": GenericScalar
    }
  }
}
Mutations

sale

Description

Mutácia slúži na manažovanie verejných zliav.

Response

Returns a SaleMutate

Arguments
Name Description
data - SaleInput!

Example

Query
mutation sale($data: SaleInput!) {
  sale(data: $data) {
    sale {
      ...SaleTypeFragment
    }
  }
}
Variables
{"data": SaleInput}
Response
{"data": {"sale": {"sale": SaleType}}}
Mutations

timeRange

Description

Mutácia slúži na definovanie časových rozsahov platností balíčkov zliav, či jednotlivých pravidiel.

Response

Returns a TimeRangeMutate

Arguments
Name Description
data - TimeRangeInput!

Example

Query
mutation timeRange($data: TimeRangeInput!) {
  timeRange(data: $data) {
    timeRange {
      ...TimeRangeTypeFragment
    }
  }
}
Variables
{"data": TimeRangeInput}
Response
{"data": {"timeRange": {"timeRange": TimeRangeType}}}
Mutations

token

Description

Mutácia slúži na prihlásenie používateľa.

Response

Returns a TokenMutate

Arguments
Name Description
data - TokenInput!

Example

Query
mutation token($data: TokenInput!) {
  token(data: $data) {
    token {
      ...TokenTypeFragment
    }
  }
}
Variables
{"data": TokenInput}
Response
{"data": {"token": {"token": TokenType}}}
Mutations

tokenActivate

Response

Returns a TokenActivateMutate

Arguments
Name Description
data - TokenActivateInput!

Example

Query
mutation tokenActivate($data: TokenActivateInput!) {
  tokenActivate(data: $data) {
    token
  }
}
Variables
{"data": TokenActivateInput}
Response
{
  "data": {
    "tokenActivate": {"token": "abc123"}
  }
}
Mutations

tokenAuth

Response

Returns an ObtainJSONWebToken

Arguments
Name Description
company - String
externalSource - String
instance - String
username - String!
password - String!

Example

Query
mutation tokenAuth(
  $company: String,
  $externalSource: String,
  $instance: String,
  $username: String!,
  $password: String!
) {
  tokenAuth(
    company: $company,
    externalSource: $externalSource,
    instance: $instance,
    username: $username,
    password: $password
  ) {
    token
  }
}
Variables
{
  "company": "abc123",
  "externalSource": "abc123",
  "instance": "abc123",
  "username": "abc123",
  "password": "xyz789"
}
Response
{"data": {"tokenAuth": {"token": "xyz789"}}}
Mutations

transaction

Description

Mutácia slúži na vytvorenie konkrétnej transakcie. Možnosti pre transakcie sú ukázané pomocou package_strategist mutácie.

Response

Returns a TransactionMutate

Arguments
Name Description
data - TransactionInput!

Example

Query
mutation transaction($data: TransactionInput!) {
  transaction(data: $data) {
    transaction {
      ...TransactionTypeFragment
    }
    metadata
  }
}
Variables
{"data": TransactionInput}
Response
{
  "data": {
    "transaction": {
      "transaction": [TransactionType],
      "metadata": GenericScalar
    }
  }
}
Mutations

transfer

Description

Mutácia slúži na prenos prostriedkov medzi peňaženkami.

Response

Returns a TransferMutate

Arguments
Name Description
data - TransferInput!

Example

Query
mutation transfer($data: TransferInput!) {
  transfer(data: $data) {
    transfers {
      ...TransactionTypeFragment
    }
  }
}
Variables
{"data": TransferInput}
Response
{"data": {"transfer": {"transfers": [TransactionType]}}}
Mutations

user

Description

Mutácia slúži na manažment všetkých typov používateľov. Medzi tieto typy patria: CONSUMER, CASHIER a MANAGER. V rámci pridávania používateľa je možné rovno asociovať používateľovi kartu.

Response

Returns a UserMutate

Arguments
Name Description
data - UserInput!

Example

Query
mutation user($data: UserInput!) {
  user(data: $data) {
    user {
      ...UserTypeFragment
    }
  }
}
Variables
{"data": UserInput}
Response
{"data": {"user": {"user": UserType}}}
Mutations

userDiscountPackage

Description

Mutácia slúži na priradzovanie zľavových balíkov pre používateĹoc s kartami.

Response

Returns a UserDiscountPackageMutate

Arguments
Name Description
data - UserDiscountPackageInput!

Example

Query
mutation userDiscountPackage($data: UserDiscountPackageInput!) {
  userDiscountPackage(data: $data) {
    userDiscountPackage {
      ...UserDiscountPackageTypeFragment
    }
  }
}
Variables
{"data": UserDiscountPackageInput}
Response
{
  "data": {
    "userDiscountPackage": {
      "userDiscountPackage": UserDiscountPackageType
    }
  }
}
Mutations

userWallet

Description

Mutácia slúži na priradzovanie peňaženiek používateľom.

Response

Returns a UserWalletMutate

Arguments
Name Description
data - UserWalletInput!

Example

Query
mutation userWallet($data: UserWalletInput!) {
  userWallet(data: $data) {
    userWallet {
      ...UserWalletTypeFragment
    }
  }
}
Variables
{"data": UserWalletInput}
Response
{"data": {"userWallet": {"userWallet": UserWalletType}}}
Mutations

verifyToken

Response

Returns a Verify

Arguments
Name Description
token - String!

Example

Query
mutation verifyToken($token: String!) {
  verifyToken(token: $token) {
    payload
  }
}
Variables
{"token": "abc123"}
Response
{"data": {"verifyToken": {"payload": GenericScalar}}}
Mutations

vouchersCreate

Description

Mutácia slúži na vytváranie zľavových kódov.

Response

Returns a VoucherCreateMutate

Arguments
Name Description
data - VoucherCreateInput!

Example

Query
mutation vouchersCreate($data: VoucherCreateInput!) {
  vouchersCreate(data: $data) {
    vouchers {
      ...VoucherTypeFragment
    }
  }
}
Variables
{"data": VoucherCreateInput}
Response
{"data": {"vouchersCreate": {"vouchers": [VoucherType]}}}
Mutations

vouchersDelete

Description

Mutácia slúži na mazanie zľavových kódov.

Response

Returns a VoucherDeleteMutate

Arguments
Name Description
data - VoucherDeleteInput!

Example

Query
mutation vouchersDelete($data: VoucherDeleteInput!) {
  vouchersDelete(data: $data) {
    vouchers {
      ...VoucherTypeFragment
    }
  }
}
Variables
{"data": VoucherDeleteInput}
Response
{"data": {"vouchersDelete": {"vouchers": [VoucherType]}}}
Mutations

vouchersUpdate

Description

Mutácia slúži na menenie zľavových kódov.

Response

Returns a VoucherUpdateMutate

Arguments
Name Description
data - VoucherUpdateInput!

Example

Query
mutation vouchersUpdate($data: VoucherUpdateInput!) {
  vouchersUpdate(data: $data) {
    vouchers {
      ...VoucherTypeFragment
    }
  }
}
Variables
{"data": VoucherUpdateInput}
Response
{"data": {"vouchersUpdate": {"vouchers": [VoucherType]}}}
Mutations

walletsCreate

Description

Mutácia slúži na pridávanie systémových peňaženiek.

Response

Returns a WalletCreateMutate

Arguments
Name Description
data - WalletsCreateInput!

Example

Query
mutation walletsCreate($data: WalletsCreateInput!) {
  walletsCreate(data: $data) {
    wallets {
      ...WalletTypeFragment
    }
  }
}
Variables
{"data": WalletsCreateInput}
Response
{"data": {"walletsCreate": {"wallets": [WalletType]}}}
Mutations

walletsDelete

Description

Mutácia slúži na mazanie systémových peňaženiek.

Response

Returns a WalletDeleteMutate

Arguments
Name Description
data - WalletDeleteInput!

Example

Query
mutation walletsDelete($data: WalletDeleteInput!) {
  walletsDelete(data: $data) {
    wallets {
      ...WalletTypeFragment
    }
  }
}
Variables
{"data": WalletDeleteInput}
Response
{"data": {"walletsDelete": {"wallets": [WalletType]}}}
Mutations

walletsUpdate

Description

Mutácia slúži na menenie systémových peňaženiek.

Response

Returns a WalletUpdateMutate

Arguments
Name Description
data - WalletsUpdateInput!

Example

Query
mutation walletsUpdate($data: WalletsUpdateInput!) {
  walletsUpdate(data: $data) {
    wallets {
      ...WalletTypeFragment
    }
  }
}
Variables
{"data": WalletsUpdateInput}
Response
{"data": {"walletsUpdate": {"wallets": [WalletType]}}}

Types

Applications

Values
Enum Value Description

BILL

ITEM
Example
"BILL"
Types

AutomationTypes

Values
Enum Value Description

DAILY

WEEKLY

MONTHLY

YEARLY

NEVER
Example
"DAILY"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

CancelTransactionInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
bill - String

Required
application - Applications

Required
userId - String
items - [CancelTransactionItemInput]
identification - UUID

Required
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": false,
  "bill": "xyz789",
  "application": "BILL",
  "userId": "abc123",
  "items": [CancelTransactionItemInput],
  "identification": "d3eddcd2-0909-4f69-9b7f-ab886c512593"
}
Types

CancelTransactionItemInput

Fields
Input Field Description
externalId - String!

Required
externalSourceId - UUID!

Required
externalReferenceId - String
id - Int!

Required
priceLevel - Int!

Required
singlePrice - Int!

Required
count - Int!

Required
Example
{
  "externalId": "xyz789",
  "externalSourceId": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "externalReferenceId": "abc123",
  "id": 987,
  "priceLevel": 987,
  "singlePrice": 123,
  "count": 123
}
Types

CancelTransactionMutate

Fields
Field Name Description
transactions - [TransactionType]
metadata - GenericScalar
Example
{
  "transactions": [TransactionType],
  "metadata": GenericScalar
}
Types

CardHoldersInput

Fields
Input Field Description
dissoc - Boolean
holder - NestedHolderInput
card - String

Required
cardExpiresAt - Date
discountPackages - [String]
Example
{
  "dissoc": true,
  "holder": NestedHolderInput,
  "card": "xyz789",
  "cardExpiresAt": "2007-12-03",
  "discountPackages": ["xyz789"]
}
Types

CardInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
code - [String]

Required
status - CardStats

Required
description - String
userId - Int
holderId - String
creatorId - String
discountPackages - [String]
expiresAt - Date
Example
{
  "record": "xyz789",
  "delete": false,
  "isPreview": true,
  "code": ["abc123"],
  "status": "UNRESOLVED",
  "description": "xyz789",
  "userId": 987,
  "holderId": "xyz789",
  "creatorId": "xyz789",
  "discountPackages": ["abc123"],
  "expiresAt": "2007-12-03"
}
Types

CardMutate

Fields
Field Name Description
card - [CardType]
Example
{"card": [CardType]}
Types

CardStats

Values
Enum Value Description

UNRESOLVED

ACTIVE

BLOCKED

DELETED
Example
"UNRESOLVED"
Types

CardStatus

Description

An enumeration.

Values
Enum Value Description

UNRESOLVED

 unresolved

ACTIVE

 active

BLOCKED

 blocked

DELETED

 deleted
Example
"UNRESOLVED"
Types

CardType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
code - String!
status - CardStatus!
user - UserType
holder - HolderType
discountPackages - DiscountPackageTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
company - CompanyType!
creator - UserType
expiresAt - Date
productPrepaymentsUsers - [ProductPrepaymentUserType!]!
userDiscountPackages - [UserDiscountPackageType!]!
changes - ChangeHistoryTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "code": "abc123",
  "status": "UNRESOLVED",
  "user": UserType,
  "holder": HolderType,
  "discountPackages": DiscountPackageTypeConnection,
  "company": CompanyType,
  "creator": UserType,
  "expiresAt": "2007-12-03",
  "productPrepaymentsUsers": [ProductPrepaymentUserType],
  "userDiscountPackages": [UserDiscountPackageType],
  "changes": ChangeHistoryTypeConnection,
  "record": "xyz789"
}
Types

CardTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [CardTypeEdge]! Contains the nodes in this connection.
pdfUrl - String
xlsxUrl - String
Example
{
  "pageInfo": PageInfo,
  "edges": [CardTypeEdge],
  "pdfUrl": "xyz789",
  "xlsxUrl": "abc123"
}
Types

CardTypeEdge

Description

A Relay edge containing a CardType and its cursor.

Fields
Field Name Description
node - CardType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": CardType,
  "cursor": "xyz789"
}
Types

CashierType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
code - String!
company - CompanyType!
sales - SaleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "code": "xyz789",
  "company": CompanyType,
  "sales": SaleTypeConnection,
  "transactions": TransactionTypeConnection,
  "record": "abc123"
}
Types

CashierTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [CashierTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [CashierTypeEdge]
}
Types

CashierTypeEdge

Description

A Relay edge containing a CashierType and its cursor.

Fields
Field Name Description
node - CashierType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": CashierType,
  "cursor": "abc123"
}
Types

ChangeHistoryEntityType

Description

An enumeration.

Values
Enum Value Description

USER

 user

CARD

 card
Example
"USER"
Types

ChangeHistoryType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
entityType - ChangeHistoryEntityType!
card - CardType
user - UserType
field - String!
before - String
after - String
description - String
creator - UserType!
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "entityType": "USER",
  "card": CardType,
  "user": UserType,
  "field": "xyz789",
  "before": "abc123",
  "after": "abc123",
  "description": "xyz789",
  "creator": UserType,
  "record": "abc123"
}
Types

ChangeHistoryTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ChangeHistoryTypeEdge]! Contains the nodes in this connection.
pdfUrl - String
xlsxUrl - String
Example
{
  "pageInfo": PageInfo,
  "edges": [ChangeHistoryTypeEdge],
  "pdfUrl": "abc123",
  "xlsxUrl": "abc123"
}
Types

ChangeHistoryTypeEdge

Description

A Relay edge containing a ChangeHistoryType and its cursor.

Fields
Field Name Description
node - ChangeHistoryType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ChangeHistoryType,
  "cursor": "xyz789"
}
Types

CompanyInput

Fields
Input Field Description
name - String

Required
email - String

Required
address - String

Required
crn - String

Required
tax - String

Required
currencyCode - String

Required
countryCode - String

Required
color - String
parentId - Int
phoneNumber - String
Example
{
  "name": "abc123",
  "email": "abc123",
  "address": "abc123",
  "crn": "xyz789",
  "tax": "abc123",
  "currencyCode": "xyz789",
  "countryCode": "xyz789",
  "color": "abc123",
  "parentId": 987,
  "phoneNumber": "abc123"
}
Types

CompanyMutate

Fields
Field Name Description
currencies - [CurrencyType]
countries - [CountryType]
company - CompanyType
Example
{
  "currencies": [CurrencyType],
  "countries": [CountryType],
  "company": CompanyType
}
Types

CompanyType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
email - String!
phoneNumber - String
address - String!
crn - String!
tax - String!
color - String!
parent - CompanyType
currency - CurrencyType!
country - CountryType!
sendNotifications - Boolean!
defaultProduct - JSONString
users - UserTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
subcompanies - CompanyTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
wallets - WalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
cards - CardTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
cashiers - CashierTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
externalsourceSet - ExternalSourceFieldConnection!
Arguments
before - String
after - String
first - Int
last - Int
sales - SaleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "address": "xyz789",
  "crn": "abc123",
  "tax": "abc123",
  "color": "abc123",
  "parent": CompanyType,
  "currency": CurrencyType,
  "country": CountryType,
  "sendNotifications": true,
  "defaultProduct": JSONString,
  "users": UserTypeConnection,
  "subcompanies": CompanyTypeConnection,
  "wallets": WalletTypeConnection,
  "cards": CardTypeConnection,
  "cashiers": CashierTypeConnection,
  "externalsourceSet": ExternalSourceFieldConnection,
  "sales": SaleTypeConnection,
  "transactions": TransactionTypeConnection,
  "record": "abc123"
}
Types

CompanyTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [CompanyTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [CompanyTypeEdge]
}
Types

CompanyTypeEdge

Description

A Relay edge containing a CompanyType and its cursor.

Fields
Field Name Description
node - CompanyType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": CompanyType,
  "cursor": "xyz789"
}
Types

ConsumerActivateInput

Fields
Input Field Description
code - String

Required
username - String

Required
password - String

Required
name - String

Required
surname - String

Required
email - String

Required
phoneNumber - String

Required
address - String

Required
gender - Genders

Required
personalNumb - Int
perpetuation - Int
infMail - Boolean

Required
infApprove - Boolean

Required
extraData - GenericScalar
profilePic - String
cardHolders - [HoldersInput]
Example
{
  "code": "abc123",
  "username": "xyz789",
  "password": "xyz789",
  "name": "abc123",
  "surname": "xyz789",
  "email": "xyz789",
  "phoneNumber": "xyz789",
  "address": "abc123",
  "gender": "MALE",
  "personalNumb": 123,
  "perpetuation": 123,
  "infMail": false,
  "infApprove": true,
  "extraData": GenericScalar,
  "profilePic": "xyz789",
  "cardHolders": [HoldersInput]
}
Types

ConsumerActivateMutate

Fields
Field Name Description
consumer - UserType
Example
{"consumer": UserType}
Types

ConsumerParagonInput

Fields
Input Field Description
card - String

Required
Example
{"card": "xyz789"}
Types

ConsumerParagonMutate

Fields
Field Name Description
registrationCode - RegistrationCodeType
Example
{"registrationCode": RegistrationCodeType}
Types

CountryInput

Fields
Input Field Description
name - String

Required
code - String

Required
Example
{
  "name": "xyz789",
  "code": "xyz789"
}
Types

CountryType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
code - String!
companies - CompanyTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
wallets - WalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "code": "xyz789",
  "companies": CompanyTypeConnection,
  "wallets": WalletTypeConnection,
  "record": "abc123"
}
Types

CurrenciesCreateInput

Fields
Input Field Description
currencies - [CurrencyCreateInput]
Example
{"currencies": [CurrencyCreateInput]}
Types

CurrenciesUpdateInput

Fields
Input Field Description
currencies - [CurrencyUpdateInput]
ownCurrencyRates - Boolean!
Example
{
  "currencies": [CurrencyUpdateInput],
  "ownCurrencyRates": false
}
Types

CurrencyCreateInput

Fields
Input Field Description
name - String

Required
code - String

Required
character - String

Required
Example
{
  "name": "xyz789",
  "code": "abc123",
  "character": "abc123"
}
Types

CurrencyCreateMutate

Fields
Field Name Description
currencies - [CurrencyType]
Example
{"currencies": [CurrencyType]}
Types

CurrencyDeleteInput

Fields
Input Field Description
records - [String]

Required
Example
{"records": ["abc123"]}
Types

CurrencyDeleteMutate

Fields
Field Name Description
currencies - [CurrencyType]
Example
{"currencies": [CurrencyType]}
Types

CurrencyInput

Fields
Input Field Description
name - String

Required
code - String

Required
character - String

Required
rate - Float
Example
{
  "name": "xyz789",
  "code": "xyz789",
  "character": "abc123",
  "rate": 123.45
}
Types

CurrencyType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
code - String!
character - String!
rate - Float!
companies - CompanyTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
wallets - WalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "code": "xyz789",
  "character": "abc123",
  "rate": 987.65,
  "companies": CompanyTypeConnection,
  "wallets": WalletTypeConnection,
  "transactions": TransactionTypeConnection,
  "record": "abc123"
}
Types

CurrencyTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [CurrencyTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [CurrencyTypeEdge]
}
Types

CurrencyTypeEdge

Description

A Relay edge containing a CurrencyType and its cursor.

Fields
Field Name Description
node - CurrencyType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": CurrencyType,
  "cursor": "xyz789"
}
Types

CurrencyUpdateInput

Fields
Input Field Description
record - String!
rate - Float!
Example
{"record": "abc123", "rate": 987.65}
Types

CurrencyUpdateMutate

Fields
Field Name Description
currencies - [CurrencyType]
Example
{"currencies": [CurrencyType]}
Types

Date

Description

The Date scalar type represents a Date value as specified by iso8601.

Example
"2007-12-03"
Types

DateTime

Description

The DateTime scalar type represents a DateTime value as specified by iso8601.

Example
"2007-12-03T10:15:30Z"
Types

DeleteMultipleCardsInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
records - [String]

Required
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": false,
  "records": ["abc123"]
}
Types

DeleteMultipleCardsMutate

Fields
Field Name Description
cards - [CardType]
Example
{"cards": [CardType]}
Types

DeleteMultipleUsersInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
records - [String]

Required
Example
{
  "record": "xyz789",
  "delete": false,
  "isPreview": false,
  "records": ["xyz789"]
}
Types

DeleteMultipleUsersMutate

Fields
Field Name Description
users - [UserType]
Example
{"users": [UserType]}
Types

DinerGroupCreditType

Description

An enumeration.

Values
Enum Value Description

DAILY

 daily

WEEKLY

 weekly

MONTHLY

 monthly

QUARTER_YEARLY

 quarter_yearly

SEMI_YEARLY

 semi_yearly

YEARLY

 yearly
Example
"DAILY"
Types

DinerGroupItemPrice

Description

An enumeration.

Values
Enum Value Description

CONTRIBUTION

 contribution

OTHER

 other
Example
"CONTRIBUTION"
Types

DinerGroupMonitoringPeriod

Description

An enumeration.

Values
Enum Value Description

MORNING

 morning

NOON

 noon

EVENING

 evening
Example
"MORNING"
Types

DinerGroupType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
validity - Boolean!
creditType - DinerGroupCreditType
monitoringPeriod - DinerGroupMonitoringPeriod
itemPrice - DinerGroupItemPrice
creditMax - Int
surchargesMax - Int
user - UserType
organisation - OrganisationType!
eatFrom - DateTime
eatTo - DateTime
diners - [DinerType!]!
surchargesFoodmanGroups - [SurchargeStockGroupType!]!
surcharges - [SurchargeType!]!
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "validity": true,
  "creditType": "DAILY",
  "monitoringPeriod": "MORNING",
  "itemPrice": "CONTRIBUTION",
  "creditMax": 123,
  "surchargesMax": 987,
  "user": UserType,
  "organisation": OrganisationType,
  "eatFrom": "2007-12-03T10:15:30Z",
  "eatTo": "2007-12-03T10:15:30Z",
  "diners": [DinerType],
  "surchargesFoodmanGroups": [SurchargeStockGroupType],
  "surcharges": [SurchargeType]
}
Types

DinerType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
user - UserType!
group - DinerGroupType
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "user": UserType,
  "group": DinerGroupType
}
Types

DiscountDiscountType

Description

An enumeration.

Values
Enum Value Description

ITEM

 item

BILL

 bill
Example
"ITEM"
Types

DiscountForm

Description

An enumeration.

Values
Enum Value Description

DISCOUNT

 discount

PRICE_LEVEL

 price_level
Example
"DISCOUNT"
Types

DiscountForms

Values
Enum Value Description

DISCOUNT

PRICE_LEVEL
Example
"DISCOUNT"
Types

DiscountInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
form - DiscountForms

Required
discountType - DiscountTypes

Required
combinable - Boolean

Required
priority - Int

Required
name - String
valueForm - ValueForms
productQuantity - Int
minBillValue - Int
maxBillValue - Int
value - Int
newPriceLevel - Int
items - [ExternalItemInput]
itemGroups - [ExternalItemInput]
priceLevels - [Int]
paymentMethods - [String]
timeRanges - [TimeRangeInput]
discountPackageId - String
operation - [String]
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": true,
  "form": "DISCOUNT",
  "discountType": "ITEM",
  "combinable": true,
  "priority": 123,
  "name": "xyz789",
  "valueForm": "PERCENTAGE",
  "productQuantity": 123,
  "minBillValue": 987,
  "maxBillValue": 987,
  "value": 123,
  "newPriceLevel": 123,
  "items": [ExternalItemInput],
  "itemGroups": [ExternalItemInput],
  "priceLevels": [987],
  "paymentMethods": ["abc123"],
  "timeRanges": [TimeRangeInput],
  "discountPackageId": "abc123",
  "operation": ["xyz789"]
}
Types

DiscountMutate

Fields
Field Name Description
discount - DiscountType
Example
{"discount": DiscountType}
Types

DiscountPackageInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
status - DiscountStats

Required
strategy - Strategies

Required
packageRules - [PackageRuleInput]
discounts - [DiscountInput]
description - String
picture - String
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": true,
  "name": "xyz789",
  "status": "ACTIVE",
  "strategy": "MOST_PREFERABLY",
  "packageRules": [PackageRuleInput],
  "discounts": [DiscountInput],
  "description": "abc123",
  "picture": "abc123"
}
Types

DiscountPackageMutate

Fields
Field Name Description
discountPackage - DiscountPackageType
Example
{"discountPackage": DiscountPackageType}
Types

DiscountPackageStatus

Description

An enumeration.

Values
Enum Value Description

ACTIVE

 active

INACTIVE

 inactive

DELETED

 deleted
Example
"ACTIVE"
Types

DiscountPackageStrategy

Description

An enumeration.

Values
Enum Value Description

MOST_PREFERABLY

 most_preferably

LEAST_PREFERABLY

 least_preferably

SUBORDINATE

 subordinate

SUPERIOR

 superior
Example
"MOST_PREFERABLY"
Types

DiscountPackageType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
description - String
status - DiscountPackageStatus!
strategy - DiscountPackageStrategy!
picture - String!
creator - UserType!
public - Boolean!
userConditions - JSONString
cards - CardTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
discounts - DiscountTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
salesPublic - SaleType
salesPrivate - SaleType
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
discountPackageUsers - [UserDiscountPackageType!]!
record - String
usersCount - Int
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "description": "abc123",
  "status": "ACTIVE",
  "strategy": "MOST_PREFERABLY",
  "picture": "abc123",
  "creator": UserType,
  "public": false,
  "userConditions": JSONString,
  "cards": CardTypeConnection,
  "discounts": DiscountTypeConnection,
  "salesPublic": SaleType,
  "salesPrivate": SaleType,
  "packageRules": PackageRuleTypeConnection,
  "discountPackageUsers": [UserDiscountPackageType],
  "record": "xyz789",
  "usersCount": 987
}
Types

DiscountPackageTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [DiscountPackageTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [DiscountPackageTypeEdge]
}
Types

DiscountPackageTypeEdge

Description

A Relay edge containing a DiscountPackageType and its cursor.

Fields
Field Name Description
node - DiscountPackageType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": DiscountPackageType,
  "cursor": "xyz789"
}
Types

DiscountStats

Values
Enum Value Description

ACTIVE

INACTIVE

DELETED
Example
"ACTIVE"
Types

DiscountType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
form - DiscountForm!
valueForm - DiscountValueForm
discountType - DiscountDiscountType
productQuantity - Int!
minBillValue - Int!
maxBillValue - Int
combinable - Boolean!
value - Int!
priority - Int!
newPriceLevel - Int
items - StockProductTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
itemGroups - StockGroupTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
priceLevels - [Int!]!
paymentMethods - [String!]!
operation - OperationTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
discountPackage - DiscountPackageType
timeRanges - [TimeRangeType!]!
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "form": "DISCOUNT",
  "valueForm": "PERCENTAGE",
  "discountType": "ITEM",
  "productQuantity": 987,
  "minBillValue": 987,
  "maxBillValue": 123,
  "combinable": false,
  "value": 987,
  "priority": 987,
  "newPriceLevel": 123,
  "items": StockProductTypeConnection,
  "itemGroups": StockGroupTypeConnection,
  "priceLevels": [123],
  "paymentMethods": ["xyz789"],
  "operation": OperationTypeConnection,
  "discountPackage": DiscountPackageType,
  "timeRanges": [TimeRangeType],
  "transactions": TransactionTypeConnection,
  "record": "xyz789"
}
Types

DiscountTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [DiscountTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [DiscountTypeEdge]
}
Types

DiscountTypeEdge

Description

A Relay edge containing a DiscountType and its cursor.

Fields
Field Name Description
node - DiscountType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": DiscountType,
  "cursor": "abc123"
}
Types

DiscountTypes

Values
Enum Value Description

ITEM

BILL
Example
"ITEM"
Types

DiscountValueForm

Description

An enumeration.

Values
Enum Value Description

PERCENTAGE

 percentage

ABSOLUTE

 absolute

MULTIPLICATION

 multiplication
Example
"PERCENTAGE"
Types

ExternalGroupConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ExternalGroupEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ExternalGroupEdge]
}
Types

ExternalGroupEdge

Description

A Relay edge containing a ExternalGroup and its cursor.

Fields
Field Name Description
node - ExternalGroupType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ExternalGroupType,
  "cursor": "abc123"
}
Types

ExternalGroupType

Fields
Field Name Description
id - ID! The ID of the object.
source - ExternalSourceField
record - Int
name - String
category - String
Example
{
  "id": 4,
  "source": ExternalSourceField,
  "record": 123,
  "name": "xyz789",
  "category": "xyz789"
}
Types

ExternalItemInput

Fields
Input Field Description
code - Int

Required
externalSourceId - UUID

Required
Example
{
  "code": 987,
  "externalSourceId": "d3eddcd2-0909-4f69-9b7f-ab886c512593"
}
Types

ExternalPayment

Fields
Field Name Description
id - ID! The ID of the object.
source - ExternalSourceField
code - String
name - String
Example
{
  "id": "4",
  "source": ExternalSourceField,
  "code": "xyz789",
  "name": "abc123"
}
Types

ExternalPaymentConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ExternalPaymentEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ExternalPaymentEdge]
}
Types

ExternalPaymentEdge

Description

A Relay edge containing a ExternalPayment and its cursor.

Fields
Field Name Description
node - ExternalPayment The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ExternalPayment,
  "cursor": "abc123"
}
Types

ExternalProductConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ExternalProductEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ExternalProductEdge]
}
Types

ExternalProductEdge

Description

A Relay edge containing a ExternalProduct and its cursor.

Fields
Field Name Description
node - ExternalProductType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ExternalProductType,
  "cursor": "xyz789"
}
Types

ExternalProductType

Fields
Field Name Description
id - ID! The ID of the object.
source - ExternalSourceField
name - String
code - Int
groupId - Int
prices - [PriceType]
Example
{
  "id": 4,
  "source": ExternalSourceField,
  "name": "xyz789",
  "code": 987,
  "groupId": 987,
  "prices": [PriceType]
}
Types

ExternalSourceEnum

Values
Enum Value Description

FOODMAN

HORES

INSTANCE
Example
"FOODMAN"
Types

ExternalSourceField

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
company - CompanyType!
type - ExternalSourceType!
title - String
host - String
port - Int
user - String
password - String
additionalData - JSONString
stockgroupSet - StockGroupTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
stockproductSet - StockProductTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "company": CompanyType,
  "type": "FOODMAN",
  "title": "xyz789",
  "host": "xyz789",
  "port": 987,
  "user": "abc123",
  "password": "xyz789",
  "additionalData": JSONString,
  "stockgroupSet": StockGroupTypeConnection,
  "stockproductSet": StockProductTypeConnection,
  "record": "abc123"
}
Types

ExternalSourceFieldConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ExternalSourceFieldEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ExternalSourceFieldEdge]
}
Types

ExternalSourceFieldEdge

Description

A Relay edge containing a ExternalSourceField and its cursor.

Fields
Field Name Description
node - ExternalSourceField The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ExternalSourceField,
  "cursor": "xyz789"
}
Types

ExternalSourceInput

Fields
Input Field Description
type - ExternalSourceEnum

Required
title - String

Required
host - String

Required
user - String

Required
port - Int
password - String
additionalData - GenericScalar

Required
Example
{
  "type": "FOODMAN",
  "title": "xyz789",
  "host": "abc123",
  "user": "xyz789",
  "port": 123,
  "password": "xyz789",
  "additionalData": GenericScalar
}
Types

ExternalSourceType

Description

An enumeration.

Values
Enum Value Description

FOODMAN

 foodman

HORES

 hores

INSTANCE

 instance
Example
"FOODMAN"
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

Genders

Values
Enum Value Description

MALE

FEMALE
Example
"MALE"
Types

GenericScalar

Description

The GenericScalar scalar type represents a generic GraphQL scalar value that could be: String, Boolean, Int, Float, List or Object.

Example
GenericScalar
Types

HolderInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
surname - String

Required
email - String
user - String

Required
wallets - [String]
extraData - GenericScalar
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": false,
  "name": "abc123",
  "surname": "abc123",
  "email": "abc123",
  "user": "xyz789",
  "wallets": ["abc123"],
  "extraData": GenericScalar
}
Types

HolderMutate

Fields
Field Name Description
holder - HolderType
Example
{"holder": HolderType}
Types

HolderType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String
surname - String
email - String
user - UserType!
wallets - UserWalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
extraData - JSONString
myCards - CardTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
productPrepaymentsUsers - [ProductPrepaymentUserType!]!
userDiscountPackages - [UserDiscountPackageType!]!
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "surname": "abc123",
  "email": "xyz789",
  "user": UserType,
  "wallets": UserWalletTypeConnection,
  "extraData": JSONString,
  "myCards": CardTypeConnection,
  "productPrepaymentsUsers": [ProductPrepaymentUserType],
  "userDiscountPackages": [UserDiscountPackageType],
  "record": "xyz789"
}
Types

HolderTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [HolderTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [HolderTypeEdge]
}
Types

HolderTypeEdge

Description

A Relay edge containing a HolderType and its cursor.

Fields
Field Name Description
node - HolderType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": HolderType,
  "cursor": "xyz789"
}
Types

HoldersInput

Fields
Input Field Description
holder - NestedHolderInput

Required
card - String

Required
Example
{
  "holder": NestedHolderInput,
  "card": "abc123"
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

ImporterInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
fileName - String

Required
Example
{
  "record": "xyz789",
  "delete": false,
  "isPreview": false,
  "fileName": "abc123"
}
Types

ImporterMutate

Fields
Field Name Description
fileName - String
Example
{"fileName": "xyz789"}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31 - 1) and 2^31 - 1 since represented in JSON as double-precision floating point numbers specifiedby IEEE 754.

Example
987
Types

JSONString

Description

Allows use of a JSON String for input / output from the GraphQL schema.

Use of this type is not recommended as you lose the benefits of having a defined, static schema (one of the key benefits of GraphQL).

Example
JSONString
Types

LogEntryDevice

Description

An enumeration.

Values
Enum Value Description

WEB

 web

MOBILE

 mobile

API

 api
Example
"WEB"
Types

LogEntryType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
user - UserType
level - String!
method - String!
url - String!
device - LogEntryDevice!
module - String!
function - String!
local - String!
message - String!
request - JSONString
happenedAt - DateTime!
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "user": UserType,
  "level": "abc123",
  "method": "abc123",
  "url": "abc123",
  "device": "WEB",
  "module": "abc123",
  "function": "xyz789",
  "local": "xyz789",
  "message": "xyz789",
  "request": JSONString,
  "happenedAt": "2007-12-03T10:15:30Z",
  "record": "abc123"
}
Types

ManualTransactionInput

Fields
Input Field Description
amount - Int
count - Int
identification - UUID

Required
walletId - String
productPrepaymentId - String
Example
{
  "amount": 987,
  "count": 123,
  "identification": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "walletId": "abc123",
  "productPrepaymentId": "abc123"
}
Types

NestedHolderInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
surname - String

Required
email - String
user - String
wallets - [String]
extraData - GenericScalar
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": false,
  "name": "xyz789",
  "surname": "xyz789",
  "email": "xyz789",
  "user": "xyz789",
  "wallets": ["abc123"],
  "extraData": GenericScalar
}
Types

Node

Description

An object with an ID

Fields
Field Name Description
id - ID! The ID of the object.
Possible Types
Node Types

OrganisationType

UserType

PermissionType

CompanyType

CurrencyType

WalletType

UserWalletType

HolderType

CardType

DiscountPackageType

DiscountType

StockProductType

StockGroupType

ExternalSourceField

PackageRuleType

SaleType

CashierType

TransactionType

VoucherType

VoucherCodeType

ProductPrepaymentType

OperationType

ChangeHistoryType

ExternalPayment

ExternalProductType

ExternalGroupType

SettingType

Example
{"id": 4}
Types

ObtainJSONWebToken

Fields
Field Name Description
token - String
Example
{"token": "abc123"}
Types

OperationInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
Example
{
  "record": "abc123",
  "delete": false,
  "isPreview": true,
  "name": "xyz789"
}
Types

OperationMutate

Fields
Field Name Description
operation - OperationType
Example
{"operation": OperationType}
Types

OperationType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
discountRules - DiscountTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "discountRules": DiscountTypeConnection,
  "packageRules": PackageRuleTypeConnection,
  "transactions": TransactionTypeConnection,
  "record": "xyz789"
}
Types

OperationTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [OperationTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [OperationTypeEdge]
}
Types

OperationTypeEdge

Description

A Relay edge containing a OperationType and its cursor.

Fields
Field Name Description
node - OperationType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": OperationType,
  "cursor": "abc123"
}
Types

OrganisationInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
contactName - String

Required
contactSurname - String

Required
email - String

Required
address - String

Required
crn - String

Required
tax - String

Required
vat - String

Required
bank - String

Required
bankAccount - String

Required
accountName - String

Required
organisationGroup - String
restrictionType - RestrictionTypes

Required
phoneNumber - String
establishmentDate - DateTime
Example
{
  "record": "xyz789",
  "delete": false,
  "isPreview": true,
  "name": "abc123",
  "contactName": "abc123",
  "contactSurname": "abc123",
  "email": "xyz789",
  "address": "abc123",
  "crn": "abc123",
  "tax": "abc123",
  "vat": "abc123",
  "bank": "xyz789",
  "bankAccount": "xyz789",
  "accountName": "xyz789",
  "organisationGroup": "xyz789",
  "restrictionType": "TEST1",
  "phoneNumber": "abc123",
  "establishmentDate": "2007-12-03T10:15:30Z"
}
Types

OrganisationMutate

Fields
Field Name Description
organisation - OrganisationType
Example
{"organisation": OrganisationType}
Types

OrganisationRestrictionType

Description

An enumeration.

Values
Enum Value Description

TEST1

 test1

TEST2

 test2
Example
"TEST1"
Types

OrganisationType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
contactName - String!
contactSurname - String!
email - String!
phoneNumber - String
address - String!
crn - String!
tax - String!
vat - String!
bank - String!
bankAccount - String!
accountName - String!
organisationGroup - String
restrictionType - OrganisationRestrictionType
establishmentDate - DateTime
users - UserTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
dinerGroups - [DinerGroupType!]!
surcharges - [SurchargeType!]!
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "contactName": "xyz789",
  "contactSurname": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "address": "xyz789",
  "crn": "abc123",
  "tax": "xyz789",
  "vat": "xyz789",
  "bank": "abc123",
  "bankAccount": "abc123",
  "accountName": "abc123",
  "organisationGroup": "xyz789",
  "restrictionType": "TEST1",
  "establishmentDate": "2007-12-03T10:15:30Z",
  "users": UserTypeConnection,
  "dinerGroups": [DinerGroupType],
  "surcharges": [SurchargeType],
  "record": "xyz789"
}
Types

OrganisationTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [OrganisationTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [OrganisationTypeEdge]
}
Types

OrganisationTypeEdge

Description

A Relay edge containing a OrganisationType and its cursor.

Fields
Field Name Description
node - OrganisationType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": OrganisationType,
  "cursor": "abc123"
}
Types

PackageRuleApplication

Description

An enumeration.

Values
Enum Value Description

BILL

 bill

ITEM

 item
Example
"BILL"
Types

PackageRuleAutomationType

Description

An enumeration.

Values
Enum Value Description

DAILY

 daily

WEEKLY

 weekly

MONTHLY

 monthly

YEARLY

 yearly

NEVER

 never
Example
"DAILY"
Types

PackageRuleInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
valueType - ValueTypes

Required
valueForm - ValueForms

Required
trigger - Triggers

Required
application - Applications
automationType - AutomationTypes

Required
value - Int

Required
priority - Int

Required
walletId - String

Required
discountPackageId - String
priceLevels - [Int]
paymentMethods - [String]
timeRanges - [TimeRangeInput]
itemGroups - [ExternalItemInput]
items - [ExternalItemInput]
operation - [String]
counter - Int
minimumValue - Int
clientParams - String
paymentMethod - String
priceList - Int
expiresAt - DateTime
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": true,
  "name": "xyz789",
  "valueType": "CREDIT",
  "valueForm": "PERCENTAGE",
  "trigger": "PURCHASE",
  "application": "BILL",
  "automationType": "DAILY",
  "value": 123,
  "priority": 987,
  "walletId": "abc123",
  "discountPackageId": "abc123",
  "priceLevels": [123],
  "paymentMethods": ["xyz789"],
  "timeRanges": [TimeRangeInput],
  "itemGroups": [ExternalItemInput],
  "items": [ExternalItemInput],
  "operation": ["xyz789"],
  "counter": 123,
  "minimumValue": 987,
  "clientParams": "xyz789",
  "paymentMethod": "xyz789",
  "priceList": 987,
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

PackageRuleMutate

Fields
Field Name Description
packageRule - PackageRuleType
Example
{"packageRule": PackageRuleType}
Types

PackageRuleTrigger

Description

An enumeration.

Values
Enum Value Description

PURCHASE

 purchase

PRODUCT

 product

AUTOMATIC

 automatic

WITHDRAWAL

 withdrawal
Example
"PURCHASE"
Types

PackageRuleType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
valueType - PackageRuleValueType!
valueForm - PackageRuleValueForm!
trigger - PackageRuleTrigger!
application - PackageRuleApplication
automationType - PackageRuleAutomationType!
value - Int!
priority - Int!
counter - Int!
minimumValue - Int!
clientParams - JSONString
timeRanges - [TimeRangeType!]!
itemGroups - StockGroupTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
items - StockProductTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
priceLevels - [Int!]!
paymentMethods - [String!]!
operation - OperationTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
wallet - WalletType!
discountPackage - DiscountPackageType
paymentMethod - String
priceList - Int
expiresAt - DateTime
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "valueType": "CREDIT",
  "valueForm": "PERCENTAGE",
  "trigger": "PURCHASE",
  "application": "BILL",
  "automationType": "DAILY",
  "value": 987,
  "priority": 987,
  "counter": 987,
  "minimumValue": 123,
  "clientParams": JSONString,
  "timeRanges": [TimeRangeType],
  "itemGroups": StockGroupTypeConnection,
  "items": StockProductTypeConnection,
  "priceLevels": [987],
  "paymentMethods": ["xyz789"],
  "operation": OperationTypeConnection,
  "wallet": WalletType,
  "discountPackage": DiscountPackageType,
  "paymentMethod": "abc123",
  "priceList": 987,
  "expiresAt": "2007-12-03T10:15:30Z",
  "transactions": TransactionTypeConnection,
  "record": "abc123"
}
Types

PackageRuleTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PackageRuleTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PackageRuleTypeEdge]
}
Types

PackageRuleTypeEdge

Description

A Relay edge containing a PackageRuleType and its cursor.

Fields
Field Name Description
node - PackageRuleType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PackageRuleType,
  "cursor": "xyz789"
}
Types

PackageRuleValueForm

Description

An enumeration.

Values
Enum Value Description

PERCENTAGE

 percentage

ABSOLUTE

 absolute

MULTIPLICATION

 multiplication
Example
"PERCENTAGE"
Types

PackageRuleValueType

Description

An enumeration.

Values
Enum Value Description

CREDIT

 credit

BONUS

 bonus
Example
"CREDIT"
Types

PackageStrategistMutate

Fields
Field Name Description
package - PackageStrategyType
Example
{"package": PackageStrategyType}
Types

PackageStrategyPrepaidProducts

Fields
Field Name Description
packageName - String
packageId - String
ruleId - String
itemName - String
credits - Int
userWalletId - String
itemId - Int
balance - Int
totalBalance - Int
expiration - DateTime
Example
{
  "packageName": "xyz789",
  "packageId": "xyz789",
  "ruleId": "abc123",
  "itemName": "xyz789",
  "credits": 123,
  "userWalletId": "xyz789",
  "itemId": 987,
  "balance": 987,
  "totalBalance": 987,
  "expiration": "2007-12-03T10:15:30Z"
}
Types

PackageStrategyPrepaidProductsPurchase

Fields
Field Name Description
packageId - String
packageName - String
expireInDays - Int
actualUserBalance - Int
credits - Int
itemId - Int
Example
{
  "packageId": "xyz789",
  "packageName": "abc123",
  "expireInDays": 987,
  "actualUserBalance": 987,
  "credits": 123,
  "itemId": 123
}
Types

PackageStrategyType

Fields
Field Name Description
user - UserType
creditPurchase - Int
creditPackage - String
creditValue - Int
bonusPackage - String
bonusValue - Int
discountPackage - String
discountValue - Int
withdrawalWallets - [PackageStrategyWallet]
purchaseWallets - [PackageStrategyWallet]
prepaidProductsWithdrawal - [PackageStrategyPrepaidProducts]
prepaidProductsPurchase - [PackageStrategyPrepaidProductsPurchase]
Example
{
  "user": UserType,
  "creditPurchase": 123,
  "creditPackage": "xyz789",
  "creditValue": 987,
  "bonusPackage": "abc123",
  "bonusValue": 123,
  "discountPackage": "abc123",
  "discountValue": 123,
  "withdrawalWallets": [PackageStrategyWallet],
  "purchaseWallets": [PackageStrategyWallet],
  "prepaidProductsWithdrawal": [
    PackageStrategyPrepaidProducts
  ],
  "prepaidProductsPurchase": [
    PackageStrategyPrepaidProductsPurchase
  ]
}
Types

PackageStrategyWallet

Fields
Field Name Description
type - String
wallet - String
name - String
package - String
balance - Int
code - String
maxWithdrawal - Int
decreaseAmount - Int
increaseAmount - Int
Example
{
  "type": "xyz789",
  "wallet": "xyz789",
  "name": "xyz789",
  "package": "xyz789",
  "balance": 123,
  "code": "abc123",
  "maxWithdrawal": 987,
  "decreaseAmount": 987,
  "increaseAmount": 123
}
Types

PageInfo

Description

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123",
  "endCursor": "abc123"
}
Types

PermissionType

Fields
Field Name Description
id - ID! The ID of the object.
name - String!
codename - String!
userSet - UserTypeConnection! Specific permissions for this user.
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "name": "xyz789",
  "codename": "xyz789",
  "userSet": UserTypeConnection,
  "record": "abc123"
}
Types

PermissionTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PermissionTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PermissionTypeEdge]
}
Types

PermissionTypeEdge

Description

A Relay edge containing a PermissionType and its cursor.

Fields
Field Name Description
node - PermissionType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PermissionType,
  "cursor": "xyz789"
}
Types

PrepaidProductPurchaseInput

Fields
Input Field Description
itemId - Int!

Required
packageId - String!

Required
count - Int!

Required
Example
{
  "itemId": 123,
  "packageId": "xyz789",
  "count": 987
}
Types

PrepaidProductWithdrawalInput

Fields
Input Field Description
itemId - Int!

Required
walletId - String!

Required
count - Int!

Required
Example
{
  "itemId": 123,
  "walletId": "abc123",
  "count": 987
}
Types

PriceType

Fields
Field Name Description
cashier - String Cashier unique code from food_dat
prices - [Float] Price for each price level (positional)
Example
{"cashier": "abc123", "prices": [123.45]}
Types

PrivateDiscountPackageInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
status - DiscountStats

Required
strategy - Strategies

Required
packageRules - [PackageRuleInput]
discounts - [DiscountInput]
description - String
picture - String
userConditions - UserConditionsInput
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": false,
  "name": "xyz789",
  "status": "ACTIVE",
  "strategy": "MOST_PREFERABLY",
  "packageRules": [PackageRuleInput],
  "discounts": [DiscountInput],
  "description": "xyz789",
  "picture": "xyz789",
  "userConditions": UserConditionsInput
}
Types

ProductPrepaymentInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
productRules - [ProductRuleInput]

Required
expires - Int
Example
{
  "record": "abc123",
  "delete": false,
  "isPreview": true,
  "name": "xyz789",
  "productRules": [ProductRuleInput],
  "expires": 123
}
Types

ProductPrepaymentMutate

Fields
Field Name Description
productPrepayment - ProductPrepaymentType
Example
{"productPrepayment": ProductPrepaymentType}
Types

ProductPrepaymentType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
expires - Int
creator - UserType!
productPrepaymentsUsers - [ProductPrepaymentUserType!]!
productRules - [ProductRuleType!]!
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
prepaymentCount - Int
userCount - Int
transactionCount - Int
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "expires": 987,
  "creator": UserType,
  "productPrepaymentsUsers": [ProductPrepaymentUserType],
  "productRules": [ProductRuleType],
  "transactions": TransactionTypeConnection,
  "record": "xyz789",
  "prepaymentCount": 987,
  "userCount": 987,
  "transactionCount": 123
}
Types

ProductPrepaymentTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ProductPrepaymentTypeEdge]! Contains the nodes in this connection.
pdfUrl - String
xlsxUrl - String
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductPrepaymentTypeEdge],
  "pdfUrl": "abc123",
  "xlsxUrl": "xyz789"
}
Types

ProductPrepaymentTypeEdge

Description

A Relay edge containing a ProductPrepaymentType and its cursor.

Fields
Field Name Description
node - ProductPrepaymentType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ProductPrepaymentType,
  "cursor": "xyz789"
}
Types

ProductPrepaymentUserInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
count - Int

Required
productPrepaymentId - String

Required
userId - String

Required
holderId - String
expiresAt - DateTime
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": true,
  "count": 123,
  "productPrepaymentId": "abc123",
  "userId": "abc123",
  "holderId": "abc123",
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

ProductPrepaymentUserMutate

Fields
Field Name Description
productPrepaymentUser - ProductPrepaymentUserType
Example
{"productPrepaymentUser": ProductPrepaymentUserType}
Types

ProductPrepaymentUserStatus

Description

An enumeration.

Values
Enum Value Description

PURCHASED

 purchased

EXPIRED

 expired

SPENT

 spent

CANCELED

 canceled

RETURNED

 returned
Example
"PURCHASED"
Types

ProductPrepaymentUserType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
status - ProductPrepaymentUserStatus!
balance - Int!
productPrepayment - ProductPrepaymentType!
user - UserType!
holder - HolderType
card - CardType!
purchasedAt - DateTime!
expiresAt - DateTime
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "status": "PURCHASED",
  "balance": 987,
  "productPrepayment": ProductPrepaymentType,
  "user": UserType,
  "holder": HolderType,
  "card": CardType,
  "purchasedAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "transactions": TransactionTypeConnection,
  "record": "xyz789"
}
Types

ProductRuleInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
value - Int

Required
item - ExternalItemInput

Required
productPrepaymentId - String
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": false,
  "value": 123,
  "item": ExternalItemInput,
  "productPrepaymentId": "xyz789"
}
Types

ProductRuleMutate

Fields
Field Name Description
productRule - ProductRuleType
Example
{"productRule": ProductRuleType}
Types

ProductRuleType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
value - Int!
item - StockProductType!
productPrepayment - ProductPrepaymentType!
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "value": 987,
  "item": StockProductType,
  "productPrepayment": ProductPrepaymentType,
  "record": "abc123"
}
Types

Refresh

Fields
Field Name Description
token - String
payload - GenericScalar
Example
{
  "token": "xyz789",
  "payload": GenericScalar
}
Types

RegistrationCodeType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
cards - JSONString!
code - String!
creator - UserType!
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "cards": JSONString,
  "code": "abc123",
  "creator": UserType,
  "record": "xyz789"
}
Types

RestrictionTypes

Values
Enum Value Description

TEST1

TEST2
Example
"TEST1"
Types

Roles

Values
Enum Value Description

CONSUMER

CASHIER

MANAGER
Example
"CONSUMER"
Types

SaleInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
name - String

Required
strategy - Strategies

Required
registered - Boolean

Required
saleFrom - DateTime

Required
saleTo - DateTime

Required
companies - [String]
cashiers - [String]
publicDiscountPackage - DiscountPackageInput
privateDiscountPackage - PrivateDiscountPackageInput
timeRanges - [TimeRangeInput]
creatorId - String
description - String
picture - String
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": false,
  "name": "xyz789",
  "strategy": "MOST_PREFERABLY",
  "registered": true,
  "saleFrom": "2007-12-03T10:15:30Z",
  "saleTo": "2007-12-03T10:15:30Z",
  "companies": ["abc123"],
  "cashiers": ["xyz789"],
  "publicDiscountPackage": DiscountPackageInput,
  "privateDiscountPackage": PrivateDiscountPackageInput,
  "timeRanges": [TimeRangeInput],
  "creatorId": "abc123",
  "description": "xyz789",
  "picture": "abc123"
}
Types

SaleMutate

Fields
Field Name Description
sale - SaleType
Example
{"sale": SaleType}
Types

SaleStrategy

Description

An enumeration.

Values
Enum Value Description

MOST_PREFERABLY

 most_preferably

LEAST_PREFERABLY

 least_preferably

SUBORDINATE

 subordinate

SUPERIOR

 superior
Example
"MOST_PREFERABLY"
Types

SaleType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
description - String
strategy - SaleStrategy!
registered - Boolean!
saleFrom - DateTime!
saleTo - DateTime!
companies - CompanyTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
cashiers - CashierTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
publicDiscountPackage - DiscountPackageType
privateDiscountPackage - DiscountPackageType
timeRanges - [TimeRangeType!]!
users - [UserType]
picture - String!
creator - UserType!
vouchers - VoucherTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
status - DiscountStats
userCount - Int
voucherCount - Int
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "description": "xyz789",
  "strategy": "MOST_PREFERABLY",
  "registered": false,
  "saleFrom": "2007-12-03T10:15:30Z",
  "saleTo": "2007-12-03T10:15:30Z",
  "companies": CompanyTypeConnection,
  "cashiers": CashierTypeConnection,
  "publicDiscountPackage": DiscountPackageType,
  "privateDiscountPackage": DiscountPackageType,
  "timeRanges": [TimeRangeType],
  "users": [UserType],
  "picture": "abc123",
  "creator": UserType,
  "vouchers": VoucherTypeConnection,
  "record": "xyz789",
  "status": "ACTIVE",
  "userCount": 123,
  "voucherCount": 987
}
Types

SaleTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [SaleTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [SaleTypeEdge]
}
Types

SaleTypeEdge

Description

A Relay edge containing a SaleType and its cursor.

Fields
Field Name Description
node - SaleType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": SaleType,
  "cursor": "xyz789"
}
Types

SettingInput

Fields
Input Field Description
ownCurrencyRates - Boolean

Required
Example
{"ownCurrencyRates": true}
Types

SettingType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
value - Boolean!
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "value": true,
  "record": "xyz789"
}
Types

SettingTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [SettingTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [SettingTypeEdge]
}
Types

SettingTypeEdge

Description

A Relay edge containing a SettingType and its cursor.

Fields
Field Name Description
node - SettingType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": SettingType,
  "cursor": "xyz789"
}
Types

SetupCompanyInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
currencies - [CurrencyInput]

Required
countries - [CountryInput]

Required
externalSources - [ExternalSourceInput]

Required
company - CompanyInput

Required
setting - SettingInput

Required
Example
{
  "record": "abc123",
  "delete": true,
  "isPreview": true,
  "currencies": [CurrencyInput],
  "countries": [CountryInput],
  "externalSources": [ExternalSourceInput],
  "company": CompanyInput,
  "setting": SettingInput
}
Types

StockGroupType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
group - Int!
name - String
category - String
additionalData - JSONString!
externalSource - ExternalSourceField
stockproductSet - StockProductTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
discounts - DiscountTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
surchargesStockGroups - [SurchargeStockGroupType!]!
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "group": 123,
  "name": "xyz789",
  "category": "xyz789",
  "additionalData": JSONString,
  "externalSource": ExternalSourceField,
  "stockproductSet": StockProductTypeConnection,
  "discounts": DiscountTypeConnection,
  "packageRules": PackageRuleTypeConnection,
  "surchargesStockGroups": [SurchargeStockGroupType],
  "record": "abc123"
}
Types

StockGroupTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [StockGroupTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [StockGroupTypeEdge]
}
Types

StockGroupTypeEdge

Description

A Relay edge containing a StockGroupType and its cursor.

Fields
Field Name Description
node - StockGroupType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": StockGroupType,
  "cursor": "xyz789"
}
Types

StockProductType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
primaryKey - Int!
code - Int!
name - String
price - Float
additionalData - JSONString!
group - StockGroupType!
externalSource - ExternalSourceField
discounts - DiscountTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
productRules - [ProductRuleType!]!
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "primaryKey": 987,
  "code": 987,
  "name": "xyz789",
  "price": 123.45,
  "additionalData": JSONString,
  "group": StockGroupType,
  "externalSource": ExternalSourceField,
  "discounts": DiscountTypeConnection,
  "packageRules": PackageRuleTypeConnection,
  "productRules": [ProductRuleType],
  "transactions": TransactionTypeConnection,
  "record": "xyz789"
}
Types

StockProductTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [StockProductTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [StockProductTypeEdge]
}
Types

StockProductTypeEdge

Description

A Relay edge containing a StockProductType and its cursor.

Fields
Field Name Description
node - StockProductType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": StockProductType,
  "cursor": "xyz789"
}
Types

Strategies

Values
Enum Value Description

MOST_PREFERABLY

LEAST_PREFERABLY

SUBORDINATE

SUPERIOR
Example
"MOST_PREFERABLY"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

SurchargeStockGroupType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
charged - String
dinerGroup - DinerGroupType!
stockGroup - StockGroupTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
surcharges - [SurchargeType!]!
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "charged": "abc123",
  "dinerGroup": DinerGroupType,
  "stockGroup": StockGroupTypeConnection,
  "surcharges": [SurchargeType]
}
Types

SurchargeType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
group - Boolean!
value - Int!
valueForm - SurchargeValueForm!
limit - Int!
organisation - OrganisationType!
dinerGroup - DinerGroupType
surchargeFoodmanGroup - SurchargeStockGroupType
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "group": false,
  "value": 123,
  "valueForm": "PERCENTAGE",
  "limit": 987,
  "organisation": OrganisationType,
  "dinerGroup": DinerGroupType,
  "surchargeFoodmanGroup": SurchargeStockGroupType
}
Types

SurchargeValueForm

Description

An enumeration.

Values
Enum Value Description

PERCENTAGE

 percentage

ABSOLUTE

 absolute

MULTIPLICATION

 multiplication
Example
"PERCENTAGE"
Types

Time

Description

The Time scalar type represents a Time value as specified by iso8601.

Example
"10:15:30Z"
Types

TimeRangeInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
day - Int

Required
month - Int

Required
timeFrom - Time

Required
timeTo - Time

Required
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": false,
  "day": 987,
  "month": 987,
  "timeFrom": "10:15:30Z",
  "timeTo": "10:15:30Z"
}
Types

TimeRangeMutate

Fields
Field Name Description
timeRange - TimeRangeType
Example
{"timeRange": TimeRangeType}
Types

TimeRangeType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
day - Int!
month - Int!
timeFrom - Time!
timeTo - Time!
discounts - DiscountTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
sales - SaleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
vouchers - VoucherTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "day": 987,
  "month": 123,
  "timeFrom": "10:15:30Z",
  "timeTo": "10:15:30Z",
  "discounts": DiscountTypeConnection,
  "sales": SaleTypeConnection,
  "packageRules": PackageRuleTypeConnection,
  "vouchers": VoucherTypeConnection,
  "record": "xyz789"
}
Types

TokenActivateInput

Fields
Input Field Description
token - String

Required
Example
{"token": "xyz789"}
Types

TokenActivateMutate

Fields
Field Name Description
token - String
Example
{"token": "xyz789"}
Types

TokenInput

Fields
Input Field Description
username - String

Required
password - String

Required
Example
{
  "username": "abc123",
  "password": "abc123"
}
Types

TokenMutate

Fields
Field Name Description
token - TokenType
Example
{"token": TokenType}
Types

TokenType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
user - UserType!
expiresAt - DateTime
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "user": UserType,
  "expiresAt": "2007-12-03T10:15:30Z",
  "record": "abc123"
}
Types

TransactionInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
description - String
amount - Int
userId - String
cardCode - String
userWalletId - String
operationId - String
discountPackageId - String
bill - String
items - [TransactionItemInput]
voucherId - String
productPrepaymentId - String
cashierId - String
companyId - String
currencyId - String
currencyCode - String
previousOperations - [String]
payments - [String]
billAmount - Int
paymentAmount - Int
prepaidProductsWithdrawal - [PrepaidProductWithdrawalInput]
prepaidProductsPurchase - [PrepaidProductPurchaseInput]
identification - UUID

Required
plannedTo - DateTime
isConfirmed - Boolean
Example
{
  "record": "abc123",
  "delete": false,
  "isPreview": true,
  "description": "abc123",
  "amount": 987,
  "userId": "xyz789",
  "cardCode": "abc123",
  "userWalletId": "abc123",
  "operationId": "xyz789",
  "discountPackageId": "xyz789",
  "bill": "xyz789",
  "items": [TransactionItemInput],
  "voucherId": "abc123",
  "productPrepaymentId": "abc123",
  "cashierId": "xyz789",
  "companyId": "abc123",
  "currencyId": "abc123",
  "currencyCode": "abc123",
  "previousOperations": ["xyz789"],
  "payments": ["abc123"],
  "billAmount": 123,
  "paymentAmount": 123,
  "prepaidProductsWithdrawal": [
    PrepaidProductWithdrawalInput
  ],
  "prepaidProductsPurchase": [
    PrepaidProductPurchaseInput
  ],
  "identification": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "plannedTo": "2007-12-03T10:15:30Z",
  "isConfirmed": true
}
Types

TransactionItemInput

Fields
Input Field Description
externalId - String!

Required
externalReferenceId - String
externalSourceId - UUID!

Required
id - Int!

Required
priceLevel - Int!

Required
singlePrice - Int!

Required
count - Int!

Required
Example
{
  "externalId": "abc123",
  "externalReferenceId": "abc123",
  "externalSourceId": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "id": 123,
  "priceLevel": 123,
  "singlePrice": 987,
  "count": 987
}
Types

TransactionMutate

Fields
Field Name Description
transaction - [TransactionType]
metadata - GenericScalar
Example
{
  "transaction": [TransactionType],
  "metadata": GenericScalar
}
Types

TransactionOperationType

Description

An enumeration.

Values
Enum Value Description

ADD

 add

CANCEL

 cancel

SUBTRACT

 subtract
Example
"ADD"
Types

TransactionSource

Description

An enumeration.

Values
Enum Value Description

MEAL_MAN

 meal_man

LOYAL_MAN

 loyal_man

FOOD_MAN

 food_man
Example
"MEAL_MAN"
Types

TransactionTransactionType

Description

An enumeration.

Values
Enum Value Description

CREDIT

 credit

BONUS

 bonus

COUPON

 coupon

VOUCHER

 voucher

DISCOUNT

 discount

PREPAID_PRODUCT_WITHDRAWAL

 prepaid_product_withdrawal

PREPAID_PRODUCT_PURCHASE

 prepaid_product_purchase

PURCHASE_CREDIT

 purchase_credit

MANUAL_CREDIT

 manual_credit

MANUAL_BONUS

 manual_bonus

TRANSFER

 transfer
Example
"CREDIT"
Types

TransactionType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
description - String
amount - Int!
count - Int!
transactionType - TransactionTransactionType!
items - StockProductTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
bill - String
source - TransactionSource!
user - UserType
userWallet - UserWalletType
voucher - VoucherType
productPrepayment - ProductPrepaymentType
productPrepaymentUser - ProductPrepaymentUserType
cashier - CashierType
company - CompanyType
currency - CurrencyType
operation - OperationType!
creator - UserType!
packageRule - PackageRuleType
discount - DiscountType
operationType - TransactionOperationType!
countCanceled - Int!
transactionReference - UUID
identification - UUID!
metadata - JSONString
isConfirmed - Boolean!
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "amount": 123,
  "count": 987,
  "transactionType": "CREDIT",
  "items": StockProductTypeConnection,
  "bill": "abc123",
  "source": "MEAL_MAN",
  "user": UserType,
  "userWallet": UserWalletType,
  "voucher": VoucherType,
  "productPrepayment": ProductPrepaymentType,
  "productPrepaymentUser": ProductPrepaymentUserType,
  "cashier": CashierType,
  "company": CompanyType,
  "currency": CurrencyType,
  "operation": OperationType,
  "creator": UserType,
  "packageRule": PackageRuleType,
  "discount": DiscountType,
  "operationType": "ADD",
  "countCanceled": 123,
  "transactionReference": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "identification": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "metadata": JSONString,
  "isConfirmed": false,
  "record": "xyz789"
}
Types

TransactionTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [TransactionTypeEdge]! Contains the nodes in this connection.
detailedUserPdfUrl - String
detailedUserXlsxUrl - String
summaryUserPdfUrl - String
summaryUserXlsxUrl - String
detailedDatePdfUrl - String
detailedDateXlsxUrl - String
summaryDatePdfUrl - String
summaryDateXlsxUrl - String
Example
{
  "pageInfo": PageInfo,
  "edges": [TransactionTypeEdge],
  "detailedUserPdfUrl": "xyz789",
  "detailedUserXlsxUrl": "abc123",
  "summaryUserPdfUrl": "abc123",
  "summaryUserXlsxUrl": "abc123",
  "detailedDatePdfUrl": "abc123",
  "detailedDateXlsxUrl": "xyz789",
  "summaryDatePdfUrl": "abc123",
  "summaryDateXlsxUrl": "xyz789"
}
Types

TransactionTypeEdge

Description

A Relay edge containing a TransactionType and its cursor.

Fields
Field Name Description
node - TransactionType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": TransactionType,
  "cursor": "xyz789"
}
Types

TransferInput

Fields
Input Field Description
source - String

Required
destination - String

Required
amount - Int

Required
description - String
Example
{
  "source": "abc123",
  "destination": "xyz789",
  "amount": 123,
  "description": "xyz789"
}
Types

TransferMutate

Fields
Field Name Description
transfers - [TransactionType]
Example
{"transfers": [TransactionType]}
Types

TransferRateInput

Fields
Input Field Description
id - String

Required
rate - Float

Required
Example
{"id": "xyz789", "rate": 987.65}
Types

Triggers

Values
Enum Value Description

PURCHASE

PRODUCT

AUTOMATIC

WITHDRAWAL
Example
"PURCHASE"
Types

UUID

Description

Leverages the internal Python implmeentation of UUID (uuid.UUID) to provide native UUID objects in fields, resolvers and input.

Example
"d3eddcd2-0909-4f69-9b7f-ab886c512593"
Types

UserConditionsInput

Fields
Input Field Description
name - [String]
address - [String]
gender - [String]
age - [Int]
packages - [String]
products - [String]
balance - [Int]
Example
{
  "name": ["abc123"],
  "address": ["abc123"],
  "gender": ["abc123"],
  "age": [123],
  "packages": ["xyz789"],
  "products": ["abc123"],
  "balance": [987]
}
Types

UserDiscountPackageInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
packageId - String

Required
userId - String

Required
holderId - String
cardId - String
userWallets - [String]
additionDate - DateTime

Required
activationDate - DateTime
Example
{
  "record": "xyz789",
  "delete": false,
  "isPreview": true,
  "packageId": "xyz789",
  "userId": "xyz789",
  "holderId": "xyz789",
  "cardId": "abc123",
  "userWallets": ["xyz789"],
  "additionDate": "2007-12-03T10:15:30Z",
  "activationDate": "2007-12-03T10:15:30Z"
}
Types

UserDiscountPackageMutate

Fields
Field Name Description
userDiscountPackage - UserDiscountPackageType
Example
{"userDiscountPackage": UserDiscountPackageType}
Types

UserDiscountPackageType

Fields
Field Name Description
id - UUID!
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
package - DiscountPackageType!
user - UserType!
holder - HolderType
card - CardType!
userWallets - UserWalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
additionDate - DateTime!
activationDate - DateTime
record - String
Example
{
  "id": "d3eddcd2-0909-4f69-9b7f-ab886c512593",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "package": DiscountPackageType,
  "user": UserType,
  "holder": HolderType,
  "card": CardType,
  "userWallets": UserWalletTypeConnection,
  "additionDate": "2007-12-03T10:15:30Z",
  "activationDate": "2007-12-03T10:15:30Z",
  "record": "xyz789"
}
Types

UserGender

Description

An enumeration.

Values
Enum Value Description

MALE

 male

FEMALE

 female
Example
"MALE"
Types

UserInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
username - String
password - String
name - String

Required
surname - String

Required
email - String
phoneNumber - String
address - String
gender - Genders
status - UserStats

Required
work - String
statusMessage - String
description - String
companyId - String
personalNumb - Int
job - String
perpetuation - Int
infMail - Boolean
infApprove - Boolean
extraData - GenericScalar
profilePic - String
role - Roles
permissions - GenericScalar
cardHolders - [CardHoldersInput]
transactions - [ManualTransactionInput]
validTill - Date
Example
{
  "record": "abc123",
  "delete": false,
  "isPreview": true,
  "username": "abc123",
  "password": "abc123",
  "name": "abc123",
  "surname": "abc123",
  "email": "xyz789",
  "phoneNumber": "abc123",
  "address": "xyz789",
  "gender": "MALE",
  "status": "ACTIVE",
  "work": "xyz789",
  "statusMessage": "xyz789",
  "description": "xyz789",
  "companyId": "xyz789",
  "personalNumb": 987,
  "job": "xyz789",
  "perpetuation": 123,
  "infMail": false,
  "infApprove": false,
  "extraData": GenericScalar,
  "profilePic": "xyz789",
  "role": "CONSUMER",
  "permissions": GenericScalar,
  "cardHolders": [CardHoldersInput],
  "transactions": [ManualTransactionInput],
  "validTill": "2007-12-03"
}
Types

UserMutate

Fields
Field Name Description
user - UserType
Example
{"user": UserType}
Types

UserStats

Values
Enum Value Description

ACTIVE

BLOCKED

PROCESSED

VALID

INVALID
Example
"ACTIVE"
Types

UserStatus

Description

An enumeration.

Values
Enum Value Description

ACTIVE

 active

BLOCKED

 blocked

PROCESSED

 processed

VALID

 valid

INVALID

 invalid
Example
"ACTIVE"
Types

UserType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
lastLogin - DateTime
userPermissions - PermissionTypeConnection! Specific permissions for this user.
Arguments
before - String
after - String
first - Int
last - Int
personalNumb - Int
username - String
name - String!
surname - String!
gender - UserGender
status - UserStatus!
statusMessage - String
email - String
phoneNumber - String!
address - String!
job - String
profilePic - String
perpetuation - Int
infMail - Boolean!
infApprove - Boolean!
isActive - Boolean!
isSuperuser - Boolean!
password - String
company - CompanyType
organisation - OrganisationType
extraData - GenericScalar
work - String
validTill - Date
logs - [LogEntryType!]!
createdDiscountPackages - DiscountPackageTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
createdWallets - WalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
userWallets - UserWalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
holders - HolderTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
myCards - CardTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
createdCards - CardTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
sales - SaleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
createdSales - SaleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
createdProductPrepayments - ProductPrepaymentTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
productPrepaymentsUsers - [ProductPrepaymentUserType!]!
createdVouchers - VoucherTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
myTransactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
createdTransactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
userDiscountPackages - [UserDiscountPackageType!]!
createdRegistrationCodes - [RegistrationCodeType!]!
tokens - [TokenType!]!
changes - ChangeHistoryTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
changedStatuses - ChangeHistoryTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
dinerGroups - [DinerGroupType!]!
diners - [DinerType!]!
record - String
fullName - String
role - String
permissions - GenericScalar
cardCount - Int
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "lastLogin": "2007-12-03T10:15:30Z",
  "userPermissions": PermissionTypeConnection,
  "personalNumb": 123,
  "username": "xyz789",
  "name": "xyz789",
  "surname": "xyz789",
  "gender": "MALE",
  "status": "ACTIVE",
  "statusMessage": "abc123",
  "email": "xyz789",
  "phoneNumber": "abc123",
  "address": "abc123",
  "job": "abc123",
  "profilePic": "xyz789",
  "perpetuation": 987,
  "infMail": true,
  "infApprove": false,
  "isActive": true,
  "isSuperuser": false,
  "password": "abc123",
  "company": CompanyType,
  "organisation": OrganisationType,
  "extraData": GenericScalar,
  "work": "xyz789",
  "validTill": "2007-12-03",
  "logs": [LogEntryType],
  "createdDiscountPackages": DiscountPackageTypeConnection,
  "createdWallets": WalletTypeConnection,
  "userWallets": UserWalletTypeConnection,
  "holders": HolderTypeConnection,
  "myCards": CardTypeConnection,
  "createdCards": CardTypeConnection,
  "sales": SaleTypeConnection,
  "createdSales": SaleTypeConnection,
  "createdProductPrepayments": ProductPrepaymentTypeConnection,
  "productPrepaymentsUsers": [ProductPrepaymentUserType],
  "createdVouchers": VoucherTypeConnection,
  "myTransactions": TransactionTypeConnection,
  "createdTransactions": TransactionTypeConnection,
  "userDiscountPackages": [UserDiscountPackageType],
  "createdRegistrationCodes": [RegistrationCodeType],
  "tokens": [TokenType],
  "changes": ChangeHistoryTypeConnection,
  "changedStatuses": ChangeHistoryTypeConnection,
  "dinerGroups": [DinerGroupType],
  "diners": [DinerType],
  "record": "abc123",
  "fullName": "abc123",
  "role": "abc123",
  "permissions": GenericScalar,
  "cardCount": 987
}
Types

UserTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [UserTypeEdge]! Contains the nodes in this connection.
userListPdfUrl - String
userListXlsxUrl - String
balancePdfUrl - String
balanceXlsxUrl - String
collectPdfUrl - String
collectXlsxUrl - String
cardPdfUrl - String
cardXlsxUrl - String
productPrepaymentsPdfUrl - String
productPrepaymentsXlsxUrl - String
productPrepaymentsTransactionsPdfUrl - String
productPrepaymentsTransactionsXlsxUrl - String
Example
{
  "pageInfo": PageInfo,
  "edges": [UserTypeEdge],
  "userListPdfUrl": "abc123",
  "userListXlsxUrl": "abc123",
  "balancePdfUrl": "abc123",
  "balanceXlsxUrl": "xyz789",
  "collectPdfUrl": "abc123",
  "collectXlsxUrl": "xyz789",
  "cardPdfUrl": "abc123",
  "cardXlsxUrl": "xyz789",
  "productPrepaymentsPdfUrl": "xyz789",
  "productPrepaymentsXlsxUrl": "abc123",
  "productPrepaymentsTransactionsPdfUrl": "xyz789",
  "productPrepaymentsTransactionsXlsxUrl": "xyz789"
}
Types

UserTypeEdge

Description

A Relay edge containing a UserType and its cursor.

Fields
Field Name Description
node - UserType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": UserType,
  "cursor": "xyz789"
}
Types

UserWalletInput

Fields
Input Field Description
record - String
delete - Boolean
isPreview - Boolean
walletId - String

Required
packageId - String

Required
userId - String
balance - Int
Example
{
  "record": "xyz789",
  "delete": true,
  "isPreview": true,
  "walletId": "abc123",
  "packageId": "xyz789",
  "userId": "abc123",
  "balance": 987
}
Types

UserWalletMutate

Fields
Field Name Description
userWallet - UserWalletType
Example
{"userWallet": UserWalletType}
Types

UserWalletType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
balance - Int!
wallet - WalletType!
user - UserType
holders - HolderTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
userDiscountPackages - [UserDiscountPackageType!]!
record - String
filteredBalance - Int
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "balance": 123,
  "wallet": WalletType,
  "user": UserType,
  "holders": HolderTypeConnection,
  "transactions": TransactionTypeConnection,
  "userDiscountPackages": [UserDiscountPackageType],
  "record": "abc123",
  "filteredBalance": 123
}
Types

UserWalletTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [UserWalletTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [UserWalletTypeEdge]
}
Types

UserWalletTypeEdge

Description

A Relay edge containing a UserWalletType and its cursor.

Fields
Field Name Description
node - UserWalletType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": UserWalletType,
  "cursor": "xyz789"
}
Types

ValueForms

Values
Enum Value Description

PERCENTAGE

ABSOLUTE

MULTIPLICATION
Example
"PERCENTAGE"
Types

ValueTypes

Values
Enum Value Description

CREDIT

BONUS
Example
"CREDIT"
Types

Verify

Fields
Field Name Description
payload - GenericScalar
Example
{"payload": GenericScalar}
Types

VoucherApplication

Description

An enumeration.

Values
Enum Value Description

BILL

 bill

ITEM

 item
Example
"BILL"
Types

VoucherCodeType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
code - String!
voucher - VoucherType
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "code": "xyz789",
  "voucher": VoucherType,
  "record": "xyz789"
}
Types

VoucherCodeTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [VoucherCodeTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [VoucherCodeTypeEdge]
}
Types

VoucherCodeTypeEdge

Description

A Relay edge containing a VoucherCodeType and its cursor.

Fields
Field Name Description
node - VoucherCodeType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": VoucherCodeType,
  "cursor": "xyz789"
}
Types

VoucherCreateInput

Fields
Input Field Description
codes - [String]

Required
status - VoucherStats

Required
restriction - Boolean

Required
application - Applications

Required
saleId - String

Required
timeRanges - [TimeRangeInput]
used - Int
capacity - Int
startsAt - DateTime
expiresAt - DateTime
Example
{
  "codes": ["abc123"],
  "status": "NEW",
  "restriction": true,
  "application": "BILL",
  "saleId": "xyz789",
  "timeRanges": [TimeRangeInput],
  "used": 987,
  "capacity": 123,
  "startsAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

VoucherCreateMutate

Fields
Field Name Description
vouchers - [VoucherType]
Example
{"vouchers": [VoucherType]}
Types

VoucherDeleteInput

Fields
Input Field Description
records - [String]

Required
Example
{"records": ["abc123"]}
Types

VoucherDeleteMutate

Fields
Field Name Description
vouchers - [VoucherType]
Example
{"vouchers": [VoucherType]}
Types

VoucherStats

Values
Enum Value Description

NEW

USED

EXPIRED

PAYED_OUT
Example
"NEW"
Types

VoucherStatus

Description

An enumeration.

Values
Enum Value Description

NEW

 new

USED

 used

EXPIRED

 expired

PAYED_OUT

 payed-out
Example
"NEW"
Types

VoucherType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
code - VoucherCodeType
status - VoucherStatus!
restriction - Boolean!
capacity - Int
used - Int
application - VoucherApplication!
sale - SaleType!
timeRanges - [TimeRangeType!]!
creator - UserType!
startsAt - DateTime
expiresAt - DateTime
transactions - TransactionTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": "4",
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "code": VoucherCodeType,
  "status": "NEW",
  "restriction": true,
  "capacity": 987,
  "used": 987,
  "application": "BILL",
  "sale": SaleType,
  "timeRanges": [TimeRangeType],
  "creator": UserType,
  "startsAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "transactions": TransactionTypeConnection,
  "record": "abc123"
}
Types

VoucherTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [VoucherTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [VoucherTypeEdge]
}
Types

VoucherTypeEdge

Description

A Relay edge containing a VoucherType and its cursor.

Fields
Field Name Description
node - VoucherType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": VoucherType,
  "cursor": "xyz789"
}
Types

VoucherUpdateEntityInput

Fields
Input Field Description
record - String

Required
code - String
status - VoucherStats
restriction - Boolean
application - Applications
saleId - String
timeRanges - [TimeRangeInput]
used - Int
capacity - Int
startsAt - DateTime
expiresAt - DateTime
Example
{
  "record": "abc123",
  "code": "xyz789",
  "status": "NEW",
  "restriction": false,
  "application": "BILL",
  "saleId": "abc123",
  "timeRanges": [TimeRangeInput],
  "used": 987,
  "capacity": 987,
  "startsAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

VoucherUpdateInput

Fields
Input Field Description
vouchers - [VoucherUpdateEntityInput]
Example
{"vouchers": [VoucherUpdateEntityInput]}
Types

VoucherUpdateMutate

Fields
Field Name Description
vouchers - [VoucherType]
Example
{"vouchers": [VoucherType]}
Types

WalletCreateInput

Fields
Input Field Description
name - String

Required
walletType - ValueTypes

Required
code - String

Required
transferRates - [TransferRateInput]
Example
{
  "name": "xyz789",
  "walletType": "CREDIT",
  "code": "xyz789",
  "transferRates": [TransferRateInput]
}
Types

WalletCreateMutate

Fields
Field Name Description
wallets - [WalletType]
Example
{"wallets": [WalletType]}
Types

WalletDeleteInput

Fields
Input Field Description
records - [String]

Required
Example
{"records": ["xyz789"]}
Types

WalletDeleteMutate

Fields
Field Name Description
wallets - [WalletType]
Example
{"wallets": [WalletType]}
Types

WalletType

Fields
Field Name Description
id - ID! The ID of the object.
deletedAt - DateTime
updatedAt - DateTime!
createdAt - DateTime!
name - String!
walletType - WalletWalletType!
transferRates - JSONString!
company - CompanyType!
currency - CurrencyType!
country - CountryType!
creator - UserType!
code - String!
userWallets - UserWalletTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
packageRules - PackageRuleTypeConnection!
Arguments
before - String
after - String
first - Int
last - Int
record - String
Example
{
  "id": 4,
  "deletedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "walletType": "CREDIT",
  "transferRates": JSONString,
  "company": CompanyType,
  "currency": CurrencyType,
  "country": CountryType,
  "creator": UserType,
  "code": "xyz789",
  "userWallets": UserWalletTypeConnection,
  "packageRules": PackageRuleTypeConnection,
  "record": "xyz789"
}
Types

WalletTypeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WalletTypeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [WalletTypeEdge]
}
Types

WalletTypeEdge

Description

A Relay edge containing a WalletType and its cursor.

Fields
Field Name Description
node - WalletType The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": WalletType,
  "cursor": "abc123"
}
Types

WalletUpdateInput

Fields
Input Field Description
record - String

Required
name - String
walletType - ValueTypes
transferRates - String
Example
{
  "record": "xyz789",
  "name": "xyz789",
  "walletType": "CREDIT",
  "transferRates": "xyz789"
}
Types

WalletUpdateMutate

Fields
Field Name Description
wallets - [WalletType]
Example
{"wallets": [WalletType]}
Types

WalletWalletType

Description

An enumeration.

Values
Enum Value Description

CREDIT

 credit

BONUS

 bonus
Example
"CREDIT"
Types

WalletsCreateInput

Fields
Input Field Description
wallets - [WalletCreateInput]!
Example
{"wallets": [WalletCreateInput]}
Types

WalletsUpdateInput

Fields
Input Field Description
wallets - [WalletUpdateInput]!
Example
{"wallets": [WalletUpdateInput]}
Documentation by Anvil SpectaQL