API-Referenz

Generiert aus derselben Spezifikation wie openapi.json(OpenAPI 3.1). Version 2026-10-01.Antworten haben die Form { data }; Fehler die Form { error, code, request_id, doc_url }.

Konto

GET`/api/v1/me`

Organisation und Berechtigungsumfang des Schlüsselsscope: read

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

const me = await cord.me();

Antwort: data

`org`	`object`	Organisation, der der Schlüssel gehört.
`scope`	`string`	read oder write: was der Schlüssel darf.
`mode`	`"live" \| "test"`	live oder test: Mit test läuft alles in der Testumgebung und berührt keine echten Daten.

Angebote

GET`/api/v1/cotizaciones`

Angebote auflistenscope: readOffset-Paginierung

Abfrageparameter: 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);
}

Antwort: data[]

`id`	`string`	Kennung (UUID).
`folio`	`string`	Lesbare Nummer, die Cord vergibt, z. B. COT-0042.
`cliente`	`string \| null`	Kunde, an den sich das Dokument richtet: Name des Unternehmens oder die Daten, um ihn anzulegen, falls er noch nicht existiert.
`status`	`string`	Status des Angebots: draft, sent, viewed, approved, rejected, expired, paid oder invoiced.
`total`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`moneda`	`string \| null`	Währung nach ISO 4217.
`terminos`	`string \| null`	Lesbare Bezeichnung des Zahlungsziels in der Sprache des Kontos („Sofort fällig“, „Net 45“); zum Vergleichen verwenden Sie terminos_codigo.
`terminos_codigo`	`string \| null`	Stabiler Code des Zahlungsziels: contado oder net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Datum nach ISO 8601.
`creada`	`string \| null`	Datum nach ISO 8601.
`link_publico`	`string`	Absoluter öffentlicher Link zum Angebot.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Schreibgeschützt. Sprache, in der das Angebot gesendet wurde: es, en, pt, fr oder de. null, solange es ein Entwurf ist; dieser folgt der Sprache des Kunden.

POST`/api/v1/cotizaciones`

Angebot erstellenAkzeptiert pk_scope: write

Feld	Typ	Beschreibung
`items` erforderlich	`object[]`	Positionen.
`cliente_id`	`string`	ID eines Kunden aus dem Kundenverzeichnis.
`cliente`	`object`	Kunde, an den sich das Dokument richtet: Name des Unternehmens oder die Daten, um ihn anzulegen, falls er noch nicht existiert.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Zahlungsbedingungen: contado oder net<N> (N Tage Zahlungsziel: 7, 15, 30, 45, 60 oder 90).
`vigencia_dias`	`integer`	Gültigkeit des Angebots in Tagen ab dem Versand.
`notas`	`string`	Interne Notizen; der Kunde sieht sie nicht.
`base_currency`	`string`	Verkaufswährung nach ISO 4217: die Währung, in der Preise erfasst, Zahlungen eingezogen und Rechnungen ausgestellt werden. Standard: die des Unternehmens.
`fiscal_currency`	`string`	Buchungswährung nach ISO 4217; weicht sie von der Verkaufswährung ab, weist die Rechnung den Wechselkurs aus.
`iva_incluido`	`boolean`	true, wenn die erfassten Preise die Steuer bereits enthalten.
`descuento`	`object \| null`	Rabatt auf das Dokument vor Steuern, anteilig nach Betrag auf die Positionen verteilt. Cord berechnet den Betrag; null entfernt ihn.
`cupon`	`string`	Code eines Gutscheins des Unternehmens. Cord prüft Gültigkeit, Währung und Einlösungen; ist er angegeben, hat er Vorrang vor descuento. Er ist der einzige Rabatt, den ein öffentlicher Schlüssel verwenden kann.
`send`	`boolean`	Nur mit geheimem Schlüssel.

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"
});

Antwort: data

`id`	`string`	Kennung (UUID).
`token`	`string`	Token des öffentlichen Links. Er ist ein Zugangsnachweis: Veröffentlichen Sie ihn nicht.
`folio`	`string`	Lesbare Nummer, die Cord vergibt, z. B. COT-0042.
`link_publico`	`string`	Absoluter öffentlicher Link, der mit dem Kunden geteilt wird.
`needs_approval`	`boolean`	true, wenn es vor dem Senden auf eine interne Freigabe wartet.
`motivo`	`string \| null`	Grund, von einer Person verfasst.
`email`	`object`	E-Mail-Adresse.

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

Angebot abrufenscope: read

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

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

Antwort: data

`id`	`string`	Kennung (UUID).
`folio`	`string`	Lesbare Nummer, die Cord vergibt, z. B. COT-0042.
`cliente`	`string \| null`	Kunde, an den sich das Dokument richtet: Name des Unternehmens oder die Daten, um ihn anzulegen, falls er noch nicht existiert.
`status`	`string`	Status des Angebots: draft, sent, viewed, approved, rejected, expired, paid oder invoiced.
`total`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`moneda`	`string \| null`	Währung nach ISO 4217.
`terminos`	`string \| null`	Lesbare Bezeichnung des Zahlungsziels in der Sprache des Kontos („Sofort fällig“, „Net 45“); zum Vergleichen verwenden Sie terminos_codigo.
`terminos_codigo`	`string \| null`	Stabiler Code des Zahlungsziels: contado oder net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Datum nach ISO 8601.
`creada`	`string \| null`	Datum nach ISO 8601.
`link_publico`	`string`	Absoluter öffentlicher Link zum Angebot.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Schreibgeschützt. Sprache, in der das Angebot gesendet wurde: es, en, pt, fr oder de. null, solange es ein Entwurf ist; dieser folgt der Sprache des Kunden.
`notas`	`string \| null`	Interne Notizen; der Kunde sieht sie nicht.
`aprobacion`	`object \| null`	Interne Freigabe, die eine Regel des Unternehmens verlangt; null, wenn nicht zutreffend.
`items`	`object[]`	Positionen.
`descuento`	`object \| null`	Rabatt auf das Dokument, vor Steuern angewendet und auf die Positionen verteilt; null, wenn keiner vorhanden ist. subtotal ist bereits netto.
`eventos`	`object[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.

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

Senden, erneut senden, bestätigen, ablehnen oder als bezahlt markierenscope: write

Feld	Typ	Beschreibung
`action` erforderlich	`"send" \| "resend" \| "approve" \| "reject" \| "mark_paid"`	Auszuführende Aktion; jede setzt den richtigen vorherigen Status voraus und ist mit Idempotency-Key idempotent.
`payment_method`	`string`	Zahlungsmethode beim Markieren als bezahlt: 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');

Antwort: data

id string Kennung (UUID).

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

Entwurf löschenscope: write

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

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

Antwort: data

id string Kennung (UUID).

POST`/api/v1/cotizaciones/ia`

Positionen aus dem Text einer Bestellung vorschlagenscope: write

Feld	Typ	Beschreibung
`texto` erforderlich	`string`	Freitext der Bestellung.

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');

Antwort: data

`items`	`any[]`	Positionen.
`moneda`	`string`	Währung der Beträge nach ISO 4217.

Kunden

GET`/api/v1/clientes`

Kunden auflistenscope: readOffset-Paginierung

Abfrageparameter: 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);
}

Antwort: data[]

`id`	`string`	Kennung (UUID).
`empresa`	`string`	Name des Unternehmens oder der Person.
`contacto`	`string`	Name der Kontaktperson.
`email`	`string`	E-Mail-Adresse.
`telefono`	`string`	Telefonnummer mit internationaler Vorwahl.
`rfc`	`string`	Steuernummer: RFC, NIF, EIN…
`terminos`	`string`	Lesbare Bezeichnung der Zahlungsbedingungen.
`terminosCode`	`string`	Code der Zahlungsbedingungen: contado oder net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Kreditlimit des Kunden in der Währung des Unternehmens.
`nivel`	`string`	Stufe oder Segment des Kunden.
`descuentoPct`	`number`	Standardrabatt des Kunden in Prozent.
`regimenFiscal`	`string`	Steuerregime-Schlüssel des SAT (Mexiko).
`usoCfdi`	`string`	CFDI-Verwendungsschlüssel (Mexiko).
`cpFiscal`	`string`	Postleitzahl der steuerlichen Anschrift (Mexiko).
`countryCode`	`string`	Land nach ISO 3166-1 Alpha-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Sprache der Dokumente, die der Kunde erhält: es, en, pt, fr oder de; null = die der Organisation. Angebote und Rechnungen behalten die Sprache, in der sie gesendet oder ausgestellt wurden; eine Änderung schreibt bereits Gesendetes nicht um. Jeder andere Wert antwortet mit 400 und field: language.

POST`/api/v1/clientes`

Kunden anlegenscope: write

Feld	Typ	Beschreibung
`empresa` erforderlich	`string`	Name des Unternehmens oder der Person.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Sprache der Dokumente, die der Kunde erhält: es, en, pt, fr oder de; null = die der Organisation. Angebote und Rechnungen behalten die Sprache, in der sie gesendet oder ausgestellt wurden; eine Änderung schreibt bereits Gesendetes nicht um. Jeder andere Wert antwortet mit 400 und 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": "…"
});

Antwort: data

id string Kennung (UUID).

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

Kunden abrufenscope: read

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

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

Antwort: data

`id`	`string`	Kennung (UUID).
`empresa`	`string`	Name des Unternehmens oder der Person.
`contacto`	`string`	Name der Kontaktperson.
`email`	`string`	E-Mail-Adresse.
`telefono`	`string`	Telefonnummer mit internationaler Vorwahl.
`rfc`	`string`	Steuernummer: RFC, NIF, EIN…
`terminos`	`string`	Lesbare Bezeichnung der Zahlungsbedingungen.
`terminosCode`	`string`	Code der Zahlungsbedingungen: contado oder net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Kreditlimit des Kunden in der Währung des Unternehmens.
`nivel`	`string`	Stufe oder Segment des Kunden.
`descuentoPct`	`number`	Standardrabatt des Kunden in Prozent.
`regimenFiscal`	`string`	Steuerregime-Schlüssel des SAT (Mexiko).
`usoCfdi`	`string`	CFDI-Verwendungsschlüssel (Mexiko).
`cpFiscal`	`string`	Postleitzahl der steuerlichen Anschrift (Mexiko).
`countryCode`	`string`	Land nach ISO 3166-1 Alpha-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Sprache der Dokumente, die der Kunde erhält: es, en, pt, fr oder de; null = die der Organisation. Angebote und Rechnungen behalten die Sprache, in der sie gesendet oder ausgestellt wurden; eine Änderung schreibt bereits Gesendetes nicht um. Jeder andere Wert antwortet mit 400 und field: language.

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

Kontaktdaten aktualisierenscope: write

Feld	Typ	Beschreibung
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Sprache der Dokumente, die der Kunde erhält: es, en, pt, fr oder de; null = die der Organisation. Angebote und Rechnungen behalten die Sprache, in der sie gesendet oder ausgestellt wurden; eine Änderung schreibt bereits Gesendetes nicht um. Jeder andere Wert antwortet mit 400 und 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' });

Antwort: data

id string Kennung (UUID).

Produkte

GET`/api/v1/productos`

Produkte auflistenAkzeptiert pk_scope: readOffset-Paginierung

Abfrageparameter: 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);
}

Antwort: data[]

`id`	`string`	Kennung (UUID).
`sku`	`string`	Interne Artikelnummer.
`nombre`	`string`	Name.
`unidad`	`string`	Maßeinheit: Stück, kg, Stunde…
`descripcion`	`string`	Beschreibung, wie der Kunde sie sieht.
`precio`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`costo`	`number`	Wird für öffentliche Schlüssel nie ausgegeben.
`activo`	`boolean`	false, wenn deaktiviert: bleibt erhalten, wird aber nicht verwendet.
`createdAt`	`string \| null`	Datum nach ISO 8601.
`preciosVolumen`	`object[]`	Staffelpreise nach Menge.
`existencias`	`number \| null`	Verfügbare Einheiten; null, wenn kein Bestand geführt wird.
`taxRate`	`number \| null`	Steuer, die beim Hinzufügen des Produkts zu einer Position vorgeschlagen wird, als Bruch von 0–1; null = der Standard der Organisation.
`claveSat`	`string \| null`	Produkt- oder Leistungsschlüssel des SAT (c_ClaveProdServ, 8 Ziffern) für den CFDI in Mexiko; null, wenn nicht klassifiziert.
`claveUnidadSat`	`string \| null`	Einheitenschlüssel des SAT (c_ClaveUnidad, z. B. H87 oder E48) für den CFDI in Mexiko; null = wird aus der Einheit abgeleitet.

POST`/api/v1/productos`

Produkt anlegenscope: write

Feld	Typ	Beschreibung
`nombre` erforderlich	`string`	Name.

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": "…"
});

Antwort: data

id string Kennung (UUID).

Rechnungen

GET`/api/v1/facturas`

Rechnungen auflistenscope: readCursor-Paginierung

Abfrageparameter: 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);
}

Antwort: data[]

`id`	`string`	Kennung (UUID).
`numero`	`string \| null`	Rechnungsnummer innerhalb ihres Nummernkreises.
`folio_fiscal`	`string \| null`	Kennung bei der Steuerbehörde (UUID des CFDI in Mexiko); null, wenn nicht zutreffend.
`cliente`	`string \| null`	Kunde, an den sich das Dokument richtet: Name des Unternehmens oder die Daten, um ihn anzulegen, falls er noch nicht existiert.
`estado`	`string`	draft, open, paid, void oder uncollectible.
`estado_fiscal`	`string`	Status der Ausstellung: pending, issued, cancelled oder error.
`pais`	`string`	Land nach ISO 3166-1 Alpha-2.
`tipo`	`string`	Dokumenttyp: cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice oder verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Wie das Dokument betitelt ist. factura_proforma ist eine Proforma-Rechnung: keine Rechnung und steuerlich ungültig. Umfasst den Typ proforma und in Spanien jedes Dokument ohne Verifactu-Eintrag.
`moneda`	`string \| null`	Währung nach ISO 4217.
`total`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`pagado`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`saldo`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`vence`	`string \| null`	Datum nach ISO 8601.
`vencida`	`boolean`	true, wenn das Fälligkeitsdatum mit offenem Betrag überschritten ist.
`cotizacion_id`	`string \| null`	ID des zugehörigen Angebots.
`creada`	`string \| null`	Datum nach ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Schreibgeschützt. Sprache, in der die Rechnung ausgestellt wurde: es, en, pt, fr oder de. null, solange sie ein Entwurf ist.

POST`/api/v1/facturas`

Rechnungsentwurf erstellenscope: write

Feld	Typ	Beschreibung
`cliente_id` erforderlich	`string`	ID eines Kunden aus dem Kundenverzeichnis.
`items` erforderlich	`object[]`	Positionen.
`currency`	`string`	Währung nach ISO 4217.
`due_date`	`string`	Fälligkeitsdatum, YYYY-MM-DD.
`service_date`	`string`	Leistungs- oder Lieferdatum, YYYY-MM-DD. Ohne Angabe vermerkt die Rechnung, dass es dem Rechnungsdatum entspricht.
`service_date_end`	`string`	Ende des Leistungszeitraums, YYYY-MM-DD. Setzt service_date voraus und darf nicht davor liegen.
`notas`	`string`	Interne Notizen; der Kunde sieht sie nicht.
`iva_incluido`	`boolean`	true, wenn die erfassten Preise die Steuer bereits enthalten.
`document_mode`	`"commercial" \| "fiscal"`	commercial oder fiscal. Ohne Angabe fiscal, wenn der Tarif es enthält und es für das Land aktiviert ist; fiscal ohne diese Voraussetzungen antwortet mit 400.
`fx_buffer_pct`	`number`	Puffer in Prozentpunkten auf den Referenzwechselkurs (2 = +2 %); höchstens 25. Standard 0.
`descuento`	`object \| null`	Rabatt auf das Dokument vor Steuern, anteilig nach Betrag auf die Positionen verteilt. Cord berechnet den Betrag; null entfernt ihn.
`cupon`	`string`	Code eines Gutscheins des Unternehmens. Cord prüft Gültigkeit, Währung und Einlösungen; ist er angegeben, hat er Vorrang vor descuento. Er ist der einzige Rabatt, den ein öffentlicher Schlüssel verwenden kann.
`buyer_reference`	`string`	Käuferreferenz für die Kreditorenbuchhaltung des Käufers (in Deutschland die Leitweg-ID der öffentlichen Verwaltung). Sie steht in der europäischen E-Rechnung (BT-10) und ist für XRechnung Pflicht. Ohne Angabe gilt die des Kunden. Ist die elektronische Adresse des Kunden eine Leitweg-ID (Schema 0204), werden ihre Prüfziffern kontrolliert (ISO/IEC 7064 MOD 97-10); eine ungültige antwortet mit 400.
`purchase_order`	`string`	Bestellnummer des Kunden (BT-13 der europäischen E-Rechnung).

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
    }
  ]
});

Antwort: data

id string Kennung (UUID).

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

Rechnung abrufenscope: read

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

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

Antwort: data

`id`	`string`	Kennung (UUID).
`numero`	`string \| null`	Rechnungsnummer innerhalb ihres Nummernkreises.
`folio_fiscal`	`string \| null`	Kennung bei der Steuerbehörde (UUID des CFDI in Mexiko); null, wenn nicht zutreffend.
`cliente`	`string \| null`	Kunde, an den sich das Dokument richtet: Name des Unternehmens oder die Daten, um ihn anzulegen, falls er noch nicht existiert.
`estado`	`string`	draft, open, paid, void oder uncollectible.
`estado_fiscal`	`string`	Status der Ausstellung: pending, issued, cancelled oder error.
`pais`	`string`	Land nach ISO 3166-1 Alpha-2.
`tipo`	`string`	Dokumenttyp: cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice oder verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Wie das Dokument betitelt ist. factura_proforma ist eine Proforma-Rechnung: keine Rechnung und steuerlich ungültig. Umfasst den Typ proforma und in Spanien jedes Dokument ohne Verifactu-Eintrag.
`moneda`	`string \| null`	Währung nach ISO 4217.
`total`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`pagado`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`saldo`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`vence`	`string \| null`	Datum nach ISO 8601.
`vencida`	`boolean`	true, wenn das Fälligkeitsdatum mit offenem Betrag überschritten ist.
`cotizacion_id`	`string \| null`	ID des zugehörigen Angebots.
`creada`	`string \| null`	Datum nach ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Schreibgeschützt. Sprache, in der die Rechnung ausgestellt wurde: es, en, pt, fr oder de. null, solange sie ein Entwurf ist.
`subtotal`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`impuestos`	`number`	Betrag in der durch `moneda` angegebenen Währung.
`moneda_contable`	`string \| null`	Währung nach ISO 4217.
`tipo_cambio`	`number \| null`	Ausgewiesener Wechselkurs von der Verkaufs- zur Buchungswährung; null, wenn beide gleich sind.
`total_contable`	`number \| null`	In die Buchungswährung umgerechneter Gesamtbetrag.
`notas`	`string \| null`	Interne Notizen; der Kunde sieht sie nicht.
`nota_credito_de`	`string \| null`	ID der Rechnung, die diese Gutschrift korrigiert.
`emisor`	`any`	Steuerdaten des Ausstellers.
`receptor`	`any`	Steuerdaten des Kunden, der die Rechnung erhält.
`descuento`	`object \| null`	Rabatt auf das Dokument, vor Steuern angewendet und auf die Positionen verteilt; null, wenn keiner vorhanden ist. subtotal ist bereits netto.
`conceptos`	`object[]`	Rechnungspositionen mit ihrer Steuer.
`pagos`	`object[]`	Eingegangene Zahlungen.

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

Ausstellen, senden, stornieren, Zahlung erfassen oder Gutschrift erstellenscope: write

Feld	Typ	Beschreibung
`action` erforderlich	`"finalize" \| "send" \| "void" \| "payment" \| "credit_note"`	Auszuführende Aktion; jede setzt den richtigen vorherigen Status voraus und ist mit Idempotency-Key idempotent.
`monto`	`number`	Betrag in der durch moneda angegebenen Währung.
`moneda`	`string`	Währung der Beträge nach ISO 4217.
`metodo`	`string`	Zahlungsmethode: transferencia, efectivo, tarjeta…
`referencia`	`string`	Referenz der Zahlung oder des Anbieters.
`motivo`	`string`	Grund, von einer Person verfasst.
`sin_comercio_exterior`	`boolean`	Mexiko, beim Ausstellen (finalize): true bestätigt, dass ein CFDI mit Waren für einen Kunden im Ausland keine endgültige Ausfuhr ist. Ohne diesen Wert antwortet diese Ausstellung mit 409 und dem Code comercio_exterior, weil Cord das Außenhandelskomplement nicht erstellt.

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');

Antwort: data

id string Kennung (UUID).

Forderungsmanagement

GET`/api/v1/cobranza`

Offene Forderungenscope: read

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

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

Antwort: data

`resumen`	`any`	Summen auf einen Blick.
`aging`	`any`	Offene Forderungen nach Alter in vier festen Stufen: vigente (noch nicht fällig), d30 (1–30 Tage überfällig), d60 (31–60) und d60p (mehr als 60). Jede enthält key, label, monto und n.
`items`	`any[]`	Positionen.
`clientes`	`any`	Saldo nach Kunden gruppiert.

Ereignisse

GET`/api/v1/events`

Ereignisverlaufscope: readCursor-Paginierung

Abfrageparameter: 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);
}

Antwort: data[]

`id`	`string`	Kennung (UUID).
`type`	`string`	Ereignistyp, z. B. quote.approved.
`object`	`string`	Objekttyp: quote, invoice, client, product, task, promise…
`object_id`	`string \| null`	ID des betroffenen Objekts.
`data`	`object`	Inhalt der Antwort oder des Ereignisses.
`actor`	`string \| null`	Wer es ausgelöst hat: user, api, mcp, client (der Empfänger des öffentlichen Links) oder system.
`created_at`	`string`	Erstellungsdatum, ISO 8601.

Aufgaben

POST`/api/v1/tareas`

Aufgabe erstellenscope: write

Feld	Typ	Beschreibung
`titulo` erforderlich	`string`	Was zu tun ist.
`due_date`	`string`	Fälligkeitsdatum, YYYY-MM-DD.
`cotizacion_id`	`string`	ID des zugehörigen Angebots.
`factura_id`	`string`	ID der zugehörigen Rechnung (die `id` aus /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' });

Antwort: data

id string Kennung (UUID).

Workflows

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

Einen Workflow „Sie starten ihn“ für Angebote oder Rechnungen ausführenscope: write

Feld	Typ	Beschreibung
`objeto` erforderlich	`"quote" \| "invoice"`	Dokumentart: quote (Angebot) oder invoice (Rechnung); sie muss zum Auslöser des Workflows passen.
`ids` erforderlich	`string[]`	Kennungen (UUID) der Dokumente, 1 bis 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":["…"]}'

Antwort: data

`documentos`	`number`	Wie viele der gesendeten Dokumente in der Organisation existieren.
`corridas`	`number`	Wie viele Ausführungen gestartet wurden: Ein Dokument, das den Filter des Workflows nicht erfüllt oder schon einmal darin war, zählt nicht.

Webhooks

GET`/api/v1/webhooks`

Von diesem Schlüssel erstellte Endpointsscope: read

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

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

Antwort: data

`id`	`string`	Kennung (UUID).
`url`	`string`	HTTPS-URL, die die Ereignisse empfängt.
`eventos`	`string[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.
`activo`	`boolean`	false, wenn deaktiviert: bleibt erhalten, wird aber nicht verwendet.
`created_at`	`string`	Erstellungsdatum, ISO 8601.

POST`/api/v1/webhooks`

Endpoint erstellen (das Secret wird nur einmal zurückgegeben)scope: write

Feld	Typ	Beschreibung
`url` erforderlich	`string`	HTTPS-URL, die die Ereignisse empfängt.
`eventos`	`string[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.

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": "…"
});

Antwort: data

`id`	`string`	Kennung (UUID).
`url`	`string`	HTTPS-URL, die die Ereignisse empfängt.
`eventos`	`string[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.
`activo`	`boolean`	false, wenn deaktiviert: bleibt erhalten, wird aber nicht verwendet.
`created_at`	`string`	Erstellungsdatum, ISO 8601.
`secret`	`string`	Secret zur Prüfung der Signatur. Wird nur einmal angezeigt.

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

Endpoint löschenscope: write

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

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

Antwort: data

id string Kennung (UUID).

Elements

GET`/api/v1/elements/config`

Konfiguration, die Cord Elements darstelltAkzeptiert pk_scope: read

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

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

Antwort: data

`object`	`"elements_config"`	Objekttyp: quote, invoice, client, product, task, promise…
`org`	`object`	Organisation, der der Schlüssel gehört.
`monedas`	`string[]`	Währungen, die das Unternehmen in Angeboten anbietet.
`impuestos`	`object`	Steuern des Dokuments oder Steuerkatalog.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"[]`	Zahlungsbedingungen: contado oder net<N> (N Tage Zahlungsziel: 7, 15, 30, 45, 60 oder 90).
`terminos_default`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Standard-Zahlungsbedingungen.
`vigencia_dias_default`	`number`	Standardgültigkeit in Tagen.
`fiscal`	`object`	Steuerdaten.

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

KI-Positionen per Streaming (text/event-stream)Akzeptiert pk_scope: write

Feld	Typ	Beschreibung
`texto`	`string`	Freitext der Bestellung.
`archivo`	`string`	JPG, PNG oder PDF, max. 4 MB.

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"

Antwortet mit text/event-stream und den Ereignissen item, done und error.

Testmodus

POST`/api/v1/test_helpers/fiscal`

Ergebnis der nächsten Ausstellung erzwingenNur sk_test_scope: write

Feld	Typ	Beschreibung
`siguiente_resultado` erforderlich	`"exito" \| "pac_caido" \| "receptor_invalido" \| "certificado_vencido" \| "timbre_duplicado"`	Ergebnis der nächsten steuerlichen Ausstellung in der Testumgebung.

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');

Antwort: data

siguiente_resultado string Ergebnis der nächsten steuerlichen Ausstellung in der Testumgebung.

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

Aufruf oder Ablauf simulierenNur sk_test_scope: write

Feld	Typ	Beschreibung
`accion` erforderlich	`"vista" \| "vencer"`	Was simuliert wird: vista (der Kunde öffnet den Link) oder vencer (das Angebot läuft ab).

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');

Antwort: data

id string Kennung (UUID).

POST`/api/v1/test_helpers/webhooks`

Webhook auslösenNur sk_test_scope: write

Feld	Typ	Beschreibung
`evento` erforderlich	`string`	Ereignistyp, z. B. quote.approved.
`objeto_id`	`string`	ID eines Angebots oder einer Rechnung aus der Testumgebung; ohne Angabe werden Beispieldaten verwendet.

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');

Antwort: data

`evento`	`string`	Ereignistyp, z. B. quote.approved.
`datos`	`"real" \| "ejemplo"`	real, wenn die Daten des angegebenen Objekts verwendet wurden; ejemplo bei erfundenen Beispieldaten.

POST`/api/v1/test_helpers/listen`

Sitzung für cord listen öffnenNur sk_test_scope: write

Feld	Typ	Beschreibung
`eventos`	`string[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.

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

Antwort: data

`id`	`string`	Kennung (UUID).
`secret`	`string`	Secret zur Prüfung der Signatur. Wird nur einmal angezeigt.
`eventos`	`string[]`	Liste von Ereignissen oder Ereignistypen. Leer = alle.
`expira`	`string`	Ablaufdatum, ISO 8601.

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

Ereignisse der Sitzung abholenNur sk_test_scope: write

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

Antwort: data

`event_id`	`string`	ID des Ereignisses; deduplizieren Sie anhand dieser ID.
`evento`	`string`	Ereignistyp, z. B. quote.approved.
`body`	`string`	Roher Body des Ereignisses; leiten Sie ihn unverändert weiter, damit die Signatur gültig bleibt.
`headers`	`object`	Header, die unverändert weitergeleitet werden, einschließlich der Signatur X-Cord-Signature-V1.

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

Sitzung für cord listen schließenNur sk_test_scope: write

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

Antwort: data

id string Kennung (UUID).

Einrichtung

POST`/api/v1/setup/plans`

Kontoeinrichtung vorschlagen (eine Person gibt sie unter review_url frei)scope: write

Feld	Typ	Beschreibung
`sitio`	`string`	Website des Unternehmens, z. B. ihrunternehmen.com.
`descripcion`	`string`	Beschreibung des Unternehmens: Branche, Zahlungsziele, erhobene oder einbehaltene Steuern.
`archivo`	`object`	Preisliste (Excel, CSV, PDF oder Foto) in Base64, bis 3 MB.

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

Antwort: data

`object`	`"setup_plan"`	Objekttyp: quote, invoice, client, product, task, promise…
`id`	`string`	Kennung (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto wartet auf die Freigabe durch eine Person unter review_url.
`review_url`	`string`	Seite, auf der eine angemeldete Person den Vorschlag prüft und anwendet. Die API wendet ihn nie an.

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

Status eines Einrichtungsvorschlagsscope: read

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

Antwort: data

`object`	`"setup_plan"`	Objekttyp: quote, invoice, client, product, task, promise…
`id`	`string`	Kennung (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto wartet auf die Freigabe durch eine Person unter review_url.
`review_url`	`string`	Seite, auf der eine angemeldete Person den Vorschlag prüft und anwendet. Die API wendet ihn nie an.

Konto

GET/api/v1/me

Angebote

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

Kunden

GET/api/v1/clientes

POST/api/v1/clientes

GET/api/v1/clientes/{id}

PATCH/api/v1/clientes/{id}

Produkte

GET/api/v1/productos

POST/api/v1/productos

Rechnungen

GET/api/v1/facturas

POST/api/v1/facturas

GET/api/v1/facturas/{id}

POST/api/v1/facturas/{id}

Forderungsmanagement

GET/api/v1/cobranza

Ereignisse

GET/api/v1/events

Aufgaben

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

Testmodus

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}

Einrichtung

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}`