Appearance

Quick Start ​

Sigue esta guía paso a paso para comenzar a usar la API de UpConta.

1. Obtén tus credenciales ​

Solicita al equipo de UpConta tus credenciales de acceso:

  • RUC de la empresa
  • Username de la aplicación
  • Password de acceso

También puedes generar un token directamente desde la aplicación:

2. Obtén un token ​

Envía una petición POST con tus credenciales para obtener un token de acceso.

POST/v3/auth/user
TESThttps://api-test.upconta.com/v3/auth/user
PRODhttps://api.upconta.com/v3/auth/user
json
{
  "ruc": "1234567890001",
  "username": "usuario_ejemplo",
  "password": "********"
}

Respuesta:

json
{
  "name": "Nombre Empresa",
  "user": "Nombre Usuario",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Guarda el token para las siguientes peticiones.

3. Verifica tu sesión ​

GET/v3/auth/user
TESThttps://api-test.upconta.com/v3/auth/user
PRODhttps://api.upconta.com/v3/auth/user
bash
curl -H "Authorization: {token}" https://api-test.upconta.com/v3/auth/user

4. Obtén información de la empresa ​

GET/v3/businesses/me?fields=name email address
TESThttps://api-test.upconta.com/v3/businesses/me?fields=name email address
PRODhttps://api.upconta.com/v3/businesses/me?fields=name email address
bash
curl -H "Authorization: {token}" \
  "https://api-test.upconta.com/v3/businesses/me?fields=name%20email%20address"

Respuesta:

json
{
  "_id": "60...",
  "name": "Nombre Empresa",
  "email": "[email protected]",
  "address": "Dirección de ejemplo"
}

5. Crea un cliente ​

POST/v3/administrative/clients
TESThttps://api-test.upconta.com/v3/administrative/clients
PRODhttps://api.upconta.com/v3/administrative/clients
json
{
  "idType": "05",
  "id": "1234567890",
  "subjectType": "01",
  "name": "Nombre Apellido",
  "phone": "021234567",
  "cellphone": "0999999999",
  "email": "[email protected]",
  "city": "Ciudad",
  "address": "Dirección de ejemplo"
}

6. Crea un producto ​

POST/v3/production/products
TESThttps://api-test.upconta.com/v3/production/products
PRODhttps://api.upconta.com/v3/production/products
json
{
  "code": "COD001",
  "price": 100.00,
  "description": "Producto de ejemplo",
  "iva": "2"
}

TIP

El campo iva acepta como valor el id del porcentaje de IVA que retorna el endpoint /v3/production/products/get-options. Por ejemplo, "2" corresponde al 12%. Siempre consulta el endpoint para obtener los valores actualizados.

7. Emite una factura ​

POST/v3/administrative/invoices
TESThttps://api-test.upconta.com/v3/administrative/invoices
PRODhttps://api.upconta.com/v3/administrative/invoices
json
{
  "client": "ID_DEL_CLIENTE",
  "infoTributaria": {
    "estab": "001",
    "ptoEmi": "002"
  },
  "detalles": [
    {
      "product": "ID_DEL_PRODUCTO",
      "cantidad": 2,
      "precioUnitario": 10
    }
  ]
}

TIP

Para producción, cambia la URL base de https://api-test.upconta.com a https://api.upconta.com.