Došlá pošta

GET

/pdmreceiveddocs

Získá kolekci BO Došlá pošta

GET

/pdmreceiveddocs/{id}

Získá konkrétní BO Došlá pošta

POST

/pdmreceiveddocs

Vytvoří nový BO Došlá pošta a vrátí jeho kompletní reprezentaci

PUT

/pdmreceiveddocs/{id}

Provede aktualizaci BO Došlá pošta a vrátí jeho kompletní, aktualizovanou reprezentaci. Operaci PUT je možné využívat i k částečným aktualizacím zdrojů (PATCH).

DELETE

/pdmreceiveddocs/{id}

Smaže BO Došlá pošta na základě jeho ID

Metadata - Perzistentní položky

Amount number

Čá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ě

BusOrder_ID string (busorder) relace

Zakázka; ID objektu 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; ID objektu Obchodní případ, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

CorrectedBy_ID string (securityuser) relace

Opravil; ID objektu Uživatel, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

CreatedBy_ID string (securityuser) relace

Vytvořil; ID objektu Uživatel, 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; ID objektu 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; ID objektu Řada dokladů, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

FirmOffice_ID string (firmoffice) relace

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

Firm_ID string (firm) relace

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

IssuedDoc_ID string (pdmissueddoc) relace

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

Note string (0)

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í; ID objektu 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; ID objektu Osoba, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

PostProvider_ID string (pdmpostprovider) relace

Poštovní poskytovatel; ID objektu Poskytovatel poštovních služeb, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

ReceivedContent_ID string (pdmreceivedcontenttype) relace

Typ obsahu; ID objektu Typy obsahů došlé pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Recipient_ID string (pdmuser) relace

Příjemce pošty; ID objektu Uživatel modulu evidence pošty, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

State_ID string (pdmreceivedstatetype) relace

Stav; ID objektu Stav došlé pošty, 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í

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

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/pdmreceiveddocs?take=1
GET
https://atd.abra.eu/demodata/pdmreceiveddocs/{id}
Response 
{
    "ID": "2000000101",
    "ObjVersion": 2,
    "DocQueue_ID": "S700000101",
    "Period_ID": "4200000101",
    "OrdNumber": 1,
    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
    "CreatedBy_ID": "SUPER00000",
    "CorrectedBy_ID": null,
    "Firm_ID": "8000000101",
    "Description": "",
    "Amount": 200,
    "FirmOffice_ID": "8000000101",
    "Person_ID": null,
    "Note": "",
    "Recipient_ID": "3000000101",
    "Division_ID": "2100000101",
    "BusOrder_ID": null,
    "BusTransaction_ID": null,
    "PostProvider_ID": "1000000000",
    "ReceivedContent_ID": "2000000000",
    "IssuedDoc_ID": null,
    "State_ID": "1000000000"
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "pdmreceiveddocs", "take": "1"}
POST
https://atd.abra.eu/demodata/pdmreceiveddocs/query
{"take": "1"}
Response 
{
    "ID": "2000000101",
    "ObjVersion": 2,
    "DocQueue_ID": "S700000101",
    "Period_ID": "4200000101",
    "OrdNumber": 1,
    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
    "CreatedBy_ID": "SUPER00000",
    "CorrectedBy_ID": null,
    "Firm_ID": "8000000101",
    "Description": "",
    "Amount": 200,
    "FirmOffice_ID": "8000000101",
    "Person_ID": null,
    "Note": "",
    "Recipient_ID": "3000000101",
    "Division_ID": "2100000101",
    "BusOrder_ID": null,
    "BusTransaction_ID": null,
    "PostProvider_ID": "1000000000",
    "ReceivedContent_ID": "2000000000",
    "IssuedDoc_ID": null,
    "State_ID": "1000000000"
}
Request 
POST
https://atd.abra.eu/demodata/pdmreceiveddocs?select=id
Body 
{
    "Amount": 200,
    "BusOrder_ID": null,
    "BusTransaction_ID": null,
    "CorrectedBy_ID": null,
    "CreatedBy_ID": "SUPER00000",
    "Description": "",
    "Division_ID": "2100000101",
    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
    "DocQueue_ID": "S700000101",
    "FirmOffice_ID": "8000000101",
    "Firm_ID": "8000000101",
    "IssuedDoc_ID": null,
    "Note": "",
    "OrdNumber": 1,
    "Period_ID": "4200000101",
    "Person_ID": null,
    "PostProvider_ID": "1000000000",
    "ReceivedContent_ID": "2000000000",
    "Recipient_ID": "3000000101",
    "State_ID": "1000000000"
}
Response 
{
    "id": "2000000101"
}
Request 
PUT
https://atd.abra.eu/demodata/pdmreceiveddocs/{id}?select=id
Body 
{
    "Amount": 200,
    "BusOrder_ID": null,
    "BusTransaction_ID": null,
    "CorrectedBy_ID": null,
    "CreatedBy_ID": "SUPER00000",
    "Description": "",
    "Division_ID": "2100000101",
    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
    "DocQueue_ID": "S700000101",
    "FirmOffice_ID": "8000000101",
    "Firm_ID": "8000000101",
    "IssuedDoc_ID": null,
    "Note": "",
    "OrdNumber": 1,
    "Period_ID": "4200000101",
    "Person_ID": null,
    "PostProvider_ID": "1000000000",
    "ReceivedContent_ID": "2000000000",
    "Recipient_ID": "3000000101",
    "State_ID": "1000000000"
}
Response 
{
    "id": "2000000101"
}
DELETE
https://atd.abra.eu/demodata/pdmreceiveddocs/{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": "pdmreceiveddocs",
                "object_data": {
                    "Amount": 200,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CorrectedBy_ID": null,
                    "CreatedBy_ID": "SUPER00000",
                    "Description": "",
                    "Division_ID": "2100000101",
                    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
                    "DocQueue_ID": "S700000101",
                    "FirmOffice_ID": "8000000101",
                    "Firm_ID": "8000000101",
                    "IssuedDoc_ID": null,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostProvider_ID": "1000000000",
                    "ReceivedContent_ID": "2000000000",
                    "Recipient_ID": "3000000101",
                    "State_ID": "1000000000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "pdmreceiveddocs",
                "object_data": {
                    "Amount": 200,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CorrectedBy_ID": null,
                    "CreatedBy_ID": "SUPER00000",
                    "Description": "",
                    "Division_ID": "2100000101",
                    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
                    "DocQueue_ID": "S700000101",
                    "FirmOffice_ID": "8000000101",
                    "Firm_ID": "8000000101",
                    "IssuedDoc_ID": null,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostProvider_ID": "1000000000",
                    "ReceivedContent_ID": "2000000000",
                    "Recipient_ID": "3000000101",
                    "State_ID": "1000000000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000100",
                "object_data": {
                    "Amount": 200,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CorrectedBy_ID": null,
                    "CreatedBy_ID": "SUPER00000",
                    "Description": "",
                    "Division_ID": "2100000101",
                    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
                    "DocQueue_ID": "S700000101",
                    "FirmOffice_ID": "8000000101",
                    "Firm_ID": "8000000101",
                    "IssuedDoc_ID": null,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostProvider_ID": "1000000000",
                    "ReceivedContent_ID": "2000000000",
                    "Recipient_ID": "3000000101",
                    "State_ID": "1000000000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000101",
                "object_data": {
                    "Amount": 200,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CorrectedBy_ID": null,
                    "CreatedBy_ID": "SUPER00000",
                    "Description": "",
                    "Division_ID": "2100000101",
                    "DocDate$DATE": "2006-03-31T22:00:00.000Z",
                    "DocQueue_ID": "S700000101",
                    "FirmOffice_ID": "8000000101",
                    "Firm_ID": "8000000101",
                    "IssuedDoc_ID": null,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostProvider_ID": "1000000000",
                    "ReceivedContent_ID": "2000000000",
                    "Recipient_ID": "3000000101",
                    "State_ID": "1000000000"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "pdmreceiveddocs",
                "obj_id": "2000000104"
            }
        }
    ]
}