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:
|
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", "externalId": "34568", "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", "externalId": "367567", "contacts": [ { "id": "22424" } ] } ] }
Método getClient
Método para obtener un cliente 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:
|
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&expandContacts=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", "externalId": "567855", "contacts": [ { "id": "22423" "name": "John", "lastName": "Doe", "email": "john@doe.com", "position": null, "contactTypeId": "5", "contactTypeName": "Administrativo" } ] }
Método getClientTaxId
Método para obtener un cliente específico.
Parámetro | Descripción | ||||||
---|---|---|---|---|---|---|---|
Método | GET | ||||||
URL | https://api.duemint.com/v1/getClientTaxId<params> | ||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué cliente se desea obtener. Los parametros posibles son:
|
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/getClientTaxId?taxId=22879&expandContacts=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", "externalId": "567855", "contacts": [ { "id": "22423" "name": "John", "lastName": "Doe", "email": "john@doe.com", "position": null, "contactTypeId": "5", "contactTypeName": "Administrativo" } ] }
Método getClientExternalId
Método para obtener un cliente específico.
Parámetro | Descripción | ||||||
---|---|---|---|---|---|---|---|
Método | GET | ||||||
URL | https://api.duemint.com/v1/getClientExternalId<params> | ||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué cliente se desea obtener. Los parametros posibles son:
|
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/getClientExternalId?externalId=22879&expandContacts=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", "externalId": "567855", "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.
|
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", "externalId": "34678", "contacts": [] } "files": []
Método updateClient
Método para actualizar un Cliente.
Parámetro | Descripción | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | PUT | |||||||||||||||||||||||||||||||||||||||
URL | https://api.duemint.com/v1/updateClient | |||||||||||||||||||||||||||||||||||||||
Post Params |
Parametros a comunicar.
|
A continuación se muestra un ejemplo usando el método updateClient de la API de Duemint.
METHOD PUT curl "https://api.duemint.com/v1/updateClient' -X PUT \ -d '{"id": "22879","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", "externalId": "34678", "contacts": [] } "files": []