Auto Light Dark
Auto Light Dark
German English

getDocuments

ag.itc.getDocuments

Ermittelt alle Dokumente anhand der übergebenen Geschäftspartner-Nummer oder dem Primärschlüssel des Geschäftspartners.

Im Standard werden Dokumente der folgenden Kategorien zurückgeliefert: NZA30, NZB30, NA, E9_4105

Die Liste kann in der Methode SC12ITCUtils.getTINADocumentCategories() bei Bedarf angepasst werden.

Request

JSON-Attribut

Datentyp

Pflicht

Anmerkungen

Entität

Feldname

Feldname intern

Anmerkungen

customerNo

String(250)

Ja *

  • entweder customerPk oder customerNo ist Pflicht

Geschäftspartner

Geschäftspartner-Nr.

CustomerNo2.Customer


customerPk

String(250)

Ja*

Geschäftspartner

Primärschlüssel

Pk.Customer


contactPersonPk 2026.6

String(250)

Nein

Ermöglicht das ansprechpartnerscharfe Abrufen von Dokumenten

Ansprechpartner

Primärschlüssel

Pk.ContactPerson

  • Wenn contactPersonPk gefüllt ist, werden ausschließlich die Dokumente, die mit dem übermittelten Ansprechpartner verknüpft sind, zurückgeliefert.

  • Wenn gleichzeitig zum contactPersonPk der customerPk oder die customerNo gefüllt ist, werden customerPk/customerNo ignoriert und nicht die Dokumente des customers geliefert

fromDate

@Date

Nein

Ab-Datum, ermöglicht die Einschränkung des Zeitraums

Dokumente

Erstellungsdatum

FileSystemCreation.Document

Prüfung auf Erstellungsdatum

toDate

@Date

Nein

Bis-Datum, ermöglicht die Einschränkung des Zeitraum

Dokumente

Erstellungsdatum

FileSystemCreation.Document

Prüfung auf Erstellungsdatum

Beispiel
JSON
{
    "eventType": "ag.itc.getDocuments",
    "payload": {
        "customerPk": "VfkPowerRangersCu",
        "contactPersonPk": "HansiVauefka-WasserCoPe",
        "fromDate" : "2026-01-01"
    }
}

Response

JSON-Attribut

Datentyp

Pflicht

Anmerkungen

Entität

Feldname

Feldname intern

Anmerkungen

 documents

List<@document>

 Nein

 

Dokumente

 

 

 

Beispiel
{
    "id": "m9lhki1k5hdkcb3EvAr",
    "status": "DONE",
    "payload": {
        "duration": 67,
        "documents": [
            {
                "documentDate": "2026-06-15T14:30:00+00:00",
                "documentNo": "INSTALLVW01Do",
                "documentType": "INSTALLVW",
                "displayName": "Installateurvertrag_Wasser_H-VFK.pdf",
                "processLists": "PRJ-ITC-0000031",
                "documentPk": "INSTALLVW01Do",
                "fileType": "pdf"
            }
        ]
    }
}