Objeto Cliente

Puedes hacer uso de la API para solicitar la información de uno o más clientes de tu empresa.

Método getClients

Método para obtener una lista de clientes de la empresa de acuerdo a parámetros definidos.

Parámetro Descripción
Método GET
URL https://api.duemint.com/v1/getClients<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué clientes se desea obtener. Los parametros posibles son:
since date Fecha desde cuando contar los clientes en formato YYYY-MM-DD, con respecto a la fecha de creación
until date Fecha hasta cuando contar los clientes en formato YYYY-MM-DD, con respecto a la fecha de creación
country string(2) Código ISO de 2 letras del país que se desea filtrar. Por ejemplo US para Estados Unidos o CL para Chile
orderBy integer 1: Fecha de creación (por defecto); 2: Nombre
order string ASC o DESC (default)
resultsPerPage integer Número de resultados por solicitud. Por defecto = 50 (máximo 100)
page integer Página de resultados. Por defecto = 1
expandContact bool 0: No expandir (Por defecto), 1: Expandir información del contacto

A continuación se muestra un ejemplo usando el método getClients de la API de Duemint.

METHOD GET
curl "https://api.duemint.com/v1/getClients?resultsPerPage=2" \
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "records": {
    "totalRecords": 12,
    "items": 2,
    "page": 1,
    "pages": 24
  },
  "items": [
    {
      "id": "22879",
      "name": "Beauty Apps",
      "taxId": "11111111-1",
      "country": "Chile",
      "region": "Metropolitana",
      "city": "Santiago",
      "address": "Direccion Matriz 123",
      "zipcode": "",
      "phone": "(+562) 24312345",
      "fax": "",
      "paymentTerm": 60,
      "sendReminders": {
        "newDocument": true,
        "soonToExpire": true,
        "expired": true,
        "newPayment": true,
        "debtSummary": true
      },
      "url": "https:\/\/www.duemint.com\/portal\/22879\/p5ackui56527s",
      "contacts": [
        {
          "id": "22423"
        }
      ]
    },
    {
      "id": "22880",
      "name": "Servicios de Ejemplo Ltda.",
      "taxId": "1-9",
      "country": "Chile",
      "region": "",
      "city": "",
      "address": "",
      "zipcode": "",
      "phone": "",
      "fax": "",
      "paymentTerm": 30,
      "sendReminders": {
        "newDocument": true,
        "soonToExpire": true,
        "expired": true,
        "newPayment": true,
        "debtSummary": true
      },
      "url": "https:\/\/www.duemint.com\/portal\/22880\/p5acvf67637af",
      "contacts": [
        {
          "id": "22424"
        }
      ]
    }
  ]
}

Método getClient

Método para obtener un pago específico.

Parámetro Descripción
Método GET
URL https://api.duemint.com/v1/getClient<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué cliente se desea obtener. Los parametros posibles son:
id integer Id único del cliente (requerido)
expandContact bool 0: No expandir (Por defecto), 1: Expandir información del contacto

A continuación se muestra un ejemplo usando el método getClient de la API de Duemint.

METHOD GET
curl "https://api.duemint.com/v1/getClient?id=22879&expandContact=1" \
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
  "id": "22879",
  "name": "Beauty Apps",
  "taxId": "11111111-1",
  "country": "Chile",
  "region": "Metropolitana",
  "city": "Santiago",
  "address": "Direccion Matriz 123",
  "zipcode": "",
  "phone": "(+562) 24312345",
  "fax": "",
  "paymentTerm": 60,
  "sendReminders": {
    "newDocument": true,
    "soonToExpire": true,
    "expired": true,
    "newPayment": true,
    "debtSummary": true
  },
  "url": "https:\/\/www.duemint.com\/portal\/22879\/p5ackui56527s",
  "contacts": [
    {
      "id": "22423"
      "name": "John",
      "lastName": "Doe",
      "email": "john@doe.com",
      "position": null,
      "contactTypeId": "5",
      "contactTypeName": "Administrativo"
    }
  ]
}

Método createClient

Método para crear un Cliente.

Parámetro Descripción
Método POST
URL https://api.duemint.com/v1/createClient
Post Params Parametros a comunicar.
name string Nombre o razón social del cliente (requerido)
taxId string Código tributario del cliente. En el caso de ser un cliente chileno el RUT debe ser en formato es sin puntos y con guión (ej: 99999999-9) (requerido)
country string(2) Código ISO de 2 letras del país que se desea filtrar. Por ejemplo US para Estados Unidos o CL para Chile (requerido)
paymentTerm integer Días de plazo de pago por defecto para el cliente
region string Región del cliente
city string Ciudad del cliente
address string Dirección del cliente
phone string Télefono del cliente
fax string Fax del cliente
zipcode string Código Zip del cliente

A continuación se muestra un ejemplo usando el método createClient de la API de Duemint.

METHOD POST
curl "https://api.duemint.com/v1/createClient' -X POST \
 -d '{"name":"Beauty Apps","taxId":"11111111-1","country":"CL","paymentTerm":"15"}'
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

El resultado ejemplo para esta llamada se muestra a continuación:

{
{
  "id": "22879",
  "name": "Beauty Apps",
  "taxId": "11111111-1",
  "country": "Chile",
  "region": "",
  "city": "",
  "address": "",
  "zipcode": "",
  "phone": "",
  "fax": "",
  "paymentTerm": 15,
  "sendReminders": {
    "newDocument": true,
    "soonToExpire": true,
    "expired": true,
    "newPayment": true,
    "debtSummary": true
  },
  "url": "https:\/\/www.duemint.com\/portal\/22879\/p5ackui56527s",
  "contacts": []
}
  "files": []