Skip to main content
POST
/
api
/
v1
/
customers
La Pyme SDK
import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

const customer = await lapyme.customers.create({
  idempotencyKey: crypto.randomUUID(),
  body: {
    name: "Acme S.A.",
    taxId: "30711222333",
    email: "compras@acme.com.ar",
  },
});
{
  "request_id": "<string>",
  "data": {
    "customer": {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "company_name": "<string>",
      "description": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "apartment": "<string>",
      "city": "<string>",
      "tax_id": "<string>",
      "tax_id_type": "<string>",
      "tax_category": "<string>",
      "contact_type": "<string>",
      "default_price_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_term_id": "<string>",
      "province_id": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "country": "<string>",
      "postal_code": "<string>",
      "assigned_salesperson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "default_ganancias_regimen": "<string>",
      "assigned_salesperson": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>"
      },
      "default_price_list": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "sales_overview": {
        "pending_balance": 123,
        "sales_count": 1,
        "total_sales": 123,
        "recent_sales": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "voucher_type": "<string>",
            "invoice_status": "<string>",
            "invoice_date": "<string>",
            "currency": "<string>",
            "total": 123,
            "formatted_invoice_number": "<string>",
            "original_sale_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    },
    "idempotent_replay": true
  },
  "warnings": [
    "<unknown>"
  ]
}

Authorizations

​
Authorization
string
header
required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Headers

​
Idempotency-Key
string
required

Clave única para evitar duplicados al reintentar la misma creación de cliente.

​
X-Request-Id
string

ID opcional de la solicitud para trazabilidad. Si se omite, el servidor genera uno.

Body

application/json
​
name
string
required
​
company_name
string | null
​
description
string | null
​
email
string<email> | null
​
phone
string | null
​
tax_id
string | null
​
tax_id_type
enum<string> | null
Available options:
CUIL/CUIT,
DNI
​
tax_category
enum<string> | null
Available options:
registered_vat_taxpayer,
final_consumer,
monotributo_taxpayer,
vat_exempt,
vat_not_applicable
​
country
string | null
​
province
string | null
​
city
string | null
​
address
string | null
​
apartment
string | null
​
postal_code
string | null
​
assigned_salesperson_id
string<uuid> | null
​
default_price_list_id
string<uuid> | null
​
payment_term_id
enum<string> | null
Available options:
days_7,
days_15,
days_30,
days_45,
days_60,
days_90,
days_30_60,
days_30_60_90
​
is_active
boolean

Response

Cliente creado exitosamente

​
request_id
string
required
​
data
object
required
​
warnings
any[]
required