Upload client batch

POST /upload/batch

Endpoint to upload a batch of client data for negotiation.

Body Required

  • dateUploaded string(date-time)

    DateTime when the data was uploaded.

  • clientsNumber integer
  • clients array[object]
    Hide clients attributes Show clients attributes array[object]
    • idSerlefin string

      Encrypted combination of Cedula and PhoneNumber.

    • firstName string
    • debtTime integer

      Debt time in days.

    • debtValue integer
    • pastInteractions array[object]
      Hide pastInteractions attributes Show pastInteractions attributes array[object]
      • interactionType string

        Type of interaction.

        Values are call, message, or whatsapp.

      • direccion string

        Direction of interaction.

        Values are in or out.

      • result object

        Logs of the interaction.

    • carteraType array[string]
    • minNegociationDiscount number(float)

      Minimum negotiation discount.

      Minimum value is 0, maximum value is 1.

    • maxNegociationDiscount number(float)

      Maximum negotiation discount.

    • expectedPaymentDate string(date-time)

      Expected date of payment.

    • maxInstallments integer

      Maximum number of installments.

Responses

  • 200

    Successful operation

    Hide response attribute Show response attribute object
    • batchId string

      ID of the uploaded batch.

POST /upload/batch
curl \
 -X POST https://serlefin.api.domu.ai/upload/batch \
 -H "Content-Type: application/json" \
 -d '{"dateUploaded":"2023-08-18T12:00:00Z","clientsNumber":1,"clients":[{"idSerlefin":"encryptedString","firstName":"John","debtTime":30,"debtValue":1000,"pastInteractions":[{"interactionType":"call","direccion":"in","result":{}}],"carteraType":["preventiva"],"minNegociationDiscount":0.1,"maxNegociationDiscount":0.5,"expectedPaymentDate":"2023-09-18T12:00:00Z","maxInstallments":5}]}'
Request example
{
  "dateUploaded": "2023-08-18T12:00:00Z",
  "clientsNumber": 1,
  "clients": [
    {
      "idSerlefin": "encryptedString",
      "firstName": "John",
      "debtTime": 30,
      "debtValue": 1000,
      "pastInteractions": [
        {
          "interactionType": "call",
          "direccion": "in",
          "result": {}
        }
      ],
      "carteraType": [
        "preventiva"
      ],
      "minNegociationDiscount": 0.1,
      "maxNegociationDiscount": 0.5,
      "expectedPaymentDate": "2023-09-18T12:00:00Z",
      "maxInstallments": 5
    }
  ]
}
Request examples
{
  "clients": [
    {
      "debtTime": 30,
      "debtValue": 1000,
      "firstName": "John",
      "idSerlefin": "encryptedString",
      "carteraType": [
        "preventiva"
      ],
      "maxInstallments": 5,
      "pastInteractions": [
        {
          "result": {},
          "direccion": "in",
          "interactionType": "call"
        }
      ],
      "expectedPaymentDate": "2023-09-18T12:00:00Z",
      "maxNegociationDiscount": 0.5,
      "minNegociationDiscount": 0.1
    }
  ],
  "dateUploaded": "2023-08-18T12:00:00Z",
  "clientsNumber": 1
}
Response examples (200)
{
  "batchId": "string"
}
Response examples (200)
{
  "batchId": "string"
}