Back to top

CRM API

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

Připojení k RAYNET CRM

Komunikačním protokolem je HTTP, proto je možné použít libovolnou aplikaci nebo knihovnu, která tento protokol podporuje. Pro demonstraci bude využita aplikace curl. Alternativou je například add-on REST Console 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 (HTTPS) pro zajištění maximální bezpečnosti. V hlavičce požadavku je nutné zaslat název Vaší instance (např. moje-crm).

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

Datové typy

Hodnoty jednotlivých entitná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. Vyhledávací kritéria akceptují také datum a čas ve formátu ISO8601 (např. 2018-01-01T12:00:00.000+01:00).

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

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

Filtrování seznamu

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

  • EQ - Test na rovnost hodnot.

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

  • NE - Test na nerovnost hodnot.

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

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

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

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

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

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

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

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

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

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

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

Uspořádání seznamu

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

  • ASC - Hodnoty jsou řazeny vzestupně

  • DESC - Hodnoty jsou řazeny sestupně

Stránkování seznamu

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

Limity API

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

curl -X GET -u 'uzivatel:heslo' -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 503 Service Unavailable:

{
  "type": "RequestLimitReached",
  "message": "API request limit reached. See the X-RateLimit-* headers and check out the API documentation for more details.",
  "documentation_url": "https://s3-eu-west-1.amazonaws.com/static-raynet/webroot/api-doc.html"
}

Co když mi limity nestačí

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

Firmy

API pro práci s firmami.

Seznam firem

seznam firem
GET/api/v2/company/{?offset,limit,sortColumn,sortDirection,name,lastName,regNumber,owner,primaryAddress-contactInfo.email,primaryAddress-contactInfo.email2,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,rowInfo.rowAccess,gdprTemplate,withoutGdpr,view}

Získání seznamu firem. 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%

Example URI

GET https://app.raynet.cz/api/v2/company/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE]=RAY%&lastName=name[LIKE]=RAY%&regNumber=12345678&owner=1&primaryAddress-contactInfo.email=test@test.cz&primaryAddress-contactInfo.email2=test@test.cz&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&rowInfo.rowAccess=INVALID&gdprTemplate=gdprTemplate[CUSTOM]=1&withoutGdpr=withoutGdpr[CUSTOM]&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

name
string (optional) Example: name[LIKE]=RAY%

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

lastName
string (optional) Example: name[LIKE]=RAY%

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

regNumber
string (optional) Example: 12345678

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

owner
number (optional) Example: 1

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

primaryAddress-contactInfo.email
string (optional) Example: test@test.cz

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

primaryAddress-contactInfo.email2
string (optional) Example: test@test.cz

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.rowAccess
string (optional) Example: INVALID

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

gdprTemplate
string (optional) Example: gdprTemplate[CUSTOM]=1

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

withoutGdpr
string (optional) Example: withoutGdpr[CUSTOM]

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "totalCount": 1,
  "data": [
    {
      "id": 2,
      "name": "Test s.r.o.",
      "titleBefore": null,
      "firstName": null,
      "lastName": null,
      "titleAfter": null,
      "role": "B_PARTNER",
      "state": "B_ACTUAL",
      "rating": "A",
      "owner": {
        "id": 1,
        "fullName": "RAYNET CRM"
      },
      "regNumber": "123456789",
      "taxNumber": "CZ123456789",
      "taxNumber2": null,
      "primaryAddress": {
        "id": 2,
        "primary": true,
        "contactAddress": false,
        "address": {
          "id": 2,
          "city": "Ostrava-Slezská Ostrava",
          "country": "Česká republika",
          "name": "Sídlo firmy",
          "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
        }
      },
      "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
        }
      },
      "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 k firme",
      "tags": [
        "stitek1",
        "stitek 2"
      ],
      "customFields": null,
      "rowInfo.createdAt": "2014-06-18 13:19",
      "rowInfo.createdBy": "demo@raynet.cz",
      "rowInfo.updatedAt": "2017-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": "2018-01-01",
          "validTill": "2019-01-01",
          "legalTitle": "LEGITIMATE_INTEREST",
          "templateName": "Opravněný zájem",
          "gdprTemplate": 1
        }
      ],
      "_version": 16
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nová firma

nová firma
PUT/api/v2/company/

Založení nové firmy s adresami

Example URI

PUT https://app.raynet.cz/api/v2/company/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "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 firmy",
        "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"
      },
      "territory": 12
    }
  ],
  "tags": [
    "tag 1",
    "tag 2"
  ],
  "customFields": {
    "Spoluprace_2aa2c": "2013-01-01"
  }
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "name": {
                    "type":"string",
                    "required":true,
                    "description": "[Název]"
                },
                "person": {
                    "type":"boolean",
                    "required":false,
                    "description": "[Jedná se o fyzickou osobu]"
                },
                "lastName": {
                    "type":"string",
                    "required":true,
                    "description": "[Příjmení fyzické osoby] - povinný v případě, že je aktivní příznak 'Jedná se o fyzickou osobu'"
                },
                "firstName": {
                    "type":"string",
                    "required":false,
                    "description": "[Jméno fyzické osoby]"
                },
                "titleBefore": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul před jménem fyzické osoby]"
                },
                "titleAfter": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul za jménem fyzické osoby]"
                },
                "salutation": {
                    "type":"string",
                    "required":false,
                    "description": "[Oslovení]"
                },                            
                "securityLevel": {
                    "type":"long",
                    "required":false,
                    "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
                },
                "owner": {
                    "type":"long",
                    "required":false,
                    "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
                },
                "rating": {
                    "enum": [ "A", "B", "C" ],
                    "required":true,
                    "description": "[Rating]"
                },
                "state": {
                    "enum": [ "A_POTENTIAL", "B_ACTUAL", "C_DEFERRED", "D_UNATTRACTIVE" ],
                    "required":true,
                    "description": "[Stav]"
                },
                "role" : {
                    "enum": [ "A_SUBSCRIBER", "B_PARTNER", "C_SUPPLIER", "D_RIVAL" ],
                    "required":true,
                    "description": "[Vztah]"
                },
                "notice": {
                    "type":"string",
                    "required":false,
                    "description": "[Poznámka k firmě]"
                },
                "category": {
                    "type":"long",
                    "required":false,
                    "description" : "[Kategorie] ID záznamu z číselníku CompanyCategory"
                },
                "contactSource": {
                    "type":"long",
                    "required":false,
                    "description" : "[Zdroj kontaktu] ID záznamu z číselníku ContactSource"
                },
                "employeesNumber": {
                    "type":"long",
                    "required":false,
                    "description" : "[Zaměstnanců] ID záznamu z číselníku EmployeesNumber"
                },
                "legalForm": {
                    "type":"long",
                    "required":false,
                    "description" : "[Právní forma] ID záznamu z číselníku LegalForm"
                },
                "paymentTerm": {
                    "type":"long",
                    "required":false,
                    "description" : "[Platbní podmínky] ID záznamu z číselníku PaymentTerm"
                },
                "turnover": {
                    "type":"long",
                    "required":false,
                    "description" : "[Obrat] ID záznamu z číselníku CompanyTurnover"
                },
                "economyActivity": {
                    "type":"long",
                    "required":false,
                    "description" : "[Obor] ID záznamu z číselníku EconomyActivity"
                },
                "companyClassification1": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 1]ID záznamu z číselníku CompanyClassification1"
                },
                "companyClassification2": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 2] ID záznamu z číselníku CompanyClassification2"
                },
                "companyClassification3": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 3] ID záznamu z číselníku CompanyClassification3"
                },
                "regNumber": {
                    "type":"string",
                    "required":false,
                    "description": "[IČ]"
                },
                "taxNumber": {
                    "type":"string",
                    "required":false,
                    "description": "[DIČ]"
                },
                "taxNumber2": {
                    "type":"string",
                    "required":false,
                    "description": "[IČ DPH] Pro slovenské firmy"
                },
                "taxPayer" : {
                    "enum": [ "YES", "NO" ],
                    "required":false,
                    "description": "[Plátce DPH]"
                },
                "bankAccount": {
                    "type":"string",
                    "required":false,
                    "description": "[Bankovní spojení]"
                },
                "addresses" : {
                    "type": "array",
                    "minItems": 0,
                    "items" : {
                        "type":"object",
                        "required":false,
                        "properties":{
                            "address": {
                                    "type":"object",
                                    "required":true,
                                    "properties":{
                                            "name": {
                                                    "type":"string",
                                                    "required":true,
                                                    "description": "[Název]"
                                            },
                                            "street": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Ulice]"
                                            },
                                            "city": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Město]"
                                            },
                                            "province": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Kraj]"
                                            },
                                            "zipCode": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[PSČ]"
                                            },
                                            "country": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Kód Země]"
                                            },
                                            "lat": {
                                                    "type":"number",
                                                    "required":false,
                                                    "description": "[Zeměpisná šířka]"
                                            },
                                            "lng": {
                                                    "type":"number",
                                                    "required":false,
                                                    "description": "[Zeměpisná délka]"
                                            }
                                    }
                            },
                            "contactInfo": {
                                    "type":"object",
                                    "required":false,
                                    "properties":{
                                            "email": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Email]"
                                            },
                                            "email2": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Email2]"
                                            },
                                            "fax": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Fax]"
                                            },
                                            "otherContact": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Jiný kontakt]"
                                            },
                                            "tel1Type": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Typ 1]"
                                            },
                                            "tel1": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Tel 1]"
                                            },
                                            "tel2Type": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Typ 2]"
                                            },
                                            "tel2": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[Tel 2]"
                                            },
                                            "www": {
                                                    "type":"string",
                                                    "required":false,
                                                    "description": "[WWW]"
                                            }
                                    }
                            },
                            "territory": {
                                    "type":"long",
                                    "required":false,
                                    "description": "[Obchodní teritorium] ID záznamu z číselníku Territory"
                            }
                        },
                    }
                },
                "socialNetworkContact": {
                        "type":"object",
                        "required":false,
                        "properties":{
                                "facebook": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Facebook]"
                                },
                                "googleplus": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Google+]"
                                },
                                "twitter": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Twitter]"
                                },
                                "linkedin": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Linkedin]"
                                },
                                "pinterest": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Pinterest]"
                                },
                                "instagram": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Instagram]"
                                },
                                "skype": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Skype]"
                                },
                                "youtube": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Youtube]"
                                }
                        }
                },
                "tags" : {
                    "type": "array",
                    "required":false,
                    "items" : {
                        "type":"string",
                        "required":true
                    }
                },
                "customFields" : {
                    "type": "object",
                    "required":false,
                    "properties" : {
                        "<customFieldKey>": {
                                "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                                "required":false,
                                "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                        }
                    }
                }
            }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené firmy"
        }
      }
    }
  }
}

Detail firmy

detail firmy
GET/api/v2/company/{companyId}/

Získání detailu firmy. V detailu firmy je uvedena firma se všemi evidovanými údaji včetně všech evidovaných adres. Pokud záznam firmy 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/

Example URI

GET https://app.raynet.cz/api/v2/company/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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 k firme",
    "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",
    "birthday": null,
    "primaryAddress": {
      "id": 2,
      "primary": true,
      "contactAddress": false,
      "address": {
        "id": 2,
        "city": "Ostrava-Slezská Ostrava",
        "country": "Česká republika",
        "name": "Sídlo firmy",
        "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
      }
    },
    "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": "2016-02-02"
    },
    "rowInfo.createdAt": "2014-06-18 13:19",
    "rowInfo.createdBy": "demo@raynet.cz",
    "rowInfo.updatedAt": "2017-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
        }
      }
    ],
    "addresses": [
      {
        "id": 2,
        "primary": true,
        "contactAddress": false,
        "address": {
          "id": 2,
          "city": "Ostrava-Slezská Ostrava",
          "country": "Česká republika",
          "name": "Sídlo firmy",
          "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
        }
      },
      {
        "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
        }
      }
    ],
    "inlineGdpr": [
      {
        "id": 1,
        "validFrom": "2018-01-01",
        "validTill": "2019-01-01",
        "legalTitle": "LEGITIMATE_INTEREST",
        "templateName": "Opravněný zájem",
        "gdprTemplate": 1
      }
    ],
    "originLead": {
      "id": 4,
      "code": "L-18-002",
      "topic": "Můj lead"
    }
  }
}

upravení firmy
POST/api/v2/company/{companyId}/

Upravení dat firmy

Example URI

POST https://app.raynet.cz/api/v2/company/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "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
  }
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "name": {
                    "type":"string",
                    "required":false,
                    "description": "[Název]"
                },
                "person": {
                    "type":"boolean",
                    "required":false,
                    "description": "[Jedná se o fyzickou osobu]"
                },
                "lastName": {
                    "type":"string",
                    "required":true,
                    "description": "[Příjmení fyzické osoby] - povinný v případě, že je aktivní příznak 'Jedná se o fyzickou osobu'"
                },
                "firstName": {
                    "type":"string",
                    "required":false,
                    "description": "[Jméno fyzické osoby]"
                },
                "titleBefore": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul před jménem fyzické osoby]"
                },
                "titleAfter": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul za jménem fyzické osoby]"
                },
                "salutation": {
                    "type":"string",
                    "required":false,
                    "description": "[Oslovení]"
                },                            
                "owner": {
                    "type":"long",
                    "required":false,
                    "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
                },
                "rating": {
                    "enum": [ "A", "B", "C" ]
                    "required":false,
                    "description": "[Rating]"
                },
                "state": {
                    "enum": [ "A_POTENTIAL", "B_ACTUAL", "C_DEFERRED", "D_UNATTRACTIVE" ],
                    "required":false,
                    "description": "[Stav]"
                },
                "role" : {
                    "enum": [ "A_SUBSCRIBER", "B_PARTNER", "C_SUPPLIER", "D_RIVAL" ],
                    "required":false,
                    "description": "[Vztah]"
                },
                "notice": {
                    "type":"string",
                    "required":false,
                    "description": "[Poznámka k firmě]"
                },
                "category": {
                    "type":"long",
                    "required":false,
                    "description" : "[Kategorie] ID záznamu z číselníku CompanyCategory"
                },
                "contactSource": {
                    "type":"long",
                    "required":false,
                    "description" : "[Zdroj kontaktu] ID záznamu z číselníku ContactSource"
                },
                "employeesNumber": {
                    "type":"long",
                    "required":false,
                    "description" : "[Zaměstnanců] ID záznamu z číselníku EmployeesNumber"
                },
                "legalForm": {
                    "type":"long",
                    "required":false,
                    "description" : "[Právní forma] ID záznamu z číselníku LegalForm"
                },
                "paymentTerm": {
                    "type":"long",
                    "required":false,
                    "description" : "[Platbní podmínky] ID záznamu z číselníku PaymentTerm"
                },
                "turnover": {
                    "type":"long",
                    "required":false,
                    "description" : "[Obrat] ID záznamu z číselníku CompanyTurnover"
                },
                "economyActivity": {
                    "type":"long",
                    "required":false,
                    "description" : "[Obor] ID záznamu z číselníku EconomyActivity"
                },
                "companyClassification1": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 1]ID záznamu z číselníku CompanyClassification1"
                },
                "companyClassification2": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 2] ID záznamu z číselníku CompanyClassification2"
                },
                "companyClassification3": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 3] ID záznamu z číselníku CompanyClassification3"
                },
                "regNumber": {
                    "type":"string",
                    "required":false,
                    "description": "[IČ]"
                },
                "taxNumber": {
                    "type":"string",
                    "required":false,
                    "description": "[DIČ]"
                },
                "taxNumber2": {
                    "type":"string",
                    "required":false,
                    "description": "[IČ DPH] Pro slovenské firmy"
                },
                "taxPayer" : {
                    "enum": [ "YES", "NO" ],
                    "required":false,
                    "description": "[Plátce DPH]"
                },
                "bankAccount": {
                    "type":"string",
                    "required":false,
                    "description": "[Bankovní spojení]"
                },
                "socialNetworkContact": {
                        "type":"object",
                        "required":false,
                        "properties":{
                                "facebook": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Facebook]"
                                },
                                "googleplus": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Google+]"
                                },
                                "twitter": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Twitter]"
                                },
                                "linkedin": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Linkedin]"
                                },
                                "pinterest": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Pinterest]"
                                },
                                "instagram": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Instagram]"
                                },
                                "skype": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Skype]"
                                }
                                "youtube": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Youtube]"
                                }
                        }
                },
                "customFields" : {
                    "type": "object",
                    "required":false,
                    "properties" : {
                        "<customFieldKey>": {
                                "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                                "required":false,
                                "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                        }
                    }
                }
            }
Response  200

smazání firmy
DELETE/api/v2/company/{companyId}/

Example URI

DELETE https://app.raynet.cz/api/v2/company/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení firmy

uzamčení firmy
POST/api/v2/company/{companyId}/lock

Uzamčení záznamu klienta pro editaci.

Example URI

POST https://app.raynet.cz/api/v2/company/123/lock
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení firmy

odemčení firmy
POST/api/v2/company/{companyId}/unlock

Odemčení záznamu klienta k editaci.

Example URI

POST https://app.raynet.cz/api/v2/company/123/unlock
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Zneplatnění firmy

zneplatnění firmy
POST/api/v2/company/{companyId}/invalid

Zneplatnění záznamu klienta.

Example URI

POST https://app.raynet.cz/api/v2/company/123/invalid
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obnovit platnost firmy

obnovení platnosti firmy
POST/api/v2/company/{companyId}/valid

Obnovení platnosti záznamu klienta.

Example URI

POST https://app.raynet.cz/api/v2/company/123/valid
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

GDPR anonymize klienta

GDPR anonymize klienta
POST/api/v2/company/{companyId}/anonymize/

U záznamu se provede anonimizace data.

Example URI

POST https://app.raynet.cz/api/v2/company/123/anonymize/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Nová adresa firmy

přidání adresy k firmě
PUT/api/v2/company/{companyId}/address/

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

Example URI

PUT https://app.raynet.cz/api/v2/company/123/address/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "address": {
    "name": "Sídlo firmy",
    "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"
  },
  "territory": 12
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "address": {
      "type": "object",
      "required": true,
      "properties": {
        "name": {
          "type": "string",
          "required": true,
          "description": "[Název]"
        },
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        },
        "lat": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná šířka]"
        },
        "lng": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná délka]"
        }
      }
    },
    "contactInfo": {
      "type": "object",
      "required": false,
      "properties": {
        "email": {
          "type": "string",
          "required": false,
          "description": "[Email]"
        },
        "email2": {
          "type": "string",
          "required": false,
          "description": "[Email2]"
        },
        "fax": {
          "type": "string",
          "required": false,
          "description": "[Fax]"
        },
        "otherContact": {
          "type": "string",
          "required": false,
          "description": "[Jiný kontakt]"
        },
        "tel1Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 1]"
        },
        "tel1": {
          "type": "string",
          "required": false,
          "description": "[Tel 1]"
        },
        "tel2Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 2]"
        },
        "tel2": {
          "type": "string",
          "required": false,
          "description": "[Tel 2]"
        },
        "www": {
          "type": "string",
          "required": false,
          "description": "[WWW]"
        }
      }
    },
    "territory": {
      "type": "long",
      "required": false,
      "description": "[Obchodní teritorium] ID záznamu z číselníku Territory"
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené adresy"
        }
      }
    }
  }
}

Adresy firmy

smazání adresy firmy
DELETE/api/v2/company/{companyId}/address/{addressId}/

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

Example URI

DELETE https://app.raynet.cz/api/v2/company/123/address/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

addressId
Long (required) Example: 123

ID adresy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

upravení adresy firmy
POST/api/v2/company/{companyId}/address/{addressId}/

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

Example URI

POST https://app.raynet.cz/api/v2/company/123/address/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

addressId
Long (required) Example: 123

ID adresy

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "address": {
    "name": "Sídlo firmy",
    "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"
  },
  "territory": 12
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "address": {
      "type": "object",
      "required": true,
      "properties": {
        "name": {
          "type": "string",
          "required": true,
          "description": "[Název]"
        },
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        },
        "lat": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná šířka]"
        },
        "lng": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná délka]"
        }
      }
    },
    "contactInfo": {
      "type": "object",
      "required": false,
      "properties": {
        "email": {
          "type": "string",
          "required": false,
          "description": "[Email]"
        },
        "email2": {
          "type": "string",
          "required": false,
          "description": "[Email2]"
        },
        "fax": {
          "type": "string",
          "required": false,
          "description": "[Fax]"
        },
        "otherContact": {
          "type": "string",
          "required": false,
          "description": "[Jiný kontakt]"
        },
        "tel1Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 1]"
        },
        "tel1": {
          "type": "string",
          "required": false,
          "description": "[Tel 1]"
        },
        "tel2Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 2]"
        },
        "tel2": {
          "type": "string",
          "required": false,
          "description": "[Tel 2]"
        },
        "www": {
          "type": "string",
          "required": false,
          "description": "[WWW]"
        }
      }
    },
    "territory": {
      "type": "long",
      "required": false,
      "description": "[Obchodní teritorium] ID záznamu z číselníku Territory"
    }
  }
}
Response  200

Primární adresa firmy

nastavení primární adresy
POST/api/v2/company/{companyId}/address/{addressId}/setPrimary/

U firmy 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.

Example URI

POST https://app.raynet.cz/api/v2/company/123/address/123/setPrimary/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

addressId
Long (required) Example: 123

ID adresy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Kontaktní adresa firmy

nastavení kontaktní adresy
POST/api/v2/company/{companyId}/address/{addressId}/setContact/

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

Example URI

POST https://app.raynet.cz/api/v2/company/123/address/123/setContact/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

addressId
Long (required) Example: 123

ID adresy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

TAGy

přidání TAGu
PUT/api/v2/company/{companyId}/tag/

Example URI

PUT https://app.raynet.cz/api/v2/company/123/tag/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "tag": "muj tag"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "tag": {
      "type": "string",
      "required": true
    }
  }
}
Response  201

smazání TAGu
DELETE/api/v2/company/{companyId}/tag/

Example URI

DELETE https://app.raynet.cz/api/v2/company/123/tag/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "tag": "muj tag"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "tag": {
      "type": "string",
      "required": true
    }
  }
}
Response  200

Propojení na jiné klienty

Propojení na jiné klienty
GET/api/v2/company/{companyId}/relationship/

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

https://app.raynet.cz/api/v2/company/1/relationship/

Example URI

GET https://app.raynet.cz/api/v2/company/123/relationship/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID firmy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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
          },
          "territory": {
            "id": 90,
            "value": "aaaaaa"
          }
        }
      },
      "companyJoinType": "parent"
    }
  ]
}

přidání propojení na klienta
PUT/api/v2/company/{companyId}/relationship/

Přidání nové vazby klienta na jiného klienta. Vazba může být tří typů - vazba mateřské firmy na dceřinnou (“parent”), dceřinné na mateřskou (“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”).

Example URI

PUT https://app.raynet.cz/api/v2/company/123/relationship/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "companyJoin": 5,
  "companyJoinType": "parent",
  "notice": "Zařazení v rámci holdingu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "companyJoin": {
      "type": " long",
      "required": true,
      "description": "[Klient] ID záznamu klienta, ke kterému bude vazba vytvořena"
    },
    "companyJoinType": {
      "enum": [
        "parent",
        "slave",
        "free"
      ],
      "required": true,
      "description": "[Typ vztahu] Typ vztahu (parent - vztah mateřské firmy na dceřinnou firmu, slave - vztah dceřinné na mateřskou, free - volná vazba)"
    },
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené vazby"
        }
      }
    }
  }
}

Úprava propojení na klienta

upravení propojení na jiného klienta
POST/api/v2/company/{companyId}/relationship/{relationshipId}/

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

Example URI

POST https://app.raynet.cz/api/v2/company/123/relationship/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

relationshipId
Long (required) Example: 123

ID vztahu s jiným klientem

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "notice": "Zařazení v rámci holdingu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    }
  }
}
Response  200

smazání propojení na jiného klienta
DELETE/api/v2/company/{companyId}/relationship/{relationshipId}/

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

Example URI

DELETE https://app.raynet.cz/api/v2/company/123/relationship/123/
URI Parameters
HideShow
companyId
Long (required) Example: 123

ID klienta

relationshipId
Long (required) Example: 123

ID vazby s klientem

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Osoby

API pro práci s osobami.

Seznam osob

seznam osob
GET/api/v2/person/{?offset,limit,sortColumn,sortDirection,owner,firstName,lastName,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,rowInfo.rowAccess,view,withoutGdpr,gdprTemplate,contactInfo.email,contactInfo.email2}

https://app.raynet.cz/api/v2/person/?offset=0&limit=1&firstName[LIKE]=Jan%

Example URI

GET https://app.raynet.cz/api/v2/person/?offset=0&limit=100&sortColumn=firstName&sortDirection=ASC&owner=1&firstName=firstName[LIKE_NOCASE]=mar%&lastName=Novak&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&rowInfo.rowAccess=INVALID&view=rowInfo&withoutGdpr=withoutGdpr[CUSTOM]&gdprTemplate=gdprTemplate[CUSTOM]=1&contactInfo.email=test@test.cz&contactInfo.email2=test@test.cz
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: firstName

Choices: firstName lastName

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

firstName
string (optional) Example: firstName[LIKE_NOCASE]=mar%

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

lastName
string (optional) Example: Novak

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

owner
number (optional) Example: 1

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

primaryRelationship-company-name
string (optional) Example: primaryRelationship-company-name[LIKE]=RAY%

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

primaryRelationship-company-id
long (optional) Example: 1

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

userAccount-id
long (optional) Example: 3

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

contactInfo.email
string (optional) Example: test@test.cz

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

contactInfo.email2
string (optional) Example: test@test.cz

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.rowAccess
string (optional) Example: INVALID

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

gdprTemplate
string (optional) Example: gdprTemplate[CUSTOM]=1

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

withoutGdpr
string (optional) Example: withoutGdpr[CUSTOM]

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2014-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": "2014-06-18 13:19",
      "rowInfo.updatedAt": "2017-09-06 09:43",
      "securityLevel": {
        "id": 1,
        "name": "Sdílená"
      },
      "notice": "poznámka",
      "activeUserAccount": true,
      "keyman": false,
      "tags": [],
      "_version": 19,
      "inlineGdpr": [
        {
          "id": 1,
          "validFrom": "2018-01-01",
          "validTill": "2019-01-01",
          "legalTitle": "LEGITIMATE_INTEREST",
          "templateName": "Opravněný zájem",
          "gdprTemplate": 1
        }
      ]
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nová osoba

založení nové osoby
PUT/api/v2/person/

Example URI

PUT https://app.raynet.cz/api/v2/person/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "titleBefore": "Ing.",
  "firstName": "Marie",
  "lastName": "Vyležíková",
  "titleAfter": "Phd.",
  "owner": 1,
  "category": 96,
  "personClassification1": 97,
  "personClassification2": 98,
  "personClassification3": 99,
  "salutation": "pani",
  "birthday": "2014-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"
  },
  "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
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "titleBefore": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul před]"
                },
                "firstName": {
                    "type":"string",
                    "required":false,
                    "description": "[Jméno]"
                },
                "lastName": {
                    "type":"string",
                    "required":true,
                    "description": "[Příjmení]"
                },
                "titleAfter": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul za]"
                },
                "owner": {
                    "type":"long",
                    "required":false,
                    "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
                },
                "category": {
                    "type":"long",
                    "required":false,
                    "description": "[Kategorie] ID záznamu z číselníku PersonCategory"
                },
                "personClassification1": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 1] ID záznamu z číselníku PersonClassification1"
                },
                "personClassification2": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 2] ID záznamu z číselníku PersonClassification2"
                },
                "personClassification3": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 3] ID záznamu z číselníku PersonClassification3"
                },
                "salutation": {
                    "type":"string",
                    "required":false,
                    "description": "[Oslovení]"
                },
                "birthday": {
                    "type":"string",
                    "required":false,
                    "description": "[Narozeniny]"
                },
                "language": {
                    "type":"long",
                    "required":false,
                    "description": "[Jazyk] ID záznamu z číselníku Language"
                },
                "maritalStatus": {
                    "type":"long",
                    "required":false,
                    "description": "[Rodinný stav] ID záznamu z číselníku MaritalStatus"
                },
                "gender": {
                    "enum": [ "MALE", "FEMALE" ],
                    "required":false,
                    "description": "[Pohlaví]"
                },
                "contactInfo": {
                    "type":"object",
                    "required":false,
                    "properties":{
                            "email": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Email]"
                            },
                            "email2": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Email2]"
                            },
                            "fax": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Fax]"
                            },
                            "otherContact": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Jiný kontakt]"
                            },
                            "tel1Type": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Typ 1]"
                            },
                            "tel1": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Tel 1]"
                            },
                            "tel2Type": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Typ 2]"
                            },
                            "tel2": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Tel 2]"
                            },
                            "www": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[WWW]"
                            }
                    }
                },
                "socialNetworkContact": {
                        "type":"object",
                        "required":false,
                        "properties":{
                                "facebook": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Facebook]"
                                },
                                "googleplus": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Google+]"
                                },
                                "twitter": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Twitter]"
                                },
                                "linkedin": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Linkedin]"
                                },
                                "pinterest": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Pinterest]"
                                },
                                "instagram": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Instagram]"
                                },
                                "skype": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Skype]"
                                },
                                "youtube": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Youtube]"
                                }
                        }
                },
                "privateAddress": {
                    "type":"object",
                    "required":false,
                    "properties":{
                            "street": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Ulice]"
                            },
                            "city": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Město]"
                            },
                            "province": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Kraj]"
                            },
                            "zipCode": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[PSČ]"
                            },
                            "country": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Kód Země]"
                            }
                    }
                },
                "notice": {
                        "type":"string",
                        "required":false,
                        "description": "[Poznámka k osobě]"
                },
                "relationship": {
                    "type":"object",
                    "required":false,
                    "properties":{
                        "company" : {
                            "type":"long",
                            "required":true,
                            "description": "[Firma] ID záznamu firmy Company"
                        },
                        "companyAddress" : {
                            "type":"long",
                            "required":false,
                            "description": "[Adresa] ID záznamu adresy z firmy CompanyAddress"
                        },
                        "notice" : {
                            "type":"string",
                            "required":false,
                            "description": "[Poznámka]"
                        },
                        "type" : {
                            "type":"string",
                            "required":false,
                            "description": "[Pozice]"
                        },
                    }
                },
                "tags" : {
                    "type": "array",
                    "required":false,
                    "items" : {
                        "type":"string",
                        "required":true
                    }
                },
                "keyman": {
                    "type":"boolean",
                    "required":false,
                    "description": "[Klíčová osoba]"
                }
            }
    }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené osoby"
        }
      }
    }
  }
}

Detail osoby

detail osoby
GET/api/v2/person/{personId}/

Získání detailu osoby. V detailu osoby je uvedena osoba se všemi evidovanými údaji včetně všech evidovaných vztahů k jednotlivým firmám. Pokud záznam 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/

Example URI

GET https://app.raynet.cz/api/v2/person/123/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2014-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"
    },
    "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": "2014-06-18 13:19",
    "rowInfo.updatedAt": "2017-09-06 09:43",
    "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,
        "link": "http://www.seznam.cz",
        "linkName": "seznam",
        "file": null
      }
    ],
    "relationships": [
      {
        "id": 1,
        "company": {
          "id": 1,
          "name": "RAYNET s.r.o."
        },
        "companyAddress": {
          "id": 1,
          "name": "Sídlo firmy"
        },
        "notice": null,
        "primary": true,
        "type": "péče o zákazníky"
      }
    ],
    "inlineGdpr": [
      {
        "id": 1,
        "validFrom": "2018-01-01",
        "validTill": "2019-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í osoby
POST/api/v2/person/{personId}/

Upravení dat osoby

Example URI

POST https://app.raynet.cz/api/v2/person/123/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
    "titleBefore": "Ing.",
    "firstName": "Marie",
    "lastName": "Vyležíková",
    "titleAfter": "Phd.",
    "owner": 1,
    "category": 96,
    "personClassification1": 97,
    "personClassification2": 98,
    "personClassification3": 99,
    "salutation": "pani",
    "birthday": "2014-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"
    },
    "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
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "titleBefore": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul před]"
                },
                "firstName": {
                    "type":"string",
                    "required":false,
                    "description": "[Jméno]"
                },
                "lastName": {
                    "type":"string",
                    "required":false,
                    "description": "[Příjmení]"
                },
                "titleAfter": {
                    "type":"string",
                    "required":false,
                    "description": "[Titul za]"
                },
                "owner": {
                    "type":"long",
                    "required":false,
                    "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
                },
                "category": {
                    "type":"long",
                    "required":false,
                    "description": "[Kategorie] ID záznamu z číselníku PersonCategory"
                },
                "personClassification1": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 1] ID záznamu z číselníku PersonClassification1"
                },
                "personClassification2": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 2] ID záznamu z číselníku PersonClassification2"
                },
                "personClassification3": {
                    "type":"long",
                    "required":false,
                    "description": "[Klasifikace 3] ID záznamu z číselníku PersonClassification3"
                },
                "salutation": {
                    "type":"string",
                    "required":false,
                    "description": "[Oslovení]"
                },
                "birthday": {
                    "type":"string",
                    "required":false,
                    "description": "[Narozeniny]"
                },
                "language": {
                    "type":"long",
                    "required":false,
                    "description": "[Jazyk] ID záznamu z číselníku Language"
                },
                "maritalStatus": {
                    "type":"long",
                    "required":false,
                    "description": "[Rodinný stav] ID záznamu z číselníku MaritalStatus"
                },
                "gender": {
                    "enum": [ "MALE", "FEMALE" ],
                    "required":false,
                    "description": "[Pohlaví]"
                },
                "contactInfo": {
                    "type":"object",
                    "required":false,
                    "properties":{
                            "email": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Email]"
                            },
                            "email2": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Email2]"
                            },
                            "fax": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Fax]"
                            },
                            "otherContact": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Jiný kontakt]"
                            },
                            "tel1Type": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Typ 1]"
                            },
                            "tel1": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Tel 1]"
                            },
                            "tel2Type": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Typ 2]"
                            },
                            "tel2": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Tel 2]"
                            },
                            "www": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[WWW]"
                            }
                    }
                },
                "socialNetworkContact": {
                        "type":"object",
                        "required":false,
                        "properties":{
                                "facebook": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Facebook]"
                                },
                                "googleplus": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Google+]"
                                },
                                "twitter": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Twitter]"
                                },
                                "linkedin": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Linkedin]"
                                },
                                "pinterest": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Pinterest]"
                                },
                                "instagram": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Instagram]"
                                },
                                "skype": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Skype]"
                                },
                                "youtube": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Youtube]"
                                }
                        }
                },
                "privateAddress": {
                    "type":"object",
                    "required":false,
                    "properties":{
                            "street": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Ulice]"
                            },
                            "city": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Město]"
                            },
                            "province": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Kraj]"
                            },
                            "zipCode": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[PSČ]"
                            },
                            "country": {
                                    "type":"string",
                                    "required":false,
                                    "description": "[Kód Země]"
                            }
                    }
                },
                "notice": {
                        "type":"string",
                        "required":false,
                        "description": "[Poznámka k osobě]"
                },
                "customFields" : {
                    "type": "object",
                    "required":false,
                    "properties" : {
                        "<customFieldKey>": {
                                "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                                "required":false,
                                "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                        }
                    }
                },
                "keyman": {
                    "type":"boolean",
                    "required":false,
                    "description": "[Klíčová osoba]"
                }
            }
Response  200

smazání osoby
DELETE/api/v2/person/{personId}/

Example URI

DELETE https://app.raynet.cz/api/v2/person/123/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení osoby

uzamčení osoby
POST/api/v2/person/{personId}/lock

Uzamčení záznamu osoby pro editaci.

Example URI

POST https://app.raynet.cz/api/v2/person/123/lock
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení osoby

odemčení osoby
POST/api/v2/person/{personId}/unlock

Odemčení záznamu osoby k editaci.

Example URI

POST https://app.raynet.cz/api/v2/person/123/unlock
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Zneplatnění osoby

zneplatnění osoby
POST/api/v2/person/{personId}/invalid

Zneplatnění záznamu osoby.

Example URI

POST https://app.raynet.cz/api/v2/person/123/invalid
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obnovit platnost osoby

obnovení platnosti osoby
POST/api/v2/person/{personId}/valid

Obnovení platnosti záznamu osoby.

Example URI

POST https://app.raynet.cz/api/v2/person/123/valid
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

GDPR anonymize osoby

GDPR anonymize osoby
POST/api/v2/person/{personId}/anonymize/

U záznamu se provede anonimizace data.

Example URI

POST https://app.raynet.cz/api/v2/person/123/anonymize/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Nový vztah k firmě

přidání vztahu
PUT/api/v2/person/{personId}/relationship/

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

Example URI

PUT https://app.raynet.cz/api/v2/person/123/relationship/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "company": 1,
  "companyAddress": 1,
  "notice": "Podpora pro zákazníky",
  "type": "podpora"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID záznamu firmy Company"
    },
    "companyAddress": {
      "type": "long",
      "required": false,
      "description": "[Adresa] ID záznamu adresy z firmy CompanyAddress"
    },
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "type": {
      "type": "string",
      "required": true,
      "description": "[Pozice]"
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného vztahu"
        }
      }
    }
  }
}

Vztahy k firmě

upravení vztahu
POST/api/v2/person/{personId}/relationship/{relationshipId}/

Example URI

POST https://app.raynet.cz/api/v2/person/123/relationship/123/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

relationshipId
Long (required) Example: 123

ID vztahu s firmou

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "company": 1,
  "companyAddress": 1,
  "notice": "Podpora pro zákazníky",
  "type": "podpora"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID záznamu firmy Company"
    },
    "companyAddress": {
      "type": "long",
      "required": false,
      "description": "[Adresa] ID záznamu adresy z firmy CompanyAddress"
    },
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "type": {
      "type": "string",
      "required": true,
      "description": "[Pozice]"
    }
  }
}
Response  200

smazání vztahu
DELETE/api/v2/person/{personId}/relationship/{relationshipId}/

U osoby s identifikátorem personId bude smazán vztah k firmě s identifikátorem relationshipId.

Example URI

DELETE https://app.raynet.cz/api/v2/person/123/relationship/123/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

relationshipId
Long (required) Example: 123

ID vztahu s firmou

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Primární vztah s firmou

nastavení primárního vztahu s firmou
POST/api/v2/person/{personId}/relationship/{relationshipId}/setPrimary/

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

Example URI

POST https://app.raynet.cz/api/v2/person/123/relationship/123/setPrimary/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

relationshipId
Long (required) Example: 123

ID vztahu s firmou

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

TAGy

přidání TAGu
PUT/api/v2/person/{personId}/tag/

Example URI

PUT https://app.raynet.cz/api/v2/person/123/tag/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "tag": "muj tag"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "tag": {
      "type": "string",
      "required": true
    }
  }
}
Response  201

smazání TAGu
DELETE/api/v2/person/{personId}/tag/

Example URI

DELETE https://app.raynet.cz/api/v2/person/123/tag/
URI Parameters
HideShow
personId
Long (required) Example: 123

ID osoby

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "tag": "muj tag"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "tag": {
      "type": "string",
      "required": true
    }
  }
}
Response  200

Leady

API pro práci s leady.

Seznam leadů

seznam leadů
GET/api/v2/lead/{?offset,limit,sortColumn,sortDirection,code,companyName,lastName,contactInfo.email,contactInfo.email2,regNumber,owner,leadDate,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,gdprTemplate,withoutGdpr,view}

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%

Example URI

GET https://app.raynet.cz/api/v2/lead/?offset=0&limit=100&sortColumn=code&sortDirection=ASC&code=code[LIKE]=L-16-1111%&companyName=companyName[LIKE]=RAY%&lastName=lastName[LIKE]=Nov%&contactInfo.email=novak@raynet.cz&contactInfo.email2=novak@raynet.cz&regNumber=1234567&owner=1&leadDate=2014-06-01&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&gdprTemplate=gdprTemplate[CUSTOM]=1&withoutGdpr=withoutGdpr[CUSTOM]&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: code

Choices: code leadDate priority companyName lastName

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: code[LIKE]=L-16-1111%

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

companyName
string (optional) Example: companyName[LIKE]=RAY%

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

lastName
string (optional) Example: lastName[LIKE]=Nov%

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

contactInfo.email
string (optional) Example: novak@raynet.cz

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

contactInfo.email2
string (optional) Example: novak@raynet.cz

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

regNumber
string (optional) Example: 1234567

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

owner
number (optional) Example: 1

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

leadDate
string (optional) Example: 2014-06-01

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

gdprTemplate
string (optional) Example: gdprTemplate[CUSTOM]=1

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

withoutGdpr
string (optional) Example: withoutGdpr[CUSTOM]

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": true,
  "totalCount": 165,
  "data": [
    {
      "id": 172,
      "code": "Z-16-00011",
      "leadDate": "2016-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",
      "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
      },
      "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": "2016-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,
      "inlineGdpr": [
        {
          "id": 1,
          "validFrom": "2018-01-01",
          "validTill": "2019-01-01",
          "legalTitle": "LEGITIMATE_INTEREST",
          "templateName": "Opravněný zájem",
          "gdprTemplate": 1
        }
      ]
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nový lead

nový lead
PUT/api/v2/lead/

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

Example URI

PUT https://app.raynet.cz/api/v2/lead/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "topic": "Objednávka",
  "priority": "DEFAULT",
  "companyName": "Neteče a nepoteče s.r.o",
  "firstName": "Jan",
  "lastName": "Kapka",
  "owner": 1,
  "note": "Importováno xxxxz webu",
  "category": 91,
  "contactSource": 61,
  "regNumber": "regNumber",
  "notice": "notice",
  "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",
    "web": "nepotece.cz",
    "fax": "+420 123 123 123",
    "otherContact": "Pobočka XY"
  },
  "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"
  ]
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "topic": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "priority": {
      "enum": [
        "MINOR",
        "DEFAULT",
        "CRITICAL"
      ],
      "required": true,
      "description": "[Priorita]"
    },
    "companyName": {
      "type": "string",
      "required": false,
      "description": "[Název společnosti]"
    },
    "regNumber": {
      "type": "string",
      "required": false,
      "description": "[IČ]"
    },
    "firstName": {
      "type": "string",
      "required": false,
      "description": "[Jméno]"
    },
    "lastName": {
      "type": "string",
      "required": false,
      "description": "[Příjmení]"
    },
    "titleBefore": {
      "type": "string",
      "required": false,
      "description": "[Titul před]"
    },
    "titleAfter": {
      "type": "string",
      "required": false,
      "description": "[Titul za]"
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "contactSource": {
      "type": "long",
      "required": false,
      "description": "[Zdroj] ID záznamu z číselníku ContactSource"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku LeadCategory"
    },
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka k leadu]"
    },
    "leadPhase": {
      "type": "long",
      "required": false,
      "description": "[Stav leadu] ID záznamu z číselníku LeadPhase"
    },
    "tags": {
      "type": "string",
      "required": false,
      "description": "[Seznam štítků oddělených čárkou]"
    },
    "territory": {
      "type": "long",
      "required": false,
      "description": "[Teritorium] ID záznamu z číselníku Territory"
    },
    "contactInfo": {
      "type": "object",
      "required": false,
      "properties": {
        "email": {
          "type": "string",
          "required": false,
          "description": "[Email]"
        },
        "email2": {
          "type": "string",
          "required": false,
          "description": "[Email 2]"
        },
        "tel1": {
          "type": "string",
          "required": false,
          "description": "[Tel 1]"
        },
        "tel1Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 1]"
        },
        "tel2": {
          "type": "string",
          "required": false,
          "description": "[Tel 2]"
        },
        "tel2Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 2]"
        },
        "www": {
          "type": "string",
          "required": false,
          "description": "[WWW]"
        },
        "fax": {
          "type": "string",
          "required": false,
          "description": "[Fax]"
        },
        "otherContact": {
          "type": "string",
          "required": false,
          "description": "[Jiný kontakt]"
        }
      }
    },
    "address": {
      "type": "object",
      "required": false,
      "properties": {
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        },
        "lat": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná šířka]"
        },
        "lng": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná délka]"
        }
      }
    },
    "socialNetworkContact": {
      "type": "object",
      "required": false,
      "properties": {
        "facebook": {
          "type": "string",
          "required": false,
          "description": "[Facebook]"
        },
        "googleplus": {
          "type": "string",
          "required": false,
          "description": "[Google+]"
        },
        "twitter": {
          "type": "string",
          "required": false,
          "description": "[Twitter]"
        },
        "linkedin": {
          "type": "string",
          "required": false,
          "description": "[Linkedin]"
        },
        "pinterest": {
          "type": "string",
          "required": false,
          "description": "[Pinterest]"
        },
        "instagram": {
          "type": "string",
          "required": false,
          "description": "[Instagram]"
        },
        "skype": {
          "type": "string",
          "required": false,
          "description": "[Skype]"
        },
        "youtube": {
          "type": "string",
          "required": false,
          "description": "[Youtube]"
        }
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    },
    "notificationMessage": {
      "type": "string",
      "required": false,
      "description": "[Text notifikace]"
    },
    "notificationEmailAddresses": {
      "type": "array",
      "required": false,
      "items": {
        "type": "string",
        "required": true,
        "description": "[Emailová adresa notifikace]"
      }
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného leadu"
        }
      }
    }
  }
}

Detail leadu

detail leadu
GET/api/v2/lead/{leadId}/

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/

Example URI

GET https://app.raynet.cz/api/v2/lead/123/
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID lead

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "data": {
    "id": 8,
    "code": "code",
    "leadDate": "2016-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",
    "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
    },
    "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": "2016-08-26 17:14",
    "rowInfo.createdBy": "seifert@raynet.cz",
    "rowInfo.updatedAt": "2016-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",
    "_version": 6,
    "attachments": [],
    "inlineGdpr": [
      {
        "id": 1,
        "validFrom": "2018-01-01",
        "validTill": "2019-01-01",
        "legalTitle": "LEGITIMATE_INTEREST",
        "templateName": "Opravněný zájem",
        "gdprTemplate": 1
      }
    ]
  }
}

upravení leadu
POST/api/v2/lead/{leadId}/

Upravení dat leadu

Example URI

POST https://app.raynet.cz/api/v2/lead/123/
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID leadu

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "topic": "Objednávka",
  "priority": "DEFAULT",
  "companyName": "Neteče a nepoteče s.r.o",
  "firstName": "Jan",
  "lastName": "Kapka",
  "owner": 1,
  "leadPhase": 105,
  "note": "Importováno xxxxz webu",
  "category": 91,
  "contactSource": 61,
  "regNumber": "regNumber",
  "notice": "notice",
  "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"
  },
  "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"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "topic": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "priority": {
      "enum": [
        "MINOR",
        "DEFAULT",
        "CRITICAL"
      ],
      "required": true,
      "description": "[Priorita]"
    },
    "leadPhase": {
      "type": "long",
      "required": false,
      "description": "[Stav leadu] ID záznamu z číselníku LeadPhase"
    },
    "companyName": {
      "type": "string",
      "required": false,
      "description": "[Název společnosti]"
    },
    "regNumber": {
      "type": "string",
      "required": false,
      "description": "[IČ]"
    },
    "firstName": {
      "type": "string",
      "required": false,
      "description": "[Jméno]"
    },
    "lastName": {
      "type": "string",
      "required": false,
      "description": "[Příjmení]"
    },
    "titleBefore": {
      "type": "string",
      "required": false,
      "description": "[Titul před]"
    },
    "titleAfter": {
      "type": "string",
      "required": false,
      "description": "[Titul za]"
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "contactSource": {
      "type": "long",
      "required": false,
      "description": "[Zdroj] ID záznamu z číselníku ContactSource"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku LeadCategory"
    },
    "notice": {
      "type": "string",
      "required": false,
      "description": "[Poznámka k leadu]"
    },
    "tags": {
      "type": "string",
      "required": false,
      "description": "[Seznam štítků oddělených čárkou]"
    },
    "territory": {
      "type": "long",
      "required": false,
      "description": "[Teritorium] ID záznamu z číselníku Territory"
    },
    "contactInfo": {
      "type": "object",
      "required": false,
      "properties": {
        "email": {
          "type": "string",
          "required": false,
          "description": "[Email]"
        },
        "email2": {
          "type": "string",
          "required": false,
          "description": "[Email 2]"
        },
        "tel1": {
          "type": "string",
          "required": false,
          "description": "[Tel 1]"
        },
        "tel1Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 1]"
        },
        "tel2": {
          "type": "string",
          "required": false,
          "description": "[Tel 2]"
        },
        "tel2Type": {
          "type": "string",
          "required": false,
          "description": "[Typ 2]"
        },
        "www": {
          "type": "string",
          "required": false,
          "description": "[WWW]"
        },
        "fax": {
          "type": "string",
          "required": false,
          "description": "[Fax]"
        },
        "otherContact": {
          "type": "string",
          "required": false,
          "description": "[Jiný kontakt]"
        }
      }
    },
    "address": {
      "type": "object",
      "required": false,
      "properties": {
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        },
        "lat": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná šířka]"
        },
        "lng": {
          "type": "number",
          "required": false,
          "description": "[Zeměpisná délka]"
        }
      }
    },
    "socialNetworkContact": {
      "type": "object",
      "required": false,
      "properties": {
        "facebook": {
          "type": "string",
          "required": false,
          "description": "[Facebook]"
        },
        "googleplus": {
          "type": "string",
          "required": false,
          "description": "[Google+]"
        },
        "twitter": {
          "type": "string",
          "required": false,
          "description": "[Twitter]"
        },
        "linkedin": {
          "type": "string",
          "required": false,
          "description": "[Linkedin]"
        },
        "pinterest": {
          "type": "string",
          "required": false,
          "description": "[Pinterest]"
        },
        "instagram": {
          "type": "string",
          "required": false,
          "description": "[Instagram]"
        },
        "skype": {
          "type": "string",
          "required": false,
          "description": "[Skype]"
        },
        "youtube": {
          "type": "string",
          "required": false,
          "description": "[Youtube]"
        }
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    }
  }
}
Response  200
HideShow
Body
{
    "success": true,
}
Schema
{
    "type": "object",
    "required": true,
    "properties": {
        "success": {
            "type": "boolean",
            "required": true
        }
    }
}

smazání leadu
DELETE/api/v2/lead/{leadId}/

Example URI

DELETE https://app.raynet.cz/api/v2/lead/123/
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID lead

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení leadu

uzamčení leadu
POST/api/v2/lead/{leadId}/lock

Uzamčení záznamu leadu pro editaci.

Example URI

POST https://app.raynet.cz/api/v2/lead/123/lock
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID leadu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení leadu

odemčení leadu
POST/api/v2/lead/{leadId}/unlock

Odemčení záznamu leadu k editaci.

Example URI

POST https://app.raynet.cz/api/v2/lead/123/unlock
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID leadu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

GDPR anonymize leadu

GDPR anonymize leadu
POST/api/v2/lead/{leadId}/anonymize/

U záznamu se provede anonimizace data.

Example URI

POST https://app.raynet.cz/api/v2/lead/123/anonymize/
URI Parameters
HideShow
leadId
Long (required) Example: 123

ID leadu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obchodní případy

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

Seznam OP

seznam OP
GET/api/v2/businessCase/{?offset,limit,sortColumn,sortDirection,name,code,company,project,category,owner,validFrom,validTill,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,rowInfo.rowAccess,view}

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%

Example URI

GET https://app.raynet.cz/api/v2/businessCase/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE]=RAY%&code=OP-15-001&company=1&project=1&category=1&owner=1&validFrom=validFrom[GT]=2014-06-01&validTill=validTill[GT]=2014-06-01&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&rowInfo.rowAccess=INVALID&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: OP-15-001

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

name
string (optional) Example: name[LIKE]=RAY%

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

company
number (optional) Example: 1

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

project
number (optional) Example: 1

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

category
number (optional) Example: 1

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

owner
number (optional) Example: 1

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

validFrom
string (optional) Example: validFrom[GT]=2014-06-01

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

validTill
string (optional) Example: validTill[GT]=2014-06-01

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

containsProduct
number (optional) Example: 21

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

productCategory
number (optional) Example: 21

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

productLine
number (optional) Example: 21

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.rowAccess
string (optional) Example: INVALID

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "totalCount": 1,
  "data": [
    {
      "id": 414,
      "code": "OP-15-0001",
      "name": "První obchodní případ",
      "company": {
        "id": 1093,
        "name": "Firma 1"
      },
      "person": null,
      "owner": {
        "id": 11,
        "fullName": "Ludmila Nováková"
      },
      "currency": {
        "id": 15,
        "value": "Kč"
      },
      "validFrom": "2015-01-19",
      "validTill": "2015-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": "2015-09-18 10:59",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": "2015-09-18 10:59",
      "rowInfo.updatedBy": "konektor@raynet.cz",
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "securityLevel": {
        "id": 1,
        "name": "Sdílená"
      },
      "description": null,
      "tags": []
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nový OP

nový OP
PUT/api/v2/businessCase/

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

Example URI

PUT https://app.raynet.cz/api/v2/businessCase/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "probability": 80,
  "validFrom": "2015-11-08",
  "description": "test",
  "businessCaseClassification1": 93,
  "currency": 17,
  "exchangeRate": 20,
  "businessCasePhase": 3
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "name": {
                    "type":"string",
                    "required":true,
                    "description": "[Předmět]"
                },
                "securityLevel": {
                    "type":"long",
                    "required":false,
                    "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina."
                },
                "owner": {
                    "type":"long",
                    "required":false,
                    "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
                },
                "company": {
                    "type":"long",
                    "required":true,
                    "description": "[Firma] ID firmy, pro kterou je obchodní případ vytvářen"
                },
                "person": {
                    "type":"long",
                    "required":false,
                    "description": "[Osoba] ID osoby zodpovědné za OP na straně klienta"
                },
                "project": {
                    "type":"long",
                    "required":false,
                    "description": "[Projekt] ID projektu na který má být OP připojen"
                },
                "totalAmount": {
                    "type":"number",
                    "required":false,
                    "description": "[Konečná cena] konečná cena OP"
                },
                "estimatedValue": {
                    "type":"number",
                    "required":false,
                    "description": "[Předpokládané náklady] předpokládané náklady na OP"
                },
                "probability": {
                    "type":"int",
                    "required":false,
                    "description": "[Pravděpodobnost] pravděpodobnost na úspěch OP"
                },
                "validFrom": {
                    "type":"date",
                    "required":false,
                    "description": "[Otevřeno od] datum otevřeno od"
                },
                "description": {
                    "type":"string",
                    "required":false,
                    "description": "[Poznámka]"
                },
                "currency": {
                    "type":"long",
                    "required":false,
                    "description": "[Měna] ID záznamu z číselníku Currency"
                },
                "exchangeRate": {
                    "type":"number",
                    "required":false,
                    "description": "[Kurz] kurz pro přepočet na výchozí měnu CRM"
                },
                "category": {
                    "type":"long",
                    "required":false,
                    "description" : "[Kategorie] ID záznamu z číselníku BusinessCaseCategory"
                },
                "source": {
                    "type":"long",
                    "required":false,
                    "description" : "[Zdroj kontaktu] ID záznamu z číselníku ContactSource"
                },
                "businessCaseClassification1": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1"
                },
                "businessCaseClassification2": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2"
                },
                "businessCaseClassification3": {
                    "type":"long",
                    "required":false,
                    "description" : "[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3"
                },
                "businessCasePhase": {
                    "type":"long",
                    "required":false,
                    "description" : "[Stav] ID záznamu z BusinessCasePhase. Pokud nebude vyplněno, založí se OP do prvního stavu."
                },
                "tags": {
                    "type": "array",
                    "required": false,
                    "items" : {
                        "type": "string",
                        "required": true
                    }
                },
                "customFields": {
                    "type": "object",
                    "required":false,
                    "properties" : {
                        "<customFieldKey>": {
                                "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                                "required":false,
                                "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                        }
                    }
                }
            }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného OP"
        }
      }
    }
  }
}

Nový OP s produkty

nový OP s produkty
PUT/api/v2/businessCase/createWithItems

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”).

Example URI

PUT https://app.raynet.cz/api/v2/businessCase/createWithItems
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "Obchodní případ s položkami",
  "company": 2,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "probability": 80,
  "validFrom": "2018-11-04",
  "description": "Popis",
  "currency": 19,
  "items": [
    {
      "productCode": "002",
      "count": 7
    },
    {
      "productCode": "003",
      "priceList": 2,
      "count": 5
    },
    {
      "productCode": "004",
      "name": "Chladící kapalina",
      "price": 250,
      "unit": "litr",
      "taxRate": 21,
      "count": 3
    }
  ]
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "securityLevel": {
      "type": "long",
      "required": false,
      "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina."
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID firmy, pro kterou je obchodní případ vytvářen"
    },
    "person": {
      "type": "long",
      "required": false,
      "description": "[Osoba] ID osoby zodpovědné za OP na straně klienta"
    },
    "totalAmount": {
      "type": "number",
      "required": false,
      "description": "[Konečná cena] konečná cena OP"
    },
    "estimatedValue": {
      "type": "number",
      "required": false,
      "description": "[Předpokládané náklady] předpokládané náklady na OP"
    },
    "probability": {
      "type": "int",
      "required": false,
      "description": "[Pravděpodobnost] pravděpodobnost na úspěch OP"
    },
    "validFrom": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum otevřeno od"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "currency": {
      "type": "long",
      "required": false,
      "description": "[Měna] ID záznamu z číselníku Currency"
    },
    "exchangeRate": {
      "type": "number",
      "required": false,
      "description": "[Kurz] kurz pro přepočet na výchozí měnu CRM"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku BusinessCaseCategory"
    },
    "source": {
      "type": "long",
      "required": false,
      "description": "[Zdroj kontaktu] ID záznamu z číselníku ContactSource"
    },
    "businessCaseClassification1": {
      "type": "long",
      "required": false,
      "description": "[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1"
    },
    "businessCaseClassification2": {
      "type": "long",
      "required": false,
      "description": "[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2"
    },
    "businessCaseClassification3": {
      "type": "long",
      "required": false,
      "description": "[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3"
    },
    "tags": {
      "type": "array",
      "required": false,
      "items": {
        "type": "string",
        "required": true
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    },
    "items": {
      "type": "array",
      "required": false,
      "minItems": 1,
      "items": {
        "type": "object",
        "required": true,
        "properties": {
          "productCode": {
            "type": "string",
            "required": false,
            "description": "[Kód produktu] Na základě zadaného kódu se dohledá produkt (nebo založí nový). Položka OP se pak vytvoří s tímto produktem."
          },
          "product": {
            "type": "number",
            "required": false,
            "description": "[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
          },
          "priceList": {
            "type": "number",
            "required": false,
            "description": "[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": {
            "type": "string",
            "required": true,
            "description": "[Název] Povinná hodnota pro nekategorizovaný produkt nebo v případě, že se produkt bude zakládat nový (kód není dohledán v exisujících produktech)."
          },
          "price": {
            "type": "number",
            "required": false,
            "description": "[Prodejní cena]"
          },
          "taxRate": {
            "type": "number",
            "required": false,
            "description": "[Daň]"
          },
          "count": {
            "type": "int",
            "required": false,
            "description": "[Množství]"
          },
          "discountPercent": {
            "type": "number",
            "required": false,
            "description": "[Sleva]"
          },
          "cost": {
            "type": "number",
            "required": false,
            "description": "[Náklady] Náklad za kus"
          },
          "unit": {
            "type": "string",
            "required": false,
            "description": "[Jednotka]"
          },
          "description": {
            "type": "string",
            "required": false,
            "description": "[Poznámka]"
          }
        }
      }
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného OP"
        }
      }
    }
  }
}

Detail OP

detail OP
GET/api/v2/businessCase/{businessCaseId}/

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/

Example URI

GET https://app.raynet.cz/api/v2/businessCase/123/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodního případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "$"
    },
    "validFrom": "2015-10-02",
    "validTill": null,
    "scheduledEnd": null,
    "totalAmount": 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": "2014-10-02 13:17",
    "rowInfo.createdBy": "konektor@raynet.cz",
    "rowInfo.updatedAt": "2014-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,
        "unit": "ks",
        "discountPercent": 0,
        "count": 1
      }
    ]
  }
}

upravení OP
POST/api/v2/businessCase/{businessCaseId}/

Upravení dat obchodního případu

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodniho pripadu

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "probability": 80,
  "validFrom": "2015-11-08",
  "validTill": "2015-11-10",
  "description": "test",
  "businessCaseClassification1": 93,
  "currency": 17,
  "exchangeRate": 20,
  "customFields": {
    "Popis_prio_c49d5": ""
  }
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
            "name": {
                "type":"string",
                "required":true,
                "description": "[Předmět]"
            },
            "businessCasePhase": {
                "type": long,
                "required":false,
                "description" : "[Stav] ID záznamu z číselníku BusinessCasePhase"
            },
            "securityLevel": {
                "type":"long",
                "required":false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna, je nastavena výchozí bezpečnostní skupina."
            },
            "owner": {
                "type":"long",
                "required":false,
                "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
            },
            "company": {
                "type":"long",
                "required":true,
                "description": "[Firma] ID firmy, pro kterou je obchodní případ vytvářen"
            },
            "person": {
                "type":"long",
                "required":false,
                "description": "[Osoba] ID osoby zodpovědné za OP na straně klienta"
            },
            "project": {
                "type":"long",
                "required":false,
                "description": "[Projekt] ID projektu na který má být OP připojen"
            },
            "totalAmount": {
                "type":"number",
                "required":false,
                "description": "[Konečná cena] konečná cena OP"
            },
            "estimatedValue": {
                "type":"number",
                "required":false,
                "description": "[Předpokládané náklady] předpokládané náklady na OP"
            },
            "probability": {
                "type":"int",
                "required":false,
                "description": "[Pravděpodobnost] pravděpodobnost na úspěch OP"
            },
            "validFrom": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum otevřeno od"
            },
            "validTill": {
                "type":"date",
                "required":false,
                "description": "[Uzavřeno] datum uzavření OP"
            },
            "description": {
                "type":"string",
                "required":false,
                "description": "[Poznámka]"
            },
            "currency": {
                "type":"long",
                "required":false,
                "description": "[Měna] ID z áznamu z číselníku Currency"
            },
            "exchangeRate": {
                "type":"number",
                "required":false,
                "description": "[Kurz] kurz pro přepočet na výchozí měnu CRM"
            },
            "category": {
                "type":"long",
                "required":false,
                "description" : "[Kategorie] ID záznamu z číselníku BusinessCaseCategory"
            },
            "source": {
                "type":"long",
                "required":false,
                "description" : "[Zdroj kontaktu] ID záznamu z číselníku ContactSource"
            },
            "businessCaseClassification1": {
                "type":"long",
                "required":false,
                "description" : "[Klasifikace 1] ID záznamu z číselníku BusinessCaseClassification1"
            },
            "businessCaseClassification2": {
                "type":"long",
                "required":false,
                "description" : "[Klasifikace 2] ID záznamu z číselníku BusinessCaseClassification2"
            },
            "businessCaseClassification3": {
                "type":"long",
                "required":false,
                "description" : "[Klasifikace 3] ID záznamu z číselníku BusinessCaseClassification3"
            },
            "tags": {
                "type": "array",
                "required": false,
                "items" : {
                    "type": "string",
                    "required": true
                }
            },
            "customFields": {
                "type": "object",
                "required":false,
                "properties" : {
                    "<customFieldKey>": {
                            "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                            "required":false,
                            "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                    }
                }
            }
        }
    }
Response  200

smazání OP
DELETE/api/v2/businessCase/{businessCaseId}/

Example URI

DELETE https://app.raynet.cz/api/v2/businessCase/123/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodní případy

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení OP

uzamčení OP
POST/api/v2/businessCase/{businessCaseId}/lock

Uzamčení záznamu OP pro editaci.

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/lock
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obch. případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení OP

odemčení OP
POST/api/v2/businessCase/{businessCaseId}/unlock

Odemčení záznamu OP k editaci.

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/unlock
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obch. případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Zneplatnění OP

zneplatnění OP
POST/api/v2/businessCase/{businessCaseId}/invalid

Zneplatnění záznamu OP.

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/invalid
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obch. případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obnovit platnost OP

obnovení platnosti OP
POST/api/v2/businessCase/{businessCaseId}/valid

Obnovení platnosti záznamu OP.

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/valid
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obch. případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Export OP do PDF

export OP do PDF
GET/api/v2/businessCase/{businessCaseId}/pdfExport{?locale}

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

Example URI

GET https://app.raynet.cz/api/v2/businessCase/123/pdfExport?locale=en
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obch. případu

locale
String (optional) Example: en

Jazyk exportovaného obch. případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  "fileName": "OP-17-001.pdf",
  "contentType": "application/octet-stream",
  "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  "instanceName": "mojecrm"
}

Přidání položek OP

přidání položek OP
PUT/api/v2/businessCase/{businessCaseId}/item/

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/

Example URI

PUT https://app.raynet.cz/api/v2/businessCase/123/item/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodního případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "productCode": "A001",
  "priceList": 2,
  "count": 2,
  "price": 123,
  "taxRate": 21,
  "discountPercent": 10.5,
  "cost": 10,
  "description": "poznamka k produktu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "productCode": {
      "type": "string",
      "required": false,
      "description": "[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "product": {
      "type": "number",
      "required": false,
      "description": "[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "priceList": {
      "type": "number",
      "required": false,
      "description": "[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": {
      "type": "string",
      "required": true,
      "description": "[Název] Povinná hodnota pouze pro nekategorizovaný produkt"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena]"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň]"
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství]"
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva]"
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka]"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    }
  }
}
Response  201

Položky OP

upravení položky OP
POST/api/v2/businessCase/{businessCaseId}/item/{businessCaseItemId}/

Upravení položky na OP

https://app.raynet.cz/api/v2/businessCase/1/item/2/

Example URI

POST https://app.raynet.cz/api/v2/businessCase/123/item/123/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodní případy

businessCaseItemId
Long (required) Example: 123

ID položky obchodního případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "name": "produkt 1",
  "price": 123,
  "taxRate": 21,
  "count": 2,
  "discountPercent": 10.5,
  "cost": 10,
  "unit": "ks",
  "description": "poznamka k produktu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název]"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena]"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň]"
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství]"
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva]"
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka]"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    }
  }
}
Response  200

smazání položky OP
DELETE/api/v2/businessCase/{businessCaseId}/item/{businessCaseItemId}/

Smazání položky na OP

https://app.raynet.cz/api/v2/businessCase/1/item/2/

Example URI

DELETE https://app.raynet.cz/api/v2/businessCase/123/item/123/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodní případy

businessCaseItemId
Long (required) Example: 123

ID položky obchodního případu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Seznam participantů OP

seznam participantů OP
GET/api/v2/businessCase/participants/{?offset,limit,sortColumn,sortDirection,note,company,company-name,person,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

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ů.

Example URI

GET https://app.raynet.cz/api/v2/businessCase/participants/?offset=0&limit=100&sortColumn=id&sortDirection=ASC&note=note[LIKE]=Pozor%&company=3&company-name=company-name[LIKE]=RAY%&person=person[EQ]=3&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: id

Choices: id company.id company.name person.id person.lastName businessCase.id businessCase.code note

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

note
string (optional) Example: note[LIKE]=Pozor%

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

company
string (optional) Example: 3

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

company-name
number (optional) Example: company-name[LIKE]=RAY%

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

person
string (optional) Example: person[EQ]=3

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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",
      "rowInfo.createdAt": "2017-09-29 13:46",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": null,
      "rowInfo.updatedBy": null,
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "_version": 0
    }
  ]
}

Nový participant

nový participant
PUT/api/v2/businessCase/{businessCaseId}/participants/

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

Example URI

PUT https://app.raynet.cz/api/v2/businessCase/123/participants/
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodního případu

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "company": 1,
  "note": "Poznámka k participantovi"
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
                "company": {
                        "type":"long",
                        "required":false,
                        "description": "[Klient] ID záznamu klienta"
                },
                "person": {
                        "type":"long",
                        "required":false,
                        "description": "[Osoba] ID záznamu osoby"
                }
                "note": {
                        "type":"string",
                        "required":false,
                        "description": "[Poznámka]"
                }
        }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného participanta"
        }
      }
    }
  }
}

Smazání participanta

smazání participanta
DELETE/api/v2/businessCase/{businessCaseId}/participants/{participantId}

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

Example URI

DELETE https://app.raynet.cz/api/v2/businessCase/123/participants/321
URI Parameters
HideShow
businessCaseId
Long (required) Example: 123

ID obchodního případu

participantId
Long (required) Example: 321

ID participanta

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Nabídky

API pro práci s nabídkami.

Seznam nabídek

seznam nabídek
GET/api/v2/offer/{?offset,limit,sortColumn,sortDirection,name,code,company,person,businessCase,owner,expirationDate,validFrom,validTill,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,rowInfo.rowAccess,view}

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%

Example URI

GET https://app.raynet.cz/api/v2/offer/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE]=RAY%&code=NAB-15-001&company=1&person=1&businessCase=1&owner=1&expirationDate=expirationDate[GT]=2014-06-01&validFrom=validFrom[GT]=2014-06-01&validTill=validTill[GT]=2014-06-01&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&rowInfo.rowAccess=INVALID&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: NAB-15-001

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

name
string (optional) Example: name[LIKE]=RAY%

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

company
number (optional) Example: 1

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

person
number (optional) Example: 1

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

businessCase
number (optional) Example: 1

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

owner
number (optional) Example: 1

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

expirationDate
string (optional) Example: expirationDate[GT]=2014-06-01

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

validFrom
string (optional) Example: validFrom[GT]=2014-06-01

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

validTill
string (optional) Example: validTill[GT]=2014-06-01

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.rowAccess
string (optional) Example: INVALID

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "totalCount": 1,
  "data": [
    {
      "id": 115,
      "code": "NAB-17-001",
      "name": "První nabídka",
      "company": {
        "id": 1093,
        "name": "Firma 1"
      },
      "person": null,
      "businessCase": {
        "id": 4,
        "code": "OP-17-001"
      },
      "owner": {
        "id": 11,
        "fullName": "Ludmila Nováková"
      },
      "currency": {
        "id": 15,
        "value": "Kč"
      },
      "validFrom": "2015-01-19",
      "validTill": "2015-01-21",
      "expirationDate": "2015-08-21",
      "totalAmount": 3797.01,
      "estimatedValue": 0,
      "status": "B_ACTIVE",
      "offerStatus": {
        "id": 45,
        "value": "Příprava"
      },
      "category": {
        "id": 96,
        "value": "Obchod morava"
      },
      "rowInfo.createdAt": "2015-09-18 10:59",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": "2015-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"
      ]
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nová nabídka

nová nabídka
PUT/api/v2/offer/

Založení nové nabídky

Example URI

PUT https://app.raynet.cz/api/v2/offer/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "businessCase": 1,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "validFrom": "2015-11-08",
  "description": "test",
  "offerStatus": 35
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
            "name": {
                "type":"string",
                "required":true,
                "description": "[Předmět]"
            },
            "securityLevel": {
                "type":"long",
                "required":false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
            },
            "owner": {
                "type":"long",
                "required":false,
                "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
            },
            "company": {
                "type":"long",
                "required":true,
                "description": "[Firma] ID firmy, pro kterou je nabídka vytvářena"
            },
            "person": {
                "type":"long",
                "required":false,
                "description": "[Osoba] ID zodp. osoby klienta pro kterou je nabídka vytvářena"
            },
            "businessCase": {
                "type":"long",
                "required":true,
                "description": "[OP] ID obch. případu nabídky"
            },
            "totalAmount": {
                "type":"number",
                "required":false,
                "description": "[Konečná cena] konečná cena nabídky"
            },
            "estimatedValue": {
                "type":"number",
                "required":false,
                "description": "[Předpokládané náklady] předpokládané náklady v nabídce"
            },
            "validFrom": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum vytvoření nabídky"
            },
            "validTill": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum uzavření nabídky"
            },
            "expirationDate": {
                "type":"date",
                "required":false,
                "description": "[Konec platnosti] konec platnosti nabídky"
            },
            "description": {
                "type":"string",
                "required":false,
                "description": "[Poznámka]"
            },
            "category": {
                "type":"long",
                "required":false,
                "description" : "[Kategorie] ID záznamu z číselníku OfferCategory"
            },
            "offerStatus": {
                "type":"long",
                "required":false,
                "description" : "[Stav] ID záznamu z OfferStatus. Pokud nebude vyplněno, založí se nabídka do prvního stavu."
            }
        }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené nabídky"
        }
      }
    }
  }
}

Detail nabídky

detail nabídky
GET/api/v2/offer/{offerId}/

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/

Example URI

GET https://app.raynet.cz/api/v2/offer/123/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "data": {
    "id": 115,
    "code": "NAB-17-001",
    "name": "První nabídka",
    "company": {
      "id": 1093,
      "name": "Firma 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": "2015-01-19",
    "validTill": "2015-01-21",
    "expirationDate": "2015-08-21",
    "totalAmount": 3797.01,
    "estimatedValue": 0,
    "status": "B_ACTIVE",
    "offerStatus": {
      "id": 45,
      "value": "Příprava"
    },
    "category": {
      "id": 96,
      "value": "Obchod morava"
    },
    "rowInfo.createdAt": "2015-09-18 10:59",
    "rowInfo.createdBy": "konektor@raynet.cz",
    "rowInfo.updatedAt": "2015-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,
        "unit": "ks",
        "discountPercent": 0,
        "count": 1
      }
    ]
  }
}

upravení nabídky
POST/api/v2/offer/{offerId}/

Upravení dat nabídky.

Example URI

POST https://app.raynet.cz/api/v2/offer/123/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "businessCase": 1,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "validFrom": "2015-11-08",
  "description": "test",
  "customFields": {
    "Popis_prio_c49d5": ""
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "securityLevel": {
      "type": "long",
      "required": false,
      "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID firmy, pro kterou je nabídka vytvářena"
    },
    "person": {
      "type": "long",
      "required": false,
      "description": "[Osoba] ID zodp. osoby klienta pro kterou je nabídka vytvářena"
    },
    "businessCase": {
      "type": "long",
      "required": true,
      "description": "[OP] ID obch. případu nabídky"
    },
    "totalAmount": {
      "type": "number",
      "required": false,
      "description": "[Konečná cena] konečná cena nabídky"
    },
    "estimatedValue": {
      "type": "number",
      "required": false,
      "description": "[Předpokládané náklady] předpokládané náklady v nabídce"
    },
    "validFrom": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum vytvoření nabídky"
    },
    "validTill": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum uzavření nabídky"
    },
    "expirationDate": {
      "type": "date",
      "required": false,
      "description": "[Konec platnosti] konec platnosti nabídky"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku OfferCategory"
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    }
  }
}
Response  200

smazání nabídky
DELETE/api/v2/offer/{offerId}/

Example URI

DELETE https://app.raynet.cz/api/v2/offer/123/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení nabídky

uzamčení nabídky
POST/api/v2/offer/{offerId}/lock

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

Example URI

POST https://app.raynet.cz/api/v2/offer/123/lock
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení nabídky

odemčení nabídky
POST/api/v2/offer/{offerId}/unlock

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

Example URI

POST https://app.raynet.cz/api/v2/offer/123/unlock
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Zneplatnění nabídky

zneplatnění nabídky
POST/api/v2/offer/{offerId}/invalid

Zneplatnění záznamu nabídky.

Example URI

POST https://app.raynet.cz/api/v2/offer/123/invalid
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obnovit platnost nabídky

obnovení platnosti nabídky
POST/api/v2/offer/{offerId}/valid

Obnovení platnosti záznamu nabídky.

Example URI

POST https://app.raynet.cz/api/v2/offer/123/valid
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Export nabídky do PDF

export nabídky do PDF
GET/api/v2/offer/{offerId}/pdfExport{?locale}

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

Example URI

GET https://app.raynet.cz/api/v2/offer/123/pdfExport?locale=en
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

locale
String (optional) Example: en

Jazyk exportované nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  "fileName": "NAB-17-001.pdf",
  "contentType": "application/octet-stream",
  "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  "instanceName": "mojecrm"
}

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

přidání položek nabídky
PUT/api/v2/offer/{offerId}/item/

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/

Example URI

PUT https://app.raynet.cz/api/v2/offer/123/item/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "productCode": "A001",
  "priceList": 2,
  "count": 2,
  "price": 123,
  "taxRate": 21,
  "discountPercent": 10.5,
  "cost": 10,
  "description": "poznamka k produktu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "productCode": {
      "type": "string",
      "required": false,
      "description": "[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "product": {
      "type": "number",
      "required": false,
      "description": "[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "priceList": {
      "type": "number",
      "required": false,
      "description": "[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": {
      "type": "string",
      "required": true,
      "description": "[Název] Povinná hodnota pouze pro nekategorizovaný produkt"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    },
    "priceListItem": {
      "type": "long",
      "required": false,
      "description": "[Položka ceníku] ID položky ceníku"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň] "
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství] "
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva] "
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka] "
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka] "
    }
  }
}
Response  201

Položky nabídky

upravení položky nabídky
POST/api/v2/offer/{offerId}/item/{offerItemId}/

Upravení položky na nabídce.

https://app.raynet.cz/api/v2/offer/1/item/2/

Example URI

POST https://app.raynet.cz/api/v2/offer/123/item/123/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

offerItemId
Long (required) Example: 123

ID položky nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "name": "produkt 1",
  "price": 123,
  "taxRate": 21,
  "count": 2,
  "discountPercent": 10.5,
  "cost": 10,
  "unit": "ks",
  "description": "poznamka k nabidce"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název] "
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    },
    "priceListItem": {
      "type": "long",
      "required": false,
      "description": "[Položka ceníku] ID položky ceníku"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň] "
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství] "
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva] "
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka] "
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka] "
    }
  }
}
Response  200

smazání položky nabídky
DELETE/api/v2/offer/{offerId}/item/{offerItemId}/

Smazání položky na nabídkce

https://app.raynet.cz/api/v2/offer/1/item/2/

Example URI

DELETE https://app.raynet.cz/api/v2/offer/123/item/123/
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

offerItemId
Long (required) Example: 123

ID položky nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Synchronizace nabídky

synchronizace nabídky s obchodním případem
POST/api/v2/offer/{offerId}/sync

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.

Example URI

POST https://app.raynet.cz/api/v2/offer/123/sync
URI Parameters
HideShow
offerId
Long (required) Example: 123

ID nabídky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "TranslatedApplicationException",
  "translatedMessage": "Nelze synchronizovat, protože obchodní případ je evidován v jiné měně."
}

Objednávky

API pro práci s objednávkami.

Seznam objednávek

seznam objednávek
GET/api/v2/salesOrder/{?offset,limit,sortColumn,sortDirection,name,code,company,person,businessCase,owner,expirationDate,requestDeliveryDate,validFrom,validTill,rowInfo.rowAccess,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

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

https://app.raynet.cz/api/v2/salesOrder/?offset=0&limit=1&name[LIKE]=RAY%

Example URI

GET https://app.raynet.cz/api/v2/salesOrder/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE]=RAY%&code=OP-15-001&company=1&person=1&businessCase=1&owner=1&expirationDate=expirationDate[GT]=2014-06-01&requestDeliveryDate=requestDeliveryDate[GT]=2014-06-01&validFrom=validFrom[GT]=2014-06-01&validTill=validTill[GT]=2014-06-01&rowInfo.rowAccess=INVALID&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: OP-15-001

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

name
string (optional) Example: name[LIKE]=RAY%

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

company
number (optional) Example: 1

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

person
number (optional) Example: 1

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

businessCase
number (optional) Example: 1

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

owner
number (optional) Example: 1

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

expirationDate
string (optional) Example: expirationDate[GT]=2014-06-01

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

requestDeliveryDate
string (optional) Example: requestDeliveryDate[GT]=2014-06-01

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

validFrom
string (optional) Example: validFrom[GT]=2014-06-01

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

validTill
string (optional) Example: validTill[GT]=2014-06-01

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.rowAccess
string (optional) Example: INVALID

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "totalCount": 1,
  "data": [
    {
      "id": 115,
      "code": "OBJ-17-001",
      "name": "První objednávka",
      "company": {
        "id": 1093,
        "name": "Firma 1"
      },
      "person": null,
      "businessCase": {
        "id": 4,
        "code": "OP-17-001"
      },
      "offer": {
        "id": 8,
        "code": "NAB-17-001"
      },
      "owner": {
        "id": 11,
        "fullName": "Ludmila Nováková"
      },
      "currency": {
        "id": 15,
        "value": "Kč"
      },
      "validFrom": "2015-01-19",
      "validTill": "2015-01-21",
      "expirationDate": "2015-08-21",
      "requestDeliveryDate": "2015-09-21",
      "totalAmount": 3797.01,
      "estimatedValue": 0,
      "status": "B_ACTIVE",
      "salesOrderStatus": {
        "id": 45,
        "value": "Příprava"
      },
      "category": {
        "id": 96,
        "value": "Obchod morava"
      },
      "rowInfo.createdAt": "2015-09-18 10:59",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": "2015-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"
      ]
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nová objednávka

nová objednávka
PUT/api/v2/salesOrder/

Založení nové objednávky

Example URI

PUT https://app.raynet.cz/api/v2/salesOrder/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "businessCase": 1,
  "offer": 4,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "validFrom": "2015-11-08",
  "description": "test",
  "salesOrderStatus": 74
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
            "name": {
                "type":"string",
                "required":true,
                "description": "[Předmět]"
            },
            "securityLevel": {
                "type":"long",
                "required":false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
            },
            "owner": {
                "type":"long",
                "required":false,
                "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
            },
            "company": {
                "type":"long",
                "required":true,
                "description": "[Firma] ID firmy, pro kterou je objednávka vytvářena"
            },
            "person": {
                "type":"long",
                "required":false,
                "description": "[Osoba] ID osoby zodpovědné za OP na straně klienta"
            },
            "businessCase": {
                "type":"long",
                "required":true,
                "description": "[OP] ID obch. případu objednávky"
            },
            "offer": {
                "type":"long",
                "required":false,
                "description": "[OP] ID nabídky, na kterou je objednávka napojena"
            },
            "totalAmount": {
                "type":"number",
                "required":false,
                "description": "[Konečná cena] konečná cena objednávky"
            },
            "estimatedValue": {
                "type":"number",
                "required":false,
                "description": "[Předpokládané náklady] předpokládané náklady v nabídce"
            },
            "validFrom": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum vytvoření objednávky"
            },
            "validTill": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum uzavření objednávky"
            },
            "expirationDate": {
                "type":"date",
                "required":false,
                "description": "[Konec platnosti] konec platnosti objednávky"
            },
            "requestDeliveryDate": {
                "type":"date",
                "required":false,
                "description": "[Dodat do] datum dodání"
            },
            "description": {
                "type":"string",
                "required":false,
                "description": "[Poznámka]"
            },
            "category": {
                "type":"long",
                "required":false,
                "description" : "[Kategorie] ID záznamu z číselníku SalesOrderCategory"
            },
            "salesOrderStatus": {
                "type":"long",
                "required":false,
                "description" : "[Stav] ID záznamu z SalesOrderStatus. Pokud nebude vyplněno, založí se objednávka do prvního stavu."
            }
        }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založené objednávky"
        }
      }
    }
  }
}

Detail objednávky

detail objednávky
GET/api/v2/salesOrder/{salesOrderId}/

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

https://app.raynet.cz/api/v2/salesOrder/1/

Example URI

GET https://app.raynet.cz/api/v2/salesOrder/123/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "data": {
    "id": 115,
    "code": "OBJ-17-001",
    "name": "První objednávka",
    "company": {
      "id": 1093,
      "name": "Firma 1"
    },
    "person": null,
    "businessCase": {
      "id": 4,
      "code": "OP-17-001"
    },
    "offer": {
      "id": 8,
      "code": "NAB-17-001"
    },
    "owner": {
      "id": 11,
      "fullName": "Ludmila Nováková"
    },
    "currency": {
      "id": 15,
      "value": "Kč"
    },
    "exchangeRate": 1,
    "validFrom": "2015-01-19",
    "validTill": "2015-01-21",
    "expirationDate": "2015-08-21",
    "requestDeliveryDate": "2015-09-21",
    "totalAmount": 3797.01,
    "estimatedValue": 0,
    "status": "B_ACTIVE",
    "salesOrderStatus": {
      "id": 45,
      "value": "Příprava"
    },
    "category": {
      "id": 96,
      "value": "Obchod morava"
    },
    "rowInfo.createdAt": "2015-09-18 10:59",
    "rowInfo.createdBy": "konektor@raynet.cz",
    "rowInfo.updatedAt": "2015-09-18 10:59",
    "rowInfo.updatedBy": "konektor@raynet.cz",
    "rowInfo.rowAccess": null,
    "rowInfo.rowState": null,
    "securityLevel": {
      "id": 1,
      "name": "Sdílená"
    },
    "description": "text",
    "deliveryAddress": {
      "name": "RAYNET Praha s.r.o.",
      "city": "Praha",
      "country": "Česká republika",
      "countryCode": "CZ",
      "province": "Praha",
      "street": "Albertov 2038/6",
      "zipCode": "128 00"
    },
    "invoiceAddress": {
      "name": "RAYNET s.r.o.",
      "city": "Ostrava-Poruba",
      "country": "Česká republika",
      "countryCode": "CZ",
      "province": "Moravskoslezský kraj",
      "street": "Francouzská 6167/5",
      "zipCode": "708 00"
    },
    "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,
        "unit": "ks",
        "discountPercent": 0,
        "count": 1
      }
    ]
  }
}

upravení objednávky
POST/api/v2/salesOrder/{salesOrderId}/

Upravení dat objednávky.

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "test",
  "company": 1,
  "businessCase": 1,
  "offer": 4,
  "owner": 3,
  "totalAmount": 123.5,
  "estimatedValue": 11,
  "validFrom": "2015-11-08",
  "description": "test",
  "salesOrderStatus": 54,
  "deliveryAddress": {
    "name": "RAYNET Praha s.r.o.",
    "city": "Praha",
    "country": "CZ",
    "province": "Praha",
    "street": "Albertov 2038/6",
    "zipCode": "128 00"
  },
  "invoiceAddress": {
    "name": "RAYNET s.r.o.",
    "city": "Ostrava-Poruba",
    "country": "CZ",
    "province": "Moravskoslezský kraj",
    "street": "Francouzská 6167/5",
    "zipCode": "708 00"
  },
  "customFields": {
    "Popis_prio_c49d5": ""
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "securityLevel": {
      "type": "long",
      "required": false,
      "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID firmy, pro kterou je objednávka vytvářena"
    },
    "person": {
      "type": "long",
      "required": false,
      "description": "[Osoba] ID osoby zodpovědné za OP na straně klienta"
    },
    "businessCase": {
      "type": "long",
      "required": true,
      "description": "[OP] ID obch. případu objednávky"
    },
    "offer": {
      "type": "long",
      "required": false,
      "description": "[OP] ID nabídky, na kterou je objednávka napojena"
    },
    "totalAmount": {
      "type": "number",
      "required": false,
      "description": "[Konečná cena] konečná cena objednávky"
    },
    "salesOrderStatus": {
      "type": "number",
      "required": false,
      "description": "[Stav] ID stavu objednávky (z číselníku salesOrderStatus)"
    },
    "estimatedValue": {
      "type": "number",
      "required": false,
      "description": "[Předpokládané náklady] předpokládané náklady v nabídce"
    },
    "validFrom": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum vytvoření objednávky"
    },
    "validTill": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum uzavření objednávky"
    },
    "expirationDate": {
      "type": "date",
      "required": false,
      "description": "[Konec platnosti] konec platnosti objednávky"
    },
    "requestDeliveryDate": {
      "type": "date",
      "required": false,
      "description": "[Dodat do] datum dodání"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku SalesOrderCategory"
    },
    "deliveryAddress": {
      "type": "object",
      "required": false,
      "description": "[Dodací adresa]",
      "properties": {
        "name": {
          "type": "string",
          "required": false,
          "description": "[Název] Klienta / Dodací adresy"
        },
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        }
      }
    },
    "invoiceAddress": {
      "type": "object",
      "required": false,
      "description": "[Fakturační adresa]",
      "properties": {
        "name": {
          "type": "string",
          "required": false,
          "description": "[Název] Klienta / Fakturační adresy"
        },
        "street": {
          "type": "string",
          "required": false,
          "description": "[Ulice]"
        },
        "city": {
          "type": "string",
          "required": false,
          "description": "[Město]"
        },
        "province": {
          "type": "string",
          "required": false,
          "description": "[Kraj]"
        },
        "zipCode": {
          "type": "string",
          "required": false,
          "description": "[PSČ]"
        },
        "country": {
          "type": "string",
          "required": false,
          "description": "[Kód Země]"
        }
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    }
  }
}
Response  200

smazání objednávky
DELETE/api/v2/salesOrder/{salesOrderId}/

Example URI

DELETE https://app.raynet.cz/api/v2/salesOrder/123/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení objednávky

uzamčení objednávky
POST/api/v2/salesOrder/{salesOrderId}/lock

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

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/lock
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení objednávky

odemčení objednávky
POST/api/v2/salesOrder/{salesOrderId}/unlock

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

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/unlock
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Zneplatnění objednávky

zneplatnění objednávky
POST/api/v2/salesOrder/{salesOrderId}/invalid

Zneplatnění záznamu objednávky.

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/invalid
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Obnovit platnost objednávky

obnovení platnosti objednávky
POST/api/v2/salesOrder/{salesOrderId}/valid

Obnovení platnosti záznamu objednávky.

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/valid
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Export objednávky do PDF

export objednávky do PDF
GET/api/v2/salesOrder/{salesOrderId}/pdfExport{?locale}

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

https://app.raynet.cz/api/v2/salesOrder/3/pdfExport

Example URI

GET https://app.raynet.cz/api/v2/salesOrder/123/pdfExport?locale=en
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

locale
String (optional) Example: en

Jazyk exportované objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "uuid": "6775ac8cebd548e9b94a8ec99c30bab7",
  "fileName": "OBJ-17-001.pdf",
  "contentType": "application/octet-stream",
  "accessToken": "d9b38352c39f4ca2b7d367cffe089d20",
  "instanceName": "mojecrm"
}

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

přidání položek objednávky
PUT/api/v2/salesOrder/{salesOrderId}/item/

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

https://app.raynet.cz/api/v2/salesOrder/1/item/

Example URI

PUT https://app.raynet.cz/api/v2/salesOrder/123/item/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "productCode": "A001",
  "priceList": 2,
  "count": 2,
  "price": 123,
  "taxRate": 21,
  "discountPercent": 10.5,
  "cost": 10,
  "description": "poznamka k produktu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "productCode": {
      "type": "string",
      "required": false,
      "description": "[Kód produktu] Na základě zadaného kódu se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "product": {
      "type": "number",
      "required": false,
      "description": "[ID produktu] Na základě zadaného ID se dohledá produkt. Položka OP se pak vytvoří s tímto produktem."
    },
    "priceList": {
      "type": "number",
      "required": false,
      "description": "[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": {
      "type": "string",
      "required": true,
      "description": "[Název] Povinná hodnota pouze pro nekategorizovaný produkt"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    },
    "priceListItem": {
      "type": "long",
      "required": false,
      "description": "[Položka ceníku] ID položky ceníku"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň] "
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství] "
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva] "
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka] "
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka] "
    }
  }
}
Response  201

Položky objednávky

upravení položky objednávky
POST/api/v2/salesOrder/{salesOrderId}/item/{salesOrderItemId}/

Upravení položky na nabídce.

https://app.raynet.cz/api/v2/salesOrder/1/item/2/

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/item/123/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

salesOrderItemId
Long (required) Example: 123

ID položky objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "name": "produkt 1",
  "price": 123,
  "taxRate": 21,
  "count": 2,
  "discountPercent": 10.5,
  "cost": 10,
  "unit": "ks",
  "description": "poznamka k produktu"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název] "
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    },
    "priceListItem": {
      "type": "long",
      "required": false,
      "description": "[Položka ceníku] ID položky ceníku"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Daň] "
    },
    "count": {
      "type": "int",
      "required": false,
      "description": "[Množství] "
    },
    "discountPercent": {
      "type": "number",
      "required": false,
      "description": "[Sleva] "
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklady] Náklad za kus"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka] "
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka] "
    }
  }
}
Response  200

smazání položky objednávky
DELETE/api/v2/salesOrder/{salesOrderId}/item/{salesOrderItemId}/

Smazání položky na nabídkce

Example URI

DELETE https://app.raynet.cz/api/v2/salesOrder/123/item/123/
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

salesOrderItemId
Long (required) Example: 123

ID položky objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Synchronizace objednávky

synchronizace objednávky s obchodním případem
POST/api/v2/salesOrder/{salesOrderId}/sync

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

Example URI

POST https://app.raynet.cz/api/v2/salesOrder/123/sync
URI Parameters
HideShow
salesOrderId
Long (required) Example: 123

ID objednávky

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "TranslatedApplicationException",
  "translatedMessage": "Nelze synchronizovat, protože obchodní případ je evidován v jiné měně."
}

Projekty

API pro práci s projekty.

Seznam projektů

seznam projektů
GET/api/v2/project/{?offset,limit,sortColumn,sortDirection,name,company,code,projectStatus,category,owner,validFrom,validTill,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

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%

Example URI

GET https://app.raynet.cz/api/v2/project/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE]=RAY%&company=1&code=PRO-15-001&projectStatus=1&category=1&owner=1&validFrom=2014-06-01&validTill=2014-06-01&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: PRO-15-001

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

name
string (optional) Example: name[LIKE]=RAY%

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

company
number (optional) Example: 1

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

projectStatus
number (optional) Example: 1

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

category
number (optional) Example: 1

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

owner
number (optional) Example: 1

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

validFrom
string (optional) Example: 2014-06-01

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

validTill
string (optional) Example: 2014-06-01

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
    "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,
        "status": "D_DONE",
        "projectStatus": {
            "id": 60,
            "value": "Hotovo"
        },
        "validFrom": "2018-02-21",
        "validTill": "2018-04-17",
        "scheduledEnd": "2018-04-29",
        "customFields": null,
        "rowInfo.createdAt": "2018-04-17 14:47",
        "rowInfo.createdBy": "svetr@raynet.cz",
        "rowInfo.updatedAt": "2018-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
    ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nový projekt

nový projekt
PUT/api/v2/project/

Založení nového projektu

Example URI

PUT https://app.raynet.cz/api/v2/project/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "Testovací projekt nový",
  "company": 4,
  "person": 9,
  "owner": 2,
  "totalAmount": 34700,
  "tradingProfit": 22700,
  "estimatedValue": 12000,
  "validFrom": "2018-02-21",
  "scheduledEnd": "2018-04-29",
  "projectStatus": 45,
  "description": "Poznámka nová",
  "tags": [
    "Štítek1",
    "Štítek2"
  ]
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Předmět]"
    },
    "securityLevel": {
      "type": "long",
      "required": false,
      "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "company": {
      "type": "long",
      "required": true,
      "description": "[Firma] ID firmy, pro kterou je projekt vytvářen"
    },
    "person": {
      "type": "long",
      "required": false,
      "description": "[Osoba] ID osoby zodpovědné za projekt na straně klienta"
    },
    "totalAmount": {
      "type": "number",
      "required": false,
      "description": "[Konečná cena] konečná cena projektu"
    },
    "estimatedValue": {
      "type": "number",
      "required": false,
      "description": "[Předpokládané náklady] předpokládané náklady na projekt"
    },
    "tradingProfit": {
      "type": "number",
      "required": false,
      "description": "[Předpokládaný zisk] předpokládaný zisk z projektu"
    },
    "validFrom": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum otevřeno od"
    },
    "validTill": {
      "type": "date",
      "required": false,
      "description": "[Uzavřeno] datum uzavření projektu"
    },
    "scheduledEnd": {
      "type": "date",
      "required": false,
      "description": "[Plánované ukončení] datum plánovaného ukončení projektu"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku ProjectCategory"
    },
    "projectStatus": {
      "type": "long",
      "required": false,
      "description": "[Stav] ID záznamu z ProjectStatus. Pokud nebude vyplněno, založí se projekt do prvního stavu."
    },
    "tags": {
      "type": "array",
      "required": false,
      "items": {
        "type": "string",
        "required": true
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného projektu"
        }
      }
    }
  }
}

Detail projektu

detail projektu
GET/api/v2/project/{projectId}/

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/

Example URI

GET https://app.raynet.cz/api/v2/project/123/
URI Parameters
HideShow
projectId
Long (required) Example: 123

ID projektu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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,
    "status": "B_ACTIVE",
    "projectStatus": {
      "id": 59,
      "value": "Aktivní (v běhu)"
    },
    "validFrom": "2018-02-20",
    "validTill": null,
    "scheduledEnd": "2018-04-28",
    "customFields": null,
    "rowInfo.createdAt": "2018-02-20 09:09",
    "rowInfo.createdBy": "svetr@raynet.cz",
    "rowInfo.updatedAt": "2018-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
        }
      }
    ],
    "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": "2018-04-05",
        "validTill": null,
        "scheduledEnd": null,
        "totalAmount": 34798,
        "tradingProfit": 22734,
        "estimatedValue": 12064,
        "status": "B_ACTIVE",
        "probability": 20,
        "businessCasePhase": {
          "id": 43,
          "value": "Začínáme"
        }
      }
    ],
    "_version": 6
  }
}

upravení projektu
POST/api/v2/project/{projectId}/

Upravení dat projektu

Example URI

POST https://app.raynet.cz/api/v2/project/123/
URI Parameters
HideShow
projectId
Long (required) Example: 123

ID projektu

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "Testovací projekt upravený",
  "company": 4,
  "person": 9,
  "owner": 2,
  "totalAmount": 34700,
  "tradingProfit": 22700,
  "estimatedValue": 12000,
  "projectStatus": 60,
  "validFrom": "2018-02-21",
  "scheduledEnd": "2018-04-29",
  "description": "Poznámka lehce upravená"
}
Schema
{
        "type": "object",
        "required": true,
        "properties": {
            "name": {
                "type": "string",
                "required": true,
                "description": "[Předmět]"
            },
            "projectStatus": {
                "type": long,
                "required": false,
                "description" : "[Stav] ID záznamu z číselníku ProjectStatus"
            },
            "securityLevel": {
                "type": "long",
                "required": false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
            },
            "owner": {
                "type": "long",
                "required": false,
                "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
            },
            "company": {
                "type": "long",
                "required": true,
                "description": "[Firma] ID firmy, pro kterou je projekt vytvářen"
            },
            "person": {
                "type": "long",
                "required": false,
                "description": "[Osoba] ID osoby zodpovědné za projekt na straně klienta"
            },
            "totalAmount": {
                "type": "number",
                "required": false,
                "description": "[Konečná cena] konečná cena projektu"
            },
            "estimatedValue": {
                "type": "number",
                "required": false,
                "description": "[Předpokládané náklady] předpokládané náklady na projekt"
            },
            "tradingProfit": {
                "type": "number",
                "required": false,
                "description": "[Předpokládaný zisk] předpokládaný zisk z projektu"
            },
            "validFrom": {
                "type": "date",
                "required": false,
                "description": "[Otevřeno od] datum otevřeno od"
            },
            "validTill": {
                "type": "date",
                "required": false,
                "description": "[Uzavřeno] datum uzavření projektu"
            },
            "scheduledEnd": {
                "type": "date",
                "required": false,
                "description": "[Plánované ukončení] datum plánovaného ukončení projektu"
            },
            "description": {
                "type": "string",
                "required": false,
                "description": "[Poznámka]"
            },
            "category": {
                "type": "long",
                "required": false,
                "description" : "[Kategorie] ID záznamu z číselníku ProjectCategory"
            },
            "tags": {
                "type": "array",
                "required": false,
                "items" : {
                    "type": "string",
                    "required": true
                }
            },
            "customFields": {
                "type": "object",
                "required": false,
                "properties" : {
                    "<customFieldKey>": {
                            "type":"number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
                            "required":false,
                            "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
                    }
                }
            }
        }
    }
Response  200

smazání projektu
DELETE/api/v2/project/{projectId}/

Example URI

DELETE https://app.raynet.cz/api/v2/project/123/
URI Parameters
HideShow
projectId
Long (required) Example: 123

ID projektu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení projektu

uzamčení projektu
POST/api/v2/project/{projectId}/lock

Uzamčení záznamu projektu pro editaci.

Example URI

POST https://app.raynet.cz/api/v2/project/123/lock
URI Parameters
HideShow
projectId
Long (required) Example: 123

ID projektu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení projektu

odemčení projektu
POST/api/v2/project/{projectId}/unlock

Odemčení záznamu projektu k editaci.

Example URI

POST https://app.raynet.cz/api/v2/project/123/unlock
URI Parameters
HideShow
projectId
Long (required) Example: 123

ID projektu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Seznam participantů projektu

seznam participantů projektu
GET/api/v2/project/participants/{?offset,limit,sortColumn,sortDirection,note,company,company-name,person,view,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt}

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%

Example URI

GET https://app.raynet.cz/api/v2/project/participants/?offset=0&limit=100&sortColumn=id&sortDirection=ASC&note=note[LIKE]=Pozor%&company=company[EQ]=3&company-name=RAY%&person=3&view=rowInfo&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazení záznamu od začátku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: id

Choices: id company.id company.name person.id person.lastName project.id project.code note

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

note
string (optional) Example: note[LIKE]=Pozor%

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

company
string (optional) Example: company[EQ]=3

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

company-name
number (optional) Example: RAY%

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

person
string (optional) Example: 3

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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",
      "rowInfo.createdAt": "2017-09-29 13:46",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": null,
      "rowInfo.updatedBy": null,
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "_version": 0
    }
  ]
}

Produkt

API pro práci s produkty.

Seznam produktů

seznam produktů
GET/api/v2/product/{?offset,limit,sortColumn,sortDirection,name,unit,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

https://app.raynet.cz/api/v2/product/?offset=0&limit=1&name[LIKE]=Jan%

Example URI

GET https://app.raynet.cz/api/v2/product/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&name=name[LIKE_NOCASE]=Licence%&unit=unit=ks&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

name
string (optional) Example: name[LIKE_NOCASE]=Licence%

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

unit
string (optional) Example: unit=ks

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2011-11-03",
      "validTill": null,
      "rowInfo.createdAt": "2011-11-03 11:28",
      "rowInfo.createdBy": "admin@firma.cz",
      "rowInfo.updatedAt": "2015-05-14 11:59",
      "rowInfo.updatedBy": "admin@firma.cz",
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "tags": [

      ]
    }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nový produkt

založení nového produktu
PUT/api/v2/product/

Example URI

PUT https://app.raynet.cz/api/v2/product/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "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"
  ]
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "code": {
      "type": "string",
      "required": true,
      "unique": true,
      "description": "[Kód]"
    },
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název]"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka]"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Popis]"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Sazba DPH]"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku ProductCategory"
    },
    "productLine": {
      "type": "long",
      "required": false,
      "description": "[Produktová řada] ID záznamu z číselníku ProductLine"
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklad]"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Standardní cena]"
    },
    "tags": {
      "type": "array",
      "required": false,
      "items": {
        "type": "string",
        "required": true
      }
    }
  }
}
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného produktu"
        }
      }
    }
  }
}

Detail produktu

detail produktu
GET/api/v2/product/{productId}/

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/

Example URI

GET https://app.raynet.cz/api/v2/product/123/
URI Parameters
HideShow
productId
Long (required) Example: 123

ID produktu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2016-04-01",
    "validTill": null,
    "rowInfo.createdAt": "2016-01-01 13:07",
    "rowInfo.createdBy": "admin@firma.cz",
    "rowInfo.updatedAt": "2016-01-01 13:07",
    "rowInfo.updatedBy": "admin@firma.cz",
    "rowInfo.rowAccess": null,
    "rowInfo.rowState": null,
    "tags": [
      "tag 1",
      "tag 2"
    ],
    "photo": null,
    "_version": 1,
    "attachments": [],
    "customFields": {
      "Vaha_(g)_80307": 10
    }
  }
}

upravení produktu
POST/api/v2/product/{productId}/

Upravení dat produktu

Example URI

POST https://app.raynet.cz/api/v2/product/123/
URI Parameters
HideShow
productId
Long (required) Example: 123

ID produktu

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "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
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "code": {
      "type": "string",
      "required": true,
      "unique": true,
      "description": "[Kód]"
    },
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název]"
    },
    "unit": {
      "type": "string",
      "required": false,
      "description": "[Jednotka]"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Popis]"
    },
    "taxRate": {
      "type": "number",
      "required": false,
      "description": "[Sazba DPH]"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku ProductCategory"
    },
    "productLine": {
      "type": "long",
      "required": false,
      "description": "[Produktová řada] ID záznamu z číselníku ProductLine"
    },
    "cost": {
      "type": "number",
      "required": false,
      "description": "[Náklad]"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Standardní cena]"
    },
    "tags": {
      "type": "array",
      "required": false,
      "items": {
        "type": "string",
        "required": true
      }
    },
    "customFields": {
      "type": "object",
      "required": false,
      "properties": {
        "<customFieldKey>": {
          "type": "number - pro volitelné pole typu BIG_DECIMAL, boolean - pro volitelné pole typu BOOLEAN, date - pro typ DATE a string - pro ostatní",
          "required": false,
          "description": "customFieldKey = vygenerovaný unikátní klíč volitelného pole (získaný z konfigurace volitelných polí). Pokud je hodnota neprázdná, nastaví se volitelnému poli, pokud je prázdná nebo null, hodnota se ve volitelném poli vymaže."
        }
      }
    }
  }
}
Response  200

smazání produktu
DELETE/api/v2/product/{productId}/

Example URI

DELETE https://app.raynet.cz/api/v2/product/123/
URI Parameters
HideShow
productId
Long (required) Example: 123

ID produktu

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Ceníky

API pro práci s ceníky.

Seznam ceníků

seznam ceníků
GET/api/v2/priceList/{?offset,limit,sortColumn,sortDirection,code,primary,currency,validFrom,validTill,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

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%

Example URI

GET https://app.raynet.cz/api/v2/priceList/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&code=code[EQ]=CEN-001&primary=primary[EQ]=YES&currency=currency[EQ]=1&validFrom=validFrom[GT]=2014-06-01&validTill=validTill[GT]=2014-06-01&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name regNumber

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

code
string (optional) Example: code[EQ]=CEN-001

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

primary
string (optional) Example: primary[EQ]=YES

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

currency
number (optional) Example: currency[EQ]=1

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

validFrom
string (optional) Example: validFrom[GT]=2014-06-01

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

validTill
string (optional) Example: validTill[GT]=2014-06-01

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2017-02-03",
      "validTill": null,
      "owner": {
        "id": 2,
        "fullName": "Igor Hnízdo"
      },
      "rowInfo.createdAt": "2017-02-03 10:02",
      "rowInfo.createdBy": "admin@firma.cz",
      "rowInfo.updatedAt": null,
      "rowInfo.updatedBy": null,
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "securityLevel": {
        "id": 1,
        "name": "Sdílená"
      }
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Unsupported filter column ..."
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "AttributeAccessDeniedException",
  "translatedMessage": "Nemáte dostatečná oprávnění pro ..."
}

Nový ceník

nový ceník
PUT/api/v2/priceList/

Založení nového ceníku

Example URI

PUT https://app.raynet.cz/api/v2/priceList/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "Ceník ABC",
  "code": "CEN-002",
  "owner": 3,
  "currency": 17,
  "category": 13,
  "validFrom": "2015-11-08",
  "validTill": "2019-11-08",
  "description": "Text text"
}
Schema
{
        "type":"object",
        "required":true,
        "properties":{
            "name": {
                "type":"string",
                "required":true,
                "description": "[Název]"
            },
            "securityLevel": {
                "type":"long",
                "required":false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
            },
            "owner": {
                "type":"long",
                "required":false,
                "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
            },
            "code": {
                "type":"long",
                "required":true,
                "description": "[Kód]"
            },
            "currency": {
                "type":"long",
                "required":true,
                "description": "[Měna] ID záznamu z číselníku Currency"
            },
            "category": {
                "type":"long",
                "required":false,
                "description" : "[Kategorie] ID záznamu z číselníku PriceListCategory"
            },
            "validFrom": {
                "type":"date",
                "required":true,
                "description": "[Otevřeno od] datum platnosti od"
            },
            "validTill": {
                "type":"date",
                "required":false,
                "description": "[Otevřeno od] datum platnosti do"
            },
            "description": {
                "type":"string",
                "required":false,
                "description": "[Poznámka]"
            }
        }
Response  201
HideShow
Body
{
  "success": true,
  "data": {
    "id": 5
  }
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "success": {
      "type": "boolean",
      "required": true
    },
    "data": {
      "type": "object",
      "required": true,
      "properties": {
        "id": {
          "type": "long",
          "required": true,
          "description": "ID nově založeného ceníku"
        }
      }
    }
  }
}

Detail ceníku

detail ceníku
GET/api/v2/priceList/{priceListId}/

Získání detailu ceníku.

https://app.raynet.cz/api/v2/priceList/1/

Example URI

GET https://app.raynet.cz/api/v2/priceList/123/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2015-11-08",
    "validTill": "2019-11-08",
    "owner": {
      "id": 2,
      "fullName": "Igor Hnízdo"
    },
    "rowInfo.createdAt": "2017-02-03 11:32",
    "rowInfo.createdBy": "admin@firma.cz",
    "rowInfo.updatedAt": "2017-02-03 11:41",
    "rowInfo.updatedBy": "admin@firma.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": "2017-02-03 11:41",
        "rowInfo.createdBy": "admin@firma.cz",
        "rowInfo.updatedAt": null,
        "rowInfo.updatedBy": null,
        "rowInfo.rowAccess": null,
        "rowInfo.rowState": null
      }
    ]
  }
}

upravení ceníku
POST/api/v2/priceList/{priceListId}/

Upravení dat ceníku

Example URI

POST https://app.raynet.cz/api/v2/priceList/123/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "name": "Ceník ABC",
  "code": "CEN-002",
  "owner": 3,
  "currency": 17,
  "category": 13,
  "validFrom": "2015-11-08",
  "validTill": "2019-11-08",
  "description": "Text text"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "name": {
      "type": "string",
      "required": true,
      "description": "[Název]"
    },
    "securityLevel": {
      "type": "long",
      "required": false,
      "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
    },
    "owner": {
      "type": "long",
      "required": false,
      "description": "[Vlastník] ID osoby, která je zároveň uživatelem"
    },
    "code": {
      "type": "long",
      "required": true,
      "description": "[Kód]"
    },
    "currency": {
      "type": "long",
      "required": true,
      "description": "[Měna] ID záznamu z číselníku Currency"
    },
    "category": {
      "type": "long",
      "required": false,
      "description": "[Kategorie] ID záznamu z číselníku PriceListCategory"
    },
    "validFrom": {
      "type": "date",
      "required": true,
      "description": "[Otevřeno od] datum platnosti od"
    },
    "validTill": {
      "type": "date",
      "required": false,
      "description": "[Otevřeno od] datum platnosti do"
    },
    "description": {
      "type": "string",
      "required": false,
      "description": "[Poznámka]"
    }
  }
}
Response  200

smazání ceníku
DELETE/api/v2/priceList/{priceListId}/

Example URI

DELETE https://app.raynet.cz/api/v2/priceList/123/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Uzamčení ceníku

uzamčení ceníku
POST/api/v2/priceList/{priceListId}/lock

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

Example URI

POST https://app.raynet.cz/api/v2/priceList/123/lock
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Odemčení ceníku

odemčení ceníku
POST/api/v2/priceList/{priceListId}/unlock

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

Example URI

POST https://app.raynet.cz/api/v2/priceList/123/unlock
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Seznam položek ceníku

seznam položek ceníku
GET/api/v2/priceList/{priceListId}/items/{?offset,limit,sortColumn,sortDirection,product-code,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt}

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.

Example URI

GET https://app.raynet.cz/api/v2/priceList/123/items/?offset=0&limit=100&sortColumn=name&sortDirection=ASC&product-code=KONV&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

offset
int (optional) Example: 0

Zobrazení záznamů od začátku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: name

Choices: name price unit cost taxRate rowInfo.createdAt rowInfo.updatedAt

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

product-code
string (optional) Example: KONV

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

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "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": "2017-06-08 21:41",
      "rowInfo.createdBy": "admin@firma.cz",
      "rowInfo.updatedAt": "2018-03-20 14:35",
      "rowInfo.updatedBy": "admin@firma.cz",
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null
    }
  ]
}

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

přidání položek ceníku
PUT/api/v2/priceList/{priceListId}/item/

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

https://app.raynet.cz/api/v2/priceList/1/item/

Example URI

PUT https://app.raynet.cz/api/v2/priceList/123/item/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "price": 400,
  "product": 1
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "product": {
      "type": "long",
      "required": true,
      "description": "[Měna] ID produktu, který do ceníku přidávám"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    }
  }
}
Response  201

Upravení položek ceníku

upravení položky ceníku
POST/api/v2/priceList/{priceListId}/item/{priceListItemId}/

Upravení položky na ceníku

Example URI

POST https://app.raynet.cz/api/v2/priceList/123/item/123/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

priceListItemId
Long (required) Example: 123

ID položky ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Body
{
  "price": 400,
  "product": 1
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "product": {
      "type": "long",
      "required": true,
      "description": "[Měna] ID produktu, který do ceníku přidávám"
    },
    "price": {
      "type": "number",
      "required": false,
      "description": "[Prodejní cena] "
    }
  }
}
Response  200

smazání položky ceníku
DELETE/api/v2/priceList/{priceListId}/item/{priceListItemId}/

Smazání položky na ceníku

Example URI

DELETE https://app.raynet.cz/api/v2/priceList/123/item/123/
URI Parameters
HideShow
priceListId
Long (required) Example: 123

ID ceníku

priceListItemId
Long (required) Example: 123

ID položky ceníku

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200

Faktury

API pro práci s fakturami.

Seznam faktur

seznam faktur
GET/api/v2/invoice/{?offset,limit,sortColumn,sortDirection,title,code,company,owner,businessCase,issueDate,invoiceType,taxableSupplyDate,dueDate,paymentDate,variableSymbol,specificSymbol,constantSymbol,rowInfo.createdAt,rowInfo.updatedAt,rowInfo.lastModifiedAt,view}

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/invoice/?offset=0&limit=1&title[LIKE]=RAY%

Example URI

GET https://app.raynet.cz/api/v2/invoice/?offset=0&limit=100&sortColumn=title&sortDirection=ASC&title=name[LIKE]=RAY%&code=12345678&company=1&owner=1&businessCase=1&issueDate=2015-01-01&invoiceType=NORMAL&taxableSupplyDate=2015-01-01&dueDate=2015-01-01&paymentDate=2015-01-01&variableSymbol=123456&specificSymbol=123456&constantSymbol=0308&rowInfo.createdAt=2014-06-01 10:00&rowInfo.updatedAt=2014-06-01 10:00&rowInfo.lastModifiedAt=2014-06-01 10:00&view=rowInfo
URI Parameters
HideShow
offset
int (optional) Example: 0

Zobrazeni zaznamu od zacatku

limit
int (optional) Example: 100

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

sortColumn
string (optional) Example: title

Choices: title code

sortDirection
string (optional) Example: ASC

Choices: ASC DESC

title
string (optional) Example: name[LIKE]=RAY%

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

code
string (optional) Example: 12345678

Filtrování faktur podle kódu faktury. Lze využít operátoru EQ, NE, LIKE. Výchozím operátorem je EQ.

company
number (optional) Example: 1

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

owner
number (optional) Example: 1

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

businessCase
number (optional) Example: 1

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

issueDate
string (optional) Example: 2015-01-01

Filtrování faktur podle data vystavení.

invoiceType
string (optional) Example: NORMAL

Filtrování faktur podle typu. Hodnoty jsou: NORMAL, PRFORMA, CREDIT_NOTE. Lze využít operátoru EQ, NE, IN. Výchozím operátorem je EQ.

taxableSupplyDate
string (optional) Example: 2015-01-01

Filtrování faktur podle data zdanitelného plnění.

dueDate
string (optional) Example: 2015-01-01

Filtrování faktur podle data splatnosti.

paymentDate
string (optional) Example: 2015-01-01

Filtrování faktur podle data uhrazení.

variableSymbol
string (optional) Example: 123456

Filtrování faktur podle variabilního symbolu. Lze využít operátoru EQ, NE, LIKE

specificSymbol
string (optional) Example: 123456

Filtrování faktur podle specifického symbolu. Lze využít operátoru EQ, NE, LIKE

constantSymbol
string (optional) Example: 0308

Filtrování faktur podle konstantního symbolu. Lze využít operátoru EQ, NE, LIKE

rowInfo.createdAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.updatedAt
string (optional) Example: 2014-06-01 10:00

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

rowInfo.lastModifiedAt
string (optional) Example: 2014-06-01 10:00

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

view
string (optional) Example: rowInfo

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

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "success": "true",
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "code": "FV2015001",
      "title": "Faktura FV2015001",
      "company": {
        "id": 1,
        "name": "RAYNET s.r.o."
      },
      "invoiceType": "NORMAL",
      "issueDate": "2015-10-02",
      "dueDate": "2015-10-16",
      "taxableSupplyDate": "2015-10-02",
      "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,
      "deliveryNote": null,
      "creditNoteReason": null,
      "vendorName": null,
      "vendorBankAccountNumber": null,
      "badDebt": false,
      "businessCase": null,
      "rowInfo.createdAt": "2015-10-02 15:14",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": "2015-10-02 15:14",
      "rowInfo.updatedBy": "konektor@raynet.cz",
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null,
      "securityLevel": {
        "id": 1,
        "name": "Sdílená"
      },
      "tags": []
    }
  ]
}

Nová faktura

nová faktura
PUT/api/v2/invoice/

Založení nové faktury

Example URI

PUT https://app.raynet.cz/api/v2/invoice/
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "company": 1,
  "title": "Faktura za dobrou radu",
  "constantSymbol": "0308",
  "currency": 15,
  "dueDate": "2015-10-16",
  "invoiceType": "NORMAL",
  "issueDate": "2015-10-02",
  "paymentTermDays": 14,
  "paymentType": "PAYMENT_DIRECT_DEBIT",
  "securityLevel": 1,
  "specificSymbol": "",
  "taxableSupplyDate": "2015-10-02",
  "businessCase": 4
}
Schema
{
    "type":"object",
    "required":true,
    "properties": {
        "company": {
            "type":"long",
            "required":true,
            "description": "[Firma] Firma které se bude fakturovat"
        },
        "securityLevel": {
            "type":"long",
            "required":false,
            "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
        },
        "title": {
            "type":"string",
            "required":false,
            "description": "[Název] Název faktury pro lepší dohledatelnost"
        },
        "constantSymbol": {
            "type":"string",
            "required":false,
            "description": "[Konstantní symbol] "
        },
        "specificSymbol": {
            "type":"string",
            "required":false,
            "description": "[Specifický symbol] "
        },
        "currency": {
            "type":"long",
            "required":true,
            "description": "[Měna] ID záznamu z číselníku Currency"
        },
        "dueDate": {
            "type":"string",
            "required":true,
            "description": "[Datum splatnosti] "
        },
        "issueDate": {
            "type":"string",
            "required":true,
            "description": "[Datum vystavení] "
        },
        "invoiceType": {
            "enum": ['NORMAL', 'PROFORMA'],
            "required":true,
            "description": "[Typ faktury] "
        },
        "paymentTermDays": {
            "type": "number",
            "required":false,
            "description": "[Splatnost] "
        },
        "paymentType": {
            "enum": [PAYMENT_DIRECT_DEBIT, PAYMENT_CASH, PAYMENT_CASH_ON_DELIVERY, PAYMENT_CARD],
            "required": true,
            "description": "[Způsob úhrady] "
        },
        "taxableSupplyDate": {
          "type":"string",
          "required": true,
          "description": "[Datum zdanitelného plnění] "
        },
        "businessCase": {
            "type":"long",
            "required":false,
            "description": "[Obchodní případ] ID záznamu obchodního případu. Pokud je vloženo jsou zkopírovány položky OP na fakturu. Není kontrolována integrita Klient - Obchodní případ - Faktura (tzn. faktura může být na jinou firmu než OP)."
        },
        "note": {
          "type":"string",
          "required": false,
          "description": "[Poznámka pro příjemce] Pokud není vyplněna, použije se předvyplnění z konfigurace fakturačního modulu"
        },
        "deliveryNote": {
          "type":"string",
          "required": false,
          "description": "[Poznámka pro příjemce - dodací list]"
        },
        "privateNote": {
          "type":"string",
          "required": false,
          "description": "[Poznámka interní]"
        }
    }
}
Response  201

Nový dobropis

nový dobropis
PUT/api/v2/invoice/creditNote

Založení nového dobropisu

Example URI

PUT https://app.raynet.cz/api/v2/invoice/creditNote
Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "invoiceId": 1,
  "reason": "Dobropis, špatně vystavená faktura"
}
Schema
{
  "type": "object",
  "required": true,
  "properties": {
    "invoiceId": {
      "type": "long",
      "required": true,
      "description": "[Faktura] Faktura, která má být dopropisována."
    },
    "reason": {
      "type": "string",
      "required": true,
      "description": "[Zdůvodnění opravu] Popis proč je dopropis vystavován."
    }
  }
}
Response  201

Detail faktury

detail faktury
GET/api/v2/invoice/{invoiceId}/

Získání detailu faktury.

https://app.raynet.cz/api/v2/invoice/1/

Example URI

GET https://app.raynet.cz/api/v2/invoice/123/
URI Parameters
HideShow
invoiceId
Long (required) Example: 123

ID faktury

Request
HideShow
Headers
X-Instance-Name: instanceName
Response  200
HideShow
Body
{
  "id": 1,
  "code": "FV2015001",
  "title": "Faktura FV2015001",
  "company": {
    "id": 1,
    "name": "RAYNET s.r.o."
  },
  "invoiceType": "NORMAL",
  "issueDate": "2015-10-02",
  "dueDate": "2015-10-16",
  "taxableSupplyDate": "2015-10-02",
  "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,
  "deliveryNote": null,
  "creditNoteReason": null,
  "vendorName": "MP",
  "vendorBankAccountNumber": "123123123",
  "badDebt": false,
  "businessCase": null,
  "rowInfo.createdAt": "2015-10-02 15:14",
  "rowInfo.createdBy": "konektor@raynet.cz",
  "rowInfo.updatedAt": "2015-10-02 15:36",
  "rowInfo.updatedBy": "konektor@raynet.cz",
  "rowInfo.rowAccess": null,
  "rowInfo.rowState": null,
  "securityLevel": {
    "id": 1,
    "name": "Sdílená"
  },
  "tags": [],
  "items": [
    {
      "id": 1,
      "name": "Nekategorizovaný produkt",
      "amount": 1,
      "unitPrice": 123,
      "taxRate": 21,
      "basePrice": 123,
      "totalTax": 25.83,
      "totalPrice": 148.83,
      "discountPercent": 0,
      "sequenceNumber": 1,
      "unitLabel": "ks",
      "calculateTaxFromTotalPrice": false,
      "priceListItem": null,
      "description": null,
      "rowInfo.createdAt": "2015-10-02 15:14",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": "2015-10-02 15:14",
      "rowInfo.updatedBy": "konektor@raynet.cz",
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null
    }
  ],
  "payments": [
    {
      "id": 1,
      "amount": 148.83,
      "date": "2015-10-02",
      "rowInfo.createdAt": "2015-10-02 15:36",
      "rowInfo.createdBy": "konektor@raynet.cz",
      "rowInfo.updatedAt": null,
      "rowInfo.updatedBy": null,
      "rowInfo.rowAccess": null,
      "rowInfo.rowState": null
    }
  ]
}

upravení faktury
POST/api/v2/invoice/{invoiceId}/

Upravení dat faktury

Example URI

POST https://app.raynet.cz/api/v2/invoice/123/
URI Parameters
HideShow
invoiceId
Long (required) Example: 123

ID faktury

Request
HideShow
Headers
Content-Type: application/json
X-Instance-Name: instanceName
Body
{
  "company": 1,
  "title": "Faktura za dobrou radu",
  "constantSymbol": "0308",
  "currency": 15,
  "dueDate": "2015-10-16",
  "invoiceType": "NORMAL",
  "issueDate": "2015-10-02",
  "paymentTermDays": 14,
  "paymentType": "PAYMENT_DIRECT_DEBIT",
  "securityLevel": 1,
  "specificSymbol": "",
  "taxableSupplyDate": "2015-10-02",
  "businessCase": 5,
  "vendorName": "RAYNET s.r.o.",
  "vendorRegNumber": "26843820",
  "vendorTaxNumber": "CZ26843820",
  "vendorAddress": {
    "street": "Francouzská 6167/5",
    "city": "Ostrava",
    "zipCode": "708 00",
    "countryCode": "CZ",
    "countryName": "Česká republika",
    "province": "Moravskoslezský kraj"
  },
  "vendorEmail": "info@raynet.cz",
  "vendorFax": "",
  "vendorPhoneNumber": "800 101 201",
  "vendorWebsite": "www.raynet.cz",
  "vendorBankName": "ČSOB",
  "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",
    "countryCode": "CZ",
    "countryName": "Česká republika",
    "province": "Moravskoslezský kraj"
  },
  "items": [
    {
      "name": "položka 1",
      "unitPrice": 123,
      "taxRate": 21,
      "amount": 2,
      "unitLabel": "ks",
      "discountPercent": 0
    },
    {
      "id": 2,
      "name": "položka 2",
      "unitPrice": 123,
      "taxRate": 21,
      "amount": 2,
      "unitLabel": "ks",
      "discountPercent": 10
    }
  ]
}
Schema
{
    "type":"object",
    "required":true,
    "properties":{
            "company": {
                "type":"long",
                "required":true,
                "description": "[Firma] Firma které se bude fakturovat"
            },
            "securityLevel": {
                "type":"long",
                "required":false,
                "description": "[Bezpečnostní úroveň] ID bezpečnostní úrovně. Pokud není vyplněna je nastavena výchozí bezpečnostní skupina."
            },
            "title": {
                "type":"string",
                "required":false,
                "description": "[Název] Název faktury pro lepší dohledatelnost"
            },
            "constantSymbol": {
                "type":"string",
                "required":false,
                "description": "[Konstantní symbol] "
            },
            "specificSymbol": {
                "type":"string",
                "required":false,
                "description": "[Specifický symbol] "
            },
            "currency": {
                "type":"long",
                "required":false,
                "description": "[Měna] ID záznamu z číselníku Currency"
            },
            "dueDate": {
                "type":"string",
                "required":