Zum Hauptinhalt springen

API V1 - GraphQL Anwendungsfälle

QUERIES

Alle Vorlagen abrufen (auf die Sie Zugriff haben)

Input : Keine

Output : typeId

Anfrage :

query Types {
    types {
        count
        types {
            id
            name
            description
        }
    }
}

Alle Verträge abrufen (auf die Sie Zugriff haben)

Input : Keine

Output : contractId

Anfrage :

query Contracts {
    contracts {
        count
        contracts {
             id
             name
             status
        }
    }
}

Informationen zu einem bestimmten Vertrag abrufen

Output : Gewünschte Information

Input : contractId

Anfrage :

query Contract {
     contract(id: "4a5cac44-390a-4235-9442-e684a8d21xxx") {
          id
          name
          status
     }
}

Alle Verträge abrufen, bei denen Attribut = „Wert"

Input : attributeDefinitionId und der zugehörige value

Output : contractId

Anfrage :

query Contracts($filters: [ContractFilterInput!]) {
    contracts(filters: $filters) {
        count
        contracts {
            id
            name
        }
    }
}

Variablen-Beispiel 1 (alle Verträge abrufen, bei denen die Gegenpartei „My external Company" ist):

{
    "filters": [
      {
        "attributeDefinitionId": "externalCompanyId",
        "value": "4a5cac44-390a-4235-9442-e684a8d21xxx",
        "operator": "EQUAL",
        "condition": "AND"
      }
   ]
}

Variablen-Beispiel 2 (alle Verträge abrufen, bei denen die Verlängerungsart stillschweigend ist):

{
    "filters": [
      {
        "attributeDefinitionId": "0144e4a2-75ed-4893-954f-84686eb94xxx",
        "value": "tacit",
        "operator": "EQUAL",
        "condition": "AND"
      }
   ]
}

Alle Gegenparteien abrufen

Input : x

Output : externalCompanyId

Anfrage :

query ExternalCompanies {
    externalCompanies {
        count
        externalCompanies {
            id
            name
        }
    }
}

MUTATIONS

Create a project

1. Einen Vertrag erstellen

Input : typeID & externalCompany.name

Output : contractId

Anfrage :

mutation CreateContract {
    createContract(
        input: {
            externalCompany: { name: "My External Company" }
            typeId: "c63b2aad-6650-41f8-adb5-8c572aa12xxx"
        }
    ) {
        id
        name
    }
}

2. createDocument

Input : contractId & templateId

Output : url / key

Anfrage :

mutation CreateDocument {
    createDocument(
        input: {
            templateId: "34745518-30c0-4097-b192-51f924258xxx"
            contractId: "feceeb15-ff2f-4ab4-a7a4-af411d1a8xxx"
        }
    ) {
        id
        contractId
        version
        status
        createdAt
    }
}

Vertragsattribute aktualisieren

Input : attributeDefinitionId und der zugehörige value associated / contractId

Output : x

Anfrage :

mutation UpdateContractAttributes {
    updateContractAttributes(
        input: {
            contractAttributes: [
                {
                    attributeDefinitionId: "22363fad-25e8-48e4-a6ee-2cf6b1b90xxx",
                    value: "Tacit"
                },
                {
                    attributeDefinitionId: "e4de6a6b-66f8-4685-aa07-e49e07087836",
                    value: "Marketing"
                },
                {
                    attributeDefinitionId: "startAt",
                    value: "2025-01-01"
                },
            ],
            contractId: "585602c2-97b7-4671-ac37-1f33a2b50xxx"
        }
    ) {
        attributeDefinitionId
        contractId
        value
        context
        updatedAt
    }
}

Ein Mitglied zu einem Vertrag hinzufügen

Input : memberID / contractId

Output : x

Anfrage :

mutation CreateContractMember {
    createContractMember(
        contractId: "eec563c3-a652-47e3-999b-b0ec7761axxx"
        memberId: "95469046-45d0-4a37-a68a-bc8a6481dxxx"
    ) {
        id
        role
    }
}

Eine Datei zu einem Vertrag hinzufügen

1. CreateFileSignedUrl

Input : x

Output : url & key

⚠️ Hinweis: Die von dieser Mutation zurückgegebenen Headers sind nur 30 Sekunden gültig!

Anfrage :

mutation CreateFileSignedUrl {
    createFileSignedUrl(contentType: "application/pdf") {
        method
        url
        key
    }
}

2. Datei auf die URL hochladen (PUT)

3. AcceptForSignature

Input : file.name, file.contentType & file.key

Output : -

Anfrage :

mutation CreateContractFile {
    createContractFile(
        input: {
            contractId: "eec563c3-a652-47e3-999b-b0ec7761axxx"
            file: {
                name: "Quote.pdf"
                contentType: "application/pdf"
                key: "signedFiles/392ef54d-dc59-41f6-8ef9-37c6a1b7d353/files/43939e25-df1b-489f-9242-804f6dcd8xxx"
            }
        }
    ) {
        id
        contractId
        isFromEmail
    }
}

Zur Unterzeichnung versenden

1. AssignSignatoryUser

Input : contractId & signatoryID

Output : -

⚠️ Hinweis: Muss so oft wiederholt werden, wie es Signaturfelder gibt.

Anfrage :

mutation AssignSignatoryUser {
    assignSignatoryUser(
        input: {
            contractId: "eec563c3-a652-47e3-999b-b0ec7761axxx"
            signatoryId: "14db8490-08e0-4238-9626-a1845c166xxx"
            email: "testAPI@tomorro.com"
        }
    ) {
        id
        name
        email
        title
        locationOfSignature
        mention
        memberId
        guestId
        type
        isBlank
    }
}

2. PrepareDocumentForSignature

Input : documentId

Output : -

Anfrage :

mutation PrepareDocumentForSignature {
    prepareDocumentForSignature(
        input: { documentId: "5a5d4fef-179c-4cd5-8606-47568cdb6xxx" }
    )
}

3. AcceptForSignature

Input : contractId & documentID

Output : -

Anfrage :

mutation AcceptForSignature {
    acceptForSignature(
        input: {
            contractId: "eec563c3-a652-47e3-999b-b0ec7761axxx"
            documentId: "5a5d4fef-179c-4cd5-8606-47568cdb6xxx"
        }
    ) {
        id
        contractId
        documentId
        type
        status
        sentAt
        signedAt
        url
        firstSigningParty
    }
}

Unterzeichnete Dateien herunterladen

1. Webhook

Richten Sie einen Webhook in Tomorro ein, um bei jeder Vertragsunterzeichnung benachrichtigt zu werden.

⚠️ Hinweis: Richten Sie den Webhook über ein Konto mit Zugriff auf das gesamte Repository ein, wenn Sie für alle Verträge benachrichtigt werden möchten.

Output : contractId

2. signatureByContractId

Input : contractId

Output : fileId

Anfrage :

query SignatureByContractId {     
    signatureByContractId(contractId: "f614b602-e935-4ef4-95c4-6e2f054d5xxx") {         
        id         
        contractId         
        signatureFiles {             
            id             
            file {                 
                id
                name
            }
        }
    }
}

3. createFileDownloadSignedUrl

Input : fileId

Output : url / key

Anfrage :

mutation CreateFileDownloadSignedUrl {    
    createFileDownloadSignedUrl(fileId: "3aad565e-16e6-4124-94d3-8a8b80c9cxxx") {
        url
        key
    }
}

Import counterparty

1. createExternalCompany

Input : Keine

Output : externalCompanyId

Anfrage :

mutation CreateExternalCompany {
    createExternalCompany(input: { name: "My External Company" }) {
        id
        attributes {
            externalCompanyId
            attributeDefinition {
                id
                name
            }
        }
    }
}

2. UpdateExternalCompanyAttributes

Input : documentId

Output : -

Anfrage :

mutation UpdateExternalCompanyAttributes($input: ExternalCompanyAttributeUpdateInput!) {
    updateExternalCompanyAttributes(input: $input) {
        externalCompanyId
        value
    }
}

Variablen :

{
    "input": {
        "externalCompanyId": "52ea33b7-19a8-48e9-a484-009b6a874xxx",
        "externalCompanyAttributes": [
            {
                "attributeDefinitionId": "0144e4a2-75ed-4893-954f-84686eb94xxx",
                "value": "498 avenue de Sautie"
            },
            {
                "attributeDefinitionId": "e8b3effb-6722-48cf-b9c6-f6a306a12xxx",
                "value": "2025-10-10"
            }
        ]
    }
}

Verwandte Artikel
API V1 - GraphQL Dokumentation
Webhooks - Dokumentation
API V2 - Dokumentation REST
Use-Case No-Code: Signierte Verträge in meinem eigenen Speicher sichern
Hat dies deine Frage beantwortet?