Odeslaná pošta

GET

/pdmissueddocs

Získá kolekci BO Odeslaná pošta

GET

/pdmissueddocs/{id}

Získá konkrétní BO Odeslaná pošta

POST

/pdmissueddocs

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

PUT

/pdmissueddocs/{id}

Provede aktualizaci BO Odeslaná 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

/pdmissueddocs/{id}

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

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; ID objektu 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; 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

CashOnDelivery number

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

ClosingIndex integer

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

Closing_ID string (pdmclosing) relace

Uzávěrka; ID objektu Uzávěrka pošty, pole vlastněné tabulkou, možné řadit a filtrovat

ConstSymbol_ID string (constantsymbol) relace

Konstantní symbol; ID objektu 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; 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

ExportNumber integer

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

FirmBankAccount_ID string (firmbankaccount) relace

Cizí bankovní účet; ID objektu Bankovní účet firmy, 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

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; ID objektu Typy obsahů odeslané pošty, 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 (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

PostNumber string (60)

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

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

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

PriceList_ID string (pdmpricelist) relace

Ceník; ID objektu Ceník pošty, 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; ID objektu 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

Řádky; 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; 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

TargetAddressType integer

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

TargetAddress_ID

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'

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í

SourceCLSID string (26)

Typ dokladu pro připojení

Source_ID string (datadocumentbusinessobject) relace

Doklad pro připojení; ID objektu Dokument

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 
{
    "ID": "2100000101",
    "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 
{
    "ID": "2100000101",
    "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,
    "ClosingIndex": 0,
    "Closing_ID": null,
    "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,
    "FirmBankAccount_ID": null,
    "FirmOffice_ID": "J000000101",
    "Firm_ID": "J000000101",
    "InsuredValue": 0,
    "IssuedContent_ID": "O000000000",
    "LongestSide": 0,
    "Multiplicator": 1,
    "Note": "",
    "OrdNumber": 1,
    "Period_ID": "4200000101",
    "Person_ID": null,
    "PostNumber": "",
    "PostProvider_ID": "1000000000",
    "Postage": 60,
    "PostageInCash": false,
    "PriceList_ID": "3100000000",
    "PrintQueueNumber": "",
    "ReceivedDoc_ID": null,
    "Rows": [],
    "Sender_ID": "3000000101",
    "TargetAddressType": 0,
    "VarSymbol": "",
    "Weight": 1.5,
    "WeightUnit": 1
}
Response 
{
    "id": "2100000101"
}
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,
    "ClosingIndex": 0,
    "Closing_ID": null,
    "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,
    "FirmBankAccount_ID": null,
    "FirmOffice_ID": "J000000101",
    "Firm_ID": "J000000101",
    "InsuredValue": 0,
    "IssuedContent_ID": "O000000000",
    "LongestSide": 0,
    "Multiplicator": 1,
    "Note": "",
    "OrdNumber": 1,
    "Period_ID": "4200000101",
    "Person_ID": null,
    "PostNumber": "",
    "PostProvider_ID": "1000000000",
    "Postage": 60,
    "PostageInCash": false,
    "PriceList_ID": "3100000000",
    "PrintQueueNumber": "",
    "ReceivedDoc_ID": null,
    "Rows": [],
    "Sender_ID": "3000000101",
    "TargetAddressType": 0,
    "VarSymbol": "",
    "Weight": 1.5,
    "WeightUnit": 1
}
Response 
{
    "id": "2100000101"
}
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,
                    "ClosingIndex": 0,
                    "Closing_ID": null,
                    "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,
                    "FirmBankAccount_ID": null,
                    "FirmOffice_ID": "J000000101",
                    "Firm_ID": "J000000101",
                    "InsuredValue": 0,
                    "IssuedContent_ID": "O000000000",
                    "LongestSide": 0,
                    "Multiplicator": 1,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostNumber": "",
                    "PostProvider_ID": "1000000000",
                    "Postage": 60,
                    "PostageInCash": false,
                    "PriceList_ID": "3100000000",
                    "PrintQueueNumber": "",
                    "ReceivedDoc_ID": null,
                    "Rows": [],
                    "Sender_ID": "3000000101",
                    "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,
                    "ClosingIndex": 0,
                    "Closing_ID": null,
                    "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,
                    "FirmBankAccount_ID": null,
                    "FirmOffice_ID": "J000000101",
                    "Firm_ID": "J000000101",
                    "InsuredValue": 0,
                    "IssuedContent_ID": "O000000000",
                    "LongestSide": 0,
                    "Multiplicator": 1,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostNumber": "",
                    "PostProvider_ID": "1000000000",
                    "Postage": 60,
                    "PostageInCash": false,
                    "PriceList_ID": "3100000000",
                    "PrintQueueNumber": "",
                    "ReceivedDoc_ID": null,
                    "Rows": [],
                    "Sender_ID": "3000000101",
                    "TargetAddressType": 0,
                    "VarSymbol": "",
                    "Weight": 1.5,
                    "WeightUnit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000100",
                "object_data": {
                    "Amount": 60,
                    "BankAccount_ID": null,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CashOnDelivery": 100,
                    "ClosingIndex": 0,
                    "Closing_ID": null,
                    "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,
                    "FirmBankAccount_ID": null,
                    "FirmOffice_ID": "J000000101",
                    "Firm_ID": "J000000101",
                    "InsuredValue": 0,
                    "IssuedContent_ID": "O000000000",
                    "LongestSide": 0,
                    "Multiplicator": 1,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostNumber": "",
                    "PostProvider_ID": "1000000000",
                    "Postage": 60,
                    "PostageInCash": false,
                    "PriceList_ID": "3100000000",
                    "PrintQueueNumber": "",
                    "ReceivedDoc_ID": null,
                    "Rows": [],
                    "Sender_ID": "3000000101",
                    "TargetAddressType": 0,
                    "VarSymbol": "",
                    "Weight": 1.5,
                    "WeightUnit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000101",
                "object_data": {
                    "Amount": 60,
                    "BankAccount_ID": null,
                    "BusOrder_ID": null,
                    "BusTransaction_ID": null,
                    "CashOnDelivery": 100,
                    "ClosingIndex": 0,
                    "Closing_ID": null,
                    "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,
                    "FirmBankAccount_ID": null,
                    "FirmOffice_ID": "J000000101",
                    "Firm_ID": "J000000101",
                    "InsuredValue": 0,
                    "IssuedContent_ID": "O000000000",
                    "LongestSide": 0,
                    "Multiplicator": 1,
                    "Note": "",
                    "OrdNumber": 1,
                    "Period_ID": "4200000101",
                    "Person_ID": null,
                    "PostNumber": "",
                    "PostProvider_ID": "1000000000",
                    "Postage": 60,
                    "PostageInCash": false,
                    "PriceList_ID": "3100000000",
                    "PrintQueueNumber": "",
                    "ReceivedDoc_ID": null,
                    "Rows": [],
                    "Sender_ID": "3000000101",
                    "TargetAddressType": 0,
                    "VarSymbol": "",
                    "Weight": 1.5,
                    "WeightUnit": 1
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "pdmissueddocs",
                "obj_id": "2100000104"
            }
        }
    ]
}