header API

API : Accéder à la liste de vos contrats

Il est possible de récupérer une liste de vos contrats selon des critères comme la date de début, la date de fin, le client, l'initiateur du contrat.

La méthode qui permet de récuperer les contrat est getContracts l'appel s'effectue en POST et attend du JSON.

Retrouver les contrats

Cette url permet d'obtenir une liste des contrats qui corresponde aux critères demandé.

https://[host]/calinda/hub/selling/do?m=getContracts

Paramètres :

Il existe des paramètres effectuer la recherche et d'autres pour ordonné la recherche selon vos besoin.

Tout d'abord les paramètres de recherche vont permettre de récupérer une liste qui répond le mieux à vos besoin.

Les champs de recherches sont :

  • bundleId : Id de la liasse, cela permettra de retourner tous les contrats liés à cette liasse. (Chaîne de caractère)
  • city : ville du client. (Chaîne de caractère)
  • colValues
  • company : Raison sociale du client (Chaîne de caractère)
  • contractDefinitionId : Modèle de contrat. (Chaîne de caractère)
  • contractSelector : 
    • 0 tous les contrats
    • 1 Contrats en cours : ouverts en attente de signature
    • 2 Contrats à valider : signés mais pas validés
    • 3 Contrats validés : contresignés
    • 4 Contrats archivés
    • 5 Contrats abandonnés
  • customer  numéro du client (Chaîne de caractère)
  • vendor : email de l'initiateur de la transaction (Chaîne de caractère)
  • startDate : date de début de la période de recherche en milliseconde (pour ne pas filtrer avec la date mettre 0)
  • endDate : date de la fin de la période de recherche en milliseconde (pour ne pas filtrer avec la date mettre 0)

Les paramètres de tri vont permettre de trié vos recherche selon les colonnes disponible pour le tri

Les champs pour le tri sont :

  • column : on attend le numéro de la colonne (Chaîne de caractère)  sur la quel le tri doit être effectué.
    • STATUS : "0"
    • DATE : "1"
    • VENDOR : "2"
    • COMPANY : "3"
    • CITY : "4"
    • CUSTOMER : "5"
    • MODEL: "6"
  • direction : sens du tri  (Chaîne de caractère)
    • Montant :  "0"
    • Descendant : "1"

Vous pouvez également appliqué un système de fenêtrage des résultats, cela vous permettra de ne pas tous les récupérer directement, si un grand nombre de contrat correspond à votre recherche.

Les champs pour le fenêtrage des résultats sont :

  • offset : Retour des recherche à partir du Nième résultat 
  • size : Nombre d'élément demandé 
This content will show up directly in it's container.

    Exemple :

    https://cloud.sellandsign.com/calinda/hub/selling/do?m=getContracts
    
    POST Param
    { 
    "contractSelector": 0, 
    "contractId": "",
     "vendor": "",
     "company": "",
     "contractDefinitionId": "",
     "startDate": 0,
     "endDate": 0, 
    "customer": "",
     "city" : "",
     "column": "1",
     "direction":"1",
    "offset": 0,
     "size": 150,
     "bundleId": "",
     "colValues": {} 
    }

    Retour:

    customerProperties  : {}
    elements[0]: {
    
            actorId: 2
            bundleId: 0
            canceledReason: ""
            city: "Marseille"
            closed: false
            closedDate: 0
            companyName: ""
            contractDefinitionContentToken: ""
            contractDefinitionDocumentToken: ""
            contractDefinitionId: 1
            contractDefinitionShowOptions: false
            contractTypeName: "selling.default_contract.adhoc.title"
            contractorName: ""
            customer: {
                number: "Mi4xNDk5Njc3OTg1NDE0LjE1OTgw",
                actorId: 2,
                syncTimer: 1519826515183,
                civility: "MONSIEUR",
                …
            }
            customerEntityId: 0
            customerName: "Test"
            customerNumber: "Mi4xNDk5Njc3OTg1NDE0LjE1OTgw"
            date: 1519826521942
            documentToken: "MTUxOTgyNjU2MTcxMV8zOTM5XzMxMzI0MA=="
            filename: "test.pdf"
            id: 3939
            keepOnMove: 0
            lastModificationPlace: "SERVER"
            messageBody: ""
            messageTitle: ""
            optionStatus: [, …]
            optionsList: [0, 4425]
            parentContractId: 0
            picturesCount: 0
            status: "SIGNED"
            syncTimer: 1519826587017
            transactionId: "2c949e2f61b2cb750161dcb8e0c717c7"
            vendorEmail: "test@calindasoftware.com"
            totalSize: 1
        }