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/'
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:
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
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 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ě
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
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
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."
}
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í.
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.
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených klientů je |
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 |
lastName | string Example: lastName=RAY Filtrování klientů podle příjmení fyzické osoby. Lze využít operátoru |
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 |
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 |
economyActivity | integer <int64> Example: economyActivity=1 Filtrování klientů podle ID oboru (EconomyActivity). Lze využít operátoru |
companyClassification1 | integer <int64> Example: companyClassification1=1 Filtrování klientů podle ID klasifikace 1 (CompanyClassification1). Lze využít operátoru |
companyClassification2 | integer <int64> Example: companyClassification2=1 Filtrování klientů podle ID klasifikace 2 (CompanyClassification2). Lze využít operátoru |
companyClassification3 | integer <int64> Example: companyClassification3=1 Filtrování klientů podle ID klasifikace 3 (CompanyClassification3). Lze využít operátoru |
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 |
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 |
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 |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování klientů podle posledního data upravení. Lze využít operátoru |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných klientů. Lze využít operátoru |
gdprTemplate | string Filtrování klientů podle právního titulu. Lze použít jen operátor |
withoutGdpr | string Filtrování klientů, kteří nemají platný právní titul. Lze využít jen operátor |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "name": "Test s.r.o.",
- "titleBefore": null,
- "firstName": null,
- "lastName": null,
- "titleAfter": null,
- "person": false,
- "role": "B_PARTNER",
- "state": "B_ACTUAL",
- "rating": "A",
- "owner": {
- "id": 1,
- "fullName": "RAYNET CRM"
}, - "regNumber": "123456789",
- "taxNumber": "CZ123456789",
- "taxNumber2": null,
- "taxPayer": "YES",
- "bankAccount": null,
- "databox": null,
- "court": null,
- "primaryAddress": {
- "id": 2,
- "primary": true,
- "contactAddress": false,
- "address": {
- "id": 2,
- "city": "Ostrava-Slezská Ostrava",
- "country": "Česká republika",
- "name": "Sídlo klienta",
- "province": "Moravskoslezský kraj",
- "street": "Těšínská",
- "zipCode": "710 00",
- "lat": 49.2499446,
- "lng": 13.703011
}, - "territory": {
- "id": 91,
- "value": "Morava"
}, - "contactInfo": {
- "email": "test@test.cz",
- "email2": "test2@test.cz",
- "primary": true,
- "tel1": "123 456 789",
- "tel1Type": "mobil",
- "tel2": "987 654 321",
- "tel2Type": "pevná linka",
- "www": "www.test.cz",
- "otherContact": null
}, - "extIds": null
}, - "contactAddress": {
- "id": 3,
- "primary": false,
- "contactAddress": true,
- "address": {
- "id": 3,
- "city": "Ostrava-Moravská Ostrava",
- "country": "Česká republika",
- "name": "Provozovna",
- "province": "Moravskoslezský kraj",
- "street": "Českobratrská 113",
- "zipCode": "702 00",
- "lat": null,
- "lng": null
}, - "territory": {
- "id": 91,
- "value": "Morava"
}, - "contactInfo": {
- "email": "provozovna@test.cz",
- "email2": null,
- "primary": true,
- "tel1": "444 444 444",
- "tel1Type": "mobil",
- "tel2": "111 111 111",
- "tel2Type": "pevná linka",
- "www": null,
- "otherContact": null
}, - "extIds": null
}, - "category": {
- "id": 15,
- "value": "Zákazník"
}, - "turnover": {
- "id": 82,
- "value": "do 1 mil. Kč"
}, - "economyActivity": {
- "id": 92,
- "value": "obor 1"
}, - "companyClassification1": {
- "id": 93,
- "value": "kla 1"
}, - "companyClassification2": {
- "id": 94,
- "value": "kla 2"
}, - "companyClassification3": {
- "id": 95,
- "value": "kla 3"
}, - "paymentTerm": {
- "id": 64,
- "value": "7 dní"
}, - "contactSource": {
- "id": 62,
- "value": "e-mail"
}, - "birthday": null,
- "notice": "poznamka ke klientovi",
- "tags": [
- "stitek1",
- "stitek 2"
], - "customFields": null,
- "rowInfo.createdAt": "2022-06-18 13:19",
- "rowInfo.createdBy": "demo@raynet.cz",
- "rowInfo.updatedAt": "2022-09-22 14:17",
- "rowInfo.updatedBy": "demo@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
], - "_version": 16
}
]
}
Založení nového klienta s adresami
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 |
{- "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": [
- {
- "address": {
- "name": "Sídlo klienta",
- "street": "Francouzská 6167/5",
- "city": "Ostrava",
- "province": "Morava",
- "zipCode": "708 00",
- "country": "CZ",
- "lat": 49.827486,
- "lng": 18.186497
}, - "contactInfo": {
- "email": "info@raynet.cz",
- "email2": "",
- "fax": "",
- "otherContact": "",
- "tel1": "+420 553 401 520",
- "tel1Type": "recepce",
- "tel2": "+420 553 401 547",
- "tel2Type": "zákaznická podpora",
- "www": "www.raynet.cz",
- "doNotSendMM": false
}, - "territory": 12
}
], - "tags": [
- "tag 1",
- "tag 2"
], - "customFields": {
- "Spoluprace_2aa2c": "2022-01-01"
}
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
companyId required | integer <int64> Example: 123 ID klienta |
{- "success": "true",
- "data": {
- "id": 2,
- "name": "Test s.r.o.",
- "person": false,
- "firstName": null,
- "lastName": null,
- "titleBefore": null,
- "titleAfter": null,
- "salutation": null,
- "owner": {
- "id": 1,
- "fullName": "RAYNET CRM"
}, - "rating": "A",
- "state": "B_ACTUAL",
- "role": "B_PARTNER",
- "notice": "poznamka ke klientovi",
- "category": {
- "id": 15,
- "value": "Zákazník"
}, - "contactSource": {
- "id": 62,
- "value": "e-mail"
}, - "employeesNumber": {
- "id": 64,
- "value": "1 - 10"
}, - "legalForm": {
- "id": 64,
- "value": "s.r.o."
}, - "paymentTerm": {
- "id": 64,
- "value": "7 dní"
}, - "turnover": {
- "id": 82,
- "value": "do 1 mil. Kč"
}, - "economyActivity": {
- "id": 92,
- "value": "obor 1"
}, - "companyClassification1": {
- "id": 93,
- "value": "kla 1"
}, - "companyClassification2": {
- "id": 94,
- "value": "kla 2"
}, - "companyClassification3": {
- "id": 95,
- "value": "kla 3"
}, - "regNumber": "123456789",
- "taxNumber": "CZ123456789",
- "taxNumber2": null,
- "taxPayer": "YES",
- "bankAccount": "123456/1111",
- "databox": null,
- "court": null,
- "birthday": null,
- "primaryAddress": {
- "id": 2,
- "primary": true,
- "contactAddress": false,
- "address": {
- "id": 2,
- "city": "Ostrava-Slezská Ostrava",
- "country": "Česká republika",
- "name": "Sídlo klienta",
- "province": "Moravskoslezský kraj",
- "street": "Těšínská",
- "zipCode": "710 00",
- "lat": null,
- "lng": null
}, - "territory": {
- "id": 91,
- "value": "Morava"
}, - "contactInfo": {
- "email": "test@test.cz",
- "email2": "test2@test.cz",
- "primary": true,
- "tel1": "123 456 789",
- "tel1Type": "mobil",
- "tel2": "987 654 321",
- "tel2Type": "pevná linka",
- "www": "www.test.cz",
- "otherContact": null
}, - "extIds": null
}, - "tags": [
- "stitek1",
- "stitek 2"
], - "logo": {
- "id": 428,
- "contentType": "image/png",
- "fileName": "logo.png",
- "size": 17485
}, - "socialNetworkContact": {
- "facebook": "abcd",
- "googleplus": null,
- "twitter": null,
- "linkedin": null,
- "pinterest": null,
- "instagram": null,
- "skype": null,
- "youtube": null
}, - "customFields": {
- "Cislo_klie_cd702": "AB123",
- "Lonsky_zis_7aac1": 500,
- "Spoluprace_2aa2c": "2022-02-02"
}, - "rowInfo.createdAt": "2022-06-18 13:19",
- "rowInfo.createdBy": "demo@raynet.cz",
- "rowInfo.updatedAt": "2022-01-23 09:50",
- "rowInfo.updatedBy": "demo@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "_version": 14,
- "attachments": [
- {
- "id": 213,
- "link": null,
- "linkName": null,
- "file": {
- "id": 631,
- "contentType": "application/zip",
- "fileName": "test_zip.zip",
- "size": 4413
}, - "folder": "Test",
- "folderId": 6
}
], - "addresses": [
- {
- "id": 2,
- "primary": true,
- "contactAddress": false,
- "address": {
- "id": 2,
- "city": "Ostrava-Slezská Ostrava",
- "country": "Česká republika",
- "name": "Sídlo klienta",
- "province": "Moravskoslezský kraj",
- "street": "Těšínská",
- "zipCode": "710 00",
- "lat": null,
- "lng": null
}, - "territory": {
- "id": 91,
- "value": "Morava"
}, - "contactInfo": {
- "email": "test@test.cz",
- "email2": "test2@test.cz",
- "primary": true,
- "tel1": "123 456 789",
- "tel1Type": "mobil",
- "tel2": "987 654 321",
- "tel2Type": "pevná linka",
- "www": "www.test.cz",
- "otherContact": null
}, - "extIds": null
}, - {
- "id": 3,
- "primary": false,
- "contactAddress": true,
- "address": {
- "id": 3,
- "city": "Ostrava-Moravská Ostrava",
- "country": "Česká republika",
- "name": "Provozovna",
- "province": "Moravskoslezský kraj",
- "street": "Českobratrská 113",
- "zipCode": "702 00",
- "lat": null,
- "lng": null
}, - "territory": {
- "id": 91,
- "value": "Morava"
}, - "contactInfo": {
- "email": "provozovna@test.cz",
- "email2": null,
- "primary": true,
- "tel1": "444 444 444",
- "tel1Type": "mobil",
- "tel2": "111 111 111",
- "tel2Type": "pevná linka",
- "www": null,
- "otherContact": null
}, - "extIds": null
}
], - "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
], - "originLead": {
- "id": 4,
- "code": "L-18-002",
- "topic": "Můj lead"
}
}
}
Upravení dat klienta
companyId required | integer <int64> Example: 123 ID klienta |
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 |
{- "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": {
- "Lonsky_zis_7aac1": 666
}
}
Přidání nové adresy ke klientovi s identifikátorem companyId
. Adresa je zařazena mezi ostatní adresy (tzn. není primární).
companyId required | integer <int64> Example: 123 ID klienta |
object | |
object | |
territory | integer <int64> [Obchodní teritorium] ID záznamu z číselníku Territory |
{- "address": {
- "name": "Sídlo klienta",
- "street": "Francouzská 6167/5",
- "city": "Ostrava",
- "province": "Morava",
- "zipCode": "708 00",
- "country": "CZ",
- "lat": null,
- "lng": null
}, - "contactInfo": {
- "email": "info@raynet.cz",
- "email2": "",
- "fax": "",
- "otherContact": "",
- "tel1": "+420 553 401 520",
- "tel1Type": "recepce",
- "tel2": "+420 553 401 547",
- "tel2Type": "zákaznická podpora",
- "www": "www.raynet.cz",
- "doNotSendMM": false
}, - "territory": 12
}
{- "success": true,
- "data": {
- "id": 5
}
}
U klienta s identifikátorem companyId
bude upravena adresa s identifikátorem addressId
.
companyId required | integer <int64> Example: 123 ID klienta |
addressId required | integer <int64> Example: 123 ID adresy |
object | |
object | |
territory | integer <int64> [Obchodní teritorium] ID záznamu z číselníku Territory |
{- "address": {
- "name": "Sídlo klienta",
- "street": "Francouzská 6167/5",
- "city": "Ostrava",
- "province": "Morava",
- "zipCode": "708 00",
- "country": "CZ",
- "lat": null,
- "lng": null
}, - "contactInfo": {
- "email": "info@raynet.cz",
- "email2": "",
- "fax": "",
- "otherContact": "",
- "tel1": "+420 553 401 520",
- "tel1Type": "recepce",
- "tel2": "+420 553 401 547",
- "tel2Type": "zákaznická podpora",
- "www": "www.raynet.cz",
- "doNotSendMM": false
}, - "territory": 12
}
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).
companyId required | integer <int64> Example: 123 ID klienta |
addressId required | integer <int64> Example: 123 ID 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.
companyId required | integer <int64> Example: 123 ID klienta |
addressId required | integer <int64> Example: 123 ID 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.
companyId required | integer <int64> Example: 123 ID klienta |
addressId required | integer <int64> Example: 123 ID adresy |
Získání vazeb na jiné klienty.
https://app.raynet.cz/api/v2/company/1/relationship/
companyId required | integer <int64> Example: 123 ID klienta |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 1,
- "notice": null,
- "companyJoin": {
- "id": 1,
- "name": "RAYNET s.r.o.",
- "role": "C_SUPPLIER",
- "state": "A_POTENTIAL",
- "regNumber": "26843820",
- "rating": "A",
- "primaryAddress": {
- "id": 1,
- "primary": null,
- "address": {
- "id": 1,
- "city": "Ostrava-Poruba",
- "country": "Česká republika",
- "countryCode": "CZ",
- "name": null,
- "province": null,
- "street": null,
- "zipCode": null,
- "lat": null,
- "lng": null
}, - "contactInfo": {
- "primary": null,
- "email": "info@raynet.cz",
- "email2": null,
- "tel1": "+420 553 401 520",
- "tel1Type": null,
- "tel2": null,
- "tel2Type": null,
- "fax": null,
- "www": null,
- "otherContact": null,
- "doNotSendMM": false
}, - "territory": {
- "id": 90,
- "value": "aaaaaa"
}
}
}, - "companyJoinType": "parent"
}
]
}
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").
companyId required | integer <int64> Example: 123 ID klienta |
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] |
{- "companyJoin": 5,
- "companyJoinType": "parent",
- "notice": "Zařazení v rámci holdingu"
}
{- "success": true,
- "data": {
- "id": 5
}
}
U existujícího propojení je možné měnit už jenom poznámku.
companyId required | integer <int64> Example: 123 ID klienta |
relationshipId required | integer <int64> Example: 123 ID vztahu s jiným klientem |
notice | string [Poznámka] |
{- "notice": "Zařazení v rámci holdingu"
}
U zadaného klienta bude smazána vazba na jiného klienta. Pokud k odstraňované vazbě existuje vazba inverzní, bude rovněž smazána.
companyId required | integer <int64> Example: 123 ID klienta |
relationshipId required | integer <int64> Example: 123 ID vazby s klientem |
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.
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 |
https://app.raynet.cz/api/v2/person/?offset=0&limit=1&firstName[LIKE]=Jan%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených kontaktních osob je |
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 |
lastName | string Example: lastName=Novak Filtrování kontaktních osob podle příjmení. Lze využít operátoru |
category | integer <int64> Example: category=1 Filtrování kontaktních osob podle ID kategorie (PersonCategory). Lze využít operátoru |
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 |
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 |
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 |
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 |
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 |
userAccount-id | integer <int64> Example: userAccount-id=3 Filtrování kontaktních osob podle ID uživatele. Lze využít operátoru |
contactInfo.email | string Example: contactInfo.email=test@test.cz Filtrování kontaktních osob podle primárního emailu. Lze využít operátoru |
contactInfo.email2 | string Example: contactInfo.email2=test@test.cz Filtrování kontaktních osob podle sekundárního emailu. Lze využít operátoru |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných kontaktních osob. Lze využít operátoru |
gdprTemplate | integer Filtrování kontaktních osob podle právního titulu. Lze použít jen operátor |
withoutGdpr | string Filtrování kontaktních osob, kteřé nemají platný právní titul. Lze využít jen operátor |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 2,
- "data": [
- {
- "id": 3,
- "titleBefore": "Ing.",
- "firstName": "Petr",
- "lastName": "Chytrý",
- "titleAfter": "CSc.",
- "primaryRelationship": {
- "id": 1,
- "type": "konzultant",
- "company": {
- "id": 1,
- "name": "RAYNET s.r.o."
}
}, - "owner": {
- "id": 2,
- "fullName": "test test"
}, - "contactInfo": {
- "email": "podpora@raynet.cz",
- "email2": "test@raynet.cz",
- "tel1": "+420 553 401 547",
- "tel1Type": "mobil",
- "tel2": null,
- "tel2Type": null,
- "www": null,
- "otherContact": null
}, - "privateAddress": {
- "city": "Ostrava",
- "country": "Česká republika",
- "countryCode": "CZ",
- "province": null,
- "street": "Ocelářská 177",
- "zipCode": "703 00"
}, - "category": {
- "id": 96,
- "value": "kat 1"
}, - "personClassification1": {
- "id": 97,
- "value": "kla 1"
}, - "personClassification2": {
- "id": 98,
- "value": "kla 2"
}, - "personClassification3": {
- "id": 99,
- "value": "kla 3"
}, - "salutation": "pan",
- "birthday": "2022-06-10",
- "language": {
- "id": 70,
- "value": "Český"
}, - "maritalStatus": {
- "id": 78,
- "value": "Svobodný/Svobodná"
}, - "gender": "FEMALE",
- "companyAddress": {
- "address": {
- "id": 1,
- "city": "Ostrava-Poruba",
- "country": "Česká republika",
- "countryCode": "CZ",
- "province": null,
- "street": "Francouzská 6167/5",
- "zipCode": "708 00"
}, - "territory": null
}, - "customFields": null,
- "rowInfo.createdAt": "2022-06-18 13:19",
- "rowInfo.createdBy": "demo@raynet.cz",
- "rowInfo.updatedAt": "2022-09-06 09:43",
- "rowInfo.updatedBy": "demo@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "notice": "poznámka",
- "activeUserAccount": true,
- "keyman": false,
- "tags": [ ],
- "_version": 19,
- "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
]
}
]
}
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 |
{- "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": {
- "email": "podpora@raynet.cz",
- "email2": "13123@4123.cz",
- "tel1": "+420 553 401 547",
- "tel1Type": "mobil",
- "tel2": "13213",
- "tel2Type": "mobil",
- "www": "www.w.cz",
- "fax": "+ 420 321 987 377",
- "otherContact": "další informace",
- "doNotSendMM": false
}, - "privateAddress": {
- "city": "Ostrava-Poruba",
- "country": "Česká republika",
- "province": "Moravskoslezský kraj",
- "street": "Francouzská 5",
- "zipCode": "708 00"
}, - "notice": "poznamka",
- "relationship": {
- "company": 1,
- "companyAddress": 1,
- "notice": "Podpora pro zákazníky",
- "type": "podpora"
}, - "tags": [
- "tag 1",
- "tag 2"
], - "keyman": false
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
personId required | integer <int64> Example: 123 ID kontaktní osoby |
{- "success": "true",
- "data": {
- "id": 3,
- "titleBefore": "Ing.",
- "firstName": "Marie",
- "lastName": "Vyležíková",
- "titleAfter": "Phd.",
- "owner": {
- "id": 2,
- "fullName": "test test"
}, - "category": {
- "id": 96,
- "value": "kat 1"
}, - "primaryRelationship": {
- "id": 1,
- "type": "oddělení podpory",
- "company": {
- "id": 2,
- "name": "RAYNET s.r.o."
}
}, - "personClassification1": {
- "id": 97,
- "value": "kla 1"
}, - "personClassification2": {
- "id": 98,
- "value": "kla 2"
}, - "personClassification3": {
- "id": 99,
- "value": "kla 3"
}, - "salutation": "paní",
- "birthday": "2022-06-10",
- "language": {
- "id": 70,
- "value": "čeština"
}, - "maritalStatus": {
- "id": 78,
- "value": "Svobodná/Svobodný"
}, - "gender": "FEMALE",
- "contactInfo": {
- "email": "podpora@raynet.cz",
- "email2": "13123@4123.cz",
- "tel1": "+420 553 401 547",
- "tel1Type": "mobil",
- "tel2": "13213",
- "tel2Type": "mobil",
- "www": "www.w.cz",
- "fax": "+ 420 321 987 377",
- "otherContact": "další kontakt",
- "doNotSendMM": false
}, - "socialNetworkContact": {
- "facebook": "vylezikovaface",
- "googleplus": null,
- "twitter": null,
- "linkedin": null,
- "pinterest": null,
- "instagram": null,
- "skype": null,
- "youtube": null
}, - "privateAddress": {
- "city": "Ostrava-Poruba",
- "country": "Česká republika",
- "countryCode": "CZ",
- "province": "Moravskoslezský kraj",
- "street": "Francouzská 5",
- "zipCode": "708 00"
}, - "customFields": {
- "VIP_b91d1": true
}, - "rowInfo.createdAt": "2022-06-18 13:19",
- "rowInfo.updatedAt": "2022-09-06 09:43",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "notice": "poznamka",
- "photo": {
- "id": 428,
- "contentType": "image/png",
- "fileName": "photo.png",
- "size": 17485
}, - "activeUserAccount": true,
- "tags": [
- "stitek 1",
- "stitek 2"
], - "_version": 19,
- "attachments": [
- {
- "id": 235,
- "linkName": "seznam",
- "file": null,
- "folder": null,
- "folderId": null
}
], - "relationships": [
- {
- "id": 1,
- "company": {
- "id": 1,
- "name": "RAYNET s.r.o."
}, - "companyAddress": {
- "id": 1,
- "name": "Sídlo klienta"
}, - "notice": null,
- "primary": true,
- "type": "péče o zákazníky"
}
], - "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
], - "keyman": false,
- "originLead": {
- "id": 4,
- "code": "L-18-002",
- "topic": "Můj lead"
}
}
}
Upravení dat kontaktní osoby
personId required | integer <int64> Example: 123 ID kontaktní osoby |
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 |
{- "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": {
- "email": "podpora@raynet.cz",
- "email2": "13123@4123.cz",
- "tel1": "+420 553 401 547",
- "tel1Type": "mobil",
- "tel2": "13213",
- "tel2Type": "mobil",
- "www": "www.w.cz",
- "fax": "+ 420 321 987 377",
- "otherContact": "další informace",
- "doNotSendMM": false
}, - "socialNetworkContact": {
- "facebook": "vylezikovaface"
}, - "privateAddress": {
- "city": "Ostrava-Poruba",
- "country": "Česká republika",
- "province": "Moravskoslezský kraj",
- "street": "Francouzská 5",
- "zipCode": "708 00"
}, - "notice": "poznamka",
- "customFields": {
- "VIP_b91d1": false
}, - "keyman": false
}
Přidání nového vztahu kontaktní osoby s identifikátorem personId
ke klientovi. Vztah bude zařazen mezi vedlejší vztahy.
personId required | integer <int64> Example: 123 ID kontaktní osoby |
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] |
{- "company": 1,
- "companyAddress": 1,
- "notice": "Podpora pro zákazníky",
- "type": "podpora"
}
{- "success": true,
- "data": {
- "id": 5
}
}
personId required | integer <int64> Example: 123 ID kontaktní osoby |
relationshipId required | integer <int64> Example: 123 ID vztahu s klientem |
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] |
{- "company": 1,
- "companyAddress": 1,
- "notice": "Podpora pro zákazníky",
- "type": "podpora"
}
U kontaktní osoby s identifikátorem personId
bude smazán vztah ke klientovi s identifikátorem relationshipId
.
personId required | integer <int64> Example: 123 ID kontaktní osoby |
relationshipId required | integer <int64> Example: 123 ID 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.
personId required | integer <int64> Example: 123 ID kontaktní osoby |
relationshipId required | integer <int64> Example: 123 ID vztahu s klientem |
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.
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 |
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených leadů je |
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 |
companyName | string Example: companyName=RAY Filtrování leadů podle jména klienta. Lze využít operátoru |
lastName | string Example: lastName=Novak Filtrování leadů podle příjmení. Lze využít operátoru |
contactInfo.email | string Example: contactInfo.email=novak@raynet.cz Filtrování leadů podle emailu. Lze využít operátoru |
contactInfo.email2 | string Example: contactInfo.email2=novak@raynet.cz Filtrování leadů podle druhého emailu. Lze využít operátoru |
regNumber | string Example: regNumber=1234567 Filtrování leadů podle IČ. Lze využít operátoru |
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 |
status | string Enum: "B_ACTIVE" "G_STORNO" "D_DONE" Example: status=D_DONE Filtrování OP podle skupiny stavu. Lze využít operátoru
|
leadPhase | integer <int64> Example: leadPhase=21 Filtrování leadů podle stavu (LeadPhase). Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování leadů podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování leadů podle posledního data upravení. Lze využít operátoru |
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 |
gdprTemplate | integer <int64> Filtrování leadů podle právního titulu. Lze použít jen operátor |
withoutGdpr | integer <int64> Filtrování leadů, kteří nemají platný právní titul. Lze využít jen operátor |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 165,
- "data": [
- {
- "id": 172,
- "code": "Z-16-00011",
- "leadDate": "2022-08-15",
- "topic": "Zájemce o zeleninu",
- "leadPhase": {
- "id": 105,
- "code01": "V řešení",
- "color": "c14d00",
- "status": "B_ACTIVE",
- "locked": false
}, - "owner": {
- "id": 63,
- "fullName": "Pan Tau"
}, - "priority": "CRITICAL",
- "company": {
- "id": 1093,
- "name": "Králíček"
}, - "person": {
- "id": 16255,
- "fullName": "Pan Ušák"
}, - "businessCase": {
- "id": 8824,
- "code": "OP-21-809",
- "name": "Zájemce o zeleninu"
}, - "companyName": "Králíček",
- "lastName": "Ušák",
- "convertDate": null,
- "contactSource": {
- "id": 815,
- "value": "web A - našli nás na internetu"
}, - "category": null,
- "firstName": "Pan",
- "contactInfo": {
- "email": "kralicek@mrkev.cz",
- "email2": "test@mrkev.cz",
- "tel1": "123456789",
- "tel1Type": "mobil",
- "tel2": null,
- "tel2Type": null,
- "www": null,
- "fax": null,
- "otherContact": null,
- "doNotSendMM": false
}, - "address": {
- "city": "Velká Lhota",
- "countryName": "Česká republika",
- "countryCode": "CZ",
- "street": "Hlavní ulice",
- "province": "Jihomoravký kraj",
- "zipCode": "123 00",
- "lat": null,
- "lng": null
}, - "socialNetworkContact": {
- "facebook": null,
- "googleplus": null,
- "twitter": null,
- "linkedin": null,
- "pinterest": null,
- "instagram": null,
- "skype": null,
- "youtube": null
}, - "customFields": null,
- "rowInfo.createdAt": "2022-08-15 13:49",
- "rowInfo.createdBy": "cervenka@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 6,
- "tags": [ ],
- "notice": "<p>Králiček by rád mrkev</p>",
- "regNumber": null,
- "leadPerson": false,
- "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
]
}
]
}
Založení nového leadu. S volitelnou možností zaslat notifikaci o vytvoření leadu na vybrané emailové adresy (vhodné pro webové formuláře).
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 |
{- "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": {
- "email": "metece@nepotece.cz",
- "email2": "test@nepotece.cz",
- "tel1": "+420 800 123 123 ",
- "tel1Type": "Mobil",
- "tel2": "+420 123 456 789",
- "tel2Type": "Pevná linka",
- "www": "nepotece.cz",
- "fax": "+420 123 123 123",
- "otherContact": "Pobočka XY",
- "doNotSendMM": false
}, - "address": {
- "street": "Hlavní ulice",
- "city": "Velká Lhota",
- "province": "Jihomoravký kraj",
- "zipCode": "123 00",
- "country": "CZ",
- "lat": null,
- "lng": null
}, - "socialNetworkContact": {
- "facebook": "kapkafb",
- "googleplus": "kapkagp",
- "twitter": "kapkatw",
- "linkedin": "kapkali",
- "pinterest": "kapkapi",
- "instagram": "kapkain",
- "skype": "kapkask",
- "youtube": "kapkayo"
}, - "customFields": {
- "VIP_b91d1": false
}, - "tags": "aaa,bbb",
- "notificationMessage": "Poptávka z webového formuláře",
- "notificationEmailAddresses": [
- "email@raynet.cz",
- "email2@raynet.cz"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
leadId required | integer <int64> Example: 123 ID lead |
{- "success": "true",
- "data": {
- "id": 8,
- "code": "code",
- "leadDate": "2022-08-26",
- "topic": "Objednávka",
- "leadPhase": {
- "id": 105,
- "code01": "V řešení",
- "color": "c14d00",
- "status": "B_ACTIVE",
- "locked": false
}, - "owner": {
- "id": 1,
- "fullName": "RAYNET CRM"
}, - "priority": "CRITICAL",
- "companyName": "Neteče a nepoteče s.r.o",
- "company": {
- "id": 1093,
- "name": "Neteče a nepoteče s.r.o"
}, - "person": null,
- "businessCase": null,
- "lastName": "Kapka",
- "convertDate": null,
- "contactSource": {
- "id": 61,
- "value": "e-mail"
}, - "category": {
- "id": 91,
- "value": "asd"
}, - "firstName": "Jan",
- "titleBefore": "Ing.",
- "titleAfter": "Ph.D.",
- "territory": {
- "id": 129,
- "value": "Morava"
}, - "contactInfo": {
- "email": "netece@nepotece.cz",
- "email2": "test@nepotece.cz",
- "tel1": "+420 800 123 123 ",
- "tel1Type": "Mobil",
- "tel2": "+420 123 456 789",
- "tel2Type": "Pevná linka",
- "fax": null,
- "www": null,
- "otherContact": null,
- "doNotSendMM": false
}, - "address": {
- "city": "Velká Lhota",
- "countryName": "Česká republika",
- "countryCode": "CZ",
- "street": "Hlavní ulice",
- "province": "Jihomoravký kraj",
- "zipCode": "123 00",
- "lat": null,
- "lng": null
}, - "socialNetworkContact": {
- "facebook": "kapkafb",
- "googleplus": "kapkagp",
- "twitter": "kapkatw",
- "linkedin": "kapkali",
- "pinterest": "kapkapi",
- "instagram": "kapkain",
- "skype": "kapkask",
- "youtube": "kapkayo"
}, - "customFields": null,
- "rowInfo.createdAt": "2022-08-26 17:14",
- "rowInfo.createdBy": "seifert@raynet.cz",
- "rowInfo.updatedAt": "2022-08-26 17:15",
- "rowInfo.updatedBy": "seifert@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": "LOCK",
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "tags": [ ],
- "notice": "notice",
- "regNumber": "regNumber",
- "leadPerson": false,
- "_version": 6,
- "attachments": [ ],
- "inlineGdpr": [
- {
- "id": 1,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "legalTitle": "LEGITIMATE_INTEREST",
- "templateName": "Opravněný zájem",
- "gdprTemplate": 1
}
]
}
}
Upravení dat leadu
leadId required | integer <int64> Example: 123 ID leadu |
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 |
{- "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": {
- "email": "netece@nepotece.cz",
- "email2": "test@nepotece.cz",
- "tel1": "+420 800 123 123 ",
- "tel1Type": "Mobil",
- "tel2": "+420 123 456 789",
- "tel2Type": "Pevná linka",
- "www": "nepotece.cz",
- "fax": "+420 123 123 123",
- "otherContact": "Pobočka XY",
- "doNotSendMM": false
}, - "address": {
- "street": "Hlavní ulice",
- "city": "Velká Lhota",
- "province": "Jihomoravký kraj",
- "zipCode": "123 00",
- "country": "CZ",
- "lat": null,
- "lng": null
}, - "socialNetworkContact": {
- "facebook": "kapkafb",
- "googleplus": "kapkagp",
- "twitter": "kapkatw",
- "linkedin": "kapkali",
- "pinterest": "kapkapi",
- "instagram": "kapkain",
- "skype": "kapkask",
- "youtube": "kapkayo"
}, - "customFields": {
- "VIP_b91d1": false
}, - "tags": "aaa,bbb"
}
{- "success": true
}
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.
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 |
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
name | string Example: name=RAY Filtrování OP podle jména. Lze využít operátoru |
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 |
validTill | string Example: validTill=2022-06-01 Filtrování OP podle data uzavření. Lze využít operátoru |
scheduledEnd | string Example: scheduledEnd=2022-06-01 Filtrování OP podle data odhad uzavření. Lze využít operátoru |
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
|
businessCasePhase | integer <int64> Example: businessCasePhase=21 Filtrování OP podle stavu (BusinessCasePhase). Lze využít operátoru |
businessCaseType | integer <int64> Example: businessCaseType=21 Filtrování OP podle typu obchodního případu (BusinessCaseType). Lze využít operátoru |
containsProduct | integer <int64> Example: containsProduct=21 Filtrování OP podle produktu. Pokud OP obsahuje zvolený produkt, bude zobrazen. Je nutné použít operátor |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování OP podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování OP podle posledního data upravení. Lze využít operátoru |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných OP. Lze využít operátoru |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 414,
- "code": "OP-15-0001",
- "name": "První obchodní případ",
- "company": {
- "id": 1093,
- "name": "Klient 1"
}, - "person": null,
- "phaseChanges": [
- {
- "phaseId": 186,
- "changes": [
- {
- "authorId": 34,
- "phaseEnd": null,
- "phaseStart": "2023-04-18 13:16"
}
]
}
], - "owner": {
- "id": 11,
- "fullName": "Ludmila Nováková"
}, - "currency": {
- "id": 15,
- "value": "Kč"
}, - "validFrom": "2022-01-19",
- "validTill": "2022-01-21",
- "scheduledEnd": null,
- "totalAmount": 3797.01,
- "tradingProfit": 3797.01,
- "estimatedValue": 1000,
- "status": "E_WIN",
- "probability": 100,
- "exchangeRate": 1,
- "businessCasePhase": {
- "id": 45,
- "value": "Výhra"
}, - "businessCaseType": null,
- "category": {
- "id": 96,
- "value": "Obchod morava"
}, - "project": null,
- "source": null,
- "businessCaseClassification1": null,
- "businessCaseClassification2": null,
- "businessCaseClassification3": null,
- "losingReason": null,
- "losingCategory": null,
- "rowInfo.createdAt": "2022-09-18 10:59",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-09-18 10:59",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": null,
- "tags": [ ]
}
]
}
Založení nového obchodního případu.
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 |
{- "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
}
{- "success": true,
- "data": {
- "id": 5
}
}
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").
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 |
{- "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": [
- {
- "productCode": "002",
- "name": "Muj produjt 002",
- "count": 7
}, - {
- "productCode": "003",
- "name": "Muj produkt 003",
- "priceList": 2,
- "count": 5
}, - {
- "productCode": "004",
- "name": "Chladící kapalina",
- "price": 250,
- "unit": "litr",
- "taxRate": 21,
- "count": 3
}
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
businessCaseId required | integer <int64> Example: 123 ID obchodního případu |
{- "success": "true",
- "data": {
- "id": 11,
- "code": "OP-15-008",
- "name": "obchodni pripad",
- "company": {
- "id": 1,
- "name": "RAYNET s.r.o."
}, - "person": {
- "id": 3,
- "fullName": "Jan Novák"
}, - "owner": {
- "id": 3,
- "fullName": "Marie Vyležíková"
}, - "currency": {
- "id": 17,
- "value": "$"
}, - "phaseChanges": [
- {
- "phaseId": 186,
- "changes": [
- {
- "authorId": 34,
- "phaseEnd": null,
- "phaseStart": "2023-04-18 13:16"
}
]
}
], - "validFrom": "2022-10-02",
- "validTill": null,
- "scheduledEnd": null,
- "totalAmount": 122,
- "totalAmountWithTax": 122,
- "estimatedValue": 10,
- "tradingProfit": 111,
- "status": "B_ACTIVE",
- "probability": 80,
- "exchangeRate": 20,
- "businessCasePhase": {
- "id": 39,
- "value": "Identifikace příležitosti"
}, - "businessCaseType": null,
- "category": null,
- "project": null,
- "source": null,
- "businessCaseClassification1": {
- "id": 93,
- "value": "test"
}, - "businessCaseClassification2": null,
- "businessCaseClassification3": null,
- "losingReason": null,
- "losingCategory": null,
- "rowInfo.createdAt": "2022-10-02 13:17",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-10-02 13:27",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": "test",
- "tags": [ ],
- "attachments": [ ],
- "customFields": {
- "Popis_prio_c49d5": "Text text",
- "Priorita_O_a5fab": "TOP"
}, - "items": [
- {
- "id": 1,
- "priceListItem": null,
- "name": "Nekategorizovaný produkt",
- "description": null,
- "price": 122,
- "taxRate": 0,
- "taxRateName": "nulová",
- "unit": "ks",
- "discountPercent": 0,
- "count": 1
}
], - "signatures": [
- {
- "id": 1,
- "status": "Začínáme",
- "docVersion": 7,
- "signedBy": {
- "id": 9,
- "fullName": "Jan Novák"
}, - "description": {
- "totalAmount": 345,
- "estimatedValue": 0,
- "currency": "USD"
}
}
], - "originalLead": {
- "id": 4,
- "code": "L-18-002",
- "topic": "Můj lead"
}
}
}
Upravení dat obchodního případu
businessCaseId required | integer <int64> Example: 123 ID obchodniho pripadu |
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 |
{- "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": {
- "Popis_prio_c49d5": ""
}
}
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
businessCaseId required | integer <int64> Example: 123 ID obch. případu |
locale | string Example: locale=en Jazyk exportovaného obch. případu |
{- "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
- "fileName": "OP-17-001.pdf",
- "contentType": "application/octet-stream",
- "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
- "instanceName": "mojecrm"
}
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/
businessCaseId required | integer <int64> Example: 123 ID obchodního případu |
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] |
{- "productCode": "A001",
- "name": "Produkt",
- "priceList": 2,
- "count": 2,
- "price": 123,
- "taxRate": 21,
- "discountPercent": 10.5,
- "cost": 10,
- "description": "poznamka k produktu"
}
Upravení položky na OP
https://app.raynet.cz/api/v2/businessCase/1/item/2/
businessCaseId required | integer <int64> Example: 123 ID obchodní případy |
businessCaseItemId required | integer <int64> Example: 123 ID položky obchodního případu |
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] |
{- "name": "produkt 1",
- "price": 123,
- "taxRate": 21,
- "count": 2,
- "discountPercent": 10.5,
- "cost": 10,
- "unit": "ks",
- "description": "poznamka k produktu"
}
Smazání položky na OP
https://app.raynet.cz/api/v2/businessCase/1/item/2/
businessCaseId required | integer <int64> Example: 123 ID obchodní případy |
businessCaseItemId required | integer <int64> Example: 123 ID položky obchodního případu |
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ů.
businessCaseId required | integer <int64> Example: 123 ID obchodního případu |
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
company | integer <int64> Example: company=3 Filtrování participantů OP podle jednoznačného identifikátoru klienta (id). Lze využít operátoru |
company-name required | string Filtrování participantů OP podle názvu klienta. Lze využít operátoru |
person | integer <int64> Example: person=3 Filtrování participantů OP podle jednoznačného identifikátoru kontaktní osoby (id). Lze využít operátoru |
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 |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "company": {
- "id": 2,
- "name": "a"
}, - "person": {
- "id": 5,
- "fullName": "Magdaléna Pišlová"
}, - "businessCase": {
- "id": 4,
- "code": "OP-17-001"
}, - "note": "poznamka",
- "category": {
- "id": 289,
- "value": "projektant(ka)"
}, - "rowInfo.createdAt": "2022-09-29 13:46",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "_version": 0
}
]
}
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.
businessCaseId required | integer <int64> Example: 123 ID obchodního případu |
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] |
{- "company": 1,
- "category": 123,
- "note": "Poznámka k participantovi"
}
{- "success": true,
- "data": {
- "id": 5
}
}
U obchodního případu s identifikátorem businessCaseId
bude smazán participant s identifikátorem participantId
.
businessCaseId required | integer <int64> Example: 123 ID obchodního případu |
participantId required | integer <int64> Example: 321 ID participanta |
Výpis historie změn stavů obchodního případu.
businessCaseId required | integer <int64> Example: 123 ID obch. případu |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "date": "2022-05-16 14:22",
- "oldBusinessCasePhase": {
- "id": 187,
- "status": "B_ACTIVE",
- "code01": "Inicializační jednání",
- "color": "E9802F",
- "phaseSequence": 3,
- "phaseTotal": 7,
- "businessCaseTypeId": 303,
- "businessCaseTypeName": "Prodej"
}, - "newBusinessCasePhase": {
- "id": 192,
- "status": "E_WIN",
- "code01": "Výhra",
- "color": null,
- "phaseSequence": null,
- "phaseTotal": null,
- "businessCaseTypeId": null,
- "businessCaseTypeName": null
}, - "owner": {
- "id": 89,
- "fullNameWithoutTitles": "Dušan Gálik"
}
}
]
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
name | string Example: name=RAY Filtrování nabídek podle jména. Lze využít operátoru |
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 |
validFrom | string Example: validFrom=2022-06-01 Filtrování nabídek podle data otevření. Lze využít operátoru |
validTill | string Example: validTill=2022-06-01 Filtrování nabídek podle data otevření. Lze využít operátoru |
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
|
offerStatus | integer <int64> Example: offerStatus=21 Filtrování nabídek podle stavu (OfferStatus). Lze využít operátoru |
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 |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování nabídek podle data vytvoření. Lze využít operátoru |
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 |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných nabídek. Lze využít operátoru |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 115,
- "sync": false,
- "code": "NAB-17-001",
- "name": "První nabídka",
- "company": {
- "id": 1093,
- "name": "Klient 1"
}, - "person": null,
- "businessCase": {
- "id": 4,
- "code": "OP-17-001"
}, - "owner": {
- "id": 11,
- "fullName": "Ludmila Nováková"
}, - "currency": {
- "id": 15,
- "value": "Kč"
}, - "validFrom": "2022-01-19",
- "validTill": "2022-01-21",
- "expirationDate": "2022-08-21",
- "totalAmount": 3797.01,
- "estimatedValue": 0,
- "status": "B_ACTIVE",
- "offerStatus": {
- "id": 45,
- "value": "Příprava"
}, - "category": {
- "id": 96,
- "value": "Obchod morava"
}, - "rowInfo.createdAt": "2022-09-18 10:59",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-09-18 10:59",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": "text",
- "tags": [
- "Štítek 1"
]
}
]
}
Založení nové nabídky
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. |
{- "name": "test",
- "company": 1,
- "businessCase": 1,
- "owner": 3,
- "totalAmount": 123.5,
- "estimatedValue": 11,
- "validFrom": "2022-11-08",
- "description": "test",
- "offerStatus": 35
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
offerId required | integer <int64> Example: 123 ID nabídky |
{- "success": "true",
- "data": {
- "id": 115,
- "sync": false,
- "code": "NAB-17-001",
- "name": "První nabídka",
- "company": {
- "id": 1093,
- "name": "Klient 1"
}, - "person": null,
- "businessCase": {
- "id": 4,
- "code": "OP-17-001"
}, - "owner": {
- "id": 11,
- "fullName": "Ludmila Nováková"
}, - "currency": {
- "id": 15,
- "value": "Kč"
}, - "exchangeRate": 1,
- "validFrom": "2022-01-19",
- "validTill": "2022-01-21",
- "expirationDate": "2022-08-21",
- "totalAmount": 3797.01,
- "estimatedValue": 0,
- "status": "B_ACTIVE",
- "offerStatus": {
- "id": 45,
- "value": "Příprava"
}, - "category": {
- "id": 96,
- "value": "Obchod morava"
}, - "rowInfo.createdAt": "2022-09-18 10:59",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-09-18 10:59",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": "text",
- "tags": [
- "Štítek 1"
], - "attachments": [ ],
- "customFields": {
- "Popis_prio_c49d5": "Text text",
- "Priorita_O_a5fab": "TOP"
}, - "items": [
- {
- "id": 1,
- "priceListItem": null,
- "name": "Nekategorizovaný produkt",
- "description": null,
- "price": 122,
- "taxRate": 0,
- "taxRateName": "nulová",
- "unit": "ks",
- "discountPercent": 0,
- "count": 1
}
], - "signatures": [
- {
- "id": 1,
- "status": "Zamítnuta",
- "docVersion": 7,
- "signedBy": {
- "id": 9,
- "fullName": "Jan Novák"
}, - "description": {
- "totalAmount": 345,
- "estimatedValue": 0,
- "currency": "USD"
}
}
]
}
}
Upravení dat nabídky.
offerId required | integer <int64> Example: 123 ID nabídky |
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 |
{- "name": "test",
- "company": 1,
- "businessCase": 1,
- "owner": 3,
- "totalAmount": 123.5,
- "estimatedValue": 11,
- "validFrom": "2022-11-08",
- "description": "test",
- "customFields": {
- "Popis_prio_c49d5": ""
}
}
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
offerId required | integer <int64> Example: 123 ID nabídky |
locale | string Example: locale=en Jazyk exportované nabídky |
{- "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
- "fileName": "NAB-17-001.pdf",
- "contentType": "application/octet-stream",
- "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
- "instanceName": "mojecrm"
}
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/
offerId required | integer <int64> Example: 123 ID nabídky |
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] |
{- "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 na nabídce.
https://app.raynet.cz/api/v2/offer/1/item/2/
offerId required | integer <int64> Example: 123 ID nabídky |
offerItemId required | integer <int64> Example: 123 ID položky nabídky |
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] |
{- "name": "produkt 1",
- "price": 123,
- "taxRate": 21,
- "count": 2,
- "discountPercent": 10.5,
- "cost": 10,
- "unit": "ks",
- "description": "poznamka k nabidce"
}
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.
offerId required | integer <int64> Example: 123 ID nabídky |
{- "message": "TranslatedApplicationException",
- "translatedMessage": "Nelze synchronizovat, protože obchodní případ je evidován v jiné měně."
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
name | string Example: name=RAY Filtrování projektu podle jména. Lze využít operátoru |
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 |
validTill | string Example: validTill=2022-06-01 Filtrování projektu podle data uzavření. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování projektu podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování projektu podle posledního data upravení. Lze využít operátoru |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných projektů. Lze využít operátoru |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 8,
- "code": "PRO-18-003",
- "name": "Testovací projekt",
- "company": {
- "id": 4,
- "name": "Extra company a.s."
}, - "person": {
- "id": 9,
- "fullName": "Ing. Milan Buldog"
}, - "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "category": {
- "id": 128,
- "value": "Výroba"
}, - "totalAmount": 340,
- "tradingProfit": 0,
- "estimatedValue": 0,
- "avgValue.totalAmount": 340,
- "avgValue.tradingProfit": 0,
- "avgValue.estimatedValue": 0,
- "minValue.totalAmount": 340,
- "minValue.tradingProfit": 0,
- "minValue.estimatedValue": 0,
- "maxValue.totalAmount": 340,
- "maxValue.tradingProfit": 0,
- "maxValue.estimatedValue": 0,
- "status": "D_DONE",
- "projectStatus": {
- "id": 60,
- "value": "Hotovo"
}, - "validFrom": "2022-02-21",
- "validTill": "2022-04-17",
- "scheduledEnd": "2022-04-29",
- "customFields": null,
- "rowInfo.createdAt": "2022-04-17 14:47",
- "rowInfo.createdBy": "svetr@raynet.cz",
- "rowInfo.updatedAt": "2022-04-18 16:03",
- "rowInfo.updatedBy": "svetr@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": "Poznámka",
- "tags": [
- "Štítek1"
], - "_version": 5
}
]
}
Založení nového projektu
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 |
{- "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": [
- "Štítek1",
- "Štítek2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
projectId required | integer <int64> Example: 123 ID projektu |
{- "success": "true",
- "data": {
- "id": 7,
- "code": "PRO-18-002",
- "name": "Testovací projekt",
- "company": {
- "id": 4,
- "name": "Extra company a.s."
}, - "person": {
- "id": 9,
- "fullName": "Ing. Milan Buldog"
}, - "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "category": {
- "id": 128,
- "value": "Výroba"
}, - "totalAmount": 34798,
- "tradingProfit": 22734,
- "estimatedValue": 12064,
- "avgValue.totalAmount": 34798,
- "avgValue.tradingProfit": 22734,
- "avgValue.estimatedValue": 12064,
- "minValue.totalAmount": 34798,
- "minValue.tradingProfit": 22734,
- "minValue.estimatedValue": 12064,
- "maxValue.totalAmount": 34798,
- "maxValue.tradingProfit": 22734,
- "maxValue.estimatedValue": 12064,
- "status": "B_ACTIVE",
- "projectStatus": {
- "id": 59,
- "value": "Aktivní (v běhu)"
}, - "validFrom": "2022-02-20",
- "validTill": null,
- "scheduledEnd": "2022-04-28",
- "customFields": null,
- "rowInfo.createdAt": "2022-02-20 09:09",
- "rowInfo.createdBy": "svetr@raynet.cz",
- "rowInfo.updatedAt": "2022-04-19 09:02",
- "rowInfo.updatedBy": "svetr@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "description": "Poznámka",
- "tags": [ ],
- "attachments": [
- {
- "id": 1,
- "link": null,
- "linkName": null,
- "file": {
- "id": 12,
- "contentType": "image/jpeg",
- "fileName": "header04.jpg",
- "size": 426507
}, - "folder": null,
- "folderId": null
}
], - "businessCases": [
- {
- "id": 8,
- "code": "OP-18-005",
- "company": {
- "id": 4,
- "name": "Extra company a.s."
}, - "person": null,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "currency": {
- "id": 19,
- "value": "Kč"
}, - "validFrom": "2022-04-05",
- "validTill": null,
- "scheduledEnd": null,
- "totalAmount": 34798,
- "tradingProfit": 22734,
- "estimatedValue": 12064,
- "status": "B_ACTIVE",
- "probability": 20,
- "businessCasePhase": {
- "id": 43,
- "value": "Začínáme"
}
}
], - "signatures": [
- {
- "id": 1,
- "status": "Aktivní (v běhu)",
- "docVersion": 7,
- "signedBy": {
- "id": 9,
- "fullName": "Jan Novák"
}, - "description": {
- "totalAmount": 0,
- "estimatedValue": 500,
- "minTotalAmount": 0,
- "avgTotalAmount": 0,
- "avgEstimatedValue": 500,
- "maxEstimatedValue": 500,
- "maxTotalAmount": 0,
- "minEstimatedValue": 500,
- "currency": "Kč"
}
}
], - "_version": 6
}
}
Upravení dat projektu
projectId required | integer <int64> Example: 123 ID projektu |
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 |
{- "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á"
}
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%
projectId required | integer <int64> Example: 123 ID projektu |
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 |
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 |
company | string Example: company=3 Filtrování participantů projektu podle jednoznačného identifikátoru klienta (id). Lze využít operátoru |
company-name | string Example: company-name=RAY Filtrování participantů projektu podle názvu klienta. Lze využít operátoru |
person | string Example: person=3 Filtrování participantů projektu podle jednoznačného identifikátoru kontaktní osoby (id). Lze využít operátoru |
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 |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "company": {
- "id": 2,
- "name": "a"
}, - "person": {
- "id": 5,
- "fullName": "Magdaléna Pišlová"
}, - "project": {
- "id": 4,
- "code": "PRO-17-001"
}, - "note": "poznamka",
- "category": {
- "id": 123,
- "value": "projektant(ka)"
}, - "rowInfo.createdAt": "2022-09-29 13:46",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "_version": 0
}
]
}
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.
projectId required | integer <int64> Example: 123 ID projektu |
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] |
{- "company": 1,
- "category": 123,
- "note": "Poznámka k participantovi"
}
{- "success": true,
- "data": {
- "id": 5
}
}
U projektu s identifikátorem projectId
bude smazán participant s identifikátorem participantId
.
projectId required | integer <int64> Example: 123 ID projektu |
participantId required | integer <int64> Example: 321 ID participanta |
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených cenníků je |
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 |
primary | string Example: primary=YES Filtrování ceníků podle příznaku, zda je ceník výchozí. Lze využít operátoru |
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 |
validTill | string Example: validTill=2022-06-01 Filtrování ceníků podle data platnosti. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování ceníků podle data vytvoření. Lze využít operátoru |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "category": null,
- "code": "Cen-001",
- "currency": {
- "id": 16,
- "value": "€"
}, - "description": null,
- "name": "Optimistický ceník pana ředitele",
- "primary": false,
- "validFrom": "2022-02-03",
- "validTill": null,
- "owner": {
- "id": 2,
- "fullName": "Igor Hnízdo"
}, - "rowInfo.createdAt": "2022-02-03 10:02",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}
}
]
}
Založení nového ceníku
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] |
{- "name": "Ceník ABC",
- "code": "CEN-002",
- "owner": 3,
- "currency": 17,
- "category": 13,
- "validFrom": "2022-11-08",
- "validTill": "2022-11-08",
- "description": "Text text"
}
{- "success": true,
- "data": {
- "id": 5
}
}
Získání detailu ceníku.
https://app.raynet.cz/api/v2/priceList/1/
priceListId required | integer <int64> Example: 123 ID ceníku |
{- "success": "true",
- "data": {
- "id": 3,
- "category": {
- "id": 103,
- "value": "Ohoo"
}, - "code": "CEN-002",
- "currency": {
- "id": 17,
- "value": "$"
}, - "description": "Text text",
- "name": "Ceník ABC",
- "primary": false,
- "validFrom": "2022-11-08",
- "validTill": "2022-11-08",
- "owner": {
- "id": 2,
- "fullName": "Igor Hnízdo"
}, - "rowInfo.createdAt": "2022-02-03 11:32",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": "2022-02-03 11:41",
- "rowInfo.updatedBy": "admin@klient.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "items": [
- {
- "id": 2,
- "product": {
- "id": 1,
- "code": "007",
- "name": "Pohovka rohová"
}, - "price": 420.1344,
- "rowInfo.createdAt": "2022-02-03 11:41",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
]
}
}
Upravení dat ceníku
priceListId required | integer <int64> Example: 123 ID ceníku |
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] |
{- "name": "Ceník ABC",
- "code": "CEN-002",
- "owner": 3,
- "currency": 17,
- "category": 13,
- "validFrom": "2022-11-08",
- "validTill": "2022-11-08",
- "description": "Text text"
}
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.
priceListId required | integer <int64> Example: 123 ID ceníku |
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 |
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 |
product-code | string Example: product-code=KONV Filtrování položek ceníku podle kódu produktu. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování podle posledního data upravení. Lze využít operátoru |
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 |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 134,
- "product": {
- "id": 57,
- "code": "KONV",
- "name": "Konvalinka"
}, - "name": "Konvalinka",
- "price": 52.381,
- "cost": 4.7619,
- "unit": "ks",
- "taxRate": 21,
- "description": null,
- "rowInfo.createdAt": "2022-06-08 21:41",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": "2022-03-20 14:35",
- "rowInfo.updatedBy": "admin@klient.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
]
}
Přidání položek na ceník
https://app.raynet.cz/api/v2/priceList/1/item/
priceListId required | integer <int64> Example: 123 ID ceníku |
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] |
{- "price": 400,
- "product": 1,
- "description": "Lorem ipsum...",
- "unit": "ks",
- "cost": 100,
- "taxRate": 21
}
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/
priceListId required | integer <int64> Example: 123 ID ceníku |
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] |
[- {
- "price": 400,
- "product": 1,
- "description": "Lorem ipsum...",
- "unit": "ks",
- "cost": 100,
- "taxRate": 21
}
]
{- "success": true,
- "data": [
- {
- "product": "1",
- "priceListItem": 12,
- "success": true,
- "message": "inserted"
}
]
}
Upravení položky na ceníku
priceListId required | integer <int64> Example: 123 ID ceníku |
priceListItemId required | integer <int64> Example: 123 ID položky ceníku |
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] |
{- "price": 400,
- "product": 1,
- "description": "Lorem ipsum...",
- "unit": "ks",
- "cost": 100,
- "taxRate": 21
}
https://app.raynet.cz/api/v2/product/?offset=0&limit=1&name[LIKE]=Jan%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených produktů je |
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 |
unit | string Example: unit=ks Filtrování prodktů podle jednotky. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování prodktů podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování prodktů podle posledního data upravení. Lze využít operátoru |
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 |
rowInfo.rowAccess | string Example: rowInfo.rowAccess=INVALID Filtrování zneplatněných produktů. Lze využít operátoru |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 13,
- "data": [
- {
- "id": 1,
- "code": "Produkt-001",
- "name": "Název produktu",
- "description": null,
- "taxRate": 21,
- "category": null,
- "primaryPriceListItem": {
- "id": 1,
- "price": 500,
- "priceList": {
- "id": 1,
- "currency": "CZK"
}
}, - "productLine": {
- "id": 355,
- "value": "Pruktová řada 10"
}, - "unit": null,
- "cost": 0,
- "validFrom": "2022-11-03",
- "validTill": null,
- "rowInfo.createdAt": "2022-11-03 11:28",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": "2022-05-14 11:59",
- "rowInfo.updatedBy": "admin@klient.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "tags": [ ]
}
]
}
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 |
{- "code": "007",
- "name": "produkt 007",
- "unit": "ks",
- "description": "popis produktu",
- "taxRate": 21,
- "category": 791,
- "productLine": 206,
- "cost": 1000,
- "price": 1500,
- "tags": [
- "tag 1",
- "tag 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
productId required | integer <int64> Example: 123 ID produktu |
{- "success": "true",
- "data": {
- "id": 75,
- "code": "007",
- "name": "produkt 007",
- "description": "popis produktu",
- "taxRate": 21,
- "category": {
- "id": 791,
- "value": "Náklady"
}, - "primaryPriceListItem": {
- "id": 249,
- "price": 1500,
- "priceList": {
- "id": 1,
- "currency": "CZK"
}
}, - "productLine": {
- "id": 206,
- "value": "fabie I"
}, - "unit": "ks",
- "cost": 1000,
- "validFrom": "2022-04-01",
- "validTill": null,
- "rowInfo.createdAt": "2022-01-01 13:07",
- "rowInfo.createdBy": "admin@klient.cz",
- "rowInfo.updatedAt": "2022-01-01 13:07",
- "rowInfo.updatedBy": "admin@klient.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "tags": [
- "tag 1",
- "tag 2"
], - "photo": null,
- "_version": 1,
- "attachments": [ ],
- "customFields": {
- "Vaha_(g)_80307": 10
}
}
}
Upravení dat produktu
productId required | integer <int64> Example: 123 ID produktu |
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 |
{- "code": "007",
- "name": "produkt 007",
- "unit": "ks",
- "description": "popis produktu",
- "taxRate": 21,
- "category": 791,
- "productLine": 206,
- "cost": 1000,
- "price": 1500,
- "tags": [
- "tag 1",
- "tag 2"
], - "customFields": {
- "Vaha_(g)_80307": 25
}
}
Uzamčení záznamu aktivity pro editaci.
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 |
Odemčení záznamu aktivity k editaci.
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 |
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených událostí je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování aktivit podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování aktivit podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování aktivit podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování aktivit podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování aktivit podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování aktivit podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování aktivit podle posledního data upravení. Lze využít operátoru |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování aktivit podle ID. Lze využít operátoru |
{- "message": "Unsupported filter column ..."
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených úkolů je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování úkolů podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování úkolů podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování úkolů podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování úkolů podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování úkolů podle statusu. Lze využít operátoru |
deadline | string Example: deadline=2022-05-03 Filtrování úkolů podle data deadline. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování úkolů podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování úkolů podle posledního data upravení. Lze využít operátoru |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování úkolů podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Neřešitelný úkol",
- "personal": false,
- "status": "SCHEDULED",
- "priority": "DEFAULT",
- "category": {
- "id": 94,
- "value": "Dohodnuto napevno"
}, - "activity": {
- "id": 1,
- "title": "První schůzka"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": {
- "id": 8,
- "name": "Igor Hnízdo"
}, - "lead": null,
- "project": null,
- "businessCase": {
- "id": 4,
- "code": "OP-18-001",
- "name": "Prodej kladiv Datel"
}, - "offer": null,
- "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": null,
- "description": "<p>Poznámka</p>",
- "solution": "<p>Řešení</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": {
- "Vip_37674": "VIP"
}, - "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": null,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
]
}
Založení nového úkolu
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
taskId required | integer <int64> Example: 123 ID úkolu |
{- "success": "true",
- "data": {
- "id": 89,
- "title": "Navázat kontakt s klientem",
- "category": {
- "id": 90,
- "value": "Lékař"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": {
- "id": 3,
- "fullName": "Pavel Dobrý"
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "deadline": "2022-06-11 15:03",
- "completed": null,
- "description": "Je potřeba být laskavý!",
- "solution": "Nakonec to dopadlo dobře.",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat úkolu
taskId required | integer <int64> Example: 123 ID úkolu |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených schůzek je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování schůzek podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování schůzek podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování schůzek podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování schůzek podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování schůzek podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování schůzek podle data vytvoření. Lze využít operátoru |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování schůzek podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Schůzka u kafe",
- "personal": false,
- "status": "SCHEDULED",
- "priority": "DEFAULT",
- "category": {
- "id": 94,
- "value": "Dohodnuto napevno"
}, - "activity": null,
- "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": null,
- "lead": null,
- "project": null,
- "businessCase": {
- "id": 4,
- "code": "OP-18-001",
- "name": "Prodej kladiv Datel"
}, - "offer": {
- "id": 3,
- "code": "NAB-18-001",
- "name": "Nabídka na prodej kladiv Datel"
}, - "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": null,
- "description": "<p>Poznámka</p>",
- "solution": "<p>Zápis ze schůzky</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": {
- "Vip_37674": "VIP"
}, - "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Albert Veselý",
- "person": 8,
- "company": null,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}, - "meetingPlace": "Kavárna",
- "companyAddress": {
- "city": "Olomouc",
- "country": "Česká republika",
- "province": null,
- "street": "Vídeňská 1026",
- "zipCode": "779 00"
}
}
]
}
Založení nové schůzky
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
meetingId required | integer <int64> Example: 123 ID schůzky |
{- "success": "true",
- "data": {
- "id": 81,
- "title": "Schůzka u kávy",
- "category": {
- "id": 90,
- "value": "Lékař"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "completed": null,
- "description": "Otázky k projednání.",
- "solution": "Výsledek jednání.",
- "meetingPlace": "Kavárna",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null
}, - {
- "id": 120,
- "owner": false,
- "role": null,
- "name": "První lead",
- "person": null,
- "company": null,
- "lead": 18
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat schůzky
meetingId required | integer <int64> Example: 123 ID schůzky |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "person": 4
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených událostí je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování událostí podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování událostí podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování událostí podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování událostí podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování událostí podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování událostí podle data vytvoření. Lze využít operátoru |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování událostí podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Seminář ke zdravému spánku",
- "personal": true,
- "status": "COMPLETED",
- "priority": "DEFAULT",
- "category": {
- "id": 95,
- "value": "Zdravý duch"
}, - "activity": null,
- "company": {
- "id": 2,
- "name": "Dobrý spánek s.r.o."
}, - "person": null,
- "lead": null,
- "project": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": "2022-02-20 10:00",
- "description": "<p>Poznámka</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": null,
- "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}, - "meetingPlace": "Impact Hub Ostrava",
- "companyAddress": {
- "city": "Ostrava",
- "country": "Česká republika",
- "province": null,
- "street": "Sokolská tř. 1263/24",
- "zipCode": "702 00"
}
}
]
}
Založení nové události
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
eventId required | integer <int64> Example: 123 ID události |
{- "success": "true",
- "data": {
- "id": 81,
- "title": "Výročí založení klienta",
- "category": {
- "id": 89,
- "value": "Firemní"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "completed": null,
- "description": "Oslavíme ve čtvrtek nebo v pátek?",
- "meetingPlace": "Impact Hub Ostrava",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null
}, - {
- "id": 120,
- "owner": false,
- "role": null,
- "name": "První lead",
- "person": null,
- "company": null,
- "lead": 18
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat události
eventId required | integer <int64> Example: 123 ID události |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "person": 4
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených emailů je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování emailů podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování emailů podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování emailů podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování emailů podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování emailů podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování emailů podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování emailů podle posledního data upravení. Lze využít operátoru |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování e-mailů podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Dlouhý e-mail s nabídkou",
- "personal": false,
- "status": "SCHEDULED",
- "priority": "DEFAULT",
- "category": {
- "id": 94,
- "value": "Dohodnuto napevno"
}, - "activity": null,
- "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": null,
- "lead": null,
- "project": null,
- "businessCase": {
- "id": 4,
- "code": "OP-18-001",
- "name": "Prodej kladiv Datel"
}, - "offer": {
- "id": 3,
- "code": "NAB-18-001",
- "name": "Nabídka na prodej kladiv Datel"
}, - "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": null,
- "description": "<p>Text e-mailu</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": {
- "Vip_37674": "VIP"
}, - "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Klient s.r.o.",
- "person": null,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
]
}
Založení nového emailu
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
emailId required | integer <int64> Example: 123 ID emailu |
{- "success": "true",
- "data": {
- "id": 81,
- "title": "Poptávka na ceník",
- "category": {
- "id": 89,
- "value": "Firemní"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "completed": null,
- "description": "Dobrý den pane Kapre, potřebujeme ceník. Děkuji",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null,
- "email": "martin@vosa.cz"
}, - {
- "id": 120,
- "owner": false,
- "role": null,
- "name": "První lead",
- "person": null,
- "company": null,
- "lead": 18,
- "email": "prvni@lead.cz"
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null,
- "email": "petr@svetr.cz"
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat emailu
emailId required | integer <int64> Example: 123 ID emailu |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "person": 4
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených telefonátů je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování telefonátů podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování telefonátů podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování telefonátů podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování telefonátů podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování telefonátů podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování telefonátů podle data vytvoření. Lze využít operátoru |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování telefonátů podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Vtipný telefonát ohledně nabídky",
- "personal": false,
- "status": "SCHEDULED",
- "priority": "DEFAULT",
- "category": {
- "id": 94,
- "value": "Dohodnuto napevno"
}, - "activity": null,
- "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": null,
- "lead": null,
- "project": null,
- "businessCase": {
- "id": 4,
- "code": "OP-18-001",
- "name": "Prodej kladiv Datel"
}, - "offer": {
- "id": 3,
- "code": "NAB-18-001",
- "name": "Nabídka na prodej kladiv Datel"
}, - "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": null,
- "description": "<p>K projednání</p>",
- "solution": "<p>výsledek telefonátu</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": {
- "Vip_37674": "VIP"
}, - "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": null,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
]
}
Založení nového telefonátu
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
phoneCallId required | integer <int64> Example: 123 ID telefonátu |
{- "success": "true",
- "data": {
- "id": 81,
- "title": "Dotaz z call centra",
- "category": {
- "id": 89,
- "value": "Firemní"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "completed": null,
- "description": "Mají ještě kapra?",
- "solution": "Kapra mají.",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat telefonátu
phoneCallId required | integer <int64> Example: 123 ID telefonátu |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "person": 4
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených dopisů je |
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 |
scheduledFrom | string Example: scheduledFrom=2022-06-01 10:00 Filtrování dopisů podle data naplánování ("od"). Lze využít operátoru |
scheduledTill | string Example: scheduledTill=2022-06-01 10:00 Filtrování dopisů podle data naplánování ("do"). Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování dopisů podle data realizování. Lze využít operátoru |
category-id | integer <int64> Example: category-id=3 Filtrování dopisů podle ID kategorie. Lze využít operátoru |
status | string Example: status=SCHEDULED Filtrování dopisů podle statusu. Lze využít operátoru |
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 |
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 |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování dopisů podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování dopisů podle posledního data upravení. Lze využít operátoru |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování dopisů podle ID. Lze využít operátoru |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 12,
- "title": "Nabídka zaslaná poštou",
- "personal": false,
- "status": "SCHEDULED",
- "priority": "DEFAULT",
- "category": {
- "id": 94,
- "value": "Dohodnuto napevno"
}, - "activity": null,
- "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "person": null,
- "lead": null,
- "project": null,
- "businessCase": {
- "id": 4,
- "code": "OP-18-001",
- "name": "Prodej kladiv Datel"
}, - "offer": {
- "id": 3,
- "code": "NAB-18-001",
- "name": "Nabídka na prodej kladiv Datel"
}, - "salesOrder": null,
- "scheduledFrom": "2022-02-20 09:00",
- "scheduledTill": "2022-02-20 10:00",
- "completed": null,
- "description": "<p>K projednání</p>",
- "tags": [
- "Tag1",
- "Tag2"
], - "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 9,
- "customFields": {
- "Vip_37674": "VIP"
}, - "participants": [
- {
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": null,
- "lead": null
}, - {
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": null,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
]
}
Založení nového telefonátu
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 |
{- "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": [
- "stitek 1",
- "stitek 2"
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
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/
letterId required | integer <int64> Example: 123 ID dopisu |
{- "success": "true",
- "data": {
- "id": 81,
- "title": "Dopis příteli",
- "category": {
- "id": 89,
- "value": "Firemní"
}, - "priority": "DEFAULT",
- "status": "SCHEDULED",
- "personal": false,
- "owner": {
- "id": 2,
- "fullName": "Petr Svetr"
}, - "company": {
- "id": 2,
- "name": "Klient s.r.o."
}, - "lead": null,
- "businessCase": null,
- "offer": null,
- "salesOrder": null,
- "project": null,
- "activity": null,
- "scheduledFrom": "2022-06-11 15:00",
- "scheduledTill": "2022-06-11 16:00",
- "completed": null,
- "description": "Dobrý den příteli.",
- "tags": [ ],
- "rowInfo.createdAt": "2022-04-24 08:06",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-05-17 10:46",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "customFields": {
- "VIP_b91d1": false
}, - "participants": [
- {
- "id": 123,
- "owner": false,
- "role": null,
- "name": "Martin Vosa",
- "person": 6,
- "company": 2,
- "lead": null
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "name": "Petr Svetr",
- "person": 2,
- "company": 2,
- "lead": null
}
], - "recurrence": {
- "id": 5,
- "count": 3,
- "endDate": null,
- "interval": "WEEKLY",
- "recurrenceDay": 4,
- "startDate": "2022-03-05"
}
}
}
Upravení dat dopisu
letterId required | integer <int64> Example: 123 ID dopisu |
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 |
{- "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": {
- "VIP_b91d1": true
}, - "participants": [
- {
- "id": -123
}, - {
- "person": 4
}, - {
- "id": 119,
- "owner": true,
- "role": "FROM",
- "person": 8,
- "company": 2,
- "lead": null
}
]
}
{- "success": true
}
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.
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 |
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 |
tags | string Example: tags=VIP Filtrování hromadných emailů podle štítků. Lze využít operátoru |
completed | string Example: completed=2022-06-01 10:00 Filtrování hromadných emailů podle data odeslání. Lze využít operátoru |
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 |
source | string Enum: "QUANDA" "SMARTEMAILING" "MAILCHIMP" "MAILGUN" "SENDGRID" "SPARKPOST" Example: source=SPARKPOST Filtrování hromadných emailů podle zdroje. Lze využít operátoru |
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 |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
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 |
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 |
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 |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 9,
- "title": "První emailová kampaň",
- "completed": "2022-01-30 18:30",
- "description": "První testovací kampaň pro VIP členy organizace",
- "tags": [
- "VIP"
], - "campaignName": "První emailová kampaň SparkPost",
- "source": "SPARKPOST",
- "externalId": "656464564",
- "stats": {
- "sent": "900",
- "clicked": "600",
- "opened": "800",
- "unsubscribed": "500"
}, - "rowInfo.createdAt": "2022-01-29 13:30",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-01-29 13:42",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 3
}
]
}
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 |
{- "title": "Druhá emailová kampaň",
- "completed": "2022-01-29 10:00",
- "description": "Druhá testovací kampaň pro VIP členy organizace",
- "tags": [
- "VIP",
- "Test"
], - "campaignName": "Druhá emailová kampaň SparkPost",
- "source": "SPARKPOST",
- "externalId": "656464568",
- "stats": {
- "sent": 500,
- "clicked": 300,
- "opened": 400,
- "unsubscribed": 200
}
}
{- "success": true,
- "data": {
- "id": 5
}
}
Získání detailu hromadného emailu.
https://app.raynet.cz/api/v2/massEmail/3/
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
{- "success": "true",
- "data": {
- "id": 9,
- "title": "První emailová kampaň",
- "completed": "2022-01-30 18:30",
- "description": "První testovací kampaň pro VIP členy organizace",
- "tags": [
- "VIP"
], - "campaignName": "První emailová kampaň SparkPost",
- "source": "SPARKPOST",
- "externalId": "656464564",
- "stats": {
- "sent": "900",
- "clicked": "600",
- "opened": "800",
- "unsubscribed": "500"
}, - "rowInfo.createdAt": "2022-01-29 13:30",
- "rowInfo.createdBy": "galik@raynet.cz",
- "rowInfo.updatedAt": "2022-01-29 13:42",
- "rowInfo.updatedBy": "galik@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 3
}
}
Upravení dat hromadného emailu.
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
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 |
{- "title": "Druhá emailová kampaň",
- "completed": "2022-01-29 10:00",
- "description": "Druhá testovací kampaň pro VIP členy organizace",
- "tags": [
- "VIP",
- "Test"
], - "campaignName": "Druhá emailová kampaň SparkPost",
- "source": "SPARKPOST",
- "externalId": "656464568",
- "stats": {
- "sent": 500,
- "clicked": 300,
- "opened": 400,
- "unsubscribed": 200
}
}
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ů.
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "massEmail": {
- "id": 9,
- "title": "Druhá emailová kampaň"
}, - "company": {
- "id": 3,
- "name": "Drozd a.s."
}, - "lead": null,
- "person": null,
- "email": "info@klient.cz",
- "opened": "2022-01-29",
- "clicked": null,
- "unsubscribed": null,
- "status": "SENT"
}
]
}
Přidání adresáta, kterému byl hromadný email odeslán (resp. bude odeslán).
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
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í |
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 |
{- "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.
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
recipientId required | integer <int64> Example: 123 ID adresáta |
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í |
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 |
{- "person": 4,
- "status": "DELIVERED",
- "email": "info@klient.cz",
- "opened": "2022-01-29",
- "clicked": "2022-01-30",
- "unsubscribed": "2022-01-31"
}
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.
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
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 |
[- {
- "email": "info@klient.cz",
- "status": "DELIVERED",
- "opened": "2022-01-29",
- "clicked": "2022-01-30",
- "unsubscribed": "2022-01-31"
}, - {
- "email": "kontakty@uslunce.cz",
- "status": "SENT",
- "opened": "2022-01-29",
- "clicked": "2022-01-30",
- "unsubscribed": "2022-01-31"
}
]
{- "success": true,
- "data": [
- {
- "email": "info@klient.cz",
- "massEmailRecipientId": [
- 12,
- 15
], - "success": true,
- "message": "inserted"
}, - {
- "email": "kontakty@uslunce.com",
- "massEmailRecipientId": [
- 13
], - "success": true,
- "message": "updated"
}, - {
- "email": "podpora@raynet.cz",
- "massEmailRecipientId": [ ],
- "success": false,
- "message": "email not found"
}
]
}
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.
massEmailId required | integer <int64> Example: 123 ID hromadného emailu |
[- "info@klient.cz",
- "kontakty@uslunce.com"
]
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).
path | string Example: path=/Dokumenty Filtrování podle cesty ve struktuře složek. Lze využít pouze operátoru |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "data": [
- {
- "id": 0,
- "name": "GDPR",
- "type": "Folder",
- "path": "/Dokumenty/GDPR",
- "owner": null,
- "link": null,
- "file": null
}, - {
- "id": 1,
- "name": "vzorek dat.xlsx",
- "type": "Document",
- "path": null,
- "owner": {
- "id": 175,
- "fullName": "Petr Svetr"
}, - "link": null,
- "file": {
- "id": 35891,
- "fileName": "vzorek dat.xlsx",
- "size": 6371,
- "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}
}, - {
- "id": 2,
- "name": "Ceník",
- "type": "Document",
- "path": null,
- "owner": {
- "id": 2619,
- "fullName": "Alena Lososová"
}, - "link": {
- "linkName": "Ceník produktu"
}, - "file": null
}
]
}
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.
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. |
{- "name": "Složka 1",
- "parent": null,
- "category": 143,
- "securityLevel": 1
}
{- "success": true,
- "data": {
- "id": 5
}
}
Vložení nového dokumentu do knihovny dokumentů.
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 |
{- "file": {
- "uuid": "7d694dbb4e6241829de8a385da797283",
- "fileName": "picture.png",
- "contentType": "image/png",
- "fileSize": 24309
}, - "status": "E_WIN",
- "securityLevel": 4,
- "category": 288,
- "template": false,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "folder": 9
}
{- "success": true,
- "data": {
- "id": 5
}
}
Získání detailu dokumentu.
https://app.raynet.cz/api/v2/dms/document/1/
documentId required | integer <int64> Example: 123 ID dokumentu |
{- "success": "true",
- "data": {
- "id": 2,
- "code": "DOK-21-002",
- "name": "Muj dokument",
- "tags": [ ],
- "description": null,
- "owner": {
- "id": 1,
- "fullName": "RAYNET CRM"
}, - "category": {
- "id": 289,
- "value": "Kategorie dokumentu"
}, - "validFrom": "2022-02-01",
- "validTill": "2022-02-01",
- "status": "A_DRAFT",
- "template": false,
- "folder": {
- "id": 8,
- "name": "Rejnoci",
- "path": "/Dokumenty/Rejnoci"
}, - "attachments": [
- {
- "id": 54,
- "link": null,
- "linkName": null,
- "file": {
- "id": 488,
- "contentType": "image/jpeg",
- "fileName": "MaMaZu.jpg",
- "size": 218878
}
}
], - "link": null,
- "file": {
- "id": 488,
- "contentType": "image/jpeg",
- "fileName": "MaMaZu.jpg",
- "size": 218878
}, - "rowInfo.createdAt": "2022-03-08 08:10",
- "rowInfo.createdBy": "romana.kaprova@raynet.cz",
- "rowInfo.updatedAt": "2022-03-08 08:29",
- "rowInfo.updatedBy": "romana.kaprova@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 4,
- "name": "Asistentka/Asistent"
}, - "extIds": null,
- "_version": 5
}
}
Upravení dat dokumentu
documentId required | integer <int64> Example: 123 ID dokumentu |
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 |
{- "file": {
- "uuid": "7d694dbb4e6241829de8a385da797283",
- "fileName": "picture.png",
- "contentType": "image/png",
- "fileSize": 24309
}, - "status": "E_WIN",
- "securityLevel": 4,
- "category": 288,
- "template": false,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "folder": 9
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených faktur je |
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 |
code | string Example: code=12345678 Filtrování faktur podle kódu faktury. Lze využít operátoru |
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: |
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 |
specificSymbol | string Example: specificSymbol=123456 Filtrování faktur podle specifického symbolu. Lze využít operátoru |
constantSymbol | string Example: constantSymbol=0308 Filtrování faktur podle konstantního symbolu. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování faktur podle data vytvoření. Lze využít operátoru |
rowInfo.updatedAt | string Example: rowInfo.updatedAt=2022-06-01 10:00 Filtrování faktur podle posledního data upravení. Lze využít operátoru |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
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 ( |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 1,
- "code": "FV2015001",
- "title": "Faktura FV2015001",
- "company": {
- "id": 1,
- "name": "RAYNET s.r.o."
}, - "invoiceType": "NORMAL",
- "issueDate": "2022-10-02",
- "dueDate": "2022-10-16",
- "taxableSupplyDate": "2022-10-02",
- "paymentDate": null,
- "invoiceState": "UNPAID",
- "baseAmount": 123,
- "totalAmount": 148.83,
- "unpaidAmount": 148.83,
- "currencyExchangeRate": 1,
- "currency": {
- "id": 15,
- "value": "Kč"
}, - "variableSymbol": "2015001",
- "constantSymbol": "0308",
- "specificSymbol": null,
- "category": null,
- "owner": {
- "id": 2,
- "fullName": "M P"
}, - "note": "VS: {VARIABILNI_SYMBOL}",
- "privateNote": null,
- "creditNoteReason": null,
- "vendorName": null,
- "vendorBankAccountNumber": null,
- "businessCase": null,
- "paymentType": "PAYMENT_CARD",
- "decimalPrecision": 2,
- "taxPayer": "YES",
- "reverseTax": false,
- "rowInfo.createdAt": "2022-10-02 15:14",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-10-02 15:14",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null,
- "securityLevel": {
- "id": 1,
- "name": "Sdílená"
}, - "tags": [ ]
}
]
}
Založení nové faktury
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 |
{- "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": {
- "street": "Hlavní třída 6078/13",
- "city": "Ostrava",
- "zipCode": "708 00",
- "country": "CZ",
- "province": "Moravskoslezský kraj"
}, - "billingName": "RAYNET s.r.o.",
- "billingAddress": {
- "street": "Hlavní třída 6078/13",
- "city": "Ostrava",
- "zipCode": "708 00",
- "country": "CZ",
- "province": "Moravskoslezský kraj"
}, - "roundingBalance": 0.2,
- "decimalPrecision": 2,
- "baseAmount": 500,
- "totalAmount": 550,
- "taxAmount": 50,
- "tags": [ ],
- "items": [
- {
- "name": "položka 1",
- "unitPrice": 123,
- "taxRate": 21,
- "amount": 2,
- "unitLabel": "ks",
- "discountPercent": 0,
- "totalPrice": 297.66
}, - {
- "name": "položka 2",
- "unitPrice": 123,
- "taxRate": 21,
- "amount": 2,
- "unitLabel": "ks",
- "discountPercent": 0,
- "totalPrice": 297.66
}
]
}
{- "success": true,
- "data": {
- "id": 5
}
}
Získání detailu faktury.
https://app.raynet.cz/api/v2/invoiceLight/1/
invoiceId required | integer <int64> Example: 123 ID faktury |
{- "id": 1,
- "code": "FV2015001",
- "title": "Faktura FV2015001",
- "company": {
- "id": 1,
- "name": "RAYNET s.r.o."
}, - "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": {
- "id": 15,
- "value": "Kód"
}, - "currencyExchangeRate": 1,
- "variableSymbol": "2015001",
- "constantSymbol": "0308",
- "specificSymbol": null,
- "category": null,
- "owner": {
- "id": 2,
- "fullName": "M P"
}, - "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": {
- "city": "Ostrava",
- "country": "Česká republika",
- "countryCode": "CZ",
- "province": null,
- "street": "Francouzská 6167/5",
- "zipCode": "70800"
}, - "billingName": "RAYNET s.r.o.",
- "billingRegNumber": "26843820",
- "billingTaxNumber": "CZ26843820",
- "billingTaxNumber2": null,
- "billingAddress": {
- "city": "Ostrava",
- "country": "Česká republika",
- "countryCode": "CZ",
- "province": null,
- "street": "Francouzská 6167/5",
- "zipCode": "70800"
}, - "businessCase": null,
- "salesOrder": null,
- "paymentType": "PAYMENT_CARD",
- "decimalPrecision": 2,
- "taxPayer": "YES",
- "reverseTax": false,
- "normalInvoice": {
- "id": 111,
- "code": "FV202300002"
}, - "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": {
- "id": 1,
- "name": "Sdílená"
}, - "_version": 6,
- "extIds": null,
- "tags": [ ],
- "items": [
- {
- "id": 1,
- "name": "Nekategorizovaný produkt",
- "amount": 1,
- "unitPrice": 123,
- "taxRate": 21,
- "taxRateName": "základní",
- "totalPrice": 148.83,
- "discountPercent": 0,
- "sequenceNumber": 1,
- "unitLabel": "ks",
- "rowInfo.createdAt": "2022-10-02 15:14",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": "2022-10-02 15:14",
- "rowInfo.updatedBy": "konektor@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
], - "payments": [
- {
- "id": 1,
- "amount": 148.83,
- "date": "2022-10-02",
- "rowInfo.createdAt": "2022-10-02 15:36",
- "rowInfo.createdBy": "konektor@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
]
}
Upravení dat faktury
invoiceId required | integer <int64> Example: 123 ID faktury |
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 |
{- "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": {
- "street": "Francouzská 6167/5",
- "city": "Ostrava",
- "zipCode": "708 00",
- "country": "CZ",
- "province": "Moravskoslezský kraj"
}, - "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": {
- "street": "Francouzská 6167/5",
- "city": "Ostrava",
- "zipCode": "708 00",
- "country": "CZ",
- "province": "Moravskoslezský kraj"
}, - "items": [
- {
- "id": 2,
- "name": "položka 2",
- "unitPrice": 123,
- "taxRate": 21,
- "amount": 2,
- "unitLabel": "ks",
- "discountPercent": 10
}
], - "payments": [
- {
- "amount": 200,
- "date": "2023-06-01"
}
]
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Zostřený režim",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Zostřený režim",
- "code02": "aa99dd"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "vlastní nový kontakt"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "vlastní nový kontakt"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "1 - 10"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "1 - 10"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "s.r.o."
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "s.r.o."
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "7 dní"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "7 dní"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "do 1 mil. Kč"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "do 1 mil. Kč"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "obor"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "obor"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "Morava"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "Morava"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "VIP",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "VIP",
- "code02": "aa99dd"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "čeština"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "čeština"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "Svobodná / Svobodný"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "Svobodná / Svobodný"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "kusový prodej",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "kusový prodej",
- "code02": "aa99dd"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "ovoce"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "ovoce"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Prodej nového zboží",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Prodej nového zboží",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Název kategorie",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Název kategorie",
- "code02": "cdcdcd"
}
{- "success": true
}
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 3,
- "code01": "Před uzavřením",
- "code02": "E9802F",
- "strValue01": "B_ACTIVE",
- "probability": 50,
- "businessCaseTypeId": 64,
- "locked": false
}
]
}
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) |
{- "code01": "Před uzavřením",
- "code02": "E9802F",
- "probability": 50,
- "businessCaseTypeId": null
}
{- "success": true,
- "data": {
- "id": 5
}
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 1"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 2"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "klasifikace 3"
}
{- "success": true
}
code01 required | string [Název měny] |
code02 required | string [Kód měny] |
strValue01 | string [Popis měny] |
{- "code01": "¥",
- "code02": "JPY",
- "strValue01": "Japonský jen"
}
{- "success": true,
- "data": 5
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název měny] |
code02 | string [Kód měny] |
strValue01 | string [Popis měny] |
{- "code01": "¥",
- "code02": "JPY",
- "strValue01": "Japonský jen"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "přechod ke konkurenci"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "přechod ke konkurenci"
}
{- "success": true
}
code01 required | string [Název číselníkové položky] |
{- "code01": "pager"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název číselníkové položky] |
{- "code01": "pager"
}
{- "success": true
}
code01 required | string [Název stavu] |
code02 | string [Barva stavu] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Název kategorie",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Název kategorie",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "Odloženo",
- "code02": "cdcdcd"
}
{- "success": true
}
code01 required | string [Název stavu] |
{- "code01": "Odloženo"
}
{- "success": true,
- "data": {
- "id": 5
}
}
code01 required | string [Název stavu] |
{- "code01": "Odloženo"
}
{- "success": true,
- "data": {
- "id": 5
}
}
code01 required | string [Název stavu] |
{- "code01": "Odloženo"
}
{- "success": true,
- "data": {
- "id": 5
}
}
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] |
{- "code01": "15%",
- "strValue01": "první snížená"
}
{- "success": true,
- "data": {
- "id": 5
}
}
code01 required | string [Popis formy souhlasu] |
{- "code01": "elektronicky"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Popis formy souhlasu] |
{- "code01": "elektronicky"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true
}
code01 required | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true,
- "data": {
- "id": 5
}
}
id required | integer <int64> Example: 123 ID položky číselníku |
code01 | string [Název kategorie] |
code02 | string [Barva kategorie] |
{- "code01": "bez reakce",
- "code02": "aa99dd"
}
{- "success": true
}
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/
fileId required | integer <int64> Example: 123 ID loga nebo fota (získaného z detailu záznamu, kde se foto / logo nachází) |
{ "fileName": "logo.png", "contentType": "image/png", "imgData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAIAAACRXR/mAAAXYElEQVR4nGWWB3QVZdrHr7quZY/7rR0si59d3FXBtYACo=" }
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/
fileId required | integer <int64> Example: 123 ID loga nebo fota (získaného z detailu záznamu, kde se foto / logo nachází) |
{ "fileName": "logo.png", "contentType": "image/png", "imgData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAIAAACRXR/mAAAXYElEQVR4nGWWB3QVZdrHr7quZY/7rR0si59d3FXBtYACo=" }
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/
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í) |
{- "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
- "fileName": "priloha.png",
- "fileSize": 1201,
- "contentType": "image/png",
- "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
- "instanceName": "mojecrm"
}
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
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) |
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) |
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
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) |
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) |
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
file required | string <binary> |
{- "uuid": "7d694dbb4e6241829de8a385da797283",
- "fileName": "picture.png",
- "contentType": "image/png",
- "fileSize": 24309
}
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 }
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
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ů |
{- "linkName": "raynet.cz"
}
{- "success": true,
- "data": 5
}
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
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
customFieldId required | string Example: soubor_29f53 Klíč (name) volitelného pole |
uuid required | string [UUID souboru] |
fileName required | string [Název souboru] |
contentType required | string [Typ souboru] |
fileSize required | integer <int64> [Velikost souboru v bytech] |
{- "uuid": "7d694dbb4e6241829de8a385da797283",
- "fileName": "picture.png",
- "contentType": "image/png",
- "fileSize": 24309
}
{- "success": true,
- "data": {
- "id": 5
}
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
legalTitle | string Example: legalTitle=LEGITIMATE_INTEREST Filtrování šablon právních titulů podle typu právního titulu ( |
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 |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování šablon právních titulů podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 2,
- "name": "Plnění smlouvy",
- "legalTitle": "CONTRACT",
- "duration": 12,
- "selectedField": {
- "lead": [ ],
- "field": [
- "name"
], - "person": [ ],
- "company": [ ]
}, - "gdprTypeAgreement": [
- 133,
- 134
], - "gdprContract": {
- "id": 129,
- "value": "Smlouva o dílo"
}, - "gdprFormAgreement": {
- "id": 140,
- "value": "elektronicky"
}, - "gdprLawRegulation": {
- "id": 143,
- "value": "Zákon o účetnictví"
}, - "_version": 0,
- "rowInfo.createdAt": "2022-02-20 08:44",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": "2022-03-05 10:55",
- "rowInfo.updatedBy": "info@raynet.cz",
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
]
}
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/
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
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 |
lead | integer <int64> Example: lead=2 Filtrování právních titulů podle leadu. Lze využít operátoru |
person | integer <int64> Example: person=10 Filtrování právních titulů podle kontaktní osoby. Lze využít operátoru |
gdprTemplate | integer <int64> Example: gdprTemplate=141 Filtrování právních titulů podle šablony právního titulu. Lze využít operátoru |
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 |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování právních titulů podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 18,
- "company": {
- "id": 1,
- "name": "[Anonymizovaný záznam]"
}, - "person": null,
- "lead": null,
- "gdprTemplate": {
- "id": 1,
- "name": "Oprávněný zájem",
- "legalTitle": "LEGITIMATE_INTEREST"
}, - "gdprFormAgreement": null,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "rowInfo.createdAt": "2022-06-05 09:22",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
]
}
Založení nového právního titulu k entitě klient, kontaktní osoba, lead
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. |
{- "person": 6,
- "gdprTemplate": 1,
- "validFrom": "2022-01-01"
}
{- "success": true,
- "data": {
- "id": 5
}
}
Získání detailu právního titlulu.
https://app.raynet.cz/api/v2/gdpr/1/
gdprId required | integer <int64> Example: 123 ID právního titulu |
{- "success": "true",
- "data": {
- "id": 18,
- "company": {
- "id": 1,
- "name": "RAYNET"
}, - "person": null,
- "lead": null,
- "gdprTemplate": {
- "id": 1,
- "name": "Oprávněný zájem",
- "legalTitle": "LEGITIMATE_INTEREST"
}, - "gdprFormAgreement": null,
- "validFrom": "2022-01-01",
- "validTill": "2022-01-01",
- "rowInfo.createdAt": "2022-06-05 09:22",
- "rowInfo.createdBy": "info@raynet.cz",
- "rowInfo.updatedAt": null,
- "rowInfo.updatedBy": null,
- "rowInfo.rowAccess": null,
- "rowInfo.rowState": null
}
}
Upravení dat právního titulu.
gdprId required | integer <int64> Example: 123 ID právního titulu |
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. |
{- "validFrom": "2022-11-08",
- "validTill": "2022-11-08"
}
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
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
sortColumn | string Value: "date" |
sortDirection | string Enum: "ASC" "DESC" |
date | string Filtrování podle data notifikace. Lze využít operátoru |
sender | integer <int64> Filtrování podle odesílatele. S operátorem |
recipient | string Filtrování podle příjemce. V případě |
flag | boolean Filtrování notifikací označených hvězdičkou. Lze využít operátoru |
read | boolean Filtrování přečtených notifikací. Lze využít operátoru |
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 |
{- "success": true,
- "totalCount": 1,
- "data": [
- {
- "id": 782319,
- "date": "2022-09-19 13:42",
- "recipient": {
- "id": 5,
- "fullName": "Jan Novák"
}, - "items": [
- {
- "title": "Petr Svetr změnil(a) údaje",
- "message": null,
- "sender": {
- "id": 9,
- "fullName": "Petr Svetr",
- "isSystem": false,
- "gender": "MALE"
}, - "types": [
- "CR_CHANGE_YOUR_RECORD_MAIN"
], - "context": [
- {
- "entityId": 299,
- "entityName": "Company",
- "value": "Test s.r.o."
}
], - "changes": [
- {
- "label": "Název",
- "innerLabel": null,
- "type": "CR_CHANGE_YOUR_RECORD_MAIN",
- "oldValue": "Test s.r.o.",
- "newValue": "Test NX s.r.o."
}, - {
- "label": "Vztah",
- "innerLabel": null,
- "type": "CR_CHANGE_YOUR_RECORD_MAIN",
- "oldValue": "Partner",
- "newValue": "Dodavatel"
}
]
}
], - "read": true,
- "flag": false
}
]
}
https://app.raynet.cz/api/v2/company/4/post/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
{- "success": "true",
- "totalCount": 2,
- "data": [
- {
- "id": 16,
- "parent": 16,
- "date": "2022-12-13 13:00",
- "comment": "Ahoj, jak se máš ?",
- "owner": {
- "id": 2,
- "fullName": "Dušan Gálik"
}, - "_version": 1
}, - {
- "id": 17,
- "parent": 16,
- "date": "2022-12-13 13:00",
- "comment": "Mám se dobře, díky",
- "owner": {
- "id": 6,
- "fullName": "Igor Hnízdo"
}, - "_version": 0
}
]
}
https://app.raynet.cz/api/v2/company/4/post/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
parent | integer <int64> [ID nadřazeného příspěvku, pod který má být nový komentář zařazen] |
comment required | string [Komentář] |
{- "parent": 16,
- "comment": "Další zajímavý komentář"
}
{- "success": true,
- "data": {
- "id": 5
}
}
https://app.raynet.cz/api/v2/company/4/post/19/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
postId required | integer <int64> Example: 123 ID příspěvku |
{- "success": true
}
https://app.raynet.cz/api/v2/company/4/watcher/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
{- "success": "true",
- "totalCount": 2,
- "data": [
- {
- "id": 16,
- "person": {
- "id": 2,
- "fullName": "Dušan Gálik"
}, - "_version": 0
}, - {
- "id": 17,
- "person": {
- "id": 6,
- "fullName": "Igor Hnízdo"
}, - "_version": 0
}
]
}
https://app.raynet.cz/api/v2/company/4/watcher/2/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
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 |
{- "success": true,
- "data": {
- "id": 5
}
}
https://app.raynet.cz/api/v2/company/4/watcher/2/
entityName required | string Example: company Název entity (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID entity |
personId required | integer <int64> Example: 123 ID kontaktní osoby pro odebrání ze sledovačů diskuze |
{- "success": true
}
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%
offset | integer <int64> Zobrazeni zaznamu od zacatku |
limit | integer <int64> Example: limit=100 Maximální počet vrácených záznamů je |
name | string Example: name=RAY Filtrování bezpečnostních úrovní podle jména. Lze využít operátoru |
locked | boolean Example: locked=YES Filtrování bezpečnostních úrovní podle stavu uzamčení. Lze využít operátoru |
{- "success": true,
- "totalCount": 2,
- "data": [
- {
- "id": 1,
- "name": "Sdílená",
- "locked": true
}, - {
- "id": 2,
- "name": "halabala",
- "locked": false
}
]
}
Založení nové bezpečnostní úrovně. Bude přiřazena automaticky všem administrátorům.
name required | string [Název] |
{- "name": "Bezpečnostní úroveň 1"
}
{- "success": true,
- "data": {
- "id": 5
}
}
securityLevelId required | integer <int64> Example: 123 ID bezpečnostní úrovně |
personIds required | Array of integers <int64> [ items <int64 > ] |
{- "personIds": [
- 84,
- 102
]
}
{- "success": true
}
securityLevelId required | integer <int64> Example: 123 ID bezpečnostní úrovně |
personIds required | Array of integers <int64> [ items <int64 > ] |
{- "personIds": [
- 84,
- 102
]
}
{- "success": true
}
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 (meta-dat) volitených polí, včetně klíčů, uživatelských názvů a skupin polí.
{- "success": true,
- "data": {
- "Company": [
- {
- "label": "Číslo klienta",
- "dataType": "STRING",
- "enumeration": [ ],
- "groupName": "Interní",
- "name": "Cislo_klie_cd702",
- "currency": null,
- "hint": null,
- "readOnly": false,
- "showInFilterView": true,
- "showInListExport": false,
- "showInListView": true,
- "fullText": true
}, - {
- "label": "Spolupráce od",
- "dataType": "DATE",
- "enumeration": [ ],
- "groupName": "Interní",
- "name": "Spoluprace_2aa2c",
- "currency": null,
- "hint": null,
- "readOnly": false,
- "showInFilterView": true,
- "showInListExport": false,
- "showInListView": true,
- "fullText": true
}
], - "Person": [
- {
- "label": "VIP",
- "dataType": "BOOLEAN",
- "enumeration": [ ],
- "groupName": "Interní",
- "name": "VIP_b91d1",
- "currency": null,
- "hint": null,
- "readOnly": false,
- "showInFilterView": true,
- "showInListExport": false,
- "showInListView": true,
- "fullText": true
}
], - "BusinessCase": [
- {
- "label": "Priorita OP",
- "dataType": "ENUMERATION",
- "enumeration": [
- "TOP",
- "Velká",
- "Střední",
- "Malá"
], - "groupName": "Priorita",
- "name": "Priorita_O_a5fab",
- "currency": null,
- "hint": null,
- "readOnly": false,
- "showInFilterView": true,
- "showInListExport": false,
- "showInListView": true,
- "fullText": true
}
], - "Offer": [ ],
- "SalesOrder": [ ],
- "Product": [ ]
}
}
Založení nového volitelného pole
entityName required | string Example: businessCase Název entity, ke které se volitelné pole založí (podporované hodnoty jsou: |
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]
|
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] |
{- "label": "Datum",
- "groupName": "Revize",
- "dataType": "DATE",
- "showInFilterView": true
}
{- "success": true,
- "data": {
- "fieldName": "datum_6ae6f"
}
}
Upravení volitelného pole
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 |
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] |
{- "label": "Datum",
- "groupName": "Revize",
- "showInListView": true
}
{- "success": true
}
Smazání volitelného pole
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 |
{- "success": true
}
Načtení seznamu všech dostupných položek enumerace (číselníku, alias roletky).
entityName required | string Example: BusinessCase Název entity, která volitelné pole obsahuje |
fieldName required | string Example: Priorita_O_a5fab Klíč volitelného pole |
{- "success": true,
- "data": [
- "TOP",
- "Velká",
- "Střední",
- "Malá"
]
}
Vložení nové hodnoty do enumerace
entityName required | string Example: BusinessCase Název entity, která volitelné pole obsahuje |
fieldName required | string Example: Priorita_O_a5fab Klíč volitelného pole |
value required | string |
{- "value": "položka 1"
}
{- "success": true
}
Upravení hodnoty enumerace
entityName required | string Example: BusinessCase Název entity, která volitelné pole obsahuje |
fieldName required | string Example: Priorita_O_a5fab Klíč volitelného pole |
oldValue required | string |
newValue required | string |
{- "oldValue": "položka 1",
- "newValue": "položka 11"
}
{- "success": true
}
Smazání hodnoty enumerace
entityName required | string Example: BusinessCase Název entity, která volitelné pole obsahuje |
fieldName required | string Example: Priorita_O_a5fab Klíč volitelného pole |
value required | string |
{- "value": "položka 1"
}
{- "success": true
}
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 |
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.
token required | string Example: 38PUaFrM6g16bSCUfPuV3Ngdhcvxz00OEW4ODppPi3Q Token |
personId | integer <int64> Example: 123 ID kontaktní osoby, které token patří |
{- "data": true,
- "success": "true"
}
Načtení konfigurace (meta-dat) vlastních akcí.
{- "data": [
- {
- "entityName": "Company",
- "appClass": "DetailView",
- "name": "RAYNET",
- "description": null,
- "type": "OPEN_URL",
- "method": null,
- "successTitle": null,
- "successMessage": null,
- "refresh": null,
- "admin": null,
- "confirm": null,
- "openType": "OPEN_WINDOW",
- "openTypeWindowWidth": 500,
- "openTypeWindowHeight": 400,
- "openTypeWindowRefresh": null
}, - {
- "entityName": "Company",
- "appClass": "ListView",
- "name": "RAYNET",
- "description": null,
- "type": "OPEN_URL",
- "method": null,
- "successTitle": null,
- "successMessage": null,
- "refresh": null,
- "admin": null,
- "confirm": null,
- "openType": "OPEN_WINDOW",
- "openTypeWindowWidth": 500,
- "openTypeWindowHeight": 200,
- "openTypeWindowRefresh": null
}
]
}
Založení nového vlastního tlačítka
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í]
|
appClass required | string Enum: "DetailView" "ListView" "MainMenu" [Typ pohledu, kde se volitelné tlačítko zobrazí]
|
name required | string [Název vlastního tlačítka] |
description | string [Popis vlastního tlačítka] Dostupné jen pro |
type required | string Enum: "AJAX" "DOWNLOAD" "OPEN_URL" [Typ akce]
|
method | string Enum: "GET" "POST" "PUT" "DELETE" [Typ http požadavku] Dostupné jen pro
|
url | string [Šablona URL adresy] |
successTitle | string [Titulek zprávy po úspěšném vykonání akce] Dostupné jen pro |
successMessage | string [Text zprávy po úspěšném vykonání akce] Dostupné jen pro |
refresh | integer [Obnovit data po (čas v ms)] Dostupné jen pro |
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
|
openTypeWindowWidth | integer [Šířka nově otevřeného okna] Dostupné jen pro kombinaci |
openTypeWindowHeight | integer [Výška nově otevřeného okna] Dostupné jen pro kombinaci |
openTypeWindowRefresh | boolean [Obnovit data po zavření okna] Dostupné jen pro kombinaci |
{- "entityName": "Company",
- "appClass": "DetailView",
- "name": "RAYNET",
- "type": "OPEN_URL",
- "openType": "OPEN_WINDOW",
- "openTypeWindowWidth": 500,
- "openTypeWindowHeight": 200
}
{- "success": true
}
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 ke konkrétnímu záznamu.
entityName required | string Example: company entita, ke které má být externí identifikátor přiřazen (podporované hodnoty jsou: |
entityId required | integer <int64> Example: 123 ID záznamu |
extId required | string Externí identifikátor |
{- "extId": "erp:123456789"
}
{- "success": "true"
}
Odstranění externího identifikátoru od konkrétního záznamu.
entityName required | string Example: company entita, od které má být externí identifikátor odebrán (podporované hodnoty jsou: |
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 |
{- "success": "true"
}
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ů.
offset | integer <int64> Od kterého indexu se budou záznamy zobrzovat ( |
limit | integer <int64> Example: limit=100 Počet vrácených záznamů, maximální počet je |
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 |
username | string Example: username=info@raynet.cz Filtrování uživatelů podle uživatelského jména. Lze využít operátoru |
rowInfo.createdAt | string Example: rowInfo.createdAt=2022-06-01 10:00 Filtrování uživatelů podle data vytvoření. Lze využít operátoru |
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 |
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 |
view | string Example: view=rowInfo Pokud je hodnota rovna |
id | integer <int64> Example: id=1 Filtrování podle ID. Lze využít operátoru |
{- "success": "true",
- "totalCount": 1,
- "data": [
- {
- "id": 8,
- "_version": 5,
- "username": "uzivatel@raynet.cz",
- "person": {
- "id": 9,
- "fullName": "Milan Buldog"
}, - "userRole": "ADMIN",
- "rowInfo.createdAt": "2022-04-17 14:47",
- "rowInfo.createdBy": "svetr@raynet.cz",
- "rowInfo.updatedAt": "2022-04-18 16:03",
- "rowInfo.updatedBy": "svetr@raynet.cz"
}
]
}
Získání detailu uživatelského účtu.
userAccountId required | integer <int64> Example: 123 ID uživatele |
{- "success": "true",
- "data": {
- "id": 2,
- "_version": 5,
- "person": {
- "id": 2,
- "fullName": "Milan Buldog"
}, - "username": "uzivatel@raynet.cz",
- "email2": "alternativni@email.cz",
- "userRole": "ADMIN",
- "personRecordFilter": null,
- "listExportPermission": true,
- "detailReportPermission": true,
- "googleContactsPermission": true,
- "bulkOperationPermission": true,
- "codelistEditPermission": true,
- "editOnlyOwnedRecordsPermission": false,
- "onlyLockRecordsPermission": false,
- "deletePermissionConfig": null,
- "twoFactorEnabled": true,
- "timezone": "EUROPE_PRAGUE",
- "dateFormat": "DAY_MONTH_YEAR",
- "timeFormat": "HOUR24",
- "startWeekDay": "MONDAY",
- "securityLevels": [
- {
- "id": 14,
- "name": "Bezpečnostní úroveň"
}, - {
- "id": 1,
- "name": "Sdílená"
}
], - "securityProfile": {
- "id": 11,
- "name": "Můj bezpečnostní profil"
}, - "rowInfo.createdAt": "2022-10-06 09:59",
- "rowInfo.createdBy": "(unknown)",
- "rowInfo.updatedAt": "2022-10-30 12:34",
- "rowInfo.updatedBy": "porubsky@raynet.cz"
}
}
Uživateli bude přidána bezpečnostní úroveň. Tu je možné přidat pouze uživateli, který není administrátor.
userAccountId required | integer <int64> Example: 123 ID uživatele |
securityLevelId required | integer <int64> Example: 123 ID bezpečnostní úrovně |
{- "success": "true"
}
Uživateli bude odebrána bezpečnostní úroveň. Tu je možné odebrat pouze uživateli, který není administrátor.
userAccountId required | integer <int64> Example: 123 ID uživatele |
securityLevelId required | integer <int64> Example: 123 ID bezpečnostní úrovně |
{- "success": "true"
}
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ěď.
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
}
}
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
.
{- "success": "true",
- "data": {
- "technicalContacts": [
- "technical@contact.cz"
], - "webhooks": [
- {
- "webhookId": "cb83cfc88bee4c90ab3111f3dc2b7dfb",
- "secretToken": "tajne-heslo",
- "eventsFilter": [
- "record.created",
- "record.updated",
- "record.deleted"
]
}
]
}
}
Založení nového webhooku.
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. |
{- "events": [
- "record.created",
- "record.updated",
- "record.deleted"
], - "entityFilter": [
- "Company"
]
}
{- "success": true,
- "data": {
- "uuid": "532d339c0a874f68ae8f2cc108c7f7b2"
}
}
Upravení emailů pro technický kontakt, který bude notifikován v případě obtíží (viz. výše).
technicalContacts required | Array of strings <email> >= 0 items [Technický kontakt] Emaily na technický kontakt. |
{- "technicalContacts": [
- "technical@contact.cz"
]
}
{- "success": true
}