Hitos

Cada contrato puede tener uno o varios hitos relacionados, es posible enlistar, crear y marcar como completados los hitos de un contrato a través de nuestro API.

GEThttps://enterprise.api.trato.io/api/contract/milestones/{:contractID}

Obtener Hitos

Para consultar los hitos de un contrato es necesario hacer la siguiente llamada:

Atributos

Name
contractID
Type
string
Description
Indica el Id del contrato.

Atriubutos de respuesta

Name
contractid
Type
string
Description
Indica el Id del contrato
Name
milestones._id
Type
string
Description
Indica el id del hito.
Name
milestones.completed
Type
integer
Description
Indica si el hito esta completado (true/false).
Name
milestones.name
Type
string
Description
Indica el nombre del hito.
Name
milestones.expectedDate
Type
string
Description
Indica la fecha del hito.
Name
milestones.realDate
Type
string
Description
Indica la fecha real del hito.

Request

GET

/api/contract/milestones/{:contractID}

curl -G https://enterprise.api.trato.io/api/contract/milestones/{:contractID}

Response

{
    'contractid': true,
    'milestones': [
        {
            '_id': "5e7bebe8a1d5562b643b8c8d",
            'completed': true,
            'name': 'Hito relevante a un pago',
            'expectedDate': "2020-03-25T23:40:24.119Z",
            'realDate': "2020-03-25T23:46:08.729Z"
        }
    ]
}

POSThttps://enterprise.api.trato.io/api/contract/milestones/{:contractID}/{:milestoneID}

Crear Hito

Para usar el api key, deberás enviarlo a traves de un Header llamado "apikey". Si mandas el apikey en un header no es necesario generar el JWT

Ejemplo de petición usando apikey

curl https://enterprise.api.trato.io/api/authentication \
  -H "apikey: {apikey}"

Mantén siempre su token ó apikey seguro para que no sea comprometido.