Terceros · API REST v1 · Documentación

GET /v1/customer Listar registros ▶

Parám.	Descripción	Defecto
`page`	Número de página	1
`per_page`	Registros por página (máx. 1000)	20
`since`	Inicio del rango de creación (columna `entered`). Solo fecha = desde las 00:00:00	—
`until`	Fin del rango de creación. Solo fecha = hasta las 23:59:59	—
`q`	Búsqueda de texto en los campos indicados en cada recurso: `name` `name_commercial` `doi` `email`	—
`s` / `o`	Campo de ordenamiento · Sentido: `asc` o `desc`	según recurso
`f`	Filtros exactos en JSON	—

# página 2, 20 por página
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/customer?page=2&per_page=20"

# creados en un rango de fechas, más recientes primero
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/customer?since=2026-07-01&until=2026-07-31&s=entered&o=desc"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "LIST",
    "data": {
        "a1b2c3d4-5e6f-7890-abcd-ef1234567890": {
            "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
            "doi_id": "RUC",
            "doi": "20123456789",
            "name": "ACME Distribuciones SAC",
            "cat_id": "cliente",
            "name_commercial": "ACME",
            "cus_cla_id": "A",
            "email": "ventas@acme.pe",
            "phone_mobile": "+51987654321",
            "city": "Lima",
            "address": "Av. Javier Prado Este 1234",
            "prd_prc_id": "LP01"
        }
    },
    "meta": {
        "page": 1,
        "per_page": 20,
        "count": 1,
        "total": 134
    }
}

GET /v1/customer/{id} Obtener un registro ▶

curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/customer/ID"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "GET",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "doi_id": "RUC",
        "doi": "20123456789",
        "name": "ACME Distribuciones SAC",
        "cat_id": "cliente",
        "name_commercial": "ACME",
        "cus_cla_id": "A",
        "email": "ventas@acme.pe",
        "phone_mobile": "+51987654321",
        "city": "Lima",
        "address": "Av. Javier Prado Este 1234",
        "prd_prc_id": "LP01"
    }
}

POST /v1/customer Crear un registro ▶

Solo se graban las columnas de la lista blanca de cada recurso (los campos grabables que aparecen en cada endpoint); cualquier otra clave del JSON se ignora en silencio. Los componentes de la clave primaria que no se envíen toman el valor ---. El id puede enviarse (máximo 45 caracteres alfanuméricos, _, - y .); si se omite, la API genera un UUID.

Requeridos en POST doi_id doi name

Componentes de la clave — si no se envían toman --- cus_cha_id sll_id cus_grp_id cus_cla_id cus_sec_id cat_id doi_id doi

Campos grabables cou_id geo_id name description name_commercial registered sic_id cus_cnt_id cus_cnt_name firstname lastname middlename status condition type activity phone phone_home phone_mobile phone_office phone_fax email state province city zone address billing_address shipping_address importer exporter legal_representatives employees mar_id edu_id annual_revenue agent_detraction agent_retention agent_collection electronic_invoicing electronic_payroll system_accounting system_invoicing user code sync prd_prc_id itm_prc_id rating score

Nunca se devuelven pass token

curl -X POST "https://pionono-sandbox.extranet.business/v1/customer" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "doi_id": "RUC",
         "doi": "20123456789",
         "name": "ACME Distribuciones SAC",
         "cat_id": "cliente",
         "name_commercial": "ACME",
         "cus_cla_id": "A",
         "email": "ventas@acme.pe",
         "phone_mobile": "+51987654321",
         "city": "Lima",
         "address": "Av. Javier Prado Este 1234",
         "prd_prc_id": "LP01"
     }'

Respuesta

{
    "status": "success",
    "code": "201",
    "message": "ADD",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "doi_id": "RUC",
        "doi": "20123456789",
        "name": "ACME Distribuciones SAC",
        "cat_id": "cliente",
        "name_commercial": "ACME",
        "cus_cla_id": "A",
        "email": "ventas@acme.pe",
        "phone_mobile": "+51987654321",
        "city": "Lima",
        "address": "Av. Javier Prado Este 1234",
        "prd_prc_id": "LP01"
    }
}

PATCH /v1/customer/{id} Actualizar un registro ▶

Ambos hacen exactamente lo mismo: actualización parcial. Solo se modifican las columnas presentes en el JSON, el resto queda intacto — no hace falta reenviar el registro completo. Se usa PATCH por corrección semántica y PUT por compatibilidad con clientes que no lo soportan. La API graba modified y modified_by automáticamente.

Si el id no existe (o ya se eliminó) responden 404 NO_DATA; si el JSON no trae ninguna columna válida, 400 NO_VALID_FIELDS.

Campos grabables cou_id geo_id name description name_commercial registered sic_id cus_cnt_id cus_cnt_name firstname lastname middlename status condition type activity phone phone_home phone_mobile phone_office phone_fax email state province city zone address billing_address shipping_address importer exporter legal_representatives employees mar_id edu_id annual_revenue agent_detraction agent_retention agent_collection electronic_invoicing electronic_payroll system_accounting system_invoicing user code sync prd_prc_id itm_prc_id rating score

curl -X PATCH "https://pionono-sandbox.extranet.business/v1/customer/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "cat_id": "cliente",
         "name_commercial": "ACME"
     }'

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "UPDATE",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "cat_id": "cliente",
        "name_commercial": "ACME"
    }
}

PUT /v1/customer/{id} Actualizar (compatibilidad) — idéntico a PATCH ▶

Campos grabables cou_id geo_id name description name_commercial registered sic_id cus_cnt_id cus_cnt_name firstname lastname middlename status condition type activity phone phone_home phone_mobile phone_office phone_fax email state province city zone address billing_address shipping_address importer exporter legal_representatives employees mar_id edu_id annual_revenue agent_detraction agent_retention agent_collection electronic_invoicing electronic_payroll system_accounting system_invoicing user code sync prd_prc_id itm_prc_id rating score

curl -X PUT "https://pionono-sandbox.extranet.business/v1/customer/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "cat_id": "cliente",
         "name_commercial": "ACME"
     }'

DELETE /v1/customer/{id} Eliminar un registro — Elimina el registro ▶

curl -X DELETE "https://pionono-sandbox.extranet.business/v1/customer/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "DELETED",
    "data": null
}