RAYNET CRM API (2.0.0)

Download OpenAPI specification:Download

Cloud CRM REST API je programové rozhraní systému RAYNET CRM, které umožňuje pracovat s daty uvnitř CRM z aplikací třetích stran. Komunikace probíhá standardním protokolem HTTP s ohledem na REST principy.

Připojení k RAYNET CRM

Komunikačním protokolem je HTTP, proto je možné použít libovolnou aplikaci nebo knihovnu, která tento protokol podporuje. Pro demonstraci bude využita aplikace curl. Alternativou je například add-on Talend API Tester do prohlížeče Google Chrome. Přístup je zabezpečen pomocí basic authentication (uživatelským jménem a API klíčem) a šifrován protokolem TLSv1.2 a vyšším (HTTPS) pro zajištění maximální bezpečnosti. V hlavičce požadavku je nutné zaslat název Vaší instance (např. moje-crm).

  curl -X GET -u 'uzivatel:api-klic' -H 'X-Instance-Name: moje-crm' 'https://app.raynet.cz/api/v2/company/'

Datové typy

Hodnoty jednotlivých atributů v systému RAYNET CRM jsou tvořeny několika základními datovými typy:

  • Řetězec - Textová hodnota.

  • Číslo - Číselná hodnota. V závislosti na kontextu se může jednat buď o číslo celé nebo o číslo desetinné. V desetinných číslech se používá desetinná tečka.

  • Pravdivostní hodnota - Hodnota ANO/NE. Pro hodnotu ANO lze využít true, on, yes a 1; pro hodnotu NE pak false, off, no a 0.

  • Datum - Datum jako řetězec ve formátu yyyy-MM-dd.

  • Datum a čas - Datum a čas jako řetězec ve formátu yyyy-MM-dd HH:mm. Akceptovány jsou také datum a čas ve formátu ISO8601 (např. 2022-01-01T12:00:00.000+01:00).

  • Reference - Datový typ reference odkazuje na jiný záznam v systému RAYNET CRM. V příchozích datech je reference mapou (JavaScriptový objektem), která obsahuje klíče:

    • id - Identifikátor referencovaného záznamu.

Datum a čas

Datum a čas jako řetězec ve formátu yyyy-MM-dd HH:mm je v časové zóně uživatele, přes kterého jsou API požadavky realizovány. Pro filtrování a zápis (PUT, POST) je možné využít oba formáty (yyyy-MM-dd HH:mm, ISO8601).

V response je ve výchozím stavu datum a čas formátován jako yyyy-MM-dd HH:mm v časové zóně uživatele. Přidáním parametru dateFormat=ISO8601 lze ovlivnit výstupní formát, kdy bude hodnota formátována do tvaru 2022-01-01T12:00:00.000+01:00. např. https://ww....company/?dateFormat=ISO8601

Filtrování seznamu

Operátory pracující nad atributy a hodnotami jsou následující:

  • EQ - Test na rovnost hodnot.

  • EQ_OR_NULL - Test na rovnost nebo prázdnou hodnotu.

  • NE - Test na nerovnost hodnot.

  • NE_OR_NULL - Test na nerovnost nebo prázdnou hodnotu.

  • LT - Hodnota v databázi je menší než zadaná.

  • LE - Hodnota v databázi je menší nebo rovna než zadaná.

  • GT - Hodnota v databázi je větší než zadaná.

  • GE - Hodnota v databázi je větší nebo rovna než zadaná.

  • LIKE - Test na hodnotu odpovídající výrazu (např. hodnota filtru ABC% nalezne všechny záznamy, které začínají znaky ABC).

  • LIKE_NOCASE - Obdoba LIKE, ale bez ohledu na malá a velká písmena.

  • IN - Test na rovnost (více) hodnot oddělených čárkou. Správný formát vstupu je např.: 1,2,3,4.

  • NOT_IN - Test na nerovnost (více) hodnot oddělených čárkou. Správný formát vstupu je např.: 1,2,3,4.

  • CUSTOM - Speciální operátor - chování testu je popsáno dále v dokumentaci.

Výchozím operátorem je rovnost EQ. Operátor se zapisuje do hranatých závorek za název atributu. Je tak možné zadat více filtrovacích kritérií nad stejným atributem. https://app..../?validFrom[GT]="2014-06-01"&validTill[LT]="2014-06-10" Častým scénářem je vyfiltrování všech záznamů, které mají daný atribut prázdný nebo naopak neprázdný. Pro tyto účely lze použít hodnotu prázdný řetězec v kombinaci s operátorem EQ nebo NE.

Uspořádání seznamu

Uspořádání seznamu je kontrolováno parametrem sortColumn a sortDirection. U každého API je výčet hodnot, pomocí kterých lze seznam řadit. Parametr sortDirection může nabývat hodnot:

  • ASC - Hodnoty jsou řazeny vzestupně

  • DESC - Hodnoty jsou řazeny sestupně

Stránkování seznamu

Seznam je možné stránkovat nastavením parametrů offset a limit. Offset udává první záznam, který bude zobrazen, limit pak počet záznamů. Maximální velikost stránky je 1 000 položek. Například https://app..../?offset=0&limit=2

Fulltext

Ve většině seznamů je možné využít fulltextové vyhledání podle zadaného textového řetězce. Slouží k tomu parametr fulltext, který se aplikuje např. takto: https://app..../?fulltext=nejakytext

Limity API

Každá API odpověď obsahuje hlavičky, které popisují stav využití API pro danou instanci.

curl -X GET -u 'uzivatel:api-klic' -H 'X-Instance-Name: moje-crm' 'https://app.raynet.cz/api/v2/company/'

HTTP/1.1 200 OK
Status: 200 OK
X-Ratelimit-Limit: 24000
X-Ratelimit-Remaining: 23999
X-Ratelimit-Reset: 1508889600

Význam jednotlivých hlaviček je následující:

Hlavička Význam
X-Ratelimit-Limit Celkový limit pro aktuální časové okno a instanci.
X-Ratelimit-Remaining Zbývající počet požadavků.
X-Ratelimit-Reset Čas, kdy bude vyprší časové okno a limit bude resetován. Hodnota udává unixový čas.

Pokud je limit překročen, je navrácena chybová hláška s HTTP kódem 429 Too Many Requests:

{
  "type": "RequestLimitReached",
  "message": "API request limit reached. See the X-RateLimit-* headers and check out the API documentation for more details."
}

Co když mi limity nestačí

Ve výchozím stavu je přístup limitován na 24 000 požadavků za den (uvažováno od půlnoci do další půlnoci v časové zóně UTC). V případě, že limit pro vaši integraci nestačí, kontaktujte naší zákaznickou podporu na e-mailu podpora@raynet.cz a spolu se určitě dobereme vhodného řešení.

Špatné přihlášení

V případě zaslaní více než 20 požadavků se špatnými přihlašovacími údaji, bude tento přístup na 60 minut zablokován. Toto omezení platí pro konkrétní IP adresu.

Klienti

API pro práci s klienty.

seznam klientů

Získání seznamu klientů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/company/?offset=0&limit=1&name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených klientů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "name" "regNumber"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

name
string
Example: name=Test s.r.o.

Filtrování klientů podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE.

lastName
string
Example: lastName=RAY

Filtrování klientů podle příjmení fyzické osoby. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

person
boolean
Example: person=true

Filtrování klientů podle příznaku Jedná se o fyzickou osobu

regNumber
string
Example: regNumber=12345678

Filtrování klientů podle IČ. Lze využít operátoru EQ, NE. Výchozím operátorem je EQ. Například: pro seznam všech klientů se zadaným IČ je nutné zadat regNumber[NE]=null

owner
integer <int64>
Example: owner=1

Filtrování klientů podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

rating
string

Filtrování klientů podle Ratingu

role
string

Filtrování klientů podle Role

state
string

Filtrování klientů podle Stavu

category
integer <int64>
Example: category=1

Filtrování klientů podle ID kategorie (CompanyCategory). Lze využít operátoru EQ, NE, IN

economyActivity
integer <int64>
Example: economyActivity=1

Filtrování klientů podle ID oboru (EconomyActivity). Lze využít operátoru EQ, NE, IN

companyClassification1
integer <int64>
Example: companyClassification1=1

Filtrování klientů podle ID klasifikace 1 (CompanyClassification1). Lze využít operátoru EQ, NE, IN

companyClassification2
integer <int64>
Example: companyClassification2=1

Filtrování klientů podle ID klasifikace 2 (CompanyClassification2). Lze využít operátoru EQ, NE, IN

companyClassification3
integer <int64>
Example: companyClassification3=1

Filtrování klientů podle ID klasifikace 3 (CompanyClassification3). Lze využít operátoru EQ, NE, IN

primaryAddress-contactInfo.email
string
Example: primaryAddress-contactInfo.email=test@test.cz

Filtrování klientů podle emailu u primární adresy. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

primaryAddress-contactInfo.email2
string
Example: primaryAddress-contactInfo.email2=test@test.cz

Filtrování klientů podle druhého emailu u primární adresy. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

primaryAddress-address.countryCode
string
Example: primaryAddress-address.countryCode=CZ

Filtrování klientů podle kódu země u primární adresy.

contactAddress-address.countryCode
string
Example: contactAddress-address.countryCode=CZ

Filtrování klientů podle kódu země u kontaktní adresy.

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování klientů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování klientů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování klientů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných klientů. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

gdprTemplate
string

Filtrování klientů podle právního titulu. Lze použít jen operátor CUSTOM.

withoutGdpr
string

Filtrování klientů, kteří nemají platný právní titul. Lze využít jen operátor CUSTOM. api/v2/company?withoutGdpr[CUSTOM]

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nový klient

Založení nového klienta s adresami

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Název]

person
boolean

[Jedná se o fyzickou osobu]

lastName
string

[Příjmení fyzické osoby] - povinný v případě, že je aktivní příznak 'Jedná se o fyzickou osobu'

firstName
string

[Jméno fyzické osoby]

titleBefore
string

[Titul před jménem fyzické osoby]

titleAfter
string

[Titul za jménem fyzické osoby]

salutation
string

[Oslovení]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

rating
required
string
Enum: "A" "B" "C"

[Rating]

state
required
string
Enum: "A_POTENTIAL" "B_ACTUAL" "C_DEFERRED" "D_UNATTRACTIVE"

[Stav]

role
required
string
Enum: "A_SUBSCRIBER" "B_PARTNER" "C_SUPPLIER" "D_RIVAL"

[Vztah]

notice
string

[Poznámka ke klientovi]

category
integer <int64>

[Kategorie] ID záznamu z číselníku CompanyCategory

contactSource
integer <int64>

[Zdroj kontaktu] ID záznamu z číselníku ContactSource

employeesNumber
integer <int64>

[Zaměstnanců] ID záznamu z číselníku EmployeesNumber

legalForm
integer <int64>

[Právní forma] ID záznamu z číselníku LegalForm

paymentTerm
integer <int64>

[Platbní podmínky] ID záznamu z číselníku PaymentTerm

turnover
integer <int64>

[Obrat] ID záznamu z číselníku CompanyTurnover

economyActivity
integer <int64>

[Obor] ID záznamu z číselníku EconomyActivity

companyClassification1
integer <int64>

[Klasifikace 1]ID záznamu z číselníku CompanyClassification1

companyClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku CompanyClassification2

companyClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku CompanyClassification3

regNumber
string

[IČ]

taxNumber
string

[DIČ]

taxNumber2
string

[IČ DPH] Pro slovenské klienty

taxPayer
string
Enum: "YES" "NO"

[Plátce DPH]

bankAccount
string

[Bankovní spojení]

databox
string

[Datová schránka]

court
string

[Spisová značka]

birthday
string <date>

[Narozeniny/Výročí]

Array of objects >= 0 items
object
originLead
integer <int64>

[Lead] ID leadu, ze kterého klient vznikl

tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "name": "RAYNET s.r.o.",
  • "securityLevel": 1,
  • "owner": 12,
  • "rating": "A",
  • "state": "A_POTENTIAL",
  • "role": "B_PARTNER",
  • "notice": "poznamka",
  • "category": 12,
  • "contactSource": 12,
  • "employeesNumber": 12,
  • "legalForm": 12,
  • "paymentTerm": 12,
  • "turnover": 12,
  • "economyActivity": 12,
  • "companyClassification1": 12,
  • "companyClassification2": 12,
  • "companyClassification3": 12,
  • "regNumber": "12345678",
  • "taxNumber": "CZ12345678",
  • "taxPayer": "YES",
  • "bankAccount": "123123123",
  • "addresses": [
    ],
  • "tags": [
    ],
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail klienta

Získání detailu klienta. V detailu je uveden klient se všemi evidovanými údaji včetně všech evidovaných adres. Pokud záznam klienta obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/company/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení klienta

Upravení dat klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Request Body schema: application/json
name
string

[Název]

person
boolean

[Jedná se o fyzickou osobu]

lastName
string

[Příjmení fyzické osoby] - povinný v případě, že je aktivní příznak 'Jedná se o fyzickou osobu'

firstName
string

[Jméno fyzické osoby]

titleBefore
string

[Titul před jménem fyzické osoby]

titleAfter
string

[Titul za jménem fyzické osoby]

salutation
string

[Oslovení]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

rating
string
Enum: "A" "B" "C"

[Rating]

state
string
Enum: "A_POTENTIAL" "B_ACTUAL" "C_DEFERRED" "D_UNATTRACTIVE"

[Stav]

role
string
Enum: "A_SUBSCRIBER" "B_PARTNER" "C_SUPPLIER" "D_RIVAL"

[Vztah]

notice
string

[Poznámka ke klientovi]

category
integer <int64>

[Kategorie] ID záznamu z číselníku CompanyCategory

contactSource
integer <int64>

[Zdroj kontaktu] ID záznamu z číselníku ContactSource

employeesNumber
integer <int64>

[Zaměstnanců] ID záznamu z číselníku EmployeesNumber

legalForm
integer <int64>

[Právní forma] ID záznamu z číselníku LegalForm

paymentTerm
integer <int64>

[Platbní podmínky] ID záznamu z číselníku PaymentTerm

turnover
integer <int64>

[Obrat] ID záznamu z číselníku CompanyTurnover

economyActivity
integer <int64>

[Obor] ID záznamu z číselníku EconomyActivity

companyClassification1
integer <int64>

[Klasifikace 1]ID záznamu z číselníku CompanyClassification1

companyClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku CompanyClassification2

companyClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku CompanyClassification3

regNumber
string

[IČ]

taxNumber
string

[DIČ]

taxNumber2
string

[IČ DPH] Pro slovenské klienty

taxPayer
string
Enum: "YES" "NO"

[Plátce DPH]

bankAccount
string

[Bankovní spojení]

databox
string

[Datová schránka]

court
string

[Spisová značka]

birthday
string <date>

[Narozeniny/Výročí]

object
originLead
integer <int64>

[Lead] ID leadu, ze kterého klient vznikl

object

Responses

Request samples

Content type
application/json
{
  • "name": "RAYNET s.r.o.",
  • "owner": 12,
  • "rating": "A",
  • "state": "A_POTENTIAL",
  • "role": "B_PARTNER",
  • "notice": "poznamka",
  • "category": 12,
  • "contactSource": 12,
  • "employeesNumber": 12,
  • "legalForm": 12,
  • "paymentTerm": 12,
  • "turnover": 12,
  • "economyActivity": 12,
  • "companyClassification1": 12,
  • "companyClassification2": 12,
  • "companyClassification3": 12,
  • "regNumber": "12345678",
  • "taxNumber": "CZ12345678",
  • "taxPayer": "YES",
  • "bankAccount": "123123123",
  • "customFields": {
    }
}

smazání klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

uzamčení klienta

Uzamčení záznamu klienta pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

odemčení klienta

Odemčení záznamu klienta k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

zneplatnění klienta

Zneplatnění záznamu klienta.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

obnovení platnosti klienta

Obnovení platnosti záznamu klienta.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

GDPR anonymize klienta

U záznamu se provede anonimizace data.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

přidání adresy ke klientovi

Přidání nové adresy ke klientovi s identifikátorem companyId. Adresa je zařazena mezi ostatní adresy (tzn. není primární).

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Request Body schema: application/json
object
object
territory
integer <int64>

[Obchodní teritorium] ID záznamu z číselníku Territory

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "contactInfo": {
    },
  • "territory": 12
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení adresy klienta

U klienta s identifikátorem companyId bude upravena adresa s identifikátorem addressId.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

addressId
required
integer <int64>
Example: 123

ID adresy

Request Body schema: application/json
object
object
territory
integer <int64>

[Obchodní teritorium] ID záznamu z číselníku Territory

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "contactInfo": {
    },
  • "territory": 12
}

smazání adresy klienta

U klienta s identifikátorem companyId bude smazána adresa s identifikátorem addressId. Nelze smazat primární adresu (tzn. u klienta vždy musí být alespoň jedna adresa).

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

addressId
required
integer <int64>
Example: 123

ID adresy

Responses

nastavení primární adresy

U klienta s identifikátorem companyId bude nastavena nová primární adresa. Adresa, která byla doposud označena jako primární se přesune mezi ostatní adresy.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

addressId
required
integer <int64>
Example: 123

ID adresy

Responses

nastavení kontaktní adresy

U klienta s identifikátorem companyId bude nastavena adresa jako kontaktní. Tato adresa se bude zobrazovat v seznamu klientů a bude jako první v detailu klienta. Adresa, která byla doposud označena jako kontaktní se přesune mezi ostatní adresy.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

addressId
required
integer <int64>
Example: 123

ID adresy

Responses

přidání TAGu ke Klientovi

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Request Body schema: application/json
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "muj tag"
}

smazání TAGu z Klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Request Body schema: application/json
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "muj tag"
}

Propojení na jiné klienty

Získání vazeb na jiné klienty.

https://app.raynet.cz/api/v2/company/1/relationship/
Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

přidání propojení na klienta

Přidání nové vazby klienta na jiného klienta. Vazba může být tří typů - vazba mateřského klienta na dceřinného ("parent"), dceřinného na mateřského ("slave") nebo volná vazba ("free"). Po přidání nové vazby vznikne mezi oběma klienty zároveň druhá vazba - vazba inverzní (např. pro novou vazbu typu "parent" vznikne zároveň opačná vazba typu "slave").

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

Request Body schema: application/json
companyJoin
required
integer <int64>

[Klient] ID záznamu klienta, ke kterému bude vazba vytvořena

companyJoinType
required
string
Enum: "parent" "slave" "free"

[Typ vztahu] Typ vztahu (parent - vztah mateřského klienta na dceřinného klienta, slave - vztah dceřinné na mateřskou, free - volná vazba)

notice
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "companyJoin": 5,
  • "companyJoinType": "parent",
  • "notice": "Zařazení v rámci holdingu"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení propojení na jiného klienta

U existujícího propojení je možné měnit už jenom poznámku.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

relationshipId
required
integer <int64>
Example: 123

ID vztahu s jiným klientem

Request Body schema: application/json
notice
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "notice": "Zařazení v rámci holdingu"
}

smazání propojení na jiného klienta

U zadaného klienta bude smazána vazba na jiného klienta. Pokud k odstraňované vazbě existuje vazba inverzní, bude rovněž smazána.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID klienta

relationshipId
required
integer <int64>
Example: 123

ID vazby s klientem

Responses

Sloučení duplicitního klienta

Při sloučení dojde k převedení všech dat ze zdrojového klienta do cílového klienta s následným smazáním zdrojového klienta. Podrobnosti o slučování najdete v tomto článku.

Authorizations:
(basicAuthinstanceName)
path Parameters
companyId
required
integer <int64>
Example: 123

ID cílového klienta, do tohoto záznamu se budou převádět data

sourceCompanyId
required
integer <int64>
Example: 123

ID zdrojového klienta, který bude sloučen s cílovým klientem a následně smazán

Responses

Kontaktní osoby

API pro práci s kontaktními osobami.

seznam kontaktních osob

https://app.raynet.cz/api/v2/person/?offset=0&limit=1&firstName[LIKE]=Jan%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených kontaktních osob je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "firstName" "lastName"
Example: sortColumn=firstName
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

firstName
string

Filtrování kontaktních osob podle křestního jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

lastName
string
Example: lastName=Novak

Filtrování kontaktních osob podle příjmení. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

category
integer <int64>
Example: category=1

Filtrování kontaktních osob podle ID kategorie (PersonCategory). Lze využít operátoru EQ, NE, IN

keyman
boolean
Example: keyman=true

Filtrování kontaktních osob podle příznaku Klíčová

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování kontaktních osob podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování kontaktních osob podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

owner
integer <int64>
Example: owner=1

Filtrování kontaktních osob podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id).

primaryRelationship-company-name
string
Example: primaryRelationship-company-name=RAY

Filtrování kontaktních osob podle názvu klienta v primárním vztahu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

primaryRelationship-company-id
integer <int64>
Example: primaryRelationship-company-id=1

Filtrování kontaktních osob podle ID klienta v primárním vztahu. Lze využít operátoru EQ, NE

personRelationship
integer <int64>

Filtrování kontaktních osob podle ID klienta, která je s osobou v nějakém vztahu (primárním nebo i vedlejším). Lze použít jen operátor CUSTOM.

userAccount-id
integer <int64>
Example: userAccount-id=3

Filtrování kontaktních osob podle ID uživatele. Lze využít operátoru EQ, NE. Jako hodnotu lze zadat i prázdný řetězec, např. pro vyfiltrování kontaktních osob bez uživ. účtu.

contactInfo.email
string
Example: contactInfo.email=test@test.cz

Filtrování kontaktních osob podle primárního emailu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

contactInfo.email2
string
Example: contactInfo.email2=test@test.cz

Filtrování kontaktních osob podle sekundárního emailu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování kontaktních osob podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných kontaktních osob. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

gdprTemplate
integer

Filtrování kontaktních osob podle právního titulu. Lze použít jen operátor CUSTOM.

withoutGdpr
string

Filtrování kontaktních osob, kteřé nemají platný právní titul. Lze využít jen operátor CUSTOM.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 2,
  • "data": [
    ]
}

založení nové kontaktní osoby

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
titleBefore
string

[Titul před]

firstName
string

[Jméno]

lastName
required
string

[Příjmení]

titleAfter
string

[Titul za]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

category
integer <int64>

[Kategorie] ID záznamu z číselníku PersonCategory

personClassification1
integer <int64>

[Klasifikace 1] ID záznamu z číselníku PersonClassification1

personClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku PersonClassification2

personClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku PersonClassification3

salutation
string

[Oslovení]

birthday
string

[Narozeniny]

language
integer <int64>

[Jazyk] ID záznamu z číselníku Language

maritalStatus
integer <int64>

[Rodinný stav] ID záznamu z číselníku MaritalStatus

gender
string
Enum: "MALE" "FEMALE"

[Pohlaví]

object
object
object
notice
string

[Poznámka k osobě]

object
tags
Array of strings
keyman
boolean

[Klíčová osoba]

originLead
integer <int64>

[Lead] ID leadu, ze kterého kontaktní osoba vznikla

Responses

Request samples

Content type
application/json
{
  • "titleBefore": "Ing.",
  • "firstName": "Marie",
  • "lastName": "Vyležíková",
  • "titleAfter": "Phd.",
  • "owner": 1,
  • "category": 96,
  • "personClassification1": 97,
  • "personClassification2": 98,
  • "personClassification3": 99,
  • "salutation": "pani",
  • "birthday": "2022-06-10",
  • "language": 70,
  • "maritalStatus": 78,
  • "gender": "FEMALE",
  • "contactInfo": {
    },
  • "privateAddress": {
    },
  • "notice": "poznamka",
  • "relationship": {
    },
  • "tags": [
    ],
  • "keyman": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail kontaktní osoby

Získání detailu kontaktní osoby. V detailu kontaktní osoby je uvedena kontaktní osoba se všemi evidovanými údaji včetně všech evidovaných vztahů k jednotlivým klientům. Pokud záznam kontaktní osoby obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/person/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení kontaktní osoby

Upravení dat kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Request Body schema: application/json
titleBefore
string

[Titul před]

firstName
string

[Jméno]

lastName
string

[Příjmení]

titleAfter
string

[Titul za]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

category
integer <int64>

[Kategorie] ID záznamu z číselníku PersonCategory

personClassification1
integer <int64>

[Klasifikace 1] ID záznamu z číselníku PersonClassification1

personClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku PersonClassification2

personClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku PersonClassification3

salutation
string

[Oslovení]

birthday
string

[Narozeniny]

language
integer <int64>

[Jazyk] ID záznamu z číselníku Language

maritalStatus
integer <int64>

[Rodinný stav] ID záznamu z číselníku MaritalStatus

gender
string
Enum: "MALE" "FEMALE"

[Pohlaví]

object
object
object
notice
string

[Poznámka k osobě]

object
keyman
boolean

[Klíčová osoba]

originLead
integer <int64>

[Lead] ID leadu, ze kterého kontaktní osoba vznikla

Responses

Request samples

Content type
application/json
{
  • "titleBefore": "Ing.",
  • "firstName": "Marie",
  • "lastName": "Vyležíková",
  • "titleAfter": "Phd.",
  • "owner": 1,
  • "category": 96,
  • "personClassification1": 97,
  • "personClassification2": 98,
  • "personClassification3": 99,
  • "salutation": "pani",
  • "birthday": "2022-06-10",
  • "language": 70,
  • "maritalStatus": 78,
  • "gender": "FEMALE",
  • "contactInfo": {
    },
  • "socialNetworkContact": {
    },
  • "privateAddress": {
    },
  • "notice": "poznamka",
  • "customFields": {
    },
  • "keyman": false
}

smazání kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

uzamčení kontaktní osoby

Uzamčení záznamu kontaktní osoby pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

odemčení kontaktní osoby

Odemčení záznamu kontaktní osoby k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

zneplatnění kontaktní osoby

Zneplatnění záznamu kontaktní osoby.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

obnovení platnosti kontaktní osoby

Obnovení platnosti záznamu kontaktní osoby.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

GDPR anonymize kontaktní osoby

U záznamu se provede anonimizace data.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Responses

přidání vztahu

Přidání nového vztahu kontaktní osoby s identifikátorem personId ke klientovi. Vztah bude zařazen mezi vedlejší vztahy.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Request Body schema: application/json
company
required
integer <int64>

[Klient] ID záznamu klienta

companyAddress
integer <int64>

[Adresa] ID záznamu adresy z klienta CompanyAddress

notice
string

[Poznámka]

type
required
string

[Pozice]

Responses

Request samples

Content type
application/json
{
  • "company": 1,
  • "companyAddress": 1,
  • "notice": "Podpora pro zákazníky",
  • "type": "podpora"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení vztahu

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

relationshipId
required
integer <int64>
Example: 123

ID vztahu s klientem

Request Body schema: application/json
company
required
integer <int64>

[Klient] ID záznamu klienta

companyAddress
integer <int64>

[Adresa] ID záznamu adresy z klienta CompanyAddress

notice
string

[Poznámka]

type
required
string

[Pozice]

Responses

Request samples

Content type
application/json
{
  • "company": 1,
  • "companyAddress": 1,
  • "notice": "Podpora pro zákazníky",
  • "type": "podpora"
}

smazání vztahu

U kontaktní osoby s identifikátorem personId bude smazán vztah ke klientovi s identifikátorem relationshipId.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

relationshipId
required
integer <int64>
Example: 123

ID vztahu s klientem

Responses

nastavení primárního vztahu s klientem

U kontaktní osoby s identifikátorem personId bude nastavena nový primární vztah s identifikátorem relationshipId. Tento klient se bude zobrazovat u kontaktní osoby jako hlavní (první). Vztah, který byl doposud jako primární, bude zařazen mezi vedlejší vztahy.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

relationshipId
required
integer <int64>
Example: 123

ID vztahu s klientem

Responses

přidání TAGu ke kontaktní osobě

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Request Body schema: application/json
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "muj tag"
}

smazání TAGu z kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID kontaktní osoby

Request Body schema: application/json
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "muj tag"
}

Sloučení duplicitní kontaktní osoby

Při sloučení dojde k převedení všech dat ze zdrojové kontaktní osoby do cílové kontaktní osoby s následným smazáním zdrojové kontaktní osoby. Podrobnosti o slučování najdete v tomto článku.

Authorizations:
(basicAuthinstanceName)
path Parameters
personId
required
integer <int64>
Example: 123

ID cílové kontaktní osoby, do tohoto záznamu se budou převádět data

sourcePersonId
required
integer <int64>
Example: 123

ID zdrojové kontaktní osoby, která bude sloučena s cílovou kontaktní osobou a následně smazána

Responses

Leady

API pro práci s leady.

seznam leadů

Získání seznamu leadů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/lead/?offset=0&limit=1&companyName[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených leadů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "leadDate" "priority" "companyName" "lastName"
Example: sortColumn=code
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=L-16-1111

Filtrování leadů podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

companyName
string
Example: companyName=RAY

Filtrování leadů podle jména klienta. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

lastName
string
Example: lastName=Novak

Filtrování leadů podle příjmení. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

contactInfo.email
string
Example: contactInfo.email=novak@raynet.cz

Filtrování leadů podle emailu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

contactInfo.email2
string
Example: contactInfo.email2=novak@raynet.cz

Filtrování leadů podle druhého emailu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

regNumber
string
Example: regNumber=1234567

Filtrování leadů podle IČ. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner
integer <int64>
Example: owner=1

Filtrování leadů podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

leadDate
string
Example: leadDate=2022-06-01

Filtrování leadů podle přijato. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Enum: "B_ACTIVE" "G_STORNO" "D_DONE"
Example: status=D_DONE

Filtrování OP podle skupiny stavu. Lze využít operátoru EQ, NE.

  • B_ACTIVE otevřené leady,
  • G_STORNO stornované leady,
  • D_DONE převedené leady
leadPhase
integer <int64>
Example: leadPhase=21

Filtrování leadů podle stavu (LeadPhase). Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování leadů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování leadů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování leadů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

gdprTemplate
integer <int64>

Filtrování leadů podle právního titulu. Lze použít jen operátor CUSTOM.

withoutGdpr
integer <int64>

Filtrování leadů, kteří nemají platný právní titul. Lze využít jen operátor CUSTOM.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 165,
  • "data": [
    ]
}

nový lead

Založení nového leadu. S volitelnou možností zaslat notifikaci o vytvoření leadu na vybrané emailové adresy (vhodné pro webové formuláře).

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
topic
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

companyName
string

[Název společnosti]

regNumber
string

[IČ]

firstName
string

[Jméno]

lastName
string

[Příjmení]

titleBefore
string

[Titul před]

titleAfter
string

[Titul za]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

contactSource
integer <int64>

[Zdroj] ID záznamu z číselníku ContactSource

category
integer <int64>

[Kategorie] ID záznamu z číselníku LeadCategory

notice
string

[Poznámka k leadu]

leadPhase
integer <int64>

[Stav leadu] ID záznamu z číselníku LeadPhase

tags
string

[Seznam štítků oddělených čárkou]

territory
integer <int64>

[Teritorium] ID záznamu z číselníku Territory

leadPerson
boolean

[Jedná se o fyzickou osobu]

object
object
object
object
notificationMessage
string

[Text notifikace]

notificationEmailAddresses
Array of strings

Responses

Request samples

Content type
application/json
{
  • "topic": "Objednávka",
  • "priority": "DEFAULT",
  • "companyName": "Neteče a nepoteče s.r.o",
  • "firstName": "Jan",
  • "lastName": "Kapka",
  • "owner": 1,
  • "notice": "Importováno xxxxz webu",
  • "category": 91,
  • "contactSource": 61,
  • "regNumber": "regNumber",
  • "leadPhase": 122,
  • "contactInfo": {
    },
  • "address": {
    },
  • "socialNetworkContact": {
    },
  • "customFields": {
    },
  • "tags": "aaa,bbb",
  • "notificationMessage": "Poptávka z webového formuláře",
  • "notificationEmailAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail leadu

Získání detailu leadu. Pokud záznam leadu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/lead/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID lead

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení leadu

Upravení dat leadu

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID leadu

Request Body schema: application/json
topic
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

leadPhase
integer <int64>

[Stav leadu] ID záznamu z číselníku LeadPhase

companyName
string

[Název společnosti]

regNumber
string

[IČ]

firstName
string

[Jméno]

lastName
string

[Příjmení]

titleBefore
string

[Titul před]

titleAfter
string

[Titul za]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

contactSource
integer <int64>

[Zdroj] ID záznamu z číselníku ContactSource

category
integer <int64>

[Kategorie] ID záznamu z číselníku LeadCategory

notice
string

[Poznámka k leadu]

tags
string

[Seznam štítků oddělených čárkou]

territory
integer <int64>

[Teritorium] ID záznamu z číselníku Territory

leadPerson
boolean

[Jedná se o fyzickou osobu]

object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "topic": "Objednávka",
  • "priority": "DEFAULT",
  • "companyName": "Neteče a nepoteče s.r.o",
  • "firstName": "Jan",
  • "lastName": "Kapka",
  • "owner": 1,
  • "leadPhase": 105,
  • "notice": "Importováno xxxxz webu",
  • "category": 91,
  • "contactSource": 61,
  • "regNumber": "regNumber",
  • "contactInfo": {
    },
  • "address": {
    },
  • "socialNetworkContact": {
    },
  • "customFields": {
    },
  • "tags": "aaa,bbb"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání leadu

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID lead

Responses

uzamčení leadu

Uzamčení záznamu leadu pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID leadu

Responses

odemčení leadu

Odemčení záznamu leadu k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID leadu

Responses

GDPR anonymize leadu

U záznamu se provede anonimizace data.

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID leadu

Responses

Sloučení duplicitního leadu

Při sloučení dojde k převedení všech dat ze zdrojového leadu do cílového leadu s následným smazáním zdrojového leadu. Podrobnosti o slučování najdete v tomto článku.

Authorizations:
(basicAuthinstanceName)
path Parameters
leadId
required
integer <int64>
Example: 123

ID cílového leadu, do tohoto záznamu se budou převádět data

sourceLeadId
required
integer <int64>
Example: 123

ID zdrojového leadu, který bude sloučen s cílovým leadem a následně smazán

Responses

Obchodní případy

API pro práci s obchodními případy (dále jen "OP").

seznam OP

Získání seznamu obchodních případů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/businessCase/?offset=0&limit=1&name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name" "validFrom" "validTill" "scheduledEnd"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=OP-15-001

Filtrování OP podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

name
string
Example: name=RAY

Filtrování OP podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
integer <int64>
Example: company=1

Filtrování OP podle klienta. Filtruje se podle jednoznačného identifikátoru klienta (id)

project
integer <int64>
Example: project=1

Filtrování OP podle projektu. Filtruje se podle jednoznačného identifikátoru projektu (id)

category
integer <int64>
Example: category=1

Filtrování OP podle kategorie (BusinessCaseCategory). Filtruje se podle jednoznačného identifikátoru kategorie (id)

owner
integer <int64>
Example: owner=1

Filtrování OP podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

validFrom
string
Example: validFrom=2022-06-01

Filtrování OP podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validTill
string
Example: validTill=2022-06-01

Filtrování OP podle data uzavření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

scheduledEnd
string
Example: scheduledEnd=2022-06-01

Filtrování OP podle data odhad uzavření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Enum: "B_ACTIVE" "E_WIN" "F_LOST" "G_STORNO"
Example: status=E_WIN

Filtrování OP podle skupiny stavu. Lze využít operátoru EQ, NE.

  • B_ACTIVE otevřené OP,
  • E_WIN vyhrané OP,
  • F_LOST prohrané OP,
  • G_STORNO stornované OP
businessCasePhase
integer <int64>
Example: businessCasePhase=21

Filtrování OP podle stavu (BusinessCasePhase). Lze využít operátoru EQ, NE, IN, NOT_IN

businessCaseType
integer <int64>
Example: businessCaseType=21

Filtrování OP podle typu obchodního případu (BusinessCaseType). Lze využít operátoru EQ, NE, IN, NOT_IN

containsProduct
integer <int64>
Example: containsProduct=21

Filtrování OP podle produktu. Pokud OP obsahuje zvolený produkt, bude zobrazen. Je nutné použít operátor CUSTOM

productCategory
integer <int64>
Example: productCategory=21

Filtrování OP podle kategorie produktu. Pokud OP obsahuje produkt ve vybrané kategorii, bude zobrazen. Je nutné použít operátor CUSTOM a použít více hodnot productCategory[CUSTOM]=1,2,3

productLine
integer <int64>
Example: productLine=21

Filtrování OP podle produktové řady produktu. Pokud OP obsahuje produkt ve vybrané produktové řadě, bude zobrazen. Je nutné použít operátor CUSTOM a použít více hodnot productLine[CUSTOM]=1,2,3

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování OP podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování OP podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování OP podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných OP. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nový OP

Založení nového obchodního případu.

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
required
integer <int64>

[Klient] ID klienta, pro kterého je obchodní případ vytvářen

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za OP na straně klienta

project
integer <int64>

[Projekt] ID projektu na který má být OP připojen

totalAmount
number

[Konečná cena] konečná cena OP

estimatedValue
number

[Předpokládané náklady] předpokládané náklady na OP

probability
integer <int32>

[Pravděpodobnost] pravděpodobnost na úspěch OP

validFrom
string <date>

[Otevřeno od] datum otevřeno od

description
string

[Poznámka]

currency
integer <int64>

[Měna] ID záznamu z číselníku Currency

exchangeRate
number

[Kurz] kurz pro přepočet na výchozí měnu CRM

category
integer <int64>

[Kategorie] ID záznamu z číselníku BusinessCaseCategory

source
integer <int64>

[Zdroj kontaktu] ID záznamu z číselníku ContactSource

businessCaseClassification1
integer <int64>

[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1

businessCaseClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2

businessCaseClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3

businessCasePhase
integer <int64>

[Stav] ID záznamu z BusinessCasePhase. Pokud nebude vyplněno, založí se OP do prvního stavu.

originalLead
integer <int64>

[Lead] ID leadu, ze kterého obchodní případ vznikl

tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "probability": 80,
  • "validFrom": "2022-11-08",
  • "description": "test",
  • "businessCaseClassification1": 93,
  • "currency": 17,
  • "exchangeRate": 20,
  • "businessCasePhase": 3
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

nový OP s produkty

Založení nového obchodního případu i s položkami (najednou). Položky se do vstupu zadávají jako kolekce v atributu "items". Každá položka z kolekce je pak v systému vytvořena dvojím způsobem: bez napojení na produkt (nekategorizovaný produkt), nebo s napojením na vybraný produkt. Pokud položka obsahuje atribut "product" (ID produktu) nebo "productCode" (kód produktu), systém produkt dohledá a na položku napojí. Pokud takový produkt nelze dohledat, pokusí se jej nově založit. Množinu produktů pro dohledání je možné omezit na nějaký konkrétní ceník, a to tím, že se přidá navíc atribtut "priceList" (ID vybraného ceníku). Pro nekategorizovaný produkt se žádný z výše uvedených parametrů nezadává, ale je potřeba vložit alespoň název produktu ("name").

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
required
integer <int64>

[Klient] ID klienta, pro kterého je obchodní případ vytvářen

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za OP na straně klienta

totalAmount
number

[Konečná cena] konečná cena OP

estimatedValue
number

[Předpokládané náklady] předpokládané náklady na OP

probability
integer <int32>

[Pravděpodobnost] pravděpodobnost na úspěch OP

validFrom
string <date>

[Otevřeno od] datum otevřeno od

description
string

[Poznámka]

currency
integer <int64>

[Měna] ID záznamu z číselníku Currency

exchangeRate
number

[Kurz] kurz pro přepočet na výchozí měnu CRM

category
integer <int64>

[Kategorie] ID záznamu z číselníku BusinessCaseCategory

source
integer <int64>

[Zdroj kontaktu] ID záznamu z číselníku ContactSource

businessCaseClassification1
integer <int64>

[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1

businessCaseClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2

businessCaseClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3

businessCasePhase
integer <int64>

[Stav] ID záznamu z BusinessCasePhase. Pokud nebude vyplněno, založí se OP do prvního stavu.

tags
Array of strings
object
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "Obchodní případ s položkami",
  • "company": 2,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "probability": 80,
  • "validFrom": "2022-11-04",
  • "description": "Popis",
  • "currency": 19,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail OP

Získání detailu obchodního případu. Pokud záznam obch. případu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/businessCase/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodního případu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení OP

Upravení dat obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodniho pripadu

Request Body schema: application/json
name
string

[Předmět]

businessCasePhase
integer <int64>

[Stav] ID záznamu z číselníku BusinessCasePhase

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
integer <int64>

[Klient] ID klienta, pro kterého je obchodní případ vytvářen

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za OP na straně klienta

project
integer <int64>

[Projekt] ID projektu na který má být OP připojen

totalAmount
number

[Konečná cena] konečná cena OP

estimatedValue
number

[Předpokládané náklady] předpokládané náklady na OP

probability
integer <int32>

[Pravděpodobnost] pravděpodobnost na úspěch OP

validFrom
string <date>

[Otevřeno od] datum otevřeno od

validTill
string <date>

[Uzavřeno] datum uzavření OP

description
string

[Poznámka]

currency
integer <int64>

[Měna] ID z áznamu z číselníku Currency

exchangeRate
number

[Kurz] kurz pro přepočet na výchozí měnu CRM

category
integer <int64>

[Kategorie] ID záznamu z číselníku BusinessCaseCategory

source
integer <int64>

[Zdroj kontaktu] ID záznamu z číselníku ContactSource

businessCaseClassification1
integer <int64>

[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1

businessCaseClassification2
integer <int64>

[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2

businessCaseClassification3
integer <int64>

[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3

originalLead
integer <int64>

[Lead] ID leadu, ze kterého obchodní případ vznikl

tags
Array of strings
object
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "probability": 80,
  • "validFrom": "2022-11-08",
  • "validTill": "2022-11-10",
  • "description": "test",
  • "businessCaseClassification1": 93,
  • "currency": 17,
  • "exchangeRate": 20,
  • "customFields": {
    }
}

smazání OP

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodní případy

Responses

uzamčení OP

Uzamčení záznamu OP pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

Responses

odemčení OP

Odemčení záznamu OP k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

Responses

zneplatnění OP

Zneplatnění záznamu OP.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

Responses

obnovení platnosti OP

Obnovení platnosti záznamu OP.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

Responses

export OP do PDF

Export obchodního případu do PDF. Konkrétně dojde k vytvoření dočasného souboru v CRM uložišti. K obsahu tohoto souboru je pak možné přistoupit prostřednictvím API /exportBody (Více v sekci: Soubory / Stažení těla exportu).

https://app.raynet.cz/api/v2/businessCase/3/pdfExport
Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

query Parameters
locale
string
Example: locale=en

Jazyk exportovaného obch. případu

Responses

Response samples

Content type
application/json
{
  • "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  • "fileName": "OP-17-001.pdf",
  • "contentType": "application/octet-stream",
  • "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  • "instanceName": "mojecrm"
}

přidání položek OP

Přidání položek na OP. Položku je možno vytvořit dvojím způsobem: bez napojení na produkt (nekategorizovaný produkt) nebo položku s napojením na vybraný produkt. Pokud chci vytvořit napojenou položku, zadám do těla requestu parametr "product" (ID produktu) nebo "productCode" (kód produktu). Systém poté na zakladě zadané hodnoty produkt dohledá a na položku napojí. Pokud chci množinu produktů (pro dohledání) omezit pouze na nějaký konkrétní ceník, musím navíc zadat parametr "priceList" (ID vybraného ceníku). Pro nekategorizovaný produkt se žádný z výše uvedených parametrů nezadává, ale je potřeba vložit alespoň název produktu ("name").

https://app.raynet.cz/api/v2/businessCase/1/item/
Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodního případu

Request Body schema: application/json
productCode
string

[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

product
integer <int64>

[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

priceList
integer <int64>

[ID ceníku] Vyhledávání produktu výše uvedenými kritérii bude omezeno pouze na zadaný ceník. Pokud není zadáno, vyhledává se ve výchozích (ne-ceníkových) produktech.

name
required
string

[Název] Povinná hodnota pouze pro nekategorizovaný produkt

price
number

[Prodejní cena]

taxRate
number

[Daň]

count
number

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "productCode": "A001",
  • "name": "Produkt",
  • "priceList": 2,
  • "count": 2,
  • "price": 123,
  • "taxRate": 21,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "description": "poznamka k produktu"
}

upravení položky OP

Upravení položky na OP

https://app.raynet.cz/api/v2/businessCase/1/item/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodní případy

businessCaseItemId
required
integer <int64>
Example: 123

ID položky obchodního případu

Request Body schema: application/json
name
string

[Název]

price
number

[Prodejní cena]

taxRate
number

[Daň]

count
number

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "name": "produkt 1",
  • "price": 123,
  • "taxRate": 21,
  • "count": 2,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "unit": "ks",
  • "description": "poznamka k produktu"
}

smazání položky OP

Smazání položky na OP

https://app.raynet.cz/api/v2/businessCase/1/item/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodní případy

businessCaseItemId
required
integer <int64>
Example: 123

ID položky obchodního případu

Responses

seznam participantů OP

Získání seznamu participantů obchodního případu. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodního případu

query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "company.id" "company.name" "person.id" "person.lastName" "businessCase.id" "businessCase.code" "note"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
note
string
Example: note=Pozor

Filtrování participantů OP podle poznámky. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
integer <int64>
Example: company=3

Filtrování participantů OP podle jednoznačného identifikátoru klienta (id). Lze využít operátoru EQ, NE, GT, GE, LT, LE

company-name
required
string

Filtrování participantů OP podle názvu klienta. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

person
integer <int64>
Example: person=3

Filtrování participantů OP podle jednoznačného identifikátoru kontaktní osoby (id). Lze využít operátoru EQ, NE, GT, GE, LT, LE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování participantů OP podle data vytvoření participanta. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování participantů OP podle posledního data upravení participanta. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování OP podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový participant obchodního případu

Přidání nového participanta k obchodnímu případu s identifikátorem businessCaseId. Je možné přidat buď klienta nebo kontaktní osobu. V rámci volání API musí být obsažena právě jedna reference na klienta nebo kontaktní osobu.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodního případu

Request Body schema: application/json
company
integer <int64>

[Klient] ID záznamu klienta

person
integer <int64>

[Kontaktní osoba] ID záznamu kontaktní osoby

category
integer <int64>

[Kategorie participace] ID kategorie participace

note
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "company": 1,
  • "category": 123,
  • "note": "Poznámka k participantovi"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání participanta z obchodního případu

U obchodního případu s identifikátorem businessCaseId bude smazán participant s identifikátorem participantId.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obchodního případu

participantId
required
integer <int64>
Example: 321

ID participanta

Responses

changelog změn stavů OP

Výpis historie změn stavů obchodního případu.

Authorizations:
(basicAuthinstanceName)
path Parameters
businessCaseId
required
integer <int64>
Example: 123

ID obch. případu

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

Nabídky

API pro práci s nabídkami.

seznam nabídek

Získání seznamu nabídek. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/offer/?offset=0&limit=1&name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=NAB-15-001

Filtrování nabídek podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

name
string
Example: name=RAY

Filtrování nabídek podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
integer <int64>
Example: company=1

Filtrování nabídek podle klienta. Filtruje se podle jednoznačného identifikátoru klienta (id)

person
integer <int64>
Example: person=1

Filtrování nabídek podle kontaktní osoby. Filtruje se podle jednoznačného identifikátoru kontaktní osoby (id)

businessCase
integer <int64>
Example: businessCase=1

Filtrování nabídek podle obchodního případu nabídky. Filtruje se podle jednoznačného identifikátoru OP (id)

owner
integer <int64>
Example: owner=1

Filtrování nabídek podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

expirationDate
string
Example: expirationDate=2022-06-01

Filtrování nabídek podle data vypršení nabídky. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validFrom
string
Example: validFrom=2022-06-01

Filtrování nabídek podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validTill
string
Example: validTill=2022-06-01

Filtrování nabídek podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Enum: "B_ACTIVE" "E_WIN" "F_LOST" "G_STORNO"
Example: status=E_WIN

Filtrování nabídek podle skupiny stavu. Lze využít operátoru EQ, NE.

  • B_ACTIVE otevřené nabídky,
  • E_WIN vyhrané nabídky,
  • F_LOST prohrané nabídky,
  • G_STORNO stornované nabídky
offerStatus
integer <int64>
Example: offerStatus=21

Filtrování nabídek podle stavu (OfferStatus). Lze využít operátoru EQ, NE, IN, NOT_IN

containsProduct
integer <int64>
Example: containsProduct=21

Filtrování nabídek podle produktu. Pokud záznam obsahuje zvolený produkt, bude zobrazen. Je nutné použít operátor CUSTOM

productCategory
integer <int64>
Example: productCategory=21

Filtrování nabídek podle kategorie produktu. Pokud záznam obsahuje produkt ve vybrané kategorii, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot productCategory[CUSTOM]=1,2,3

productLine
integer <int64>
Example: productLine=21

Filtrování nabídek podle produktové řady produktu. Pokud záznam obsahuje produkt ve vybrané produktové řadě, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot productLine[CUSTOM]=1,2,3

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování nabídek podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování nabídek podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování nabídek podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných nabídek. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nová nabídka

Založení nové nabídky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
required
integer <int64>

[Klient] ID klienta, pro kterého je nabídka vytvářena

person
integer <int64>

[Kontaktní osoba] ID zodp. kontaktní osoby klienta pro kterou je nabídka vytvářena

businessCase
required
integer <int64>

[OP] ID obch. případu nabídky

totalAmount
number

[Konečná cena] konečná cena nabídky

estimatedValue
number

[Předpokládané náklady] předpokládané náklady v nabídce

validFrom
string <date>

[Otevřeno od] datum vytvoření nabídky

validTill
string <date>

[Otevřeno od] datum uzavření nabídky

expirationDate
string <date>

[Konec platnosti] konec platnosti nabídky

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku OfferCategory

offerStatus
integer <int64>

[Stav] ID záznamu z OfferStatus. Pokud nebude vyplněno, založí se nabídka do prvního stavu.

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "businessCase": 1,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "validFrom": "2022-11-08",
  • "description": "test",
  • "offerStatus": 35
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail nabídky

Získání detailu nabídky. Pokud záznam nabídky obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/offerId/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení nabídky

Upravení dat nabídky.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Request Body schema: application/json
name
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
integer <int64>

[Klient] ID klienta, pro kterého je nabídka vytvářena

person
integer <int64>

[Kontaktní osoba] ID zodp. kontaktní osoby klienta pro kterou je nabídka vytvářena

businessCase
integer <int64>

[OP] ID obch. případu nabídky

totalAmount
number

[Konečná cena] konečná cena nabídky

estimatedValue
number

[Předpokládané náklady] předpokládané náklady v nabídce

validFrom
string <date>

[Otevřeno od] datum vytvoření nabídky

validTill
string <date>

[Otevřeno od] datum uzavření nabídky

expirationDate
string <date>

[Konec platnosti] konec platnosti nabídky

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku OfferCategory

offerStatus
integer <int64>

[Stav] ID záznamu z OfferStatus. Pokud nebude vyplněno, založí se nabídka do prvního stavu.

object
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "businessCase": 1,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "validFrom": "2022-11-08",
  • "description": "test",
  • "customFields": {
    }
}

smazání nabídky

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

uzamčení nabídky

Uzamčení záznamu nabídky pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

odemčení nabídky

Odemčení záznamu nabídky k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

zneplatnění nabídky

Zneplatnění záznamu nabídky.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

obnovení platnosti nabídky

Obnovení platnosti záznamu nabídky.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

export nabídky do PDF

Export nabídky do PDF. Konkrétně dojde k vytvoření dočasného souboru v CRM uložišti. K obsahu tohoto souboru je pak možné přistoupit prostřednictvím API /exportBody (Více v sekci: Soubory / Stažení těla exportu).

https://app.raynet.cz/api/v2/offer/3/pdfExport
Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

query Parameters
locale
string
Example: locale=en

Jazyk exportované nabídky

Responses

Response samples

Content type
application/json
{
  • "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  • "fileName": "NAB-17-001.pdf",
  • "contentType": "application/octet-stream",
  • "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  • "instanceName": "mojecrm"
}

přidání položek nabídky

Přidání položek na nabídku. Položku je možno vytvořit dvojím způsobem: bez napojení na produkt (nekategorizovaný produkt) nebo položku s napojením na vybraný produkt. Pokud chci vytvořit napojenou položku, zadám do těla requestu parametr "product" (ID produktu) nebo "productCode" (kód produktu). Systém poté na zakladě zadané hodnoty produkt dohledá a na položku napojí. Pokud chci množinu produktů (pro dohledání) omezit pouze na nějaký konkrétní ceník, musím navíc zadat parametr "priceList" (ID vybraného ceníku). Pro nekategorizovaný produkt se žádný z výše uvedených parametrů nezadává, ale je potřeba vložit alespoň název produktu ("name").

https://app.raynet.cz/api/v2/offerId/1/item/
Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Request Body schema: application/json
productCode
string

[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

product
integer <int64>

[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

priceList
integer <int64>

[ID ceníku] Vyhledávání produktu výše uvedenými kritérii bude omezeno pouze na zadaný ceník. Pokud není zadáno, vyhledává se ve výchozích (ne-ceníkových) produktech.

name
required
string

[Název] Povinná hodnota pouze pro nekategorizovaný produkt

price
number

[Prodejní cena]

priceListItem
integer <int64>

[Položka ceníku] ID položky ceníku

taxRate
number

[Daň]

count
integer <int32>

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "productCode": "A001",
  • "name": "Muj produkt",
  • "priceList": 2,
  • "count": 2,
  • "price": 123,
  • "taxRate": 21,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "description": "poznamka k produktu"
}

upravení položky nabídky

Upravení položky na nabídce.

https://app.raynet.cz/api/v2/offer/1/item/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

offerItemId
required
integer <int64>
Example: 123

ID položky nabídky

Request Body schema: application/json
name
string

[Název]

price
number

[Prodejní cena]

priceListItem
integer <int64>

[Položka ceníku] ID položky ceníku

taxRate
number

[Daň]

count
integer <int32>

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "name": "produkt 1",
  • "price": 123,
  • "taxRate": 21,
  • "count": 2,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "unit": "ks",
  • "description": "poznamka k nabidce"
}

smazání položky nabídky

Smazání položky na nabídkce

https://app.raynet.cz/api/v2/offer/1/item/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

offerItemId
required
integer <int64>
Example: 123

ID položky nabídky

Responses

synchronizace nabídky s obchodním případem

Zapne synchronizaci dané nabídky s navázaným obchodním případem. Ukončí synchronizaci ostatních nabídek / objednávek, pokud je u nich zapnutá. Nakonec zaktualizuje položky obchodního případu tak, aby odpovídaly položkám zadané nabídky.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

Response samples

Content type
application/json
{
  • "message": "TranslatedApplicationException",
  • "translatedMessage": "Nelze synchronizovat, protože obchodní případ je evidován v jiné měně."
}

zrušení synchronizace nabídky s obchodním případem

Vypne synchronizaci dané nabídky s navázaným obchodním případem.

Authorizations:
(basicAuthinstanceName)
path Parameters
offerId
required
integer <int64>
Example: 123

ID nabídky

Responses

Objednávky

API pro práci s objednávkami.

seznam objednávek

Získání seznamu objednávek. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/salesOrder/?offset=0&limit=1&name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=OP-15-001

Filtrování objednávek podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

name
string
Example: name=RAY

Filtrování objednávek podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
integer <int64>
Example: company=1

Filtrování objednávek podle klienta. Filtruje se podle jednoznačného identifikátoru klienta (id)

person
integer <int64>
Example: person=1

Filtrování objednávek podle kontaktní osoby. Filtruje se podle jednoznačného identifikátoru kontaktní osoby (id)

businessCase
integer <int64>
Example: businessCase=1

Filtrování objednávek podle obchodního případu objednávky. Filtruje se podle jednoznačného identifikátoru OP (id)

owner
integer <int64>
Example: owner=1

Filtrování objednávek podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

expirationDate
string
Example: expirationDate=2022-06-01

Filtrování objednávek podle data dodání. Lze využít operátoru EQ, NE, GT, GE, LT, LE

requestDeliveryDate
string
Example: requestDeliveryDate=2022-06-01

Filtrování objednávek podle data vypršení objednávky. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validFrom
string
Example: validFrom=2022-06-01

Filtrování objednávek podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validTill
string
Example: validTill=2022-06-01

Filtrování objednávek podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Enum: "B_ACTIVE" "E_WIN" "F_LOST" "G_STORNO"
Example: status=E_WIN

Filtrování OP podle skupiny stavu. Lze využít operátoru EQ, NE.

  • B_ACTIVE otevřené nabídky,
  • E_WIN vyhrané nabídky,
  • F_LOST prohrané nabídky,
  • G_STORNO stornované nabídky
salesOrderStatus
integer <int64>
Example: salesOrderStatus=21

Filtrování objednávek podle stavu (SalesOrderStatus). Lze využít operátoru EQ, NE, IN, NOT_IN

containsProduct
integer <int64>
Example: containsProduct=21

Filtrování objednávek podle produktu. Pokud záznam obsahuje zvolený produkt, bude zobrazen. Je nutné použít operátor CUSTOM

productCategory
integer <int64>
Example: productCategory=21

Filtrování objednávek podle kategorie produktu. Pokud záznam obsahuje produkt ve vybrané kategorii, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot productCategory[CUSTOM]=1,2,3

productLine
integer <int64>
Example: productLine=21

Filtrování objednávek podle produktové řady produktu. Pokud záznam obsahuje produkt ve vybrané produktové řadě, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot productLine[CUSTOM]=1,2,3

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování objednávek podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování objednávek podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování objednávek podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných objednávek. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nová objednávka

Založení nové objednávky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
required
integer <int64>

[Klient] ID klienta, pro kterého je objednávka vytvářena

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za OP na straně klienta

businessCase
required
integer <int64>

[OP] ID obch. případu objednávky

offer
integer <int64>

[OP] ID nabídky, na kterou je objednávka napojena

totalAmount
number

[Konečná cena] konečná cena objednávky

estimatedValue
number

[Předpokládané náklady] předpokládané náklady v nabídce

validFrom
string <date>

[Otevřeno od] datum vytvoření objednávky

validTill
string <date>

[Otevřeno od] datum uzavření objednávky

expirationDate
string <date>

[Konec platnosti] konec platnosti objednávky

requestDeliveryDate
string <date>

[Dodat do] datum dodání

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku SalesOrderCategory

salesOrderStatus
integer <int64>

[Stav] ID záznamu z SalesOrderStatus. Pokud nebude vyplněno, založí se objednávka do prvního stavu.

object

[Dodací adresa]

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "businessCase": 1,
  • "offer": 4,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "validFrom": "2022-11-08",
  • "description": "test",
  • "salesOrderStatus": 74
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail objednávky

Získání detailu objednávky. Pokud záznam objednávky obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/salesOrder/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení objednávky

Upravení dat objednávky.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Request Body schema: application/json
name
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
integer <int64>

[Klient] ID klienta, pro kterého je objednávka vytvářena

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za OP na straně klienta

businessCase
integer <int64>

[OP] ID obch. případu objednávky

offer
integer <int64>

[OP] ID nabídky, na kterou je objednávka napojena

totalAmount
number

[Konečná cena] konečná cena objednávky

salesOrderStatus
integer <int64>

[Stav] ID stavu objednávky (z číselníku salesOrderStatus)

estimatedValue
number

[Předpokládané náklady] předpokládané náklady v nabídce

validFrom
string <date>

[Otevřeno od] datum vytvoření objednávky

validTill
string <date>

[Otevřeno od] datum uzavření objednávky

expirationDate
string <date>

[Konec platnosti] konec platnosti objednávky

requestDeliveryDate
string <date>

[Dodat do] datum dodání

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku SalesOrderCategory

object

[Dodací adresa]

object

[Fakturační adresa]

object
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "company": 1,
  • "businessCase": 1,
  • "offer": 4,
  • "owner": 3,
  • "totalAmount": 123.5,
  • "estimatedValue": 11,
  • "validFrom": "2022-11-08",
  • "description": "test",
  • "salesOrderStatus": 54,
  • "deliveryAddress": {
    },
  • "invoiceAddress": {
    },
  • "customFields": {
    }
}

smazání objednávky

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

uzamčení objednávky

Uzamčení záznamu objednávky pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

odemčení objednávky

Odemčení záznamu objednávky k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

zneplatnění objednávky

Zneplatnění záznamu objednávky.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

obnovení platnosti objednávky

Obnovení platnosti záznamu objednávky.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

export objednávky do PDF

Export objednávky do PDF. Konkrétně dojde k vytvoření dočasného souboru v CRM uložišti. K obsahu tohoto souboru je pak možné přistoupit prostřednictvím API /exportBody (Více v sekci: Soubory / Stažení těla exportu).

https://app.raynet.cz/api/v2/salesOrder/3/pdfExport
Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

query Parameters
locale
string
Example: locale=en

Jazyk exportované objednávky

Responses

Response samples

Content type
application/json
{
  • "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  • "fileName": "OBJ-17-001.pdf",
  • "contentType": "application/octet-stream",
  • "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  • "instanceName": "mojecrm"
}

přidání položek objednávky

Přidání položek na objednávku. Položku je možno vytvořit dvojím způsobem: bez napojení na produkt (nekategorizovaný produkt) nebo položku s napojením na vybraný produkt. Pokud chci vytvořit napojenou položku, zadám do těla requestu parametr "product" (ID produktu) nebo "productCode" (kód produktu). Systém poté na zakladě zadané hodnoty produkt dohledá a na položku napojí. Pokud chci množinu produktů (pro dohledání) omezit pouze na nějaký konkrétní ceník, musím navíc zadat parametr "priceList" (ID vybraného ceníku). Pro nekategorizovaný produkt se žádný z výše uvedených parametrů nezadává, ale je potřeba vložit alespoň název produktu ("name").

https://app.raynet.cz/api/v2/salesOrder/1/item/
Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Request Body schema: application/json
productCode
string

[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

product
integer <int64>

[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem.

priceList
integer <int64>

[ID ceníku] Vyhledávání produktu výše uvedenými kritérii bude omezeno pouze na zadaný ceník. Pokud není zadáno, vyhledává se ve výchozích (ne-ceníkových) produktech.

name
required
string

[Název] Povinná hodnota pouze pro nekategorizovaný produkt

price
number

[Prodejní cena]

priceListItem
integer <int64>

[Položka ceníku] ID položky ceníku

taxRate
number

[Daň]

count
integer <int32>

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "productCode": "A001",
  • "name": "Muj produkt",
  • "priceList": 2,
  • "count": 2,
  • "price": 123,
  • "taxRate": 21,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "description": "poznamka k produktu"
}

upravení položky objednávky

Upravení položky na nabídce.

https://app.raynet.cz/api/v2/salesOrder/1/item/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

salesOrderItemId
required
integer <int64>
Example: 123

ID položky objednávky

Request Body schema: application/json
name
string

[Název]

price
number

[Prodejní cena]

priceListItem
integer <int64>

[Položka ceníku] ID položky ceníku

taxRate
number

[Daň]

count
integer <int32>

[Množství]

discountPercent
number

[Sleva]

cost
number

[Náklady] Náklad za kus

unit
string

[Jednotka]

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "name": "produkt 1",
  • "price": 123,
  • "taxRate": 21,
  • "count": 2,
  • "discountPercent": 10.5,
  • "cost": 10,
  • "unit": "ks",
  • "description": "poznamka k produktu"
}

smazání položky objednávky

Smazání položky na nabídkce

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

salesOrderItemId
required
integer <int64>
Example: 123

ID položky objednávky

Responses

synchronizace objednávky s obchodním případem

Zapne synchronizaci dané objednávky s navázaným obchodním případem. Ukončí synchronizaci ostatních nabídek / objednávek, pokud je u nich zapnutá. Nakonec zaktualizuje položky obchodního případu tak, aby odpovídaly položkám zadané objednávky.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

Response samples

Content type
application/json
{
  • "message": "TranslatedApplicationException",
  • "translatedMessage": "Nelze synchronizovat, protože obchodní případ je evidován v jiné měně."
}

zrušení synchronizace objednávky s obchodním případem

Vypne synchronizaci dané objednávky s navázaným obchodním případem.

Authorizations:
(basicAuthinstanceName)
path Parameters
salesOrderId
required
integer <int64>
Example: 123

ID objednávky

Responses

Projekty

API pro práci s projekty.

seznam projektů

Získání seznamu projektů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/project/?offset=0&limit=1&name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=PRO-15-001

Filtrování projektu podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

name
string
Example: name=RAY

Filtrování projektu podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
integer <int64>
Example: company=1

Filtrování projektu podle klienta. Filtruje se podle jednoznačného identifikátoru klienta (id)

projectStatus
integer <int64>
Example: projectStatus=1

Filtrování projektu podle stavu (ProjectStatus). Filtruje se podle jednoznačného identifikátoru stavu (id)

category
integer <int64>
Example: category=1

Filtrování projektu podle kategorie (ProjectCategory). Filtruje se podle jednoznačného identifikátoru kategorie (id)

owner
integer <int64>
Example: owner=1

Filtrování projektu podle vlastníka (Person). Filtruje se podle jednoznačného identifikátoru vlastníka (id)

validFrom
string
Example: validFrom=2022-06-01

Filtrování projektu podle data otevření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validTill
string
Example: validTill=2022-06-01

Filtrování projektu podle data uzavření. Lze využít operátoru EQ, NE, GT, GE, LT, LE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování projektu podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování projektu podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování projektu podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných projektů. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nový projekt

Založení nového projektu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Předmět]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
required
integer <int64>

[Klient] ID klienta, pro kterého je projekt vytvářen

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za projekt na straně klienta

totalAmount
integer <int64>

[Konečná cena] konečná cena projektu

avgValue.totalAmount
number

[Průměrná hodnota] průměrná hodnota projektu

minValue.totalAmount
number

[Minimální hodnota] minimální hodnota projektu

maxValue.totalAmount
number

[Maximální hodnota] maximální hodnota projektu

validFrom
string <date>

[Otevřeno od] datum otevřeno od

validTill
string <date>

[Uzavřeno] datum uzavření projektu

scheduledEnd
string <date>

[Plánované ukončení] datum plánovaného ukončení projektu

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ProjectCategory

projectStatus
integer <int64>

[Stav] ID záznamu z ProjectStatus. Pokud nebude vyplněno, založí se projekt do prvního stavu.

tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "name": "Testovací projekt nový",
  • "company": 4,
  • "person": 9,
  • "owner": 2,
  • "totalAmount": 34700,
  • "avgValue.totalAmount": 34700,
  • "minValue.totalAmount": 34700,
  • "maxValue.totalAmount": 34700,
  • "validFrom": "2022-02-21",
  • "scheduledEnd": "2022-04-29",
  • "projectStatus": 45,
  • "description": "Poznámka nová",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail projektu

Získání detailu projektu. Pokud záznam projektu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/project/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení projektu

Upravení dat projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Request Body schema: application/json
name
string

[Předmět]

projectStatus
integer <int64>

[Stav] ID záznamu z číselníku ProjectStatus

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

company
integer <int64>

[Klient] ID klienta, pro kterého je projekt vytvářen

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby zodpovědné za projekt na straně klienta

totalAmount
number

[Konečná cena] konečná cena projektu

avgValue.totalAmount
number

[Průměrná hodnota] průměrná hodnota projektu

minValue.totalAmount
number

[Minimální hodnota] minimální hodnota projektu

maxValue.totalAmount
number

[Maximální hodnota] maximální hodnota projektu

validFrom
string <date>

[Otevřeno od] datum otevřeno od

validTill
string <date>

[Uzavřeno] datum uzavření projektu

scheduledEnd
string <date>

[Plánované ukončení] datum plánovaného ukončení projektu

description
string

[Poznámka]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ProjectCategory

tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "name": "Testovací projekt upravený",
  • "company": 4,
  • "person": 9,
  • "owner": 2,
  • "totalAmount": 34700,
  • "avgValue.totalAmount": 34700,
  • "minValue.totalAmount": 34700,
  • "maxValue.totalAmount": 34700,
  • "projectStatus": 60,
  • "validFrom": "2022-02-21",
  • "scheduledEnd": "2022-04-29",
  • "description": "Poznámka lehce upravená"
}

smazání projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

uzamčení projektu

Uzamčení záznamu projektu pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

odemčení projektu

Odemčení záznamu projektu k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

zneplatnění projektu

Zneplatnění záznamu projektu.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

obnovení platnosti projektu

Obnovení platnosti záznamu projektu.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Responses

seznam participantů projektu

Získání seznamu participantů projektu. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/project/4/participants/?offset=0&limit=1&company-name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

query Parameters
offset
integer <int64>

Zobrazení záznamu od začátku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "company.id" "company.name" "person.id" "person.lastName" "project.id" "project.code" "note"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
note
string
Example: note=Pozor

Filtrování participantů projektu podle poznámky. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

company
string
Example: company=3

Filtrování participantů projektu podle jednoznačného identifikátoru klienta (id). Lze využít operátoru EQ, NE, GT, GE, LT, LE

company-name
string
Example: company-name=RAY

Filtrování participantů projektu podle názvu klienta. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

person
string
Example: person=3

Filtrování participantů projektu podle jednoznačného identifikátoru kontaktní osoby (id). Lze využít operátoru EQ, NE, GT, GE, LT, LE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování participantů projektu podle data vytvoření participanta. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování participantů projektu podle posledního data upravení participanta. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování projektu podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový participant projektu

Přidání nového participanta k projektu s identifikátorem projectId. Je možné přidat buď klienta nebo kontaktní osobu. V rámci volání API musí být obsažena právě jedna reference na klienta nebo kontaktní osobu.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

Request Body schema: application/json
company
integer <int64>

[Klient] ID záznamu klienta

person
integer <int64>

[Kontaktní osoba] ID záznamu kontaktní osoby

category
integer <int64>

[Kategorie participace] ID kategorie participace

note
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "company": 1,
  • "category": 123,
  • "note": "Poznámka k participantovi"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání participanta z projektu

U projektu s identifikátorem projectId bude smazán participant s identifikátorem participantId.

Authorizations:
(basicAuthinstanceName)
path Parameters
projectId
required
integer <int64>
Example: 123

ID projektu

participantId
required
integer <int64>
Example: 321

ID participanta

Responses

Ceníky

API pro práci s ceníky.

seznam ceníků

Získání seznamu ceníků. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/priceList/?offset=0&limit=1&code[LIKE]=CEN-001%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených cenníků je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

code
string
Example: code=CEN-001

Filtrování ceníků podle kódu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

primary
string
Example: primary=YES

Filtrování ceníků podle příznaku, zda je ceník výchozí. Lze využít operátoru EQ, NE

currency
integer <int64>
Example: currency=1

Filtrování ceníků podle měny (Currency). Filtruje se podle jednoznačného identifikátoru měny (id)

validFrom
string
Example: validFrom=2022-06-01

Filtrování ceníků podle data platnosti. Lze využít operátoru EQ, NE, GT, GE, LT, LE

validTill
string
Example: validTill=2022-06-01

Filtrování ceníků podle data platnosti. Lze využít operátoru EQ, NE, GT, GE, LT, LE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování ceníků podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování ceníků podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování ceníků podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nový ceník

Založení nového ceníku

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Název]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

code
required
string

[Kód]

currency
required
integer <int64>

[Měna] ID záznamu z číselníku Currency

category
integer <int64>

[Kategorie] ID záznamu z číselníku PriceListCategory

validFrom
required
string <date>

[Otevřeno od] datum platnosti od

validTill
string <date>

[Otevřeno od] datum platnosti do

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "name": "Ceník ABC",
  • "code": "CEN-002",
  • "owner": 3,
  • "currency": 17,
  • "category": 13,
  • "validFrom": "2022-11-08",
  • "validTill": "2022-11-08",
  • "description": "Text text"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail ceníku

Získání detailu ceníku.

https://app.raynet.cz/api/v2/priceList/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení ceníku

Upravení dat ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Request Body schema: application/json
name
string

[Název]

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

code
string

[Kód]

currency
integer <int64>

[Měna] ID záznamu z číselníku Currency

category
integer <int64>

[Kategorie] ID záznamu z číselníku PriceListCategory

validFrom
string <date>

[Otevřeno od] datum platnosti od

validTill
string <date>

[Otevřeno od] datum platnosti do

description
string

[Poznámka]

Responses

Request samples

Content type
application/json
{
  • "name": "Ceník ABC",
  • "code": "CEN-002",
  • "owner": 3,
  • "currency": 17,
  • "category": 13,
  • "validFrom": "2022-11-08",
  • "validTill": "2022-11-08",
  • "description": "Text text"
}

smazání ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Responses

uzamčení ceníku

Uzamčení záznamu ceníku pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Responses

odemčení ceníku

Odemčení záznamu ceníku k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Responses

seznam položek ceníku

V rámci detailu ceníku je vráceno prvních 1000 položek ceníku. Pokud potřebujete vyčíst větší množství položek z konkrétního ceníku, je nutné použít toto volání API.

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

query Parameters
offset
integer <int64>

Zobrazení záznamů od začátku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "name" "price" "unit" "cost" "taxRate" "rowInfo.createdAt" "rowInfo.updatedAt"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
product-id
integer <int64>
Example: product-id=100

Filtrování položek ceníku podle ID produktu. Lze využít operátoru EQ, NE, IN

product-code
string
Example: product-code=KONV

Filtrování položek ceníku podle kódu produktu. Lze využít operátoru EQ, NE, LIKE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

přidání položek ceníku

Přidání položek na ceník

https://app.raynet.cz/api/v2/priceList/1/item/
Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Request Body schema: application/json
product
required
integer <int64>

[Produkt] ID produktu, který do ceníku přidávám

price
number

[Prodejní cena]

description
string

[Poznámka]

unit
string

[Jednotka]

cost
number

[Náklady]

taxRate
number

[Sazba DPH]

Responses

Request samples

Content type
application/json
{
  • "price": 400,
  • "product": 1,
  • "description": "Lorem ipsum...",
  • "unit": "ks",
  • "cost": 100,
  • "taxRate": 21
}

hromadné přidání/upravení položek ceníku

Hromadné přidání/upravení položek na ceník. API je omezeno na 100 současně vkládaných položek.

https://app.raynet.cz/api/v2/priceList/1/itemBulkUpsert/
Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

Request Body schema: application/json
Array
product
integer <int64>

[Produkt] ID produktu, který do ceníku přidávám

price
integer <int64>

[Prodejní cena]

description
string

[Poznámka]

unit
string

[Jednotka]

cost
number

[Náklady]

taxRate
number

[Sazba DPH]

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

upravení položky ceníku

Upravení položky na ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

priceListItemId
required
integer <int64>
Example: 123

ID položky ceníku

Request Body schema: application/json
product
integer <int64>

[Produkt] ID produktu, který do ceníku přidávám

price
number

[Prodejní cena]

description
string

[Poznámka]

unit
string

[Jednotka]

cost
number

[Náklady]

taxRate
number

[Sazba DPH]

Responses

Request samples

Content type
application/json
{
  • "price": 400,
  • "product": 1,
  • "description": "Lorem ipsum...",
  • "unit": "ks",
  • "cost": 100,
  • "taxRate": 21
}

smazání položky ceníku

Smazání položky na ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
priceListId
required
integer <int64>
Example: 123

ID ceníku

priceListItemId
required
integer <int64>
Example: 123

ID položky ceníku

Responses

Produkt

API pro práci s produkty.

seznam produktů

https://app.raynet.cz/api/v2/product/?offset=0&limit=1&name[LIKE]=Jan%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených produktů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "code" "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

name
string
Example: name=Licence

Filtrování produktů podle názvu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

unit
string
Example: unit=ks

Filtrování prodktů podle jednotky. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování prodktů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování prodktů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování produktů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

rowInfo.rowAccess
string
Example: rowInfo.rowAccess=INVALID

Filtrování zneplatněných produktů. Lze využít operátoru EQ, NE, EQ_OR_NULL, NE_OR_NULL

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 13,
  • "data": [
    ]
}

založení nového produktu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code
required
string

[Kód]

name
required
string

[Název]

unit
string

[Jednotka]

description
string

[Popis]

taxRate
number

[Sazba DPH]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ProductCategory

productLine
integer <int64>

[Produktová řada] ID záznamu z číselníku ProductLine

cost
number

[Náklad]

price
number

[Standardní cena]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "code": "007",
  • "name": "produkt 007",
  • "unit": "ks",
  • "description": "popis produktu",
  • "taxRate": 21,
  • "category": 791,
  • "productLine": 206,
  • "cost": 1000,
  • "price": 1500,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail produktu

Získání detailu produktu. Pokud záznam produktu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/product/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
productId
required
integer <int64>
Example: 123

ID produktu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení produktu

Upravení dat produktu

Authorizations:
(basicAuthinstanceName)
path Parameters
productId
required
integer <int64>
Example: 123

ID produktu

Request Body schema: application/json
code
string

[Kód]

name
string

[Název]

unit
string

[Jednotka]

description
string

[Popis]

taxRate
number

[Sazba DPH]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ProductCategory

productLine
integer <int64>

[Produktová řada] ID záznamu z číselníku ProductLine

cost
number

[Náklad]

price
number

[Standardní cena]

tags
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "code": "007",
  • "name": "produkt 007",
  • "unit": "ks",
  • "description": "popis produktu",
  • "taxRate": 21,
  • "category": 791,
  • "productLine": 206,
  • "cost": 1000,
  • "price": 1500,
  • "tags": [
    ],
  • "customFields": {
    }
}

smazání produktu

Authorizations:
(basicAuthinstanceName)
path Parameters
productId
required
integer <int64>
Example: 123

ID produktu

Responses

zneplatnění produktu

Zneplatnění záznamu produktu.

Authorizations:
(basicAuthinstanceName)
path Parameters
productId
required
integer <int64>
Example: 123

ID produktu

Responses

obnovení platnosti produktu

Obnovení platnosti záznamu produktu.

Authorizations:
(basicAuthinstanceName)
path Parameters
productId
required
integer <int64>
Example: 123

ID produktu

Responses

Aktivity

API pro práci s aktivitami.

uzamčení aktivity

Uzamčení záznamu aktivity pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
activityType
required
string
Example: task

Typ aktivity, může nabývat hodnot: 'task', 'meeting', 'event', 'email', 'phonecall' nebo 'letter'

activityId
required
integer <int64>
Example: 123

ID aktivity

Responses

odemčení aktivity

Odemčení záznamu aktivity k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
activityType
required
string
Example: meeting

Typ aktivity, může nabývat hodnot: 'task', 'meeting', 'event', 'email', 'phonecall' nebo 'letter'

activityId
required
integer <int64>
Example: 123

ID aktivity

Responses

seznam aktivit

Získání seznamu všech aktivit, nezávisle na typu. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/activity/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených událostí je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování aktivit podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování aktivit podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování aktivit podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování aktivit podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování aktivit podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování aktivit podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování aktivit podle ID kontaktní osoby, která je vlastníkem aktivity. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování aktivit podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování aktivit podle ID klienta, kterého se aktivity týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování aktivit podle ID leadu, kterého se aktivity týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování aktivit podle ID obchodního případu, kterého se události týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování aktivit podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování aktivit podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování aktivit podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování aktivit podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "message": "Unsupported filter column ..."
}

Úkol

seznam úkolů

Získání seznamu úkolů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/task/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených úkolů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "deadline" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování úkolů podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování úkolů podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování úkolů podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování úkolů podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování úkolů podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování úkolů podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

deadline
string
Example: deadline=2022-05-03

Filtrování úkolů podle data deadline. Lze využít operátoru EQ, NE, GT, GE, LT, LE

owner-id
integer <int64>
Example: owner-id=3

Filtrování úkolů podle ID kontaktní osoby, která je vlastníkem úkolu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování úkolů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování úkolů podle ID klienta, kterého se úkoly týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování úkolů podle ID leadu, kterého se úkoly týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování úkolů podle ID obchodního případu, kterého se úkoly týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování úkolů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování úkolů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování úkolů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování úkolů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový úkol

Založení nového úkolu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby v kontextu záznamu

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem (zadavatelem) úkolu

resolver
required
integer <int64>

[Řešitel] ID kontaktní osoby, který je řešitelem úkolu

deadline
required
string <date-time>

[Deadline]

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[Zadání úkolu]

solution
string

[Řešení úkolu]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Navázat kontakt s klientem",
  • "priority": "DEFAULT",
  • "category": 1,
  • "person": 2,
  • "company": 3,
  • "owner": 4,
  • "resolver": 6,
  • "deadline": "2022-06-11 15:03",
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Je potřeba být laskavý!",
  • "solution": "Nakonec to dopadlo dobře.",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail úkolu

Získání detailu úkolu. Pokud záznam úkolu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/task/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
taskId
required
integer <int64>
Example: 123

ID úkolu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení úkolu

Upravení dat úkolu

Authorizations:
(basicAuthinstanceName)
path Parameters
taskId
required
integer <int64>
Example: 123

ID úkolu

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

deadline
string <date-time>

[Deadline] deadline datum

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[Zadání úkolu]

solution
string

[Řešení úkolu]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Navázat kontakt s klientem",
  • "category": 90,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "person": 3,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "deadline": "2022-06-11 15:03",
  • "description": "Je potřeba být laskavý!",
  • "solution": "Nakonec to dopadlo dobře.",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání úkolu

Authorizations:
(basicAuthinstanceName)
path Parameters
taskId
required
integer <int64>
Example: 123

ID úkolu

Responses

Schůzka

seznam schůzek

Získání seznamu schůzek. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/meeting/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených schůzek je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování schůzek podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování schůzek podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování schůzek podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování schůzek podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování schůzek podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování schůzek podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování schůzek podle ID kontaktní osoby, která je vlastníkem schůzky. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování schůzek podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování schůzek podle ID klienta, kterého se schůzky týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování schůzek podle ID leadu, kterého se schůzky týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování schůzek podle ID obchodního případu, kterého se schůzky týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování schůzek podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování schůzek podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování schůzek podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování schůzek podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nová schůzka

Založení nové schůzky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je účastníkem schůzky

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[Otázky k projednání]

solution
string

[Výsledek jednání]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Schůzka s klientem",
  • "priority": "DEFAULT",
  • "category": 1,
  • "owner": 4,
  • "person": 2,
  • "company": 3,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Opravdu chcete náš produkt?",
  • "solution": "Berou to.",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail schůzky

Získání detailu schůzky. Pokud záznam schůzky obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/meeting/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
meetingId
required
integer <int64>
Example: 123

ID schůzky

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení schůzky

Upravení dat schůzky

Authorizations:
(basicAuthinstanceName)
path Parameters
meetingId
required
integer <int64>
Example: 123

ID schůzky

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[Otázky k projednání]

solution
string

[Výsledek jednání]

meetingPlace
string

[Místo konání]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Schůzka u kávy",
  • "category": 90,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Otázky k projednání.",
  • "solution": "Výsledek jednání.",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání schůzky

Authorizations:
(basicAuthinstanceName)
path Parameters
meetingId
required
integer <int64>
Example: 123

ID schůzky

Responses

Událost

seznam událostí

Získání seznamu událostí. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/event/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených událostí je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování událostí podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování událostí podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování událostí podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování událostí podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování událostí podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování událostí podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování událostí podle ID kontaktní osoby, která je vlastníkem události. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování událostí podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování událostí podle ID klienta, kterého se událostí týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování událostí podle ID leadu, kterého se událostí týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování událostí podle ID obchodního případu, kterého se události týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování událostí podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování událostí podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování událostí podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování událostí podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nová událost

Založení nové události

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je účastníkem události

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[Informace o události]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Výročí založení klienta",
  • "priority": "DEFAULT",
  • "category": 1,
  • "owner": 4,
  • "person": 2,
  • "company": 3,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Oslavíme ve čtvrtek nebo v pátek?",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail události

Získání detailu události. Pokud záznam události obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/event/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
eventId
required
integer <int64>
Example: 123

ID události

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení události

Upravení dat události

Authorizations:
(basicAuthinstanceName)
path Parameters
eventId
required
integer <int64>
Example: 123

ID události

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[Infomace o události]

meetingPlace
string

[Místo konání]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Výročí založení klienta",
  • "category": 89,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Oslavíme ve čtvrtek nebo v pátek?",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání události

Authorizations:
(basicAuthinstanceName)
path Parameters
eventId
required
integer <int64>
Example: 123

ID události

Responses

Email

seznam emailů

Získání seznamu emailů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/email/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených emailů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování emailů podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování emailů podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování emailů podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování emailů podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování emailů podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování emailů podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování emailů podle ID kontaktní osoby, která je vlastníkem emailu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování emailů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování emailů podle ID klienta, kterého se emaily týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování emailů podle ID leadu, kterého se emaily týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování emailů podle ID obchodního případu, kterého se emailů týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování emailů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování emailů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování emailů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování e-mailů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový email

Založení nového emailu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je v kentextu záznamu

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[Obsah emailu]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Poptávka na ceník",
  • "priority": "DEFAULT",
  • "category": 1,
  • "owner": 4,
  • "person": 2,
  • "company": 3,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Dobrý den pane Kapre, potřebujeme ceník. Děkuji",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail emailu

Získání detailu emailu. Pokud záznam emailu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/email/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
emailId
required
integer <int64>
Example: 123

ID emailu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení emailu

Upravení dat emailu

Authorizations:
(basicAuthinstanceName)
path Parameters
emailId
required
integer <int64>
Example: 123

ID emailu

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[Obsah emailu]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Poptávka na ceník",
  • "category": 89,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Dobrý den pane Kapre, potřebujeme ceník. Děkuji",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání emailu

Authorizations:
(basicAuthinstanceName)
path Parameters
emailId
required
integer <int64>
Example: 123

ID emailu

Responses

Telefonát

seznam telefonátů

Získání seznamu telefonátů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/phoneCall/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených telefonátů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování telefonátů podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování telefonátů podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování telefonátů podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování telefonátů podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování telefonátů podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování telefonátů podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování telefonátů podle ID kontaktní osoby, která je vlastníkem telefonátu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování telefonátů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování telefonátů podle ID klienta, kterého se telefonáty týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování telefonátů podle ID leadu, kterého se telefonáty týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování telefonátů podle ID obchodního případu, kterého se telefonáty týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování telefonátů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování telefonátů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování telefonátů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování telefonátů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový telefonát

Založení nového telefonátu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je účastníkem telefonátu

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[K projednání]

solution
string

[Výsledek telefonátu]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Dotaz z call centra",
  • "priority": "DEFAULT",
  • "category": 1,
  • "owner": 2,
  • "person": 2,
  • "company": 3,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Mají ještě kapra?",
  • "solution": "Kapra mají.",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail telefonátu

Získání detailu telefonátu. Pokud záznam telefonátu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/phoneCall/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
phoneCallId
required
integer <int64>
Example: 123

ID telefonátu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení telefonátu

Upravení dat telefonátu

Authorizations:
(basicAuthinstanceName)
path Parameters
phoneCallId
required
integer <int64>
Example: 123

ID telefonátu

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[K projednání]

solution
string

[Výsledek telefonátu]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Dotaz z call centra",
  • "category": 89,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Mají ještě kapra?",
  • "solution": "Kapra mají.",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání telefonátu

Authorizations:
(basicAuthinstanceName)
path Parameters
phoneCallId
required
integer <int64>
Example: 123

ID telefonátu

Responses

Dopis

seznam dopisů

Získání seznamu dopisů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/letter/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených dopisů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "tags" "scheduledFrom" "scheduledTill" "completed" "category" "owner" "status"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=myTag

Filtrování dopisů podle předmětu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

scheduledFrom
string
Example: scheduledFrom=2022-06-01 10:00

Filtrování dopisů podle data naplánování ("od"). Lze využít operátoru GT, GE, LT, LE

scheduledTill
string
Example: scheduledTill=2022-06-01 10:00

Filtrování dopisů podle data naplánování ("do"). Lze využít operátoru GT, GE, LT, LE

completed
string
Example: completed=2022-06-01 10:00

Filtrování dopisů podle data realizování. Lze využít operátoru GT, GE, LT, LE

category-id
integer <int64>
Example: category-id=3

Filtrování dopisů podle ID kategorie. Lze využít operátoru EQ, NE, GT, GE, LT, LE

status
string
Example: status=SCHEDULED

Filtrování dopisů podle statusu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

owner-id
integer <int64>
Example: owner-id=3

Filtrování dopisů podle ID kontaktní osoby, která je vlastníkem dopisu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

personFilter
integer <int64>
Example: personFilter=3

Filtrování dopisů podle ID kontaktní osoby, která je participantem. Nelze využít standardních operátorů.

companyContextFilter
integer <int64>
Example: companyContextFilter=3

Filtrování dopisů podle ID klienta, kterého se dopisy týkají (klient je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

leadContextFilter
integer <int64>
Example: leadContextFilter=3

Filtrování dopisů podle ID leadu, kterého se dopisy týkají (lead je napojený v kontextu nebo je participantem). Nelze využít standardních operátorů.

businessCase
integer <int64>
Example: businessCase=3

Filtrování dopisů podle ID obchodního případu, kterého se dopisy týkají. Lze využít operátoru EQ, NE, IN, NOT_IN

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování dopisů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování dopisů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování dopisů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování dopisů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

nový dopis

Založení nového telefonátu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Předmět]

priority
required
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, který je vlastníkem záznamu

person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, které se dopis zasílá

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

lead
integer <int64>

[Lead] ID leadu v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánování v kalendáři od]

scheduledTill
string <date-time>

[Naplánování v kalendáři do]

completed
string <date-time>

[Datum realizace]

description
string

[Obsah dopisu]

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "Dopis příteli",
  • "priority": "DEFAULT",
  • "category": 1,
  • "owner": 4,
  • "person": 2,
  • "company": 3,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Dobrý den příteli.",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail dopisu

Získání detailu dopisu. Pokud záznam dopisu obsahuje volitelná pole, ve výstupu nejsou přítomná pole, která obsahují prázdnou hodnotu (z optimalizačních důvodů).

https://app.raynet.cz/api/v2/letter/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
letterId
required
integer <int64>
Example: 123

ID dopisu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení dopisu

Upravení dat dopisu

Authorizations:
(basicAuthinstanceName)
path Parameters
letterId
required
integer <int64>
Example: 123

ID dopisu

Request Body schema: application/json
title
string

[Předmět]

priority
string
Enum: "MINOR" "DEFAULT" "CRITICAL"

[Priorita]

status
string
Enum: "NEW" "SCHEDULED" "COMPLETED" "CANCELLED"

[Stav]

category
integer <int64>

[Kategorie] ID záznamu z číselníku ActivityCategory

personal
boolean

[Soukromá aktivita]

company
integer <int64>

[Klient] ID klienta v kontextu záznamu

businessCase
integer <int64>

[Obch. případ] ID obch. případu v kontextu záznamu

offer
integer <int64>

[Nabídka] ID nabídky v kontextu záznamu

salesOrder
integer <int64>

[Objednávka] ID objednávky v kontextu záznamu

project
integer <int64>

[Projekt] ID projektu v kontextu záznamu

activity
integer <int64>

[Aktivita] ID aktivity v kontextu záznamu

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina.

scheduledFrom
string <date-time>

[Naplánováno od] datum naplánování od

scheduledTill
string <date-time>

[Naplánováno do] datum naplánování do

completed
string <date-time>

[Realizováno] datum realizace aktivity

description
string

[Obsah dopisu]

tags
string

[Seznam štítků oddělených čárkou]

object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "Dopis příteli",
  • "category": 89,
  • "priority": "DEFAULT",
  • "status": "SCHEDULED",
  • "personal": false,
  • "company": 2,
  • "businessCase": 5,
  • "project": 4,
  • "activity": 14,
  • "scheduledFrom": "2022-06-11 15:00",
  • "scheduledTill": "2022-06-11 16:00",
  • "description": "Dobrý den příteli.",
  • "tags": "aaa, bbb",
  • "customFields": {
    },
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání dopisu

Authorizations:
(basicAuthinstanceName)
path Parameters
letterId
required
integer <int64>
Example: 123

ID dopisu

Responses

Hromadný email

API pro práci s entitou hromadný email. API slouží jako podpora pro integrace s mailovými službami třetích stran. Pomocí totoho API je možné zaznamenat výsledek mailové kampaně (uskutečněný službou třetí strany), tzn. jaký email a komu byl odeslán a s jakým výsledkem. Adresáti hromadného emailu mohou být tímto API napojeni přímo na konkrétní Klienty nebo Kontaktní osoby.

seznam hromadných emailů

Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Od kterého záznamu v pořadí seznam zobrazit (stránkování)

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "campaignName" "source"
Example: sortColumn=title
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=První

Filtrování hromadných emailů podle názvu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

tags
string
Example: tags=VIP

Filtrování hromadných emailů podle štítků. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

completed
string
Example: completed=2022-06-01 10:00

Filtrování hromadných emailů podle data odeslání. Lze využít operátoru EQ, NE, GT, GE, LT, LE

campaignName
string
Example: campaignName=První

Filtrování hromadných emailů podle názvu kampaně (pojmenování v externí emailové službě). Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

source
string
Enum: "QUANDA" "SMARTEMAILING" "MAILCHIMP" "MAILGUN" "SENDGRID" "SPARKPOST"
Example: source=SPARKPOST

Filtrování hromadných emailů podle zdroje. Lze využít operátoru EQ, NE.

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování hromadných emailů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování hromadných emailů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování hromadných emailů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

company
integer <int64>
Example: company=21

Filtrování podle klienta. Pokud je mezi adresáty hromadného e-mailu vybraný klient, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot company[CUSTOM]=1,2,3

person
integer <int64>
Example: person=21

Filtrování podle kontaktní osoby. Pokud je mezi adresáty hromadného e-mailu vybraná kontaktní osoba, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot person[CUSTOM]=1,2,3

lead
integer <int64>
Example: lead=21

Filtrování podle leadu. Pokud je mezi adresáty hromadného e-mailu vybraný lead, bude zobrazen. Je nutné použít operátor CUSTOM a lze použít více hodnot lead[CUSTOM]=1,2,3

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového hromadného emailu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
title
required
string

[Název] Název hromadného emailu

completed
string <date>

[Rozesláno] Datum odeslání hromadného emailu

description
string

[Popis]

tags
Array of strings
campaignName
string

[Název kampaně] Název v mailingové službě

source
required
string
Enum: "QUANDA" "SMARTEMAILING" "MAILCHIMP" "MAILGUN" "SENDGRID" "SPARKPOST"

[Zdroj] Mailingová služba

externalId
string

[Externí ID] ID kampaně v mailingové službě

externalOverviewUrl
string

[Odkaz na výsledky kampaně] URL s odkazem na výsledky kampaně v externí mailingové službě

externalThumbnailUrl
string

[Odkaz na detail kampaně] URL s odkazem na detail kampaně v externí mailingové službě

object

Responses

Request samples

Content type
application/json
{
  • "title": "Druhá emailová kampaň",
  • "completed": "2022-01-29 10:00",
  • "description": "Druhá testovací kampaň pro VIP členy organizace",
  • "tags": [
    ],
  • "campaignName": "Druhá emailová kampaň SparkPost",
  • "source": "SPARKPOST",
  • "externalId": "656464568",
  • "stats": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail hromadného emailu

Získání detailu hromadného emailu.

https://app.raynet.cz/api/v2/massEmail/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení hromadného emailu

Upravení dat hromadného emailu.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Request Body schema: application/json
title
string

[Název] Název hromadného emailu

completed
string <date>

[Rozesláno] Datum odeslání hromadného emailu

description
string

[Popis]

tags
Array of strings
campaignName
string

[Název kampaně] Název v mailingové službě

source
string
Enum: "QUANDA" "SMARTEMAILING" "MAILCHIMP" "MAILGUN" "SENDGRID" "SPARKPOST"

[Zdroj] Mailingová služba

externalId
string

[Externí ID] ID kampaně v mailingové službě

externalOverviewUrl
string

[Odkaz na výsledky kampaně] URL s odkazem na výsledky kampaně v externí mailingové službě

externalThumbnailUrl
string

[Odkaz na detail kampaně] URL s odkazem na detail kampaně v externí mailingové službě

object

Responses

Request samples

Content type
application/json
{
  • "title": "Druhá emailová kampaň",
  • "completed": "2022-01-29 10:00",
  • "description": "Druhá testovací kampaň pro VIP členy organizace",
  • "tags": [
    ],
  • "campaignName": "Druhá emailová kampaň SparkPost",
  • "source": "SPARKPOST",
  • "externalId": "656464568",
  • "stats": {
    }
}

smazání hromadného emailu

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Responses

seznam adresátů hromadného emailu

Získání seznamu adresátů hromadného emailu. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

query Parameters
offset
integer <int64>

Od kterého záznamu v pořadí seznam zobrazit (stránkování)

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Value: "id"
Example: sortColumn=id
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

status
string
Enum: "NOT_SENT" "DELIVERED" "REJECTED" "SENT" "UNKNOWN"
Example: status=SENT

Filtrování adresátů podle stavu odeslání. Lze využít operátoru EQ, NE.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

přidání adresáta hromadného emailu

Přidání adresáta, kterému byl hromadný email odeslán (resp. bude odeslán).

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Request Body schema: application/json
person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je adresátem emailu

company
integer <int64>

[Klient] ID klienta, který je adresátem emailu

lead
integer <int64>

[Lead] ID leadu, který je adresátem emailu

status
required
string
Enum: "NOT_SENT" "DELIVERED" "REJECTED" "SENT" "UNKNOWN"

[Stav] Stav odeslání

email
string

[Email] Email, kam byla zpráva odeslána

opened
string <date>

[Otevřeno] Datum, kdy adresátem email otevřel

clicked
string <date>

[Kliknuto] Datum, kdy adresát provedl akci (klik)

unsubscribed
string <date>

[Odhlášeno] Datum, kdy se adresát z kampaně odhlásil

Responses

Request samples

Content type
application/json
{
  • "person": 4,
  • "status": "DELIVERED",
  • "email": "Text emailu",
  • "opened": "2022-01-29",
  • "clicked": "2022-01-30",
  • "unsubscribed": "2022-01-31"
}

upravení adresáta hromadného emailu

Upravení adresáta hromadného emailu.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

recipientId
required
integer <int64>
Example: 123

ID adresáta

Request Body schema: application/json
person
integer <int64>

[Kontaktní osoba] ID kontaktní osoby, která je adresátem emailu

company
integer <int64>

[Klient] ID klienta, který je adresátem emailu

lead
integer <int64>

[Lead] ID leadu, který je adresátem emailu

status
string
Enum: "NOT_SENT" "DELIVERED" "REJECTED" "SENT" "UNKNOWN"

[Stav] Stav odeslání

email
string

[Email] Email, kam byla zpráva odeslána

opened
string <date>

[Otevřeno] Datum, kdy adresátem email otevřel

clicked
string <date>

[Kliknuto] Datum, kdy adresát provedl akci (klik)

unsubscribed
string <date>

[Odhlášeno] Datum, kdy se adresát z kampaně odhlásil

Responses

Request samples

Content type
application/json
{
  • "person": 4,
  • "status": "DELIVERED",
  • "email": "info@klient.cz",
  • "opened": "2022-01-29",
  • "clicked": "2022-01-30",
  • "unsubscribed": "2022-01-31"
}

smazání adresáta hromadného emailu

Smazání adresáta hromadného emailu.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

recipientId
required
integer <int64>
Example: 123

ID adresáta

Responses

vložení/upravení adresátů hromadného emailu

Hromadné vložení nebo upravení adresátů hromadného emailu (upsert). Podle emailu bude buď upraven záznam adresáta nebo bude do hromadného emailu vložen nový adresát. Nový adresát se dohledá v adresáři (Klienti, Kontaktní osoby, Leady) podle zadaného emailu vždy v obou možných polích (email, email2). Pokud nebude adresát dohledán, nebude do hromadného emailu založen. Jestliže bude email dohledán u více kontaktů, budou do hromadného emailu přidány všechny entity.

Maximální počet adres k úpravě/přidání, které lze zaslat jedním požadavkem je 1000.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Request Body schema: application/json
Array
email
required
string

Email, podle kterého se bude dohledávat kontakt v CRM

status
required
string
Enum: "NOT_SENT" "DELIVERED" "REJECTED" "SENT" "UNKNOWN"

[Stav] Stav odeslání

opened
string <date>

[Otevřeno] Datum, kdy adresátem email otevřel

clicked
string <date>

[Kliknuto] Datum, kdy adresát provedl akci (klik)

unsubscribed
string <date>

[Odhlášeno] Datum, kdy se adresát z kampaně odhlásil

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

smazání adresátů hromadného emailu

Hromadné smazání adresátů hromadného emailu podle emailové adresy. Budou smazáni všichni adresáti dohledáni podle emailu.

Maximální počet adres ke smazání, které lze zaslat je 1000.

Authorizations:
(basicAuthinstanceName)
path Parameters
massEmailId
required
integer <int64>
Example: 123

ID hromadného emailu

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "info@klient.cz",
  • "kontakty@uslunce.com"
]

Knihovna dokumentů

API pro práci s knihovnou dokumentů.

seznam složek a souborů

Api pro listování strukturou složek. Ve výsledku je vrácen seznam složek, souborů a odkazů, které jsou relevantní pro filtrovanou cestu (path).

Authorizations:
(basicAuthinstanceName)
query Parameters
path
string
Example: path=/Dokumenty

Filtrování podle cesty ve struktuře složek. Lze využít pouze operátoru EQ

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": [
    ]
}

nová složka

Založení nové složky v DMS. Složka musí mít unikátní název v rámci svého zařazení a nesmí obsahovat některé speciální znaky.

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Název]

parent
integer or null <int64>

[Nadřazená složka] ID složky, do které má být složka vložena. Pokud není vyplněna je založena do hlavní složky.

category
integer <int64>

[Kategorie] ID záznamu z číselníku DocumentCategory

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

Responses

Request samples

Content type
application/json
{
  • "name": "Složka 1",
  • "parent": null,
  • "category": 143,
  • "securityLevel": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání složky

Authorizations:
(basicAuthinstanceName)
path Parameters
folderId
required
integer <int64>
Example: 123

ID klienta

Responses

smazání složky kaskádovitě

Authorizations:
(basicAuthinstanceName)
path Parameters
folderId
required
integer <int64>
Example: 123

ID klienta

Responses

nový dokument

Vložení nového dokumentu do knihovny dokumentů.

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
object
object
status
string
Enum: "A_DRAFT" "E_WIN" "G_STORNO"

[Stav] - výchozí hodnota A_DRAFT

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

category
integer <int64>

[Kategorie] ID záznamu z číselníku DocumentCategory

template
boolean

[Šablona]

validFrom
string <date>

[Platné od] datum platné od

validTill
string <date>

[Platné do] datum platné do

folder
required
integer <int64>

[Umístění] ID záznamu adresáře

Responses

Request samples

Content type
application/json
{
  • "file": {
    },
  • "status": "E_WIN",
  • "securityLevel": 4,
  • "category": 288,
  • "template": false,
  • "validFrom": "2022-01-01",
  • "validTill": "2022-01-01",
  • "folder": 9
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail dokumentu

Získání detailu dokumentu.

https://app.raynet.cz/api/v2/dms/document/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení dokumentu

Upravení dat dokumentu

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Request Body schema: application/json
object
object
status
string
Enum: "A_DRAFT" "E_WIN" "G_STORNO"

[Stav] - výchozí hodnota A_DRAFT

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

category
integer <int64>

[Kategorie] ID záznamu z číselníku DocumentCategory

template
boolean

[Šablona]

validFrom
string <date>

[Platné od] datum platné od

validTill
string <date>

[Platné do] datum platné do

folder
integer <int64>

[Umístění] ID záznamu adresáře

Responses

Request samples

Content type
application/json
{
  • "file": {
    },
  • "status": "E_WIN",
  • "securityLevel": 4,
  • "category": 288,
  • "template": false,
  • "validFrom": "2022-01-01",
  • "validTill": "2022-01-01",
  • "folder": 9
}

smazání dokumentu

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

uzamčení dokumentu

Uzamčení záznamu dokumentu pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

odemčení dokumentu

Odemčení záznamu dokumentu k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

zneplatnění dokumentu

Zneplatnění záznamu dokumnetu.

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

obnovení platnosti dokumentu

Obnovení platnosti záznamu dokumentu.

Authorizations:
(basicAuthinstanceName)
path Parameters
documentId
required
integer <int64>
Example: 123

ID dokumentu

Responses

Faktury

API pro práci s fakturačním modulem.

seznam faktur

Získání seznamu faktur. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/invoiceLight/?offset=0&limit=1&title[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených faktur je 1000

sortColumn
string
Enum: "id" "rowInfo.createdAt" "rowInfo.updatedAt" "rowInfo.lastModifiedAt" "title" "code" "issueDate"
Example: sortColumn=title
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

title
string
Example: title=RAY

Filtrování faktur podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

code
string
Example: code=12345678

Filtrování faktur podle kódu faktury. Lze využít operátoru EQ, NE, LIKE. Výchozím operátorem je EQ.

company
integer <int64>
Example: company=1

Filtrování faktur podle klienta. Filtruje se podle jednoznačného identifikátoru klienta (id)

owner
integer <int64>
Example: owner=1

Filtrování faktur podle vlastníka. Filtruje se podle jednoznačného identifikátoru vlastníka (id)

businessCase
integer <int64>
Example: businessCase=1

Filtrování faktur podle obchodního případu. Filtruje se podle jednoznačného identifikátoru OP (id)

issueDate
string
Example: issueDate=2022-01-01

Filtrování faktur podle data vystavení.

invoiceType
string
Example: invoiceType=NORMAL

Filtrování faktur podle typu. Hodnoty jsou: NORMAL, PROFORMA, CREDIT_NOTE. Lze využít operátoru EQ, NE, IN. Výchozím operátorem je EQ.

taxableSupplyDate
string
Example: taxableSupplyDate=2022-01-01

Filtrování faktur podle data zdanitelného plnění.

dueDate
string
Example: dueDate=2022-01-01

Filtrování faktur podle data splatnosti.

paymentDate
string
Example: paymentDate=2022-01-01

Filtrování faktur podle data uhrazení.

variableSymbol
string
Example: variableSymbol=123456

Filtrování faktur podle variabilního symbolu. Lze využít operátoru EQ, NE, LIKE

specificSymbol
string
Example: specificSymbol=123456

Filtrování faktur podle specifického symbolu. Lze využít operátoru EQ, NE, LIKE

constantSymbol
string
Example: constantSymbol=0308

Filtrování faktur podle konstantního symbolu. Lze využít operátoru EQ, NE, LIKE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování faktur podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování faktur podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování faktur podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

tags
string
Example: tags=tags

Filtrování podle štítku. Je možné hledat podle více štítků oddělených čárkou. Záznam potom musí alespoň jeden obsahovat (tag1,tag2).

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nová faktura

Založení nové faktury

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code
required
string

[Číslo] Číslo faktury

company
required
integer <int64>

[Klient] Klient kterému se bude fakturovat

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

title
string

[Název] Název faktury pro lepší dohledatelnost

constantSymbol
string

[Konstantní symbol]

specificSymbol
string

[Specifický symbol]

variableSymbol
string

[Variabilní symbol]

currency
required
integer <int64>

[Měna] ID záznamu z číselníku Currency

currencyExchangeRate
number

[Kurz]

dueDate
required
string

[Datum splatnosti]

issueDate
required
string

[Datum vystavení]

paymentDate
string

[Datum zaplacení]

invoiceType
required
string
Enum: "NORMAL" "PROFORMA"

[Typ faktury]

invoiceState
required
string
Enum: "UNPAID" "PARTIALLY_PAID" "PAID" "CANCELLED"

[Stav faktury]

paymentType
required
string
Enum: "PAYMENT_DIRECT_DEBIT" "PAYMENT_CASH" "PAYMENT_CASH_ON_DELIVERY" "PAYMENT_CARD"

[Způsob úhrady]

taxableSupplyDate
required
string

[Datum zdanitelného plnění]

owner
required
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

taxPayer
required
string
Enum: "YES" "NO"

[Plátce DPH]

businessCase
integer <int64>

[Obchodní případ] ID záznamu obchodního případu. Není kontrolována integrita Klient - Obchodní případ - Faktura (tzn. faktura může být na jiného klienta než OP).

salesOrder
integer <int64>

[Objednávka] ID záznamu objednávky. Není kontrolována integrita Klient - Obchodní případ - Objednávka - Faktura (tzn. faktura může být na jiného klienta než Objednávka).

note
string

[Poznámka pro příjemce] Pokud není vyplněna, použije se předvyplnění z konfigurace fakturačního modulu

privateNote
string

[Poznámka interní]

creditNoteReason
string

[Zdůvodnění opravy]

vendorName
required
string

[Dodavatel - Jméno klienta]

vendorRegNumber
string

[Dodavatel - IČ]

vendorTaxNumber
string

[Dodavatel - DIČ]

vendorTaxNumber2
string

[Dodavatel - IČ DPH]

required
object

[Adresa dodavatele]

vendorEmail
string

[Dodavatel - Email]

vendorPhoneNumber
string

[Dodavatel - Telefon]

vendorWebsite
string

[Dodavatel - Web]

vendorBankAccountNumber
required
string

[Dodavatel - Číslo účtu]

vendorBankIban
string

[Dodavatel - IBAN]

vendorBankSwift
string

[Dodavatel - SWIFT]

vendorBusinessRegisterNote
string

[Dodavatel - Zapsán v rejstříku]

billingName
required
string

[Odběratel - Jméno klienta]

billingRegNumber
string

[Odběratel - IČ]

billingTaxNumber
string

[Odběratel - DIČ]

billingTaxNumber2
string

[Odběratel - IČ DPH]

required
object

[Adresa odběratele]

category
integer <int64>

[Kategorie] ID záznamu z číselníku InvoiceCategory

reverseTax
boolean

[Příznak pro Režim přenesení daňové povinnosti]

proformaTaxMove
boolean

[Příznak pro Záloha je daňový pohyb]

normalInvoice
integer <int64>

[Vazba na jinou fakturu] ID propojené faktury (ID daňového dokladu u opravné nebo zálohové faktury)

decimalPrecision
integer <int64>

[Počet desetinných míst]

roundingBalance
number

[Haléřové vyrovnání / zaokrouhlení]

discount
number

[Sleva v dané měně]

discountPercent
number

[Sleva v procentech]

baseAmount
number

[Celkem bez DPH]

totalAmount
number

[Celkem s DPH]

taxAmount
number

[DPH]

Array of objects >= 0 items
Array of objects >= 0 items
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "code": "FV202300001",
  • "company": 1,
  • "title": "Faktura za dobrou radu",
  • "constantSymbol": "0308",
  • "currency": 15,
  • "dueDate": "2022-10-16",
  • "invoiceType": "NORMAL",
  • "invoiceState": "UNPAID",
  • "issueDate": "2022-10-02",
  • "paymentType": "PAYMENT_DIRECT_DEBIT",
  • "owner": 6,
  • "taxPayer": "YES",
  • "securityLevel": 1,
  • "specificSymbol": "",
  • "taxableSupplyDate": "2022-10-02",
  • "businessCase": 4,
  • "vendorName": "RAYNET s.r.o.",
  • "vendorBankAccountNumber": "11555511/0300",
  • "vendorAddress": {
    },
  • "billingName": "RAYNET s.r.o.",
  • "billingAddress": {
    },
  • "roundingBalance": 0.2,
  • "decimalPrecision": 2,
  • "baseAmount": 500,
  • "totalAmount": 550,
  • "taxAmount": 50,
  • "tags": [ ],
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail faktury

Získání detailu faktury.

https://app.raynet.cz/api/v2/invoiceLight/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
invoiceId
required
integer <int64>
Example: 123

ID faktury

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "FV2015001",
  • "title": "Faktura FV2015001",
  • "company": {
    },
  • "invoiceType": "NORMAL",
  • "issueDate": "2022-10-02",
  • "dueDate": "2022-10-16",
  • "taxableSupplyDate": "2022-10-02",
  • "paymentDate": null,
  • "invoiceState": "PAID",
  • "baseAmount": 123,
  • "totalAmount": 148.83,
  • "unpaidAmount": 0,
  • "currency": {
    },
  • "currencyExchangeRate": 1,
  • "variableSymbol": "2015001",
  • "constantSymbol": "0308",
  • "specificSymbol": null,
  • "category": null,
  • "owner": {
    },
  • "note": "VS: {VARIABILNI_SYMBOL}",
  • "privateNote": null,
  • "creditNoteReason": null,
  • "vendorName": "RAYNET s.r.o.",
  • "vendorBankAccountNumber": "192913372/0300",
  • "vendorBankIban": "CZ9303000000000192913372",
  • "vendorBankSwift": "CEKOCZPP",
  • "vendorRegNumber": "26843820",
  • "vendorTaxNumber": "CZ26843820",
  • "vendorTaxNumber2": null,
  • "vendorEmail": "fakturace@raynet.cz",
  • "vendorWebsite": "www.raynet.cz",
  • "vendorPhoneNumber": "+420 553 401 520",
  • "vendorBusinessRegisterNote": "Krajský obchodní soud v Ostravě, oddíl C, vložka 28180",
  • "vendorAddress": {
    },
  • "billingName": "RAYNET s.r.o.",
  • "billingRegNumber": "26843820",
  • "billingTaxNumber": "CZ26843820",
  • "billingTaxNumber2": null,
  • "billingAddress": {
    },
  • "businessCase": null,
  • "salesOrder": null,
  • "paymentType": "PAYMENT_CARD",
  • "decimalPrecision": 2,
  • "taxPayer": "YES",
  • "reverseTax": false,
  • "normalInvoice": {
    },
  • "roundingBalance": 0.2,
  • "taxAmount": "20,",
  • "discount": "10,",
  • "discountPercent": 2,
  • "proformaTaxMove": false,
  • "rowInfo.createdAt": "2022-10-02 15:14",
  • "rowInfo.createdBy": "konektor@raynet.cz",
  • "rowInfo.updatedAt": "2022-10-02 15:36",
  • "rowInfo.updatedBy": "konektor@raynet.cz",
  • "rowInfo.rowAccess": null,
  • "rowInfo.rowState": null,
  • "securityLevel": {
    },
  • "_version": 6,
  • "extIds": null,
  • "tags": [ ],
  • "items": [
    ],
  • "payments": [
    ]
}

upravení faktury

Upravení dat faktury

Authorizations:
(basicAuthinstanceName)
path Parameters
invoiceId
required
integer <int64>
Example: 123

ID faktury

Request Body schema: application/json
code
string

[Číslo] Číslo faktury

company
integer <int64>

[Klient] Klient kterému se bude fakturovat

securityLevel
integer <int64>

[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina.

owner
integer <int64>

[Vlastník] ID kontaktní osoby, která je zároveň uživatelem

title
string

[Název] Název faktury pro lepší dohledatelnost

variableSymbol
string

[Variabilní symbol]

constantSymbol
string

[Konstantní symbol]

specificSymbol
string

[Specifický symbol]

currency
integer <int64>

[Měna] ID záznamu z číselníku Currency

currencyExchangeRate
number

[Kurz]

dueDate
string

[Datum splatnosti]

issueDate
string

[Datum vystavení]

paymentDate
string

[Datum zaplacení]

taxableSupplyDate
string

[Datum zdanitelného plnění]

invoiceType
string
Enum: "NORMAL" "PROFORMA"

[Typ faktury]

invoiceState
string
Enum: "UNPAID" "PARTIALLY_PAID" "PAID" "CANCELLED"

[Stav faktury]

paymentType
string
Enum: "PAYMENT_DIRECT_DEBIT" "PAYMENT_CASH" "PAYMENT_CASH_ON_DELIVERY" "PAYMENT_CARD"

[Způsob úhrady]

taxPayer
string
Enum: "YES" "NO"

[Plátce DPH]

businessCase
integer <int64>

[Obchodní případ] ID záznamu obchodního případu. Není kontrolována integrita Klient - Obchodní případ - Faktura (tzn. faktura může být na jiného klienta než OP).

salesOrder
integer <int64>

[Objednávka] ID záznamu objednávky. Není kontrolována integrita Klient - Obchodní případ - Objednávka - Faktura (tzn. faktura může být na jiného klienta než Objednávka).

note
string

[Poznámka pro příjemce] Pokud není vyplněna, použije se předvyplnění z konfigurace fakturačního modulu

privateNote
string

[Poznámka interní]

creditNoteReason
string

[Zdůvodnění opravy]

vendorName
string

[Dodavatel - Jméno klienta]

vendorRegNumber
string

[Dodavatel - IČ]

vendorTaxNumber
string

[Dodavatel - DIČ]

vendorTaxNumber2
string

[Dodavatel - IČ DPH]

object

[Adresa dodavatele]

vendorEmail
string

[Dodavatel - Email]

vendorPhoneNumber
string

[Dodavatel - Telefon]

vendorWebsite
string

[Dodavatel - Web]

vendorBankAccountNumber
string

[Dodavatel - Číslo účtu]

vendorBankIban
string

[Dodavatel - IBAN]

vendorBankSwift
string

[Dodavatel - SWIFT]

vendorBusinessRegisterNote
string

[Dodavatel - Zapsán v rejstříku]

billingName
string

[Odběratel - Jméno klienta]

billingRegNumber
string

[Odběratel - IČ]

billingTaxNumber
string

[Odběratel - DIČ]

billingTaxNumber2
string

[Odběratel - IČ DPH]

object

[Adresa odběratele]

category
integer <int64>

[Kategorie] ID záznamu z číselníku InvoiceCategory

reverseTax
boolean

[Příznak pro Režim přenesení daňové povinnosti]

proformaTaxMove
boolean

[Příznak pro Záloha je daňový pohyb]

normalInvoice
integer <int64>

[Vazba na jinou fakturu] ID propojené faktury (ID daňového dokladu u opravné nebo zálohové faktury)

decimalPrecision
integer <int64>

[Počet desetinných míst]

roundingBalance
number

[Haléřové vyrovnání / zaokrouhlení]

discount
number

[Sleva v dané měně]

discountPercent
number

[Sleva v procentech]

baseAmount
number

[Celkem bez DPH]

totalAmount
number

[Celkem s DPH]

taxAmount
number

[DPH]

Array of objects >= 0 items
Array of objects >= 0 items
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "company": 1,
  • "title": "Faktura za dobrou radu",
  • "constantSymbol": "0308",
  • "currency": 15,
  • "dueDate": "2022-10-16",
  • "invoiceType": "NORMAL",
  • "issueDate": "2022-10-02",
  • "paymentType": "PAYMENT_DIRECT_DEBIT",
  • "securityLevel": 1,
  • "specificSymbol": "",
  • "taxableSupplyDate": "2022-10-02",
  • "businessCase": 5,
  • "vendorName": "RAYNET s.r.o.",
  • "vendorRegNumber": "26843820",
  • "vendorTaxNumber": "CZ26843820",
  • "vendorAddress": {
    },
  • "vendorEmail": "info@raynet.cz",
  • "vendorPhoneNumber": "800 101 201",
  • "vendorWebsite": "www.raynet.cz",
  • "vendorBankAccountNumber": "11555511/0300",
  • "vendorBankIban": "CZ05 0300 0000 0000 1155 5511",
  • "vendorBankSwift": "CEKOCZPP",
  • "vendorBusinessRegisterNote": "Krajský obchodní soud v Ostravě, oddíl C, vložka 28180",
  • "billingName": "RAYNET s.r.o.",
  • "billingRegNumber": "26843820",
  • "billingTaxNumber": "CZ26843820",
  • "billingAddress": {
    },
  • "items": [
    ],
  • "payments": [
    ]
}

smazání faktury

Authorizations:
(basicAuthinstanceName)
path Parameters
invoiceId
required
integer <int64>
Example: 123

ID faktury

Responses

uzamčení faktury

Uzamčení záznamu faktury pro editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
invoiceId
required
integer <int64>
Example: 123

ID faktury

Responses

odemčení faktury

Odemčení záznamu faktury k editaci.

Authorizations:
(basicAuthinstanceName)
path Parameters
invoiceId
required
integer <int64>
Example: 123

ID faktury

Responses

Číselníky

API pro práci s číselníky.

seznam kategorií leadu

LeadCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie leadu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie leadu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie leadu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií klienta

CompanyCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie klienta

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Zostřený režim",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Zostřený režim",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam zdrojů kontaktu

ContactSource

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového zdroje kontaktu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "vlastní nový kontakt"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení zdroje kontaktu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "vlastní nový kontakt"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání zdroje kontaktu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam počtu zaměstnanců

EmployeesNumber

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

přidání počtu zaměstnanců

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "1 - 10"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení počtu zaměstnanců

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "1 - 10"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání počtu zaměstnanců

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam právních forem

LegalForm

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové právní formy

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "s.r.o."
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení právní formy

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "s.r.o."
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání právní formy

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam platebních podmínek

PaymentTerm

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

přidání platební podmínky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "7 dní"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení platební podmínky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "7 dní"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání platební podmínky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam obratů

CompanyTurnover

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

přidání nového obratu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "do 1 mil. Kč"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení obratu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "do 1 mil. Kč"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání obratu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam oborů činnosti

EconomyActivity

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového oboru činnosti

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "obor"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení oboru činnosti

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "obor"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání oboru činnosti

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 1 pro klienta

CompanyClassification1

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 1 pro klienta

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 1 pro klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 1 klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 2 pro klienta

CompanyClassification2

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 2 pro klienta

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 2 pro klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 2 klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 3 pro klienta

CompanyClassification3

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 3 pro klienta

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 3 pro klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 3 klienta

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam obchodních teritorií

Territory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového obchodního teritoria

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "Morava"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení obchodního teritoria

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "Morava"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání obchodního teritoria

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií kontaktní osoby

PersonCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie kontaktní osoby

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "VIP",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "VIP",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 1 kontaktní osoby

PersonClassification1

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 1 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 1 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 1 kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 2 kontaktní osoby

PersonClassification2

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 2 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 2 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 2 kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 3 kontaktní osoby

PersonClassification3

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 3 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 3 pro kontaktní osobu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 3 kontaktní osoby

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam jazyků

Language

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového jazyku

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "čeština"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení jazyku

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "čeština"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání jazyku

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam rodinných stavů

MaritalStatus

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

přidání rodinného stavu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "Svobodná / Svobodný"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení rodinného stavu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "Svobodná / Svobodný"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání rodinného stavu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorie produktů

ProductCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie produktu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "kusový prodej",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie produktu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "kusový prodej",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie produktů

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam produktových řad

ProductLine

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové produktové řady

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "ovoce"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení produktové řady

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "ovoce"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání produktové řady

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií obchodního případu

BusinessCaseCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie obchodního případu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Prodej nového zboží",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Prodej nového zboží",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií participace obchodního případu

BusinessCaseRelationshipCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie participace obchodního případu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Název kategorie",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie participace obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Název kategorie",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie participace obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam typů obchodního případu

BusinessCaseType

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

seznam stavů obchodního případu

BusinessCasePhase

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového stavu obchodního případu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název stavu OP]

code02
string

[Barva stavu OP]

probability
integer <int32>

[Výchozí pravděpodobnost] pro daný stav OP

businessCaseTypeId
integer or null <int64>

[ID typu OP] (povinné, pokud je zapnuto rozšíření 'Typy obchodu' v nastavení evidence OP)

Responses

Request samples

Content type
application/json
{
  • "code01": "Před uzavřením",
  • "code02": "E9802F",
  • "probability": 50,
  • "businessCaseTypeId": null
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání stavu obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID stavu OP

Responses

seznam klasifikací 1 pro obchodní případ

BusinessCaseClassification1

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 1 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 1 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 1"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 1 obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 2 pro obchodní případ

BusinessCaseClassification2

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 2 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 2 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 2"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 2 obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam klasifikací 3 pro obchodní případ

BusinessCaseClassification3

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové klasifikace 3 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení klasifikace 3 pro obchodní případ

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "klasifikace 3"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání klasifikace 3 obchodního případu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam měn

Currency

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové měny

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název měny]

code02
required
string

[Kód měny]

strValue01
string

[Popis měny]

Responses

Request samples

Content type
application/json
{
  • "code01": "¥",
  • "code02": "JPY",
  • "strValue01": "Japonský jen"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": 5
}

upravení měny

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název měny]

code02
string

[Kód měny]

strValue01
string

[Popis měny]

Responses

Request samples

Content type
application/json
{
  • "code01": "¥",
  • "code02": "JPY",
  • "strValue01": "Japonský jen"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání měny

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií prohry

LosingCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie prohry

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "přechod ke konkurenci"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie prohry

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "přechod ke konkurenci"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie prohry

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam typů telefonu

TypTel

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového typu telefonu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "pager"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení typu telefonu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název číselníkové položky]

Responses

Request samples

Content type
application/json
{
  • "code01": "pager"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání typu telefonu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam stavů leadu

LeadPhase

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového stavu leadu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název stavu]

code02
string

[Barva stavu]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání stavu leadu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií nabídky

OfferCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie nabídky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie nabídky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie nabídky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií objednávky

SalesOrderCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie objednávky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie objednávky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie objednávky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií projektu

ProjectCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie projektu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií participace projektu

ProjectRelationshipCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie participace projektu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Název kategorie",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie participace projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Název kategorie",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie participace projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií ceníku

PriceListCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie ceníku

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo",
  • "code02": "cdcdcd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie ceníku

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam stavů nabídky

OfferStatus

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového stavu nabídky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název stavu]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání stavu nabídky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam stavů objednávky

SalesOrderStatus

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového stavu objednávky

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název stavu]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání stavu objednávky

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam stavů projektu

ProjectStatus

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nového stavu projektu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název stavu]

Responses

Request samples

Content type
application/json
{
  • "code01": "Odloženo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání stavu projektu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam sazeb DPH

TaxRate

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové sazby DPH

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Hodnota sazby v procentech]

numValue01
integer <int64>

[Hodnota sazby v číselném vyjádření] - pokud není hodnota zadána, je vypočítána z code01

strValue01
string

[Název sazby]

Responses

Request samples

Content type
application/json
{
  • "code01": "15%",
  • "strValue01": "první snížená"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání sazby DPH

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam forem souhlasu

GdprFormAgreement

Authorizations:
(basicAuthinstanceName)

Responses

založení nové formy souhlasu

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Popis formy souhlasu]

Responses

Request samples

Content type
application/json
{
  • "code01": "elektronicky"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení formy souhlasu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Popis formy souhlasu]

Responses

Request samples

Content type
application/json
{
  • "code01": "elektronicky"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání formy souhlasu

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií aktivit

ActivityCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie aktivity

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie aktivity

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie aktivity

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

seznam kategorií faktur

InvoiceCategory

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

založení nové kategorie faktur

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
code01
required
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení kategorie faktur

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Request Body schema: application/json
code01
string

[Název kategorie]

code02
string

[Barva kategorie]

Responses

Request samples

Content type
application/json
{
  • "code01": "bez reakce",
  • "code02": "aa99dd"
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání kategorie faktur

Authorizations:
(basicAuthinstanceName)
path Parameters
id
required
integer <int64>
Example: 123

ID položky číselníku

Responses

Soubory

API pro načtení obsahu souborů v podobě příloh nebo obrázků (fotek, log) k záznamům.

Stažení ikony obrázku

Získání obsahu obrázku (loga nebo fota) v malé velikosti, zakódovaného do Base 64 formátu.

https://app.raynet.cz/api/v2/icon/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
fileId
required
integer <int64>
Example: 123

ID loga nebo fota (získaného z detailu záznamu, kde se foto / logo nachází)

Responses

Response samples

Content type
image/png
{
  "fileName": "logo.png",
  "contentType": "image/png",
  "imgData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAIAAACRXR/mAAAXYElEQVR4nGWWB3QVZdrHr7quZY/7rR0si59d3FXBtYACo="
}

Stažení obrázku

Získání obsahu obrázku (loga nebo fota) v plné velikosti zakódovaného do Base 64 formátu.

https://app.raynet.cz/api/v2/image/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
fileId
required
integer <int64>
Example: 123

ID loga nebo fota (získaného z detailu záznamu, kde se foto / logo nachází)

Responses

Response samples

Content type
image/png
{
  "fileName": "logo.png",
  "contentType": "image/png",
  "imgData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAIAAACRXR/mAAAXYElEQVR4nGWWB3QVZdrHr7quZY/7rR0si59d3FXBtYACo="
}

Stažení meta informací o souboru

Stažení meta informací o jakémkoliv souboru v CRM (příloha, logo atd). API vrátí jméno souboru, typ souboru, unikátní identifikátor (UUID), název instance CRM a vygenerovaný access token. Tyto údaje pak slouží k jednorázovému použití v api /fileBody pro získání obsahu souboru.

https://app.raynet.cz/api/v2/fileHeader/3/
Authorizations:
(basicAuthinstanceName)
path Parameters
fileId
required
integer <int64>
Example: 123

ID souboru (získaného z detailu záznamu (např.: attachment -> file -> id), kde se foto, logo nebo příloha nachází)

Responses

Response samples

Content type
application/json
{
  • "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  • "fileName": "priloha.png",
  • "fileSize": 1201,
  • "contentType": "image/png",
  • "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  • "instanceName": "mojecrm"
}

Stažení těla souboru

Stažení těla (obsahu) jakéhokoliv souboru v CRM (přílohy, loga atd). Jedná se o file request bez vlastních http hlaviček a bez autorizace (aby mohl být volán automaticky prohlížečem prostřednictvím hyperlinku). Z tohoto důvodu je potřeba do url předat údaje (uuid, acces token a název instance), které se získají z předchozího volání API /fileHeader (viz výše). Navíc se za url do parametrů přidává název (fileName) a typ souboru (contentType), což se následně vrátí v hlavičce odpovědi (prohlížeč pak má správné údaje o stahovaném souboru - např. pro korektní zobrazení a otevření v asociované aplikaci).

https://app.raynet.cz/api/v2/fileBody/6775ac8cebd548e9b94a8ec99c30bab7/d9b38352c39f4ca2b7d367cffe089d20/
mojecrm/?fileName=priloha.png&contentType=image%2Fpng
Authorizations:
(basicAuthinstanceName)
path Parameters
uuid
required
integer <int64>
Example: 6775ac8cebd548e9b94a8ec99c30bab7

UUID souboru (jednoznačný identifikátor souboru v CRM, získaný z API /fileHeader)

accessToken
required
string
Example: d9b38352c39f4ca2b7d367cffe089d20

Access token (vygenerovaný jednorázový autorizační klíč, získaný z API /fileHeader)

instanceName
required
string
Example: mojecrm

Název instance (název vašeho CRM, získaný z API /fileHeader)

query Parameters
fileName
required
string
Example: fileName=priloha.png

Název souboru (získaný z API /fileHeader)

contentType
required
string
Example: contentType=image/png

Typ obsahu souboru (získaný z API /fileHeader)

Responses

Stažení těla exportu

Stažení těla (obsahu) souboru, který byl v předchozím kroku z CRM vyexportován prostřednictvím některého z export API (např. API /businessCase/:businessCaseId/pdfExport). Jedná se o file request bez vlastních http hlaviček a bez autorizace (aby mohl být volán automaticky prohlížečem prostřednictvím hyperlinku). Z tohoto důvodu je potřeba do url předat údaje (uuid, acces token a název instance), které se získají z předchozího volání export API. Navíc se za url do parametrů přidává název (fileName) a typ souboru (contentType), což se následně vrátí v hlavičce odpovědi (prohlížeč pak má správné údaje o stahovaném souboru - např. pro korektní zobrazení a otevření v asociované aplikaci).

https://app.raynet.cz/api/v2/exportBody/6775ac8cebd548e9b94a8ec99c30bab7/d9b38352c39f4ca2b7d367cffe089d20/
mojecrm/?fileName=obchodni_pripad.png&contentType=application%2Foctet-stream
Authorizations:
(basicAuthinstanceName)
path Parameters
uuid
required
integer <int64>
Example: 6775ac8cebd548e9b94a8ec99c30bab7

UUID souboru (jednoznačný identifikátor souboru v CRM, získaný např. z API /businessCase/:businessCaseId/pdfExport)

accessToken
required
string
Example: d9b38352c39f4ca2b7d367cffe089d20

Access token (vygenerovaný jednorázový autorizační klíč, získaný např. z API /businessCase/:businessCaseId/pdfExport)

instanceName
required
string
Example: mojecrm

Název instance (název vašeho CRM, získaný např. z API /businessCase/:businessCaseId/pdfExport)

query Parameters
fileName
required
string
Example: fileName=priloha.png

Název exportovaného souboru (získaný např. z API /businessCase/:businessCaseId/pdfExport)

contentType
required
string
Example: contentType=application/octet-stream

Typ obsahu exportovaného souboru (získaný např. z API /businessCase/:businessCaseId/pdfExport)

Responses

Upload souboru do CRM

Nahrání souboru do uložiště v CRM. Obsah souboru je potřeba nahrát ve formátu 'multipart/form-data' (standardní formát pro odeslání formulářových dat obsahujících soubor http requestem) a to pod atributem s názvem 'file'. API vrací informace o nově nahraném souboru (zejména unikátní identifikátr souboru - UUID). Výstupní parametry pak slouží jako vstup pro API k založení nové přílohy (viz níže).

https://app.raynet.cz/api/v2/fileUpload
Authorizations:
(basicAuthinstanceName)
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "uuid": "7d694dbb4e6241829de8a385da797283",
  • "fileName": "picture.png",
  • "contentType": "image/png",
  • "fileSize": 24309
}

Přidání přílohy

  https://app.raynet.cz/api/v2/attachment/company/3/

API slouží k:

a) vytvoření záznamu přílohy odkazující na libovolné URL, např. na webové stránky. Příloha se přiřadí k vybrané entitě, zadané jejím ID a názvem entity. API ke své funkci potřebuje znát URL odkazu a název odkazu.

  { "link": "https://raynet.cz", "linkName": "raynet.cz"}

b) vytvoření záznamu přílohy, která odkazuje na předem uploadovaný soubor. Příloha se přiřadí k vybrané entitě, zadané jejím ID a názvem entity. API ke své funkci potřebuje znát UUID předem nahraného souboru spolu s dalšími parametry tohoto souboru.

  {"fileName":"upload.bin","uuid":"0cd5d016-f534-4093-943b-740961b03b6f","contentType":"application/octet-stream","fileSize":21195}

c) vytvoření záznamu přílohy odkazující na složku z knihovny dokumentů. Příloha se přiřadí k vybrané entitě, zadané jejím ID a názvem entity. API ke své funkci potřebuje znát ID složky.

  { "folderId": 6 }
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

Request Body schema: application/json
link
string

[URL odkazu] pro přidání odkazu

linkName
string

[Název odkazu] pro přidání odkazu

uuid
string

[UUID souboru] pro přidání přílohy

fileName
string

[Název souboru] pro přidání přílohy

contentType
string

[Typ souboru] pro přidání přílohy

fileSize
integer <int64>

[Velikost souboru v bytech] pro přidání přílohy

folderId
integer <int64>

[DMS složka] ID složky v knihovně dokumentů

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": 5
}

Přidání přílohy se souborem do volitelného pole

API slouží k vytvoření záznamu přílohy, která odkazuje na předem uploadovaný soubor. Příloha se přiřadí volitelnému poli typu soubor (zadaného klíčem volitelného pole) na vybraném záznamu dané entity, zadané ID záznamu a názvem entity. API ke své funkci potřebuje znát UUID předem nahraného souboru spolu s dalšími parametry tohoto souboru.

https://app.raynet.cz/api/v2/attachment/company/3/soubor_29f53
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

customFieldId
required
string
Example: soubor_29f53

Klíč (name) volitelného pole

Request Body schema: application/json
uuid
required
string

[UUID souboru]

fileName
required
string

[Název souboru]

contentType
required
string

[Typ souboru]

fileSize
required
integer <int64>

[Velikost souboru v bytech]

Responses

Request samples

Content type
application/json
{
  • "uuid": "7d694dbb4e6241829de8a385da797283",
  • "fileName": "picture.png",
  • "contentType": "image/png",
  • "fileSize": 24309
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Smazání přílohy

API umožňuje smazat existující přílohu na základě zadaného ID přílohy.

https://app.raynet.cz/api/v2/attachment/125/
Authorizations:
(basicAuthinstanceName)
path Parameters
attachmentId
required
integer <int64>
Example: 125

ID přílohy

Responses

GDPR šablony právních titulů

API pro práci s GDPR šablony právních titulů.

seznam šablon právních titulů

Získání seznamu šablon právních titulů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/gdprTemplate/?name[LIKE]=RAY%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Value: "name"
Example: sortColumn=name
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
name
string
Example: name=RAY

Filtrování šablon právních titulů podle názvu. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

legalTitle
string
Example: legalTitle=LEGITIMATE_INTEREST

Filtrování šablon právních titulů podle typu právního titulu (LEGITIMATE_INTEREST, CONSENT, CONTRACT, LEGAL_OBLIGATION, PUBLIC_INTEREST, VITAL_INTEREST)

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování šablon právních titulů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování šablon právních titulů podle posledního data upravení klienta. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování šablon právních titulů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování šablon právních titulů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

GDPR

API pro práci s GDPR právními tituly.

seznam právních titulů

Získání seznamu právních titulů k entitě. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/gdpr/
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Value: "gdprTemplate"
Example: sortColumn=gdprTemplate
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
company
integer <int64>
Example: company=1

Filtrování právních titulů podle klienta. Lze využít operátoru EQ, NE, GT, GE, LT, LE

lead
integer <int64>
Example: lead=2

Filtrování právních titulů podle leadu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

person
integer <int64>
Example: person=10

Filtrování právních titulů podle kontaktní osoby. Lze využít operátoru EQ, NE, GT, GE, LT, LE

gdprTemplate
integer <int64>
Example: gdprTemplate=141

Filtrování právních titulů podle šablony právního titulu. Lze využít operátoru EQ, NE, GT, GE, LT, LE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování právních titulů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování právních titulů podle posledního data upravení klienta. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování právních titulů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování právních titulů podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

nový právní titul

Založení nového právního titulu k entitě klient, kontaktní osoba, lead

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
gdprTemplate
required
integer <int64>

[Šablona právního titulu] ID Šablony právního titulu

gdprFormAgreement
integer <int64>

[Forma udělení souhlasu] ID Formy udělení souhlasu. Jen pro právní titul CONSENT.

company
integer <int64>

[Klient] ID klienta, kterou je vytvářen právní titlu

person
integer <int64>

[Kontaktní osoba] ID zodp. kontaktní osoby klienta, pro kterou je vytvářen právní titlu

lead
integer <int64>

[Lead] ID leadu, pro kterou je vytvářen právní titlu

validFrom
string <date>

[Platnost od] datum platnosti právního titlulu od

validTill
string <date>

[Platnost do] datum platnosti právního titlulu do

contractValidity
string <date>

[Platnost smlouvy do] datum platnosti smlouvy do. Jen pro právní titul CONTRACT.

Responses

Request samples

Content type
application/json
{
  • "person": 6,
  • "gdprTemplate": 1,
  • "validFrom": "2022-01-01"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

detail právního titlulu

Získání detailu právního titlulu.

https://app.raynet.cz/api/v2/gdpr/1/
Authorizations:
(basicAuthinstanceName)
path Parameters
gdprId
required
integer <int64>
Example: 123

ID právního titulu

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

upravení právního titulu

Upravení dat právního titulu.

Authorizations:
(basicAuthinstanceName)
path Parameters
gdprId
required
integer <int64>
Example: 123

ID právního titulu

Request Body schema: application/json
validFrom
string <date>

[Platnost od] datum platnosti právního titlulu od

validTill
string <date>

[Platnost do] datum platnosti právního titlulu do

gdprFormAgreement
integer <int64>

[Forma udělení souhlasu] ID Formy udělení souhlasu. Jen pro právní titul CONSENT.

contractValidity
string <date>

[Platnost smlouvy do] datum platnosti smlouvy do. Jen pro právní titul CONTRACT.

Responses

Request samples

Content type
application/json
{
  • "validFrom": "2022-11-08",
  • "validTill": "2022-11-08"
}

zneplatnění právního titulu

Zneplatnění právního titulu.

Authorizations:
(basicAuthinstanceName)
path Parameters
gdprId
required
integer <int64>
Example: 123

ID právního titulu

Responses

Notifikace

API pro práci s notifikacemi.

seznam notifikací

Získání notifikací. Pokud není použit filtr recipient[CUSTOM]=all-recipient, tak jsou vráceny jen notifikace aktuálního uživatele.

https://app.raynet.cz/api/v2/notification/?sender[EQ]=2
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

sortColumn
string
Value: "date"
sortDirection
string
Enum: "ASC" "DESC"
date
string

Filtrování podle data notifikace. Lze využít operátoru EQ, NE, GT, GE, LT, LE

sender
integer <int64>

Filtrování podle odesílatele. S operátorem CUSTOM

recipient
string

Filtrování podle příjemce. V případě recipient[CUSTOM]=all-recipient operátoru umožní vyfiltrovat notifikace všech uživatelů. Tento filtr může použít pouze uživatel s rolí administrátor. Lze využít operátoru EQ, NE, IN, CUSTOM

flag
boolean

Filtrování notifikací označených hvězdičkou. Lze využít operátoru EQ, NE.

read
boolean

Filtrování přečtených notifikací. Lze využít operátoru EQ, NE.

context
string

Filtrování podle kontextu notifikace, kde kontext musí být ve formátu NázevEntity#IdEntity (podporované názvy entit jsou: 'company', 'lead', 'person', 'businessCase', 'offer', 'salesOrder', 'product', 'project', 'invoice', 'task', 'email', 'event', 'letter', 'phoneCall', 'meeting')

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 1,
  • "data": [
    ]
}

smazání notifikace

Uživatelé mohou smazat jen vlastní notifikace, kdežto administrátor může smazat i cizí.

Authorizations:
(basicAuthinstanceName)
path Parameters
notificationId
required
integer <int64>
Example: 123

ID notifikace

Responses

Diskuze

API pro práci s diskuzemi.

seznam příspěvků diskuze

https://app.raynet.cz/api/v2/company/4/post/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 2,
  • "data": [
    ]
}

nový příspěvek do diskuze

https://app.raynet.cz/api/v2/company/4/post/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

Request Body schema: application/json
parent
integer <int64>

[ID nadřazeného příspěvku, pod který má být nový komentář zařazen]

comment
required
string

[Komentář]

Responses

Request samples

Content type
application/json
{
  • "parent": 16,
  • "comment": "Další zajímavý komentář"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání příspěvku z diskuze

https://app.raynet.cz/api/v2/company/4/post/19/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

postId
required
integer <int64>
Example: 123

ID příspěvku

Responses

Response samples

Content type
application/json
{
  • "success": true
}

seznam sledovačů diskuze

https://app.raynet.cz/api/v2/company/4/watcher/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 2,
  • "data": [
    ]
}

přidání sledovače diskuze

https://app.raynet.cz/api/v2/company/4/watcher/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

personId
required
integer <int64>
Example: 123

ID kontaktní osoby pro přidání mezi sledovače diskuze

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

odebrání sledovače diskuze

https://app.raynet.cz/api/v2/company/4/watcher/2/
Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

Název entity (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, priceList, project, invoice, task, email, event, letter, phoneCall, meeting)

entityId
required
integer <int64>
Example: 123

ID entity

personId
required
integer <int64>
Example: 123

ID kontaktní osoby pro odebrání ze sledovačů diskuze

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bezpečnostní úrovně

API pro práci s bezpečnostními úrovněmi.

seznam bezpečnostních úrovní

Získání seznamu bezpečnostních úrovní. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

https://app.raynet.cz/api/v2/securityLevel/?offset=0&limit=1&name[LIKE]=Sd%
Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Zobrazeni zaznamu od zacatku

limit
integer <int64>
Example: limit=100

Maximální počet vrácených záznamů je 1000

name
string
Example: name=RAY

Filtrování bezpečnostních úrovní podle jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

locked
boolean
Example: locked=YES

Filtrování bezpečnostních úrovní podle stavu uzamčení. Lze využít operátoru EQ, NE.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "totalCount": 2,
  • "data": [
    ]
}

nová bezpečnostní úroveň

Založení nové bezpečnostní úrovně. Bude přiřazena automaticky všem administrátorům.

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
name
required
string

[Název]

Responses

Request samples

Content type
application/json
{
  • "name": "Bezpečnostní úroveň 1"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

smazání bezpečnostní úrovně

Authorizations:
(basicAuthinstanceName)
path Parameters
securityLevelId
required
integer <int64>
Example: 123

ID bezpečnostní úrovně

Responses

Response samples

Content type
application/json
{
  • "success": true
}

hromadné přidání uživatelů do bezpečnostní úrovně

Authorizations:
(basicAuthinstanceName)
path Parameters
securityLevelId
required
integer <int64>
Example: 123

ID bezpečnostní úrovně

Request Body schema: application/json
personIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "personIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

hromadné odebrání uživatelů z bezpečnostní úrovně

Authorizations:
(basicAuthinstanceName)
path Parameters
securityLevelId
required
integer <int64>
Example: 123

ID bezpečnostní úrovně

Request Body schema: application/json
personIds
required
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "personIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Volitelná pole

API pro načtení konfigurace volitených polí a pro načtení obsahů (seznamů) polí typu ENUMERATION (tzn. číselník, alias roletka). Pozn.: Získání a uložení samotných hodnot volitelných polí se děje prostřednictvím standardních API - add, detail a update.

Načtení konfigurace

Načtení konfigurace (meta-dat) volitených polí, včetně klíčů, uživatelských názvů a skupin polí.

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Nové volitelné pole

Založení nového volitelného pole

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: businessCase

Název entity, ke které se volitelné pole založí (podporované hodnoty jsou: company, lead, person, businessCase, offer, salesOrder, product, project, task, email, event, letter, phoneCall, meeting)

Request Body schema: application/json
label
required
string

[Název pole] (minimálně 3 znaky)

groupName
required
string

[Název panelu] (minimálně 3 znaky)

dataType
required
string
Enum: "STRING" "FILE" "TEXT" "ENUMERATION" "HYPERLINK" "DATE" "DATETIME" "TIME" "BIG_DECIMAL" "MONETARY" "PERCENT" "BOOLEAN"

[Typ pole]

  • STRING Textové pole,
  • FILE Soubor,
  • TEXT Velké textové pole,
  • ENUMERATION Roletka,
  • HYPERLINK Odkaz,
  • DATE Datum,
  • DATETIME Datum s časem,
  • TIME Časové pole,
  • BIG_DECIMAL Číslo,
  • MONETARY Měna,
  • PERCENT Procenta,
  • BOOLEAN Zatržítko
currency
string

[Měna] - povinný v případě, že je dataType=MONETARY

hint
string

[Textová nápověda]

readOnly
boolean

[Pouze pro čtení]

showInFilterView
boolean

[V pokročilých filtrech]

showInListExport
boolean

[V exportech]

showInListView
boolean

[Jako sloupec v seznamu]

fullText
boolean

[Ve fulltextu]

Responses

Request samples

Content type
application/json
{
  • "label": "Datum",
  • "groupName": "Revize",
  • "dataType": "DATE",
  • "showInFilterView": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Upravení volitelného pole

Upravení volitelného pole

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, ve které se má volitelné pole upravit

fieldName
required
string
Example: datum_6ae6f

Kód volitelného pole, které se má upravit

Request Body schema: application/json
label
required
string

[Název pole] (minimálně 3 znaky)

groupName
required
string

[Název panelu] (minimálně 3 znaky)

currency
string

[Měna] - povinný v případě, že je dataType=MONETARY

hint
string

[Textová nápověda]

readOnly
boolean

[Pouze pro čtení]

showInFilterView
boolean

[V pokročilých filtrech]

showInListExport
boolean

[V exportech]

showInListView
boolean

[Jako sloupec v seznamu]

fullText
boolean

[Ve fulltextu]

Responses

Request samples

Content type
application/json
{
  • "label": "Datum",
  • "groupName": "Revize",
  • "showInListView": true
}

Response samples

Content type
application/json
{
  • "success": true
}

Smazání volitelného pole

Smazání volitelného pole

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, ze které se má volitelné pole smazat

fieldName
required
string
Example: datum_6ae6f

Kód volitelného pole, které se má smazat

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Načtení seznamu položek enumerace

Načtení seznamu všech dostupných položek enumerace (číselníku, alias roletky).

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, která volitelné pole obsahuje

fieldName
required
string
Example: Priorita_O_a5fab

Klíč volitelného pole

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Založení nové položky enumerace

Vložení nové hodnoty do enumerace

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, která volitelné pole obsahuje

fieldName
required
string
Example: Priorita_O_a5fab

Klíč volitelného pole

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "položka 1"
}

Response samples

Content type
application/json
{
  • "success": true
}

Upravení položky enumerace

Upravení hodnoty enumerace

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, která volitelné pole obsahuje

fieldName
required
string
Example: Priorita_O_a5fab

Klíč volitelného pole

Request Body schema: application/json
oldValue
required
string
newValue
required
string

Responses

Request samples

Content type
application/json
{
  • "oldValue": "položka 1",
  • "newValue": "položka 11"
}

Response samples

Content type
application/json
{
  • "success": true
}

Smazání položky enumerace

Smazání hodnoty enumerace

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: BusinessCase

Název entity, která volitelné pole obsahuje

fieldName
required
string
Example: Priorita_O_a5fab

Klíč volitelného pole

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "položka 1"
}

Response samples

Content type
application/json
{
  • "success": true
}

Vlastní tlačítka

Konfigurace

Tlačítko vlastních akcí můžete použít pro spouštění integračních scénárů vytvořených programátory namíru nebo v platformách jako je například https://www.integromat.com/. Tlačítka mohou také otevírat externí URL adresy nebo spouštět akce. Ty vám vyplní a stáhnou vlastní tiskovou sestavu, zahájí hovor na telefonu nebo odešlou data do jiné cloudové aplikace.

Tlačítka si můžete nakonfigurovat sami v administraci vašeho CRM v sekci "Pro vývojáře -> Tlačítka vlastních akcí".

Parametry vlastního tlačítka jsou:

Atribut Popis Poznámka
Název Název tlačítka
URL Šablona URL adresy Je možné použít proměnné {token}, {entityId}, {entityName}, {userName}, {userId}, {personId}, {extId_$extIdCode} viz níže
Umístění Kde se tlačítko zobrazí Možnosti jsou: Hlavní menu, Seznam, Detail
Záznam Název entity kde se má tlačítko zobrazit Jen pro umístnění v seznamu nebo detailu záznamu
Popis Popis tlačítka Jen pro umístnění v seznamu nebo detailu záznamu. Zobrazí se při dvou a více tlačítkách v jedné entitě.
Akce Typ akce OPEN URL, AJAX, DOWNLOAD viz níže
Metoda Typ http požadavku GET, POST, PUT, DELETE Jen pro akce typu AJAX a DOWNLOAD
Obnovit data po Čas v ms Dostupné jen pro Seznam a Detail. CRM po stanoveném čase provede aktualizaci zobrazených dat
Titulek úspěchu Titulek zprávy po úspěšném vykonání akce Jen pro AJAX
Text úspěchu Text zprávy po úspěšném vykonání akce Jen pro AJAX
Vyžadovat potvrzení před spuštěním Před spuštěním akce bude uživateli zobrazen dialog s potvrzením
Viditelné jen pro administrátora Vidí pouze administrátor
Vyžadovat uložení záznamu Záznam musí být uložen před spuštěním akce Dosupné jen pro Detail
Otevírat do URL otevřít v nové záložce nebo v novém okně Možnosti jsou OPEN_TAB a OPEN_WINDOW. Dostupné jen pro akci OPEN URL.
Šířka Šířka nově otevřeného okna Dostupné jen pro akci OPEN URL s možností OPEN_WINDOW.
Výška Výška nově otevřeného okna Dostupné jen pro akci OPEN URL s možností OPEN_WINDOW.
Obnovit data po zavření okna Po zavření okna obnoví kartu s detailem nebo seznamem Dostupné jen pro akci OPEN URL s možností OPEN_WINDOW a umístěním v Seznam nebo Detail.

Parametry URL adresy:

Parametr Popis
token Bezpečnostní token generovaný CRM. Je možné jej ověřit pomocí API (viz níže)
entityId ID záznamu, ze kterého je akce spouštěna. Dostupné jen pro Detail
entityName Název entity, ze které je akce spouštěna. Dostupné jen pro Detail a Seznam
userName Email uživatele, který akci spouští.
userId ID uživatele, který akci spouští. Uživatele je možné vyfiltrovat pomocí API seznam kontaktních osob s parametrem userAccount-id
personId ID kontaktní osoby, která akci spustila. Kontaktní osobu je možné vyfiltrovat pomocí API detail kontaktní osoby s parametrem id
extId_$extIdCode Hodnota externího id v záznamu, ze kterého je akce spouštěna. Dostupné jen pro Detail. Např. v případě externího id "mojeid:123" zadejte extId_mojeid

Pokud je akce spuštěna ze Seznamu a je použita jiná metoda než GET, jsou zaslány v rámci RequestBody ID zobrazených záznamů (vždy).

Akce:

Akce Popis
OPEN URL Otevření URL adresy do nové záložky
AJAX Asynchronní požadavek. Při úspěšném zpracování je nutné vrátit HTTP 200 a {"success": true}. Při chybě je možné vrátit JSON ve formátu {"success": false, "message": "Došlo k chybě"}
DOWNLOAD Stažení souboru

ověření bezpečnostního tokenu

Při použití tlačítka vlastní akce je důležité ověřit, že požadavek vzešel opravdu ze strany CRM a nebyl podrvžen. K tomuto slouží parametry URL token a personId, se kterými je možné provést ověření. Parametr personId je nepovinný, dodatečně ověřuje, že token vytvořil právě daný uživatel. Token je možné ověřit pouze jednou a jeho platnost je 60 sekund.

Authorizations:
(basicAuthinstanceName)
path Parameters
token
required
string
Example: 38PUaFrM6g16bSCUfPuV3Ngdhcvxz00OEW4ODppPi3Q

Token

personId
integer <int64>
Example: 123

ID kontaktní osoby, které token patří

Responses

Response samples

Content type
application/json
{
  • "data": true,
  • "success": "true"
}

Načtení konfigurace

Načtení konfigurace (meta-dat) vlastních akcí.

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Nové vlastní tlačítko

Založení nového vlastního tlačítka

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
entityName
required
string
Enum: "Company" "Person" "Lead" "BusinessCase" "Offer" "SalesOrder" "Project" "Product" "PriceList" "Invoice" "Task" "Meeting" "Event" "Email" "PhoneCall" "Letter" "MassEmail"

[Název entity, ke které se volitelné tlačítko zobrazí]

  • Company Klient
  • Person Kontaktní osoba
  • Lead Lead
  • BusinessCase Obchodní případ
  • Offer Nabídka
  • SalesOrder Objednávka
  • Project Projekt
  • Product Produkt
  • PriceList Ceník
  • Invoice Faktura
  • Task Úkol
  • Meeting Schůzka
  • Event Událost
  • Email E-mail
  • PhoneCall Telefonát
  • Letter Dopis
  • MassEmail Hromadný e-mail
appClass
required
string
Enum: "DetailView" "ListView" "MainMenu"

[Typ pohledu, kde se volitelné tlačítko zobrazí]

  • DetailView Detailní pohled
  • ListView Seznamový pohled
  • MainMenu Hlavní menu
name
required
string

[Název vlastního tlačítka]

description
string

[Popis vlastního tlačítka] Dostupné jen pro appClass=ListView nebo appClass=DetailView.

type
required
string
Enum: "AJAX" "DOWNLOAD" "OPEN_URL"

[Typ akce]

  • AJAX Asynchronní požadavek
  • DOWNLOAD Stažení souboru
  • OPEN_URL Otevření URL adresy do nové záložky
method
string
Enum: "GET" "POST" "PUT" "DELETE"

[Typ http požadavku] Dostupné jen pro type=AJAX nebo type=DOWNLOAD.

  • GET
  • POST
  • PUT
  • DELETE
url
string

[Šablona URL adresy]

successTitle
string

[Titulek zprávy po úspěšném vykonání akce] Dostupné jen pro type=AJAX.

successMessage
string

[Text zprávy po úspěšném vykonání akce] Dostupné jen pro type=AJAX.

refresh
integer

[Obnovit data po (čas v ms)] Dostupné jen pro appClass=DetailView nebo appClass=ListView.

admin
boolean

[Viditelné jen pro administrátora]

confirm
boolean

[Vyžadovat potvrzení před spuštěním]

openType
string
Enum: "OPEN_TAB" "OPEN_WINDOW"

[Způsob otevření url odkazu] Dostupné jen pro type=OPEN_URL.

  • OPEN_TAB V nové záložce
  • OPEN_WINDOW V novém okně
openTypeWindowWidth
integer

[Šířka nově otevřeného okna] Dostupné jen pro kombinaci type=OPEN_URL a openType=OPEN_WINDOW.

openTypeWindowHeight
integer

[Výška nově otevřeného okna] Dostupné jen pro kombinaci type=OPEN_URL a openType=OPEN_WINDOW.

openTypeWindowRefresh
boolean

[Obnovit data po zavření okna] Dostupné jen pro kombinaci type=OPEN_URL, openType=OPEN_WINDOW a appClass=DetailView nebo appClass=ListView.

Responses

Request samples

Content type
application/json
{
  • "entityName": "Company",
  • "appClass": "DetailView",
  • "name": "RAYNET",
  • "type": "OPEN_URL",
  • "openType": "OPEN_WINDOW",
  • "openTypeWindowWidth": 500,
  • "openTypeWindowHeight": 200
}

Response samples

Content type
application/json
{
  • "success": true
}

Externí identifikátor

V rámci identifikace záznamu je možné využít externí identifikátor, který lze uložit ke konkrétnímu záznamu. Na základě tohoto identifikátoru lze následně záznam dohledat (zavolat API pro detail tohoto záznamu). Každý záznam může mít až 10 externích identifikátorů.

Identifikátor by měl mít prefix určující jeho původ (respektive systém, ze kterého pochází). Toto je vhodné při integraci více systémů, tak aby byly identifikátory jednoznačné. Externí identifikátor tak může mít například podobu erp:123455.

Externí identifikátor lze zapsat pomocí přímo určeného API k již existujícímu záznamu (viz. níže) nebo jej lze poslat zároveň při vytváření záznamu. Např. při vytvoření klienta je možné zapsat externí identifikátor takto:

curl -X PUT 'api/v2/company'

{
  "name": "RAYNET s.r.o.",
  "rating": "A",
  "state": "A_POTENTIAL",
  "role": "B_PARTNER",
  "extId": "erp:123455"
} 

Detail daného záznamu je možné následně získat pomocí URL: /api/v2/{entityName}/ext/{extId}/ (https://app.raynet.cz/api/v2/company/ext/erp:123456/)

přidání externího identifikátoru

Přidání externího identifikátoru ke konkrétnímu záznamu.

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

entita, ke které má být externí identifikátor přiřazen (podporované hodnoty jsou: company, person, lead, businessCase, offer, salesOrder, project, product, priceList, invoiceLight, task, meeting, event, email, letter, phoneCall, massEmail, businessCasePhase, companyAddress, gdprTemplate, gdpr, userAccount, notification a všechny entity ze sekce Číselníky).

entityId
required
integer <int64>
Example: 123

ID záznamu

Request Body schema: application/json
extId
required
string

Externí identifikátor

Responses

Request samples

Content type
application/json
{
  • "extId": "erp:123456789"
}

Response samples

Content type
application/json
{
  • "success": "true"
}

odstranění externího identifikátoru

Odstranění externího identifikátoru od konkrétního záznamu.

Authorizations:
(basicAuthinstanceName)
path Parameters
entityName
required
string
Example: company

entita, od které má být externí identifikátor odebrán (podporované hodnoty jsou: company, person, lead, businessCase, offer, salesOrder, project, product, priceList, invoiceLight, task, meeting, event, email, letter, phoneCall, massEmail, businessCasePhase, companyAddress, gdprTemplate, gdpr, userAccount, notification a všechny entity ze sekce Číselníky).

entityId
required
integer <int64>
Example: 123

ID záznamu

extId
required
integer <int64>
Example: erp:123456789

externí identifikátor, který má být u záznamu uveden

Responses

Response samples

Content type
application/json
{
  • "success": "true"
}

Uživatelé

API pro práci s uživateli.

seznam uživatelů

Získání seznamu uživatelů. Tento seznam může být filtrován, řazen a stránkován za použítí níže uvedených parametrů.

Authorizations:
(basicAuthinstanceName)
query Parameters
offset
integer <int64>

Od kterého indexu se budou záznamy zobrzovat (0 = od začátku).

limit
integer <int64>
Example: limit=100

Počet vrácených záznamů, maximální počet je 1000.

sortColumn
string
Enum: "username" "userRole"
Example: sortColumn=username
sortDirection
string
Enum: "ASC" "DESC"
Example: sortDirection=ASC
fulltext
string
Example: fulltext=myText

Fulltextové vyhledání v seznamu. Operátor se v tomto případě nepoužívá.

userRole
string
Enum: "ADMIN" "FULL_THROTTLE" "CERTAIN_RESTRICTIONS" "READONLY"
Example: userRole=ADMIN

Filtrování uživatelů podle role uživatele. Lze využít operátoru EQ, NE.

username
string
Example: username=info@raynet.cz

Filtrování uživatelů podle uživatelského jména. Lze využít operátoru EQ, NE, LIKE, LIKE_NOCASE

rowInfo.createdAt
string
Example: rowInfo.createdAt=2022-06-01 10:00

Filtrování uživatelů podle data vytvoření. Lze využít operátoru GT, GE, LT, LE

rowInfo.updatedAt
string
Example: rowInfo.updatedAt=2022-06-01 10:00

Filtrování uživatelů podle posledního data upravení. Lze využít operátoru GT, GE, LT, LE

rowInfo.lastModifiedAt
string
Example: rowInfo.lastModifiedAt=2022-06-01 10:00

Filtrování uživatelů podle posledního data modifikace (vytvoření nebo upravení). Lze využít operátoru GT, GE, LT, LE. Vhodné pro periodickou detekci změn.

view
string
Example: view=rowInfo

Pokud je hodnota rovna rowInfo, jsou vráceny pouze stavové informace o záznamu (data vytvoření, upravení, verze, ...). Vhodné pro periodickou detekci změn.

id
integer <int64>
Example: id=1

Filtrování podle ID. Lze využít operátoru EQ, NE, IN, GT, GE, LT, LE

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "totalCount": 1,
  • "data": [
    ]
}

detail uživatele

Získání detailu uživatelského účtu.

Authorizations:
(basicAuthinstanceName)
path Parameters
userAccountId
required
integer <int64>
Example: 123

ID uživatele

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

přidání bezpečností úrovně uživatele

Uživateli bude přidána bezpečnostní úroveň. Tu je možné přidat pouze uživateli, který není administrátor.

Authorizations:
(basicAuthinstanceName)
path Parameters
userAccountId
required
integer <int64>
Example: 123

ID uživatele

securityLevelId
required
integer <int64>
Example: 123

ID bezpečnostní úrovně

Responses

Response samples

Content type
application/json
{
  • "success": "true"
}

odebrání bezpečností úrovně uživatele

Uživateli bude odebrána bezpečnostní úroveň. Tu je možné odebrat pouze uživateli, který není administrátor.

Authorizations:
(basicAuthinstanceName)
path Parameters
userAccountId
required
integer <int64>
Example: 123

ID uživatele

securityLevelId
required
integer <int64>
Example: 123

ID bezpečnostní úrovně

Responses

Response samples

Content type
application/json
{
  • "success": "true"
}

Webhook

Webhook je nástroj pro zasílání notifikací o změnách ve vašem CRM do externího systému skrz protokol HTTP. Notifikace jsou odesílány jako požadavky typu POST na zvolené URL adresy.

Konfiguraci provedete v nastavení RAYNET CRM v sekci Webhook. Můžete nastavit více URL pro zasílání požadavků a ke každé navíc určit:

  • typy událostí se mají odesílat,

  • bezpečnostní kód, který bude s každým požadavkem odeslán v hlavičce X-RAYNETCRM-Token.

Součástí konfigurace je také technický kontakt, což je sada emailů, na které bude v případě problémů odeslán e-mail. Bude zaslán v těchto případech:

  • Vaše URL více než 1 den nepřijímá notifikace (server je nedostupný nebo vrací jiný HTTP kód než 2xx).

  • Vaše URL již opět přijmá požadavky, pokud nastal bod 1.

  • Vaše URL nepřijímá požadavky více než 7 dní. Webhook bude deaktivován a odstraněn z nastavení.

Interně se odchozí notifikace ze CRM řadí do fronty. V případě, že cílové URL dostupné, jsou zasílány opakovaně. Při odstávce externího systému tedy o žádné události nepříjdete.

Ve výchozím stavu je rychlost odesílání omezena na 1 událost/s na každé konfigurované URL. Současně je omezena maximální doba zpracování webhooku (connectTimeout - 10s, socketTimeout - 60s). Po spojení se čeká maximálně 10s na odpověď.

podporované události

record.created

Událost je zaslána po vytvoření nového záznamu. Součástí dat je typ záznamu a jeho id. Součástí je i externí ID, pokud je u záznamu definováno.

{
   "eventId": "62497f2c609d4b7184b9adf1e427fa55",
   "createdAt": "2017-01-18T13:16:39.923+01:00",
   "type": "record.created",
   "author": "admin@raynet.cz",
   "source": {
      "name": "user",
      "description": "browser"
   },
   "data": {
      "entityName": "Company",
      "entityId": 123,
      "extIds": [
          "1111"
      ]
   }
}

record.updated

Událost je zaslána po změně záznamu.

{
   "eventId": "d3ba342896d94dd5a4ee72d998e1e7c4",
   "createdAt": "2017-01-19T14:02:31.123+01:00",
   "type": "record.updated",
   "author": "admin@raynet.cz",
   "source": {
      "name": "user",
      "description": "browser"
   },
   "data": {
      "entityName": "Company",
      "entityId": 2,
      "extIds": null
   }
}

record.deleted

Událost je zaslána po odstranění záznamu.

{
   "eventId": "22b1d9c792814537b574e053642f2ce6",
   "createdAt": "2017-02-02T11:45:00.873+01:00",
   "type": "record.deleted",
   "author": "admin@raynet.cz",
   "source": {
      "name": "user",
      "description": "browser"
   },
   "data": {
      "entityName": "Company",
      "entityId": 2,
      "extIds": null
   }
}

zdroj události

Součástí události je klíč source identifikující zdroj akce, která událost vyvolala. Možné hodnoty vnořeného atributu name jsou:

  • user: událost je důsledkem uživatelské akce. Pole description je pak buď browser (CRM v prohlížeči) nebo mobile (mobilní aplikace).

  • api: událost byla vygenerována na základě API požadavku. Pokud bylo použito přihlášení API klíčem, description obsahuje název API klíče.

  • Ostatní události jsou označeny jako system.

seznam webhooků

Získání seznamu webhooků

Authorizations:
(basicAuthinstanceName)

Responses

Response samples

Content type
application/json
{
  • "success": "true",
  • "data": {
    }
}

nový webhook

Založení nového webhooku.

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
url
required
string

[Url] Adresa pro zaslání webhooku (http nebo https).

secretToken
string

[Bezpečnostní token] Token bude zaslán spolu s požadavkem v HTTP hlavičce X-RAYNETCRM-Token.

events
required
Array of strings non-empty
Items Enum: "record.created" "record.updated" "record.deleted"

[Události] Typy událostí, které webhook bude zpracovávat (tzn. record.created, record.updated nebo record.deleted).

entityFilter
Array of strings >= 0 items
Items Enum: "Company," "Person," "Lead" "BusinessCase" "SalesOrder" "Offer" "Project" "Product" "PriceList" "Invoice" "Task" "Email" "Meeting," "Letter," "PhoneCall," "MassEmail," "Event"

[Entity] Entity, které webhook bude zpracovávat. Pokud zůstane prázdné, budou se zpracovávat všechny entity.

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "entityFilter": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

upravení technického kontaktu

Upravení emailů pro technický kontakt, který bude notifikován v případě obtíží (viz. výše).

Authorizations:
(basicAuthinstanceName)
Request Body schema: application/json
technicalContacts
required
Array of strings <email> >= 0 items

[Technický kontakt] Emaily na technický kontakt.

Responses

Request samples

Content type
application/json
{
  • "technicalContacts": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

smazání webhooku

Authorizations:
(basicAuthinstanceName)
path Parameters
uuid
required
integer <int64>
Example: 532d339c0a874f68ae8f2cc108c7f7b2

UUID webhooku

Responses

Response samples

Content type
application/json
{
  • "success": true
}