Objeto Pago

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

Método getPayments

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

Parámetro Descripción
Método GET
URL https://api.duemint.com/v1/getPayments<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué pagos se desea obtener. Los parametros posibles son:
since date Fecha desde cuando contar los pagos en formato YYYY-MM-DD, con respecto a la fecha definida en el parámetro dateBy
until date Fecha hasta cuando contar los pagos en formato YYYY-MM-DD, con respecto a la fecha definida en el parámetro dateBy
dateBy integer 1 = Fecha de pago (por defecto); 2 = Fecha de creación
currency string(3) Código ISO de la moneda que se desea filtrar. Por ejemplo USD para Dólar Americano o CLP para Pesos Chilenos
paymentMethodId integer Id único del método de pago. Ver getPaymentMethods
documentId integer Id único del documento (factura) al que esta asociado el pago. Ver getDocuments
clientId integer Id único del cliente. Ver getClients
clientTaxId string Código tributario del cliente. En el caso de un RUT chileno el formato es sin puntos y con guión (ej: 99999999-9)
orderBy integer 1: Fecha de pago (por defecto); 2: Fecha de creación; 3: Monto pagado
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
expandFile bool 0: No expandir (Por defecto), 1: Expandir información del archivo

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

METHOD GET
curl "https://api.duemint.com/v1/getPayments?clientId=8201&expandFile=1" \
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

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

{
  "records": {
    "totalRecords": 2,
    "items": 2,
    "page": 1,
    "pages": 1
  },
  "items": [
    {
      "id": "42578",
      "createdAt": "2018-03-27 18:07:45",
      "date": "2018-03-23",
      "currency": "CLP",
      "amount": "65770.00",
      "paymentMethod": "",
      "transactionCode": "",
      "documentNumber": "",
      "comments": "",
      "client": {
        "id": "8201"
      },
      "documents": [
        {
          "amount": "31816.00",
          "document": {
            "id": "53413"
          }
        },
        {
          "amount": "31894.00",
          "document": {
            "id": "60866"
          }
        },
        {
          "amount": "2060.00",
          "document": {
            "id": "68469"
          }
        }
      ],
      "files": [
        {
          "id": "62364",
          "name": "Comprobante pago duemint.pdf",
          "ext": "pdf",
          "mime": "application\/pdf",
          "url": "https:\/\/www.duemint.com\/portal\/s3File\/3800183\/67uhi764h8k6kui890.pdf\/62364"
        }
      ]
    },
    {
      "id": "16628",
      "createdAt": "2017-11-20 12:18:45",
      "date": "2017-11-20",
      "currency": "CLP",
      "amount": "31690.00",
      "paymentMethod": "",
      "transactionCode": "",
      "documentNumber": "",
      "comments": "",
      "client": {
        "id": "8201"
      },
      "documents": [
        {
          "amount": "31690.00",
          "document": {
            "id": "44850"
          }
        }
      ],
      "files": []
    }
  ]
}

Método getPayment

Método para obtener un pago específico.

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

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

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

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

{
  "id": "42578",
  "createdAt": "2018-03-27 18:07:45",
  "date": "2018-03-23",
  "currency": "CLP",
  "amount": "65770.00",
  "paymentMethod": "",
  "transactionCode": "",
  "documentNumber": "",
  "comments": "",
  "client": {
    "id": "8201"
  },
  "documents": [
    {
      "amount": "31816.00",
      "document": {
        "id": "53413"
      }
    },
    {
      "amount": "31894.00",
      "document": {
        "id": "60866"
      }
    },
    {
      "amount": "2060.00",
      "document": {
        "id": "68469"
      }
    }
  ],
  "files": [
    {
      "id": "62364",
    }
  ]
}

Método createPayment

Método para crear un pago.

Parámetro Descripción
Método POST
URL https://api.duemint.com/v1/createPayment
Post Params Parametros a comunicar.
clientId integer Id único del cliente del pago (requerido)
total float Monto total del pago (requerido)
date date YYYY-MM-DD Fecha de pago (requerido)
currency string(3) Código ISO de la moneda del documento. Por ejemplo USD para Dólar Americano o CLP para Pesos Chilenos (requerido)
documents array Arreglo con uno o más documentos asociados al pago. Cada tupla del arreglo debe ser {'documentId' => '(int) Id del documento', 'amount' => '(float) monto pagado del documento'} (requerido)
paymentMethod string(255) Nombre del método de pago
transactionCode string(255) Código de transacción
documentNumber string(255) Número de documento
send boolean 0: No enviar (por defecto); 1: Enviar recordatorio de Pago Recibido (si existe)

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

METHOD POST
curl "https://api.duemint.com/v1/createPayment' -X POST \
 -d '{"clientId":"8195","date":"2018-04-06","total":"256525","currency":"CLP","documents":[{"documentId":"77771","amount":"160253"},{"documentId":"106260","amount":"96272"}]}'
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

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

{
  "id": "72839",
  "createdAt": "2018-04-27 13:19:11",
  "date": "2018-04-06",
  "currency": "CLP",
  "amount": "256525.00",
  "paymentMethod": "",
  "transactionCode": "",
  "documentNumber": "",
  "comments": "",
  "client": {
    "id": "8195"
  },
  "documents": [
    {
      "amount": "160253.00",
      "document": {
        "id": "77771"
      }
    },
    {
      "amount": "96272.00",
      "document": {
        "id": "106260"
      }
    }
  ],
  "files": []
}

Método getPaymentMethods

Método para obtener un lista de métodos de pago. El id único de un método de pago puede ser utilizado como parámetro en getPayments

Parámetro Descripción
Método GET
URL https://api.duemint.com/v1/getPaymentMethods<params>
Params Parámetros que pueden ser agregados a la solicitud para discriminar qué tags se desea obtener. Los parametros posibles son:
orderBy integer 1: Id (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

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

METHOD GET
curl "https://api.duemint.com/v1/getPaymentMethods?resultsPerPage=5&order=ASC" \
 -H 'Authorization: Bearer <token>' -H 'Accept: application/json'

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

{
  "records": {
    "totalRecords": 12,
    "items": 5,
    "page": 1,
    "pages": 3
  },
  "items": [
    {
      "id": "1",
      "name": "Transferencia"
    },
    {
      "id": "2",
      "name": "Cheque"
    },
    {
      "id": "3",
      "name": "Dep\u00f3sito"
    },
    {
      "id": "4",
      "name": "Efectivo"
    },
    {
      "id": "5",
      "name": "Vale Vista"
    }
  ]
}