Référence de l’API

Générée à partir du même contrat que openapi.json(OpenAPI 3.1). Version 2026-10-01.Chaque réponse est renvoyée dans { data } ; les erreurs, dans { error, code, request_id, doc_url }.

Compte

GET`/api/v1/me`

Organisation et portée de la cléscope: read

curl https://cordhq.app/api/v1/me \
  -H "Authorization: Bearer sk_test_..."

const me = await cord.me();

Réponse : data

`org`	`object`	Organisation propriétaire de la clé.
`scope`	`string`	read ou write : ce que la clé peut faire.
`mode`	`"live" \| "test"`	live ou test : avec test, tout se passe dans l’environnement de test, sans toucher aux données réelles.

Devis

GET`/api/v1/cotizaciones`

Lister les devisscope: readPagination par offset

Paramètres : limit, offset, cursor, status, folio, cliente_id

curl https://cordhq.app/api/v1/cotizaciones \
  -H "Authorization: Bearer sk_test_..."

for await (const item of cord.quotes.listAll()) {
  console.log(item.id);
}

Réponse : data[]

`id`	`string`	Identifiant (UUID).
`folio`	`string`	Numéro lisible attribué par Cord, par exemple COT-0042.
`cliente`	`string \| null`	Client destinataire : nom de l’entreprise, ou les informations pour le créer s’il n’existe pas.
`status`	`string`	État du devis : draft, sent, viewed, approved, rejected, expired, paid ou invoiced.
`total`	`number`	Montant dans la devise indiquée par `moneda`.
`moneda`	`string \| null`	Devise ISO 4217.
`terminos`	`string \| null`	Libellé lisible du délai dans la langue du compte (« À réception », « Net 45 ») ; pour comparer, utilisez terminos_codigo.
`terminos_codigo`	`string \| null`	Code stable du délai : contado ou net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Date ISO 8601.
`creada`	`string \| null`	Date ISO 8601.
`link_publico`	`string`	Lien public absolu du devis.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Lecture seule. Langue dans laquelle le devis a été envoyé : es, en, pt, fr ou de. null tant qu’il s’agit d’un brouillon, qui suit la langue du client.

POST`/api/v1/cotizaciones`

Créer un devisAccepte pk_scope: write

Champ	Type	Description
`items` obligatoire	`object[]`	Lignes.
`cliente_id`	`string`	ID d’un client du répertoire.
`cliente`	`object`	Client destinataire : nom de l’entreprise, ou les informations pour le créer s’il n’existe pas.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Conditions de paiement : contado ou net<N> (N jours de délai : 7, 15, 30, 45, 60 ou 90).
`vigencia_dias`	`integer`	Nombre de jours de validité du devis à compter de son envoi.
`notas`	`string`	Notes internes ; le client ne les voit pas.
`base_currency`	`string`	Devise de vente ISO 4217 : celle dans laquelle les prix sont saisis, le paiement encaissé et la facture émise. Par défaut : celle de l’entreprise.
`fiscal_currency`	`string`	Devise comptable ISO 4217 ; si elle diffère de la devise de vente, la facture indique le taux de change.
`iva_incluido`	`boolean`	true si les prix saisis incluent déjà la taxe.
`descuento`	`object \| null`	Remise sur le document avant taxes, répartie entre les lignes au prorata de leur montant. Cord calcule le montant ; null la supprime.
`cupon`	`string`	Code d’un coupon de l’entreprise. Cord vérifie sa validité, sa devise et ses utilisations ; s’il est fourni, il prime sur descuento. C’est la seule remise acceptée avec une clé publiable.
`send`	`boolean`	Uniquement avec une clé secrète.

curl -X POST https://cordhq.app/api/v1/cotizaciones \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"cliente":{"empresa":"Acme"},"items":[{"descripcion":"Instalación","cantidad":1,"precio_unitario":12500,"tax_rate":0.16}],"base_currency":"MXN"}'

const created = await cord.quotes.create({
  "cliente": {
    "empresa": "Acme"
  },
  "items": [
    {
      "descripcion": "Instalación",
      "cantidad": 1,
      "precio_unitario": 12500,
      "tax_rate": 0.16
    }
  ],
  "base_currency": "MXN"
});

Réponse : data

`id`	`string`	Identifiant (UUID).
`token`	`string`	Jeton du lien public. C’est un identifiant d’accès : ne le publiez pas.
`folio`	`string`	Numéro lisible attribué par Cord, par exemple COT-0042.
`link_publico`	`string`	Lien public absolu partagé avec le client.
`needs_approval`	`boolean`	true s’il est retenu en attente de validation interne avant l’envoi.
`motivo`	`string \| null`	Motif, rédigé par une personne.
`email`	`object`	Adresse e-mail.

GET`/api/v1/cotizaciones/{id}`

Récupérer un devisscope: read

curl https://cordhq.app/api/v1/cotizaciones/ID \
  -H "Authorization: Bearer sk_test_..."

const item = await cord.quotes.retrieve('ID');

Réponse : data

`id`	`string`	Identifiant (UUID).
`folio`	`string`	Numéro lisible attribué par Cord, par exemple COT-0042.
`cliente`	`string \| null`	Client destinataire : nom de l’entreprise, ou les informations pour le créer s’il n’existe pas.
`status`	`string`	État du devis : draft, sent, viewed, approved, rejected, expired, paid ou invoiced.
`total`	`number`	Montant dans la devise indiquée par `moneda`.
`moneda`	`string \| null`	Devise ISO 4217.
`terminos`	`string \| null`	Libellé lisible du délai dans la langue du compte (« À réception », « Net 45 ») ; pour comparer, utilisez terminos_codigo.
`terminos_codigo`	`string \| null`	Code stable du délai : contado ou net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Date ISO 8601.
`creada`	`string \| null`	Date ISO 8601.
`link_publico`	`string`	Lien public absolu du devis.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Lecture seule. Langue dans laquelle le devis a été envoyé : es, en, pt, fr ou de. null tant qu’il s’agit d’un brouillon, qui suit la langue du client.
`notas`	`string \| null`	Notes internes ; le client ne les voit pas.
`aprobacion`	`object \| null`	Validation interne exigée par une règle de l’entreprise ; null si elle ne s’applique pas.
`items`	`object[]`	Lignes.
`descuento`	`object \| null`	Remise sur le document, appliquée avant taxes et répartie entre les lignes ; null s’il n’y en a pas. subtotal est déjà net.
`eventos`	`object[]`	Liste d’événements ou de types d’événement. Vide = tous.

POST`/api/v1/cotizaciones/{id}`

Envoyer, renvoyer, approuver, refuser ou marquer comme payéscope: write

Champ	Type	Description
`action` obligatoire	`"send" \| "resend" \| "approve" \| "reject" \| "mark_paid"`	Action à exécuter ; chacune exige le bon état préalable et est idempotente avec Idempotency-Key.
`payment_method`	`string`	Moyen de paiement lors du marquage comme payé : transferencia, efectivo, tarjeta…

curl -X POST https://cordhq.app/api/v1/cotizaciones/ID \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"action":"send"}'

await cord.quotes.send('ID');

Réponse : data

id string Identifiant (UUID).

DELETE`/api/v1/cotizaciones/{id}`

Supprimer un brouillonscope: write

curl -X DELETE https://cordhq.app/api/v1/cotizaciones/ID \
  -H "Authorization: Bearer sk_test_..."

await cord.quotes.del('ID');

Réponse : data

id string Identifiant (UUID).

POST`/api/v1/cotizaciones/ia`

Proposer des lignes à partir du texte d’une commandescope: write

Champ	Type	Description
`texto` obligatoire	`string`	Texte libre de la commande.

curl -X POST https://cordhq.app/api/v1/cotizaciones/ia \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"texto":"…"}'

const { items } = await cord.quotes.draftFromText('5 sacos de cemento');

Réponse : data

`items`	`any[]`	Lignes.
`moneda`	`string`	Devise ISO 4217 des montants.

Clients

GET`/api/v1/clientes`

Lister les clientsscope: readPagination par offset

Paramètres : limit, offset, cursor, q, email

curl https://cordhq.app/api/v1/clientes \
  -H "Authorization: Bearer sk_test_..."

for await (const item of cord.clients.listAll()) {
  console.log(item.id);
}

Réponse : data[]

`id`	`string`	Identifiant (UUID).
`empresa`	`string`	Nom de l’entreprise ou de la personne.
`contacto`	`string`	Nom de la personne à contacter.
`email`	`string`	Adresse e-mail.
`telefono`	`string`	Téléphone avec l’indicatif international.
`rfc`	`string`	Identifiant fiscal : RFC, NIF, EIN…
`terminos`	`string`	Libellé lisible des conditions de paiement.
`terminosCode`	`string`	Code des conditions de paiement : contado ou net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Plafond de crédit du client, dans la devise de l’entreprise.
`nivel`	`string`	Niveau ou segment du client.
`descuentoPct`	`number`	Remise par défaut du client, en pourcentage.
`regimenFiscal`	`string`	Code de régime fiscal du SAT (Mexique).
`usoCfdi`	`string`	Code d’usage du CFDI (Mexique).
`cpFiscal`	`string`	Code postal de l’adresse fiscale (Mexique).
`countryCode`	`string`	Pays ISO 3166-1 alpha-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Langue des documents que reçoit le client : es, en, pt, fr ou de ; null = celle de l’organisation. Les devis et les factures conservent la langue dans laquelle ils ont été envoyés ou émis ; la modifier ne réécrit pas ce qui a déjà été envoyé. Toute autre valeur répond 400 avec field: language.

POST`/api/v1/clientes`

Créer un clientscope: write

Champ	Type	Description
`empresa` obligatoire	`string`	Nom de l’entreprise ou de la personne.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Langue des documents que reçoit le client : es, en, pt, fr ou de ; null = celle de l’organisation. Les devis et les factures conservent la langue dans laquelle ils ont été envoyés ou émis ; la modifier ne réécrit pas ce qui a déjà été envoyé. Toute autre valeur répond 400 avec field: language.

curl -X POST https://cordhq.app/api/v1/clientes \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"empresa":"…"}'

const created = await cord.clients.create({
  "empresa": "…"
});

Réponse : data

id string Identifiant (UUID).

GET`/api/v1/clientes/{id}`

Récupérer un clientscope: read

curl https://cordhq.app/api/v1/clientes/ID \
  -H "Authorization: Bearer sk_test_..."

const item = await cord.clients.retrieve('ID');

Réponse : data

`id`	`string`	Identifiant (UUID).
`empresa`	`string`	Nom de l’entreprise ou de la personne.
`contacto`	`string`	Nom de la personne à contacter.
`email`	`string`	Adresse e-mail.
`telefono`	`string`	Téléphone avec l’indicatif international.
`rfc`	`string`	Identifiant fiscal : RFC, NIF, EIN…
`terminos`	`string`	Libellé lisible des conditions de paiement.
`terminosCode`	`string`	Code des conditions de paiement : contado ou net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Plafond de crédit du client, dans la devise de l’entreprise.
`nivel`	`string`	Niveau ou segment du client.
`descuentoPct`	`number`	Remise par défaut du client, en pourcentage.
`regimenFiscal`	`string`	Code de régime fiscal du SAT (Mexique).
`usoCfdi`	`string`	Code d’usage du CFDI (Mexique).
`cpFiscal`	`string`	Code postal de l’adresse fiscale (Mexique).
`countryCode`	`string`	Pays ISO 3166-1 alpha-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Langue des documents que reçoit le client : es, en, pt, fr ou de ; null = celle de l’organisation. Les devis et les factures conservent la langue dans laquelle ils ont été envoyés ou émis ; la modifier ne réécrit pas ce qui a déjà été envoyé. Toute autre valeur répond 400 avec field: language.

PATCH`/api/v1/clientes/{id}`

Mettre à jour les coordonnéesscope: write

Champ	Type	Description
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Langue des documents que reçoit le client : es, en, pt, fr ou de ; null = celle de l’organisation. Les devis et les factures conservent la langue dans laquelle ils ont été envoyés ou émis ; la modifier ne réécrit pas ce qui a déjà été envoyé. Toute autre valeur répond 400 avec field: language.

curl -X PATCH https://cordhq.app/api/v1/clientes/ID \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{}'

await cord.clients.update('ID', { email: 'compras@acme.mx' });

Réponse : data

id string Identifiant (UUID).

Produits

GET`/api/v1/productos`

Lister les produitsAccepte pk_scope: readPagination par offset

Paramètres : limit, offset, cursor

curl https://cordhq.app/api/v1/productos \
  -H "Authorization: Bearer sk_test_..."

for await (const item of cord.products.listAll()) {
  console.log(item.id);
}

Réponse : data[]

`id`	`string`	Identifiant (UUID).
`sku`	`string`	Code interne du produit.
`nombre`	`string`	Nom.
`unidad`	`string`	Unité de mesure : pièce, kg, heure…
`descripcion`	`string`	Description telle que le client la voit.
`precio`	`number`	Montant dans la devise indiquée par `moneda`.
`costo`	`number`	Jamais exposé à une clé publiable.
`activo`	`boolean`	false s’il est désactivé : il est conservé mais n’est pas utilisé.
`createdAt`	`string \| null`	Date ISO 8601.
`preciosVolumen`	`object[]`	Prix dégressifs par quantité.
`existencias`	`number \| null`	Unités disponibles ; null si le stock n’est pas suivi.
`taxRate`	`number \| null`	Taxe proposée lorsque le produit est ajouté à une ligne, sous forme de fraction 0–1 ; null = celle par défaut de l’organisation.
`claveSat`	`string \| null`	Code de produit ou de service du SAT (c_ClaveProdServ, 8 chiffres) pour le CFDI au Mexique ; null s’il n’a pas été classé.
`claveUnidadSat`	`string \| null`	Code d’unité du SAT (c_ClaveUnidad, comme H87 ou E48) pour le CFDI au Mexique ; null = déduit de l’unité.

POST`/api/v1/productos`

Créer un produitscope: write

Champ	Type	Description
`nombre` obligatoire	`string`	Nom.

curl -X POST https://cordhq.app/api/v1/productos \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"nombre":"…"}'

const created = await cord.products.create({
  "nombre": "…"
});

Réponse : data

id string Identifiant (UUID).

Factures

GET`/api/v1/facturas`

Lister les facturesscope: readPagination par curseur

Paramètres : limit, cursor, estado, cliente, desde, hasta, q

curl https://cordhq.app/api/v1/facturas \
  -H "Authorization: Bearer sk_test_..."

for await (const item of cord.invoices.listAll()) {
  console.log(item.id);
}

Réponse : data[]

`id`	`string`	Identifiant (UUID).
`numero`	`string \| null`	Numéro de la facture dans sa série.
`folio_fiscal`	`string \| null`	Identifiant auprès de l’administration fiscale (UUID du CFDI au Mexique) ; null s’il ne s’applique pas.
`cliente`	`string \| null`	Client destinataire : nom de l’entreprise, ou les informations pour le créer s’il n’existe pas.
`estado`	`string`	draft, open, paid, void ou uncollectible.
`estado_fiscal`	`string`	État de l’émission : pending, issued, cancelled ou error.
`pais`	`string`	Pays ISO 3166-1 alpha-2.
`tipo`	`string`	Type de document : cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice ou verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Intitulé du document. factura_proforma est une facture pro forma : ce n’est pas une facture et elle n’a pas de valeur fiscale. Couvre le type proforma et, en Espagne, tout document sans enregistrement Verifactu.
`moneda`	`string \| null`	Devise ISO 4217.
`total`	`number`	Montant dans la devise indiquée par `moneda`.
`pagado`	`number`	Montant dans la devise indiquée par `moneda`.
`saldo`	`number`	Montant dans la devise indiquée par `moneda`.
`vence`	`string \| null`	Date ISO 8601.
`vencida`	`boolean`	true si la date d’échéance est dépassée avec un reste à payer.
`cotizacion_id`	`string \| null`	ID du devis associé.
`creada`	`string \| null`	Date ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Lecture seule. Langue dans laquelle la facture a été émise : es, en, pt, fr ou de. null tant qu’il s’agit d’un brouillon.

POST`/api/v1/facturas`

Créer une facture en brouillonscope: write

Champ	Type	Description
`cliente_id` obligatoire	`string`	ID d’un client du répertoire.
`items` obligatoire	`object[]`	Lignes.
`currency`	`string`	Devise ISO 4217.
`due_date`	`string`	Date d’échéance, YYYY-MM-DD.
`service_date`	`string`	Date de la prestation ou de la livraison (Leistungsdatum), YYYY-MM-DD. Sans elle, la facture indique qu’elle coïncide avec la date d’émission.
`service_date_end`	`string`	Fin de la période de prestation, YYYY-MM-DD. Nécessite service_date et ne peut pas être antérieure.
`notas`	`string`	Notes internes ; le client ne les voit pas.
`iva_incluido`	`boolean`	true si les prix saisis incluent déjà la taxe.
`document_mode`	`"commercial" \| "fiscal"`	commercial ou fiscal. Sans lui, fiscal si l’offre l’inclut et que le pays l’a activé ; fiscal sans cela répond 400.
`fx_buffer_pct`	`number`	Marge de couverture en points de pourcentage sur le taux de change de référence (2 = +2 %) ; plafonnée à 25. Par défaut 0.
`descuento`	`object \| null`	Remise sur le document avant taxes, répartie entre les lignes au prorata de leur montant. Cord calcule le montant ; null la supprime.
`cupon`	`string`	Code d’un coupon de l’entreprise. Cord vérifie sa validité, sa devise et ses utilisations ; s’il est fourni, il prime sur descuento. C’est la seule remise acceptée avec une clé publiable.
`buyer_reference`	`string`	Référence de l’acheteur pour sa comptabilité fournisseurs (en Allemagne, le Leitweg-ID de l’administration publique). Elle figure dans la facture électronique européenne (BT-10) et XRechnung l’exige. Sans elle, celle du client s’applique. Si l’adresse électronique du client est un Leitweg-ID (schéma 0204), ses chiffres de contrôle sont vérifiés (ISO/IEC 7064 MOD 97-10) et une référence qui échoue répond 400.
`purchase_order`	`string`	Numéro du bon de commande du client (BT-13 de la facture électronique européenne).

curl -X POST https://cordhq.app/api/v1/facturas \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"cliente_id":"…","items":[{"descripcion":"…","cantidad":1,"precio_unitario":1}]}'

const created = await cord.invoices.create({
  "cliente_id": "…",
  "items": [
    {
      "descripcion": "…",
      "cantidad": 1,
      "precio_unitario": 1
    }
  ]
});

Réponse : data

id string Identifiant (UUID).

GET`/api/v1/facturas/{id}`

Récupérer une facturescope: read

curl https://cordhq.app/api/v1/facturas/ID \
  -H "Authorization: Bearer sk_test_..."

const item = await cord.invoices.retrieve('ID');

Réponse : data

`id`	`string`	Identifiant (UUID).
`numero`	`string \| null`	Numéro de la facture dans sa série.
`folio_fiscal`	`string \| null`	Identifiant auprès de l’administration fiscale (UUID du CFDI au Mexique) ; null s’il ne s’applique pas.
`cliente`	`string \| null`	Client destinataire : nom de l’entreprise, ou les informations pour le créer s’il n’existe pas.
`estado`	`string`	draft, open, paid, void ou uncollectible.
`estado_fiscal`	`string`	État de l’émission : pending, issued, cancelled ou error.
`pais`	`string`	Pays ISO 3166-1 alpha-2.
`tipo`	`string`	Type de document : cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice ou verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Intitulé du document. factura_proforma est une facture pro forma : ce n’est pas une facture et elle n’a pas de valeur fiscale. Couvre le type proforma et, en Espagne, tout document sans enregistrement Verifactu.
`moneda`	`string \| null`	Devise ISO 4217.
`total`	`number`	Montant dans la devise indiquée par `moneda`.
`pagado`	`number`	Montant dans la devise indiquée par `moneda`.
`saldo`	`number`	Montant dans la devise indiquée par `moneda`.
`vence`	`string \| null`	Date ISO 8601.
`vencida`	`boolean`	true si la date d’échéance est dépassée avec un reste à payer.
`cotizacion_id`	`string \| null`	ID du devis associé.
`creada`	`string \| null`	Date ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Lecture seule. Langue dans laquelle la facture a été émise : es, en, pt, fr ou de. null tant qu’il s’agit d’un brouillon.
`subtotal`	`number`	Montant dans la devise indiquée par `moneda`.
`impuestos`	`number`	Montant dans la devise indiquée par `moneda`.
`moneda_contable`	`string \| null`	Devise ISO 4217.
`tipo_cambio`	`number \| null`	Taux de change déclaré de la devise de vente vers la devise comptable ; null si ce sont les mêmes.
`total_contable`	`number \| null`	Total converti dans la devise comptable.
`notas`	`string \| null`	Notes internes ; le client ne les voit pas.
`nota_credito_de`	`string \| null`	ID de la facture que corrige cet avoir.
`emisor`	`any`	Informations fiscales de l’émetteur.
`receptor`	`any`	Informations fiscales du client destinataire de la facture.
`descuento`	`object \| null`	Remise sur le document, appliquée avant taxes et répartie entre les lignes ; null s’il n’y en a pas. subtotal est déjà net.
`conceptos`	`object[]`	Lignes de la facture avec leur taxe.
`pagos`	`object[]`	Paiements reçus.

POST`/api/v1/facturas/{id}`

Émettre, envoyer, annuler, enregistrer un paiement ou un avoirscope: write

Champ	Type	Description
`action` obligatoire	`"finalize" \| "send" \| "void" \| "payment" \| "credit_note"`	Action à exécuter ; chacune exige le bon état préalable et est idempotente avec Idempotency-Key.
`monto`	`number`	Montant dans la devise indiquée par moneda.
`moneda`	`string`	Devise ISO 4217 des montants.
`metodo`	`string`	Moyen de paiement : transferencia, efectivo, tarjeta…
`referencia`	`string`	Référence du paiement ou du prestataire.
`motivo`	`string`	Motif, rédigé par une personne.
`sin_comercio_exterior`	`boolean`	Mexique, à l’émission (finalize) : true confirme qu’un CFDI comportant des marchandises pour un client à l’étranger n’est pas une exportation définitive. Sans lui, cette émission répond 409 avec le code comercio_exterior, car Cord ne génère pas le complément de commerce extérieur.

curl -X POST https://cordhq.app/api/v1/facturas/ID \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"action":"finalize"}'

await cord.invoices.finalize('ID');

Réponse : data

id string Identifiant (UUID).

Recouvrement

GET`/api/v1/cobranza`

Créances à encaisserscope: read

curl https://cordhq.app/api/v1/cobranza \
  -H "Authorization: Bearer sk_test_..."

const cartera = await cord.collections.retrieve();

Réponse : data

`resumen`	`any`	Totaux en un coup d’œil.
`aging`	`any`	Créances par ancienneté en quatre tranches fixes : vigente (non échues), d30 (1–30 jours de retard), d60 (31–60) et d60p (plus de 60). Chacune contient key, label, monto et n.
`items`	`any[]`	Lignes.
`clientes`	`any`	Solde regroupé par client.

Événements

GET`/api/v1/events`

Historique des événementsscope: readPagination par curseur

Paramètres : limit, cursor, type, object_id

curl https://cordhq.app/api/v1/events \
  -H "Authorization: Bearer sk_test_..."

for await (const item of cord.events.listAll()) {
  console.log(item.id);
}

Réponse : data[]

`id`	`string`	Identifiant (UUID).
`type`	`string`	Type d’événement, par exemple quote.approved.
`object`	`string`	Type d’objet : quote, invoice, client, product, task, promise…
`object_id`	`string \| null`	ID de l’objet concerné.
`data`	`object`	Contenu de la réponse ou de l’événement.
`actor`	`string \| null`	Qui l’a fait : user, api, mcp, client (le destinataire du lien public) ou system.
`created_at`	`string`	Date de création, ISO 8601.

Tâches

POST`/api/v1/tareas`

Créer une tâchescope: write

Champ	Type	Description
`titulo` obligatoire	`string`	Ce qu’il faut faire.
`due_date`	`string`	Date d’échéance, YYYY-MM-DD.
`cotizacion_id`	`string`	ID du devis associé.
`factura_id`	`string`	ID de la facture associée (l’`id` de /facturas).

curl -X POST https://cordhq.app/api/v1/tareas \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"titulo":"…"}'

await cord.tasks.create({ titulo: 'Llamar a Acme' });

Réponse : data

id string Identifiant (UUID).

Workflows

POST`/api/v1/workflows/{id}/invoke`

Lancer un workflow « Vous le lancez » sur des devis ou des facturesscope: write

Champ	Type	Description
`objeto` obligatoire	`"quote" \| "invoice"`	Type de document : quote (devis) ou invoice (facture) ; il doit correspondre au déclencheur du workflow.
`ids` obligatoire	`string[]`	Identifiants (UUID) des documents, de 1 à 50.

curl -X POST https://cordhq.app/api/v1/workflows/ID/invoke \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"objeto":"quote","ids":["…"]}'

Réponse : data

`documentos`	`number`	Nombre de documents envoyés qui existent dans l’organisation.
`corridas`	`number`	Nombre d’exécutions démarrées : un document qui ne remplit pas le filtre du workflow ou qui y est déjà passé ne compte pas.

Webhooks

GET`/api/v1/webhooks`

Endpoints créés par cette cléscope: read

curl https://cordhq.app/api/v1/webhooks \
  -H "Authorization: Bearer sk_test_..."

const items = await cord.webhookEndpoints.list();

Réponse : data

`id`	`string`	Identifiant (UUID).
`url`	`string`	URL HTTPS qui reçoit les événements.
`eventos`	`string[]`	Liste d’événements ou de types d’événement. Vide = tous.
`activo`	`boolean`	false s’il est désactivé : il est conservé mais n’est pas utilisé.
`created_at`	`string`	Date de création, ISO 8601.

POST`/api/v1/webhooks`

Créer un endpoint (le secret n’est renvoyé qu’une fois)scope: write

Champ	Type	Description
`url` obligatoire	`string`	URL HTTPS qui reçoit les événements.
`eventos`	`string[]`	Liste d’événements ou de types d’événement. Vide = tous.

curl -X POST https://cordhq.app/api/v1/webhooks \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"url":"…"}'

const created = await cord.webhookEndpoints.create({
  "url": "…"
});

Réponse : data

`id`	`string`	Identifiant (UUID).
`url`	`string`	URL HTTPS qui reçoit les événements.
`eventos`	`string[]`	Liste d’événements ou de types d’événement. Vide = tous.
`activo`	`boolean`	false s’il est désactivé : il est conservé mais n’est pas utilisé.
`created_at`	`string`	Date de création, ISO 8601.
`secret`	`string`	Secret pour vérifier la signature. Il n’est affiché qu’une fois.

DELETE`/api/v1/webhooks/{id}`

Supprimer un endpointscope: write

curl -X DELETE https://cordhq.app/api/v1/webhooks/ID \
  -H "Authorization: Bearer sk_test_..."

await cord.webhookEndpoints.del('ID');

Réponse : data

id string Identifiant (UUID).

Elements

GET`/api/v1/elements/config`

Configuration affichée par Cord ElementsAccepte pk_scope: read

curl https://cordhq.app/api/v1/elements/config \
  -H "Authorization: Bearer sk_test_..."

const config = await cord.elements.config();

Réponse : data

`object`	`"elements_config"`	Type d’objet : quote, invoice, client, product, task, promise…
`org`	`object`	Organisation propriétaire de la clé.
`monedas`	`string[]`	Devises que l’entreprise propose dans ses devis.
`impuestos`	`object`	Taxes du document ou catalogue de taxes.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"[]`	Conditions de paiement : contado ou net<N> (N jours de délai : 7, 15, 30, 45, 60 ou 90).
`terminos_default`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Conditions de paiement par défaut.
`vigencia_dias_default`	`number`	Validité par défaut, en jours.
`fiscal`	`object`	Informations fiscales.

POST`/api/v1/elements/ai-draft`

Lignes générées par l’IA en streaming (text/event-stream)Accepte pk_scope: write

Champ	Type	Description
`texto`	`string`	Texte libre de la commande.
`archivo`	`string`	JPG, PNG ou PDF, 4 Mo maximum.

curl -X POST https://cordhq.app/api/v1/elements/ai-draft \
  -H "Authorization: Bearer sk_test_..." \
  -F "texto=5 sacos de cemento y 2 de arena"

Répond en text/event-stream avec les événements item, done et error.

Mode test

POST`/api/v1/test_helpers/fiscal`

Forcer le résultat de la prochaine émissionsk_test_ uniquementscope: write

Champ	Type	Description
`siguiente_resultado` obligatoire	`"exito" \| "pac_caido" \| "receptor_invalido" \| "certificado_vencido" \| "timbre_duplicado"`	Résultat de la prochaine émission fiscale dans l’environnement de test.

curl -X POST https://cordhq.app/api/v1/test_helpers/fiscal \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"siguiente_resultado":"exito"}'

await cord.testHelpers.fiscal.setNextOutcome('pac_caido');

Réponse : data

siguiente_resultado string Résultat de la prochaine émission fiscale dans l’environnement de test.

POST`/api/v1/test_helpers/cotizaciones/{id}`

Simuler une consultation ou une expirationsk_test_ uniquementscope: write

Champ	Type	Description
`accion` obligatoire	`"vista" \| "vencer"`	Ce qu’il faut simuler : vista (le client ouvre le lien) ou vencer (le devis expire).

curl -X POST https://cordhq.app/api/v1/test_helpers/cotizaciones/ID \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"accion":"vista"}'

await cord.testHelpers.quotes.expire('ID');

Réponse : data

id string Identifiant (UUID).

POST`/api/v1/test_helpers/webhooks`

Déclencher un webhooksk_test_ uniquementscope: write

Champ	Type	Description
`evento` obligatoire	`string`	Type d’événement, par exemple quote.approved.
`objeto_id`	`string`	ID d’un devis ou d’une facture de l’environnement de test ; sans lui, des données d’exemple sont utilisées.

curl -X POST https://cordhq.app/api/v1/test_helpers/webhooks \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"evento":"…"}'

await cord.testHelpers.webhooks.trigger('invoice.paid');

Réponse : data

`evento`	`string`	Type d’événement, par exemple quote.approved.
`datos`	`"real" \| "ejemplo"`	real si les données de l’objet indiqué ont été utilisées ; ejemplo s’il s’agit de données fictives.

POST`/api/v1/test_helpers/listen`

Ouvrir une session cord listensk_test_ uniquementscope: write

Champ	Type	Description
`eventos`	`string[]`	Liste d’événements ou de types d’événement. Vide = tous.

curl -X POST https://cordhq.app/api/v1/test_helpers/listen \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse : data

`id`	`string`	Identifiant (UUID).
`secret`	`string`	Secret pour vérifier la signature. Il n’est affiché qu’une fois.
`eventos`	`string[]`	Liste d’événements ou de types d’événement. Vide = tous.
`expira`	`string`	Date d’expiration, ISO 8601.

GET`/api/v1/test_helpers/listen/{id}`

Récupérer les événements de la sessionsk_test_ uniquementscope: write

curl https://cordhq.app/api/v1/test_helpers/listen/ID \
  -H "Authorization: Bearer sk_test_..."

Réponse : data

`event_id`	`string`	ID de l’événement ; dédupliquez à partir de celui-ci.
`evento`	`string`	Type d’événement, par exemple quote.approved.
`body`	`string`	Corps brut de l’événement ; transmettez-le sans modification pour que la signature soit valide.
`headers`	`object`	En-têtes à transmettre tels quels, y compris la signature X-Cord-Signature-V1.

DELETE`/api/v1/test_helpers/listen/{id}`

Fermer une session cord listensk_test_ uniquementscope: write

curl -X DELETE https://cordhq.app/api/v1/test_helpers/listen/ID \
  -H "Authorization: Bearer sk_test_..."

Réponse : data

id string Identifiant (UUID).

Configuration

POST`/api/v1/setup/plans`

Proposer une configuration du compte (une personne l’approuve sur review_url)scope: write

Champ	Type	Description
`sitio`	`string`	Site web de l’entreprise, par exemple votreentreprise.com.
`descripcion`	`string`	Description de l’entreprise : secteur d’activité, délais de paiement, taxes facturées ou retenues.
`archivo`	`object`	Liste de prix (Excel, CSV, PDF ou photo) en base64, 3 Mo maximum.

curl -X POST https://cordhq.app/api/v1/setup/plans \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse : data

`object`	`"setup_plan"`	Type d’objet : quote, invoice, client, product, task, promise…
`id`	`string`	Identifiant (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto attend l’approbation d’une personne sur review_url.
`review_url`	`string`	Page où une personne connectée examine et applique la proposition. L’API ne l’applique jamais.

GET`/api/v1/setup/plans/{id}`

État d’une proposition de configurationscope: read

curl https://cordhq.app/api/v1/setup/plans/ID \
  -H "Authorization: Bearer sk_test_..."

Réponse : data

`object`	`"setup_plan"`	Type d’objet : quote, invoice, client, product, task, promise…
`id`	`string`	Identifiant (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto attend l’approbation d’une personne sur review_url.
`review_url`	`string`	Page où une personne connectée examine et applique la proposition. L’API ne l’applique jamais.

Compte

GET/api/v1/me

Devis

GET/api/v1/cotizaciones

POST/api/v1/cotizaciones

GET/api/v1/cotizaciones/{id}

POST/api/v1/cotizaciones/{id}

DELETE/api/v1/cotizaciones/{id}

POST/api/v1/cotizaciones/ia

Clients

GET/api/v1/clientes

POST/api/v1/clientes

GET/api/v1/clientes/{id}

PATCH/api/v1/clientes/{id}

Produits

GET/api/v1/productos

POST/api/v1/productos

Factures

GET/api/v1/facturas

POST/api/v1/facturas

GET/api/v1/facturas/{id}

POST/api/v1/facturas/{id}

Recouvrement

GET/api/v1/cobranza

Événements

GET/api/v1/events

Tâches

POST/api/v1/tareas

Workflows

POST/api/v1/workflows/{id}/invoke

Webhooks

GET/api/v1/webhooks

POST/api/v1/webhooks

DELETE/api/v1/webhooks/{id}

Elements

GET/api/v1/elements/config

POST/api/v1/elements/ai-draft

Mode test

POST/api/v1/test_helpers/fiscal

POST/api/v1/test_helpers/cotizaciones/{id}

POST/api/v1/test_helpers/webhooks

POST/api/v1/test_helpers/listen

GET/api/v1/test_helpers/listen/{id}

DELETE/api/v1/test_helpers/listen/{id}

Configuration

POST/api/v1/setup/plans

GET/api/v1/setup/plans/{id}

GET`/api/v1/me`

GET`/api/v1/cotizaciones`

POST`/api/v1/cotizaciones`

GET`/api/v1/cotizaciones/{id}`

POST`/api/v1/cotizaciones/{id}`

DELETE`/api/v1/cotizaciones/{id}`

POST`/api/v1/cotizaciones/ia`

GET`/api/v1/clientes`

POST`/api/v1/clientes`

GET`/api/v1/clientes/{id}`

PATCH`/api/v1/clientes/{id}`

GET`/api/v1/productos`

POST`/api/v1/productos`

GET`/api/v1/facturas`

POST`/api/v1/facturas`

GET`/api/v1/facturas/{id}`

POST`/api/v1/facturas/{id}`

GET`/api/v1/cobranza`

GET`/api/v1/events`

POST`/api/v1/tareas`

POST`/api/v1/workflows/{id}/invoke`

GET`/api/v1/webhooks`

POST`/api/v1/webhooks`

DELETE`/api/v1/webhooks/{id}`

GET`/api/v1/elements/config`

POST`/api/v1/elements/ai-draft`

POST`/api/v1/test_helpers/fiscal`

POST`/api/v1/test_helpers/cotizaciones/{id}`

POST`/api/v1/test_helpers/webhooks`

POST`/api/v1/test_helpers/listen`

GET`/api/v1/test_helpers/listen/{id}`

DELETE`/api/v1/test_helpers/listen/{id}`

POST`/api/v1/setup/plans`

GET`/api/v1/setup/plans/{id}`