Odeslaná pošta

GET

/pdmissueddocs

Získá kolekci BO Odeslaná pošta

GET

/pdmissueddocs/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Odeslaná pošta

GET

/pdmissueddocs/views/{view}

Získá pohled nad BO Odeslaná pošta

GET

/pdmissueddocs/{id}

Získá daný BO Odeslaná pošta

GET

/pdmissueddocs/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Odeslaná pošta

GET

/pdmissueddocs/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO Odeslaná pošta aktuálnímu uživateli znepřístupněny

GET

/pdmissueddocs/{id}/rows

Získá řádky kolekce Řádek odeslané pošty

GET

/pdmissueddocs/{id}/rows/{id1}

Získá daný řádek kolekce Řádek odeslané pošty

GET

/pdmissueddocs/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Odeslaná pošta

POST

/pdmissueddocs

Vytvoří nový BO Odeslaná pošta

POST

/pdmissueddocs/query

Vyhodnotí query dotaz nad BO Odeslaná pošta

POST

/pdmissueddocs/{id}/rows

Vytvoří nový řádek v kolekci Řádek odeslané pošty

PUT

/pdmissueddocs/{id}

Modifikuje daný BO Odeslaná pošta

PUT

/pdmissueddocs/{id}/editlock

Vytvoří editační zámek na daném BO Odeslaná pošta

PUT

/pdmissueddocs/{id}/editunlock

Zruší editační zámek na daném BO Odeslaná pošta

PUT

/pdmissueddocs/{id}/rows/{id1}

Modifikuje řádek v kolekci Řádek odeslané pošty

DELETE

/pdmissueddocs/{id}

Smaže BO Odeslaná pošta

DELETE

/pdmissueddocs/{id}/rows/{id1}

Smaže řádek z kolekce Řádek odeslané pošty

Metadata - Perzistentní položky

amount number

Celková částka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

bankaccount_id string (bankaccount) relace

Vlastní bankovní účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

busorder_id string (busorder) relace

Zakázka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

bustransaction_id string (bustransaction) relace

Obchodní případ, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

cashondelivery number

Dobírečné, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

closing_id string (pdmclosing) relace

Uzávěrka, pole vlastněné tabulkou, možné řadit a filtrovat

closingindex integer

Pořadí, pole vlastněné tabulkou, možné řadit a filtrovat

constsymbol_id string (constantsymbol) relace

Konstantní symbol, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

correctedby_id string (securityuser) relace

Opravil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

createdby_id string (securityuser) relace

Vytvořil, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

description string (100)

Popis, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

division_id string (division) relace

Středisko, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

docdate$date string

Datum dok., pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

docqueue_id string (docqueue) relace

Zdrojová řada, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

exportnumber integer

Pořadí exportu, pole vlastněné tabulkou, možné řadit a filtrovat

firm_id string (firm) relace

Firma, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

firmbankaccount_id string (firmbankaccount) relace

Cizí bankovní účet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

firmoffice_id string (firmoffice) relace

Provozovna, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

insuredvalue number

Cena zásilky, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

issuedcontent_id string (pdmissuedcontenttype) relace

Typ obsahu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

longestside number

Nejdelší strana, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

multiplicator integer

Počet, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

note string

Poznámka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

objversion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

ordnumber integer

Pořadové číslo, pole vlastněné tabulkou, možné řadit a filtrovat

period_id string (period) relace

Období, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

person_id string (person) relace

Osoba, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

postage number

Poštovné/ks, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole obsahuje částku v lokální měně

postageincash boolean

Placeno v hotovosti, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

postnumber string (60)

Podací číslo, pole vlastněné tabulkou, možné řadit a filtrovat

postprovider_id string (pdmpostprovider) relace

Poštovní poskytovatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

pricelist_id string (pdmpricelist) relace

Ceník, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

printqueuenumber string (30)

Přidělené číslo z číselné řady, pole vlastněné tabulkou, možné řadit a filtrovat

receiveddoc_id string (pdmreceiveddoc) relace

Došlá pošta, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

rows array (pdmissueddocrow) relace

kolekce BO Řádek odeslané pošty, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

sender_id string (pdmuser) relace

Odesílatel pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

targetaddress_id string (address) relace

Adresa, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

targetaddresstype integer

Typ adresy, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

varsymbol string (10)

Variabilní symbol, pole vlastněné tabulkou, možné řadit a filtrovat

weight number

Hmotnost, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

weightunit integer

Hmotnostní jednotka, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

classid string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

displayname string (24)

Číslo dok., pouze pro čtení

forcecalculateamount boolean

Vynucení přepočetu poštovného

id string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

newrelateddocument_id string (10)

ID dokladu pro připojení, fkAnsiCaseSensitive

newrelatedtype integer

Typ relace

servicetypesstring string (100)

Služby pošty textově, pouze pro čtení

source_id string (datadocumentbusinessobject) relace

Doklad pro připojení

sourceclsid string (26)

Typ dokladu pro připojení

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/pdmissueddocs?take=1
GET
https://atd.abra.eu/demodata/pdmissueddocs/{id}
Response 
{
    "objversion": 5,
    "rows": [],
    "docqueue_id": "R700000101",
    "period_id": "4200000101",
    "ordnumber": 1,
    "docdate$date": "2006-03-31T22:00:00.000Z",
    "createdby_id": "SUPER00000",
    "correctedby_id": null,
    "firm_id": "J000000101",
    "description": "",
    "amount": 60,
    "firmoffice_id": "J000000101",
    "person_id": null,
    "note": "",
    "sender_id": "3000000101",
    "division_id": "2100000101",
    "busorder_id": null,
    "bustransaction_id": null,
    "postprovider_id": "1000000000",
    "issuedcontent_id": "O000000000",
    "insuredvalue": 0,
    "postage": 60,
    "postnumber": "",
    "closingindex": 0,
    "exportnumber": 0,
    "printqueuenumber": "",
    "weight": 1.5,
    "weightunit": 1,
    "receiveddoc_id": null,
    "multiplicator": 1,
    "pricelist_id": "3100000000",
    "targetaddresstype": 0,
    "targetaddress_id": "WD00000101",
    "closing_id": null,
    "cashondelivery": 100,
    "postageincash": false,
    "bankaccount_id": null,
    "constsymbol_id": null,
    "varsymbol": "",
    "firmbankaccount_id": null,
    "longestside": 0
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "pdmissueddocs", "take": "1"}
POST
https://atd.abra.eu/demodata/pdmissueddocs/query
{"take": "1"}
Response 
{
    "objversion": 5,
    "rows": [],
    "docqueue_id": "R700000101",
    "period_id": "4200000101",
    "ordnumber": 1,
    "docdate$date": "2006-03-31T22:00:00.000Z",
    "createdby_id": "SUPER00000",
    "correctedby_id": null,
    "firm_id": "J000000101",
    "description": "",
    "amount": 60,
    "firmoffice_id": "J000000101",
    "person_id": null,
    "note": "",
    "sender_id": "3000000101",
    "division_id": "2100000101",
    "busorder_id": null,
    "bustransaction_id": null,
    "postprovider_id": "1000000000",
    "issuedcontent_id": "O000000000",
    "insuredvalue": 0,
    "postage": 60,
    "postnumber": "",
    "closingindex": 0,
    "exportnumber": 0,
    "printqueuenumber": "",
    "weight": 1.5,
    "weightunit": 1,
    "receiveddoc_id": null,
    "multiplicator": 1,
    "pricelist_id": "3100000000",
    "targetaddresstype": 0,
    "targetaddress_id": "WD00000101",
    "closing_id": null,
    "cashondelivery": 100,
    "postageincash": false,
    "bankaccount_id": null,
    "constsymbol_id": null,
    "varsymbol": "",
    "firmbankaccount_id": null,
    "longestside": 0
}
Request 
POST
https://atd.abra.eu/demodata/pdmissueddocs?select=id
Body 
{
    "amount": 60,
    "bankaccount_id": null,
    "busorder_id": null,
    "bustransaction_id": null,
    "cashondelivery": 100,
    "closing_id": null,
    "closingindex": 0,
    "constsymbol_id": null,
    "correctedby_id": null,
    "createdby_id": "SUPER00000",
    "description": "",
    "division_id": "2100000101",
    "docdate$date": "2006-03-31T22:00:00.000Z",
    "docqueue_id": "R700000101",
    "exportnumber": 0,
    "firm_id": "J000000101",
    "firmbankaccount_id": null,
    "firmoffice_id": "J000000101",
    "insuredvalue": 0,
    "issuedcontent_id": "O000000000",
    "longestside": 0,
    "multiplicator": 1,
    "note": "",
    "ordnumber": 1,
    "period_id": "4200000101",
    "person_id": null,
    "postage": 60,
    "postageincash": false,
    "postnumber": "",
    "postprovider_id": "1000000000",
    "pricelist_id": "3100000000",
    "printqueuenumber": "",
    "receiveddoc_id": null,
    "rows": [],
    "sender_id": "3000000101",
    "targetaddress_id": "WD00000101",
    "targetaddresstype": 0,
    "varsymbol": "",
    "weight": 1.5,
    "weightunit": 1
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/pdmissueddocs/{id}?select=id
Body 
{
    "amount": 60,
    "bankaccount_id": null,
    "busorder_id": null,
    "bustransaction_id": null,
    "cashondelivery": 100,
    "closing_id": null,
    "closingindex": 0,
    "constsymbol_id": null,
    "correctedby_id": null,
    "createdby_id": "SUPER00000",
    "description": "",
    "division_id": "2100000101",
    "docdate$date": "2006-03-31T22:00:00.000Z",
    "docqueue_id": "R700000101",
    "exportnumber": 0,
    "firm_id": "J000000101",
    "firmbankaccount_id": null,
    "firmoffice_id": "J000000101",
    "insuredvalue": 0,
    "issuedcontent_id": "O000000000",
    "longestside": 0,
    "multiplicator": 1,
    "note": "",
    "ordnumber": 1,
    "period_id": "4200000101",
    "person_id": null,
    "postage": 60,
    "postageincash": false,
    "postnumber": "",
    "postprovider_id": "1000000000",
    "pricelist_id": "3100000000",
    "printqueuenumber": "",
    "receiveddoc_id": null,
    "rows": [],
    "sender_id": "3000000101",
    "targetaddress_id": "WD00000101",
    "targetaddresstype": 0,
    "varsymbol": "",
    "weight": 1.5,
    "weightunit": 1
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/pdmissueddocs/{id}
Response 
200 - OK Everything worked as expected.
Dávkové zprocování záznamů Request 
PUT
https://atd.abra.eu/demodata//batch
  • CREATE
  • UPDATE
  • DELETE
Body - Create 
{
    "items": [
        {
            "type": "create",
            "id": "id0",
            "data": {
                "class_id": "pdmissueddocs",
                "object_data": {
                    "amount": 60,
                    "bankaccount_id": null,
                    "busorder_id": null,
                    "bustransaction_id": null,
                    "cashondelivery": 100,
                    "closing_id": null,
                    "closingindex": 0,
                    "constsymbol_id": null,
                    "correctedby_id": null,
                    "createdby_id": "SUPER00000",
                    "description": "",
                    "division_id": "2100000101",
                    "docdate$date": "2006-03-31T22:00:00.000Z",
                    "docqueue_id": "R700000101",
                    "exportnumber": 0,
                    "firm_id": "J000000101",
                    "firmbankaccount_id": null,
                    "firmoffice_id": "J000000101",
                    "insuredvalue": 0,
                    "issuedcontent_id": "O000000000",
                    "longestside": 0,
                    "multiplicator": 1,
                    "note": "",
                    "ordnumber": 1,
                    "period_id": "4200000101",
                    "person_id": null,
                    "postage": 60,
                    "postageincash": false,
                    "postnumber": "",
                    "postprovider_id": "1000000000",
                    "pricelist_id": "3100000000",
                    "printqueuenumber": "",
                    "receiveddoc_id": null,
                    "rows": [],
                    "sender_id": "3000000101",
                    "targetaddress_id": "WD00000101",
                    "targetaddresstype": 0,
                    "varsymbol": "",
                    "weight": 1.5,
                    "weightunit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "pdmissueddocs",
                "object_data": {
                    "amount": 60,
                    "bankaccount_id": null,
                    "busorder_id": null,
                    "bustransaction_id": null,
                    "cashondelivery": 100,
                    "closing_id": null,
                    "closingindex": 0,
                    "constsymbol_id": null,
                    "correctedby_id": null,
                    "createdby_id": "SUPER00000",
                    "description": "",
                    "division_id": "2100000101",
                    "docdate$date": "2006-03-31T22:00:00.000Z",
                    "docqueue_id": "R700000101",
                    "exportnumber": 0,
                    "firm_id": "J000000101",
                    "firmbankaccount_id": null,
                    "firmoffice_id": "J000000101",
                    "insuredvalue": 0,
                    "issuedcontent_id": "O000000000",
                    "longestside": 0,
                    "multiplicator": 1,
                    "note": "",
                    "ordnumber": 1,
                    "period_id": "4200000101",
                    "person_id": null,
                    "postage": 60,
                    "postageincash": false,
                    "postnumber": "",
                    "postprovider_id": "1000000000",
                    "pricelist_id": "3100000000",
                    "printqueuenumber": "",
                    "receiveddoc_id": null,
                    "rows": [],
                    "sender_id": "3000000101",
                    "targetaddress_id": "WD00000101",
                    "targetaddresstype": 0,
                    "varsymbol": "",
                    "weight": 1.5,
                    "weightunit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000100",
                "object_data": {
                    "amount": 60,
                    "bankaccount_id": null,
                    "busorder_id": null,
                    "bustransaction_id": null,
                    "cashondelivery": 100,
                    "closing_id": null,
                    "closingindex": 0,
                    "constsymbol_id": null,
                    "correctedby_id": null,
                    "createdby_id": "SUPER00000",
                    "description": "",
                    "division_id": "2100000101",
                    "docdate$date": "2006-03-31T22:00:00.000Z",
                    "docqueue_id": "R700000101",
                    "exportnumber": 0,
                    "firm_id": "J000000101",
                    "firmbankaccount_id": null,
                    "firmoffice_id": "J000000101",
                    "insuredvalue": 0,
                    "issuedcontent_id": "O000000000",
                    "longestside": 0,
                    "multiplicator": 1,
                    "note": "",
                    "ordnumber": 1,
                    "period_id": "4200000101",
                    "person_id": null,
                    "postage": 60,
                    "postageincash": false,
                    "postnumber": "",
                    "postprovider_id": "1000000000",
                    "pricelist_id": "3100000000",
                    "printqueuenumber": "",
                    "receiveddoc_id": null,
                    "rows": [],
                    "sender_id": "3000000101",
                    "targetaddress_id": "WD00000101",
                    "targetaddresstype": 0,
                    "varsymbol": "",
                    "weight": 1.5,
                    "weightunit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000101",
                "object_data": {
                    "amount": 60,
                    "bankaccount_id": null,
                    "busorder_id": null,
                    "bustransaction_id": null,
                    "cashondelivery": 100,
                    "closing_id": null,
                    "closingindex": 0,
                    "constsymbol_id": null,
                    "correctedby_id": null,
                    "createdby_id": "SUPER00000",
                    "description": "",
                    "division_id": "2100000101",
                    "docdate$date": "2006-03-31T22:00:00.000Z",
                    "docqueue_id": "R700000101",
                    "exportnumber": 0,
                    "firm_id": "J000000101",
                    "firmbankaccount_id": null,
                    "firmoffice_id": "J000000101",
                    "insuredvalue": 0,
                    "issuedcontent_id": "O000000000",
                    "longestside": 0,
                    "multiplicator": 1,
                    "note": "",
                    "ordnumber": 1,
                    "period_id": "4200000101",
                    "person_id": null,
                    "postage": 60,
                    "postageincash": false,
                    "postnumber": "",
                    "postprovider_id": "1000000000",
                    "pricelist_id": "3100000000",
                    "printqueuenumber": "",
                    "receiveddoc_id": null,
                    "rows": [],
                    "sender_id": "3000000101",
                    "targetaddress_id": "WD00000101",
                    "targetaddresstype": 0,
                    "varsymbol": "",
                    "weight": 1.5,
                    "weightunit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "1600000104"
            }
        }
    ]
}