Referência da API

Gerada a partir do mesmo contrato que o openapi.json(OpenAPI 3.1). Versão 2026-10-01.Toda resposta vem em { data }; os erros, em { error, code, request_id, doc_url }.

Conta

GET`/api/v1/me`

Organização e escopo da chavescope: read

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

const me = await cord.me();

Resposta: data

`org`	`object`	Organização dona da chave.
`scope`	`string`	read ou write: o que a chave pode fazer.
`mode`	`"live" \| "test"`	live ou test: com test, tudo acontece no ambiente de teste e não toca em dados reais.

Orçamentos

GET`/api/v1/cotizaciones`

Listar orçamentosscope: readPaginação por offset

Parâmetros: 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);
}

Resposta: data[]

`id`	`string`	Identificador (UUID).
`folio`	`string`	Número legível atribuído pelo Cord, por exemplo COT-0042.
`cliente`	`string \| null`	Cliente a quem o documento se destina: nome da empresa, ou os dados para cadastrá-lo se ainda não existir.
`status`	`string`	Status do orçamento: draft, sent, viewed, approved, rejected, expired, paid ou invoiced.
`total`	`number`	Valor na moeda indicada por `moneda`.
`moneda`	`string \| null`	Moeda ISO 4217.
`terminos`	`string \| null`	Rótulo legível do prazo no idioma da conta (“À vista”, “Net 45”); para comparar, use terminos_codigo.
`terminos_codigo`	`string \| null`	Código estável do prazo: contado ou net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Data ISO 8601.
`creada`	`string \| null`	Data ISO 8601.
`link_publico`	`string`	Link público absoluto do orçamento.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Somente leitura. Idioma em que foi enviado: es, en, pt, fr ou de. null enquanto for rascunho, que segue o idioma do cliente.

POST`/api/v1/cotizaciones`

Criar um orçamentoAceita pk_scope: write

Campo	Tipo	Descrição
`items` obrigatório	`object[]`	Itens.
`cliente_id`	`string`	ID de um cliente do cadastro.
`cliente`	`object`	Cliente a quem o documento se destina: nome da empresa, ou os dados para cadastrá-lo se ainda não existir.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Condições de pagamento: contado ou net<N> (N dias de prazo: 7, 15, 30, 45, 60 ou 90).
`vigencia_dias`	`integer`	Dias de validade do orçamento a partir do envio.
`notas`	`string`	Notas internas; o cliente não as vê.
`base_currency`	`string`	Moeda de venda ISO 4217: aquela em que os preços são informados, o pagamento é recebido e a fatura é emitida. Padrão: a do negócio.
`fiscal_currency`	`string`	Moeda contábil ISO 4217; se for diferente da moeda de venda, a fatura declara a taxa de câmbio.
`iva_incluido`	`boolean`	true se os preços informados já incluem o imposto.
`descuento`	`object \| null`	Desconto no documento antes dos impostos, distribuído entre os itens na proporção do valor de cada um. O Cord calcula o valor; null o remove.
`cupon`	`string`	Código de um cupom do negócio. O Cord valida a validade, a moeda e os usos; se for enviado, prevalece sobre descuento. É o único desconto aceito com uma chave publicável.
`send`	`boolean`	Somente com Secret Key.

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

Resposta: data

`id`	`string`	Identificador (UUID).
`token`	`string`	Token do link público. É uma credencial: não o publique.
`folio`	`string`	Número legível atribuído pelo Cord, por exemplo COT-0042.
`link_publico`	`string`	Link público absoluto compartilhado com o cliente.
`needs_approval`	`boolean`	true se ficou retido aguardando aprovação interna antes de ser enviado.
`motivo`	`string \| null`	Motivo, escrito por uma pessoa.
`email`	`object`	E-mail.

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

Consultar um orçamentoscope: read

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

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

Resposta: data

`id`	`string`	Identificador (UUID).
`folio`	`string`	Número legível atribuído pelo Cord, por exemplo COT-0042.
`cliente`	`string \| null`	Cliente a quem o documento se destina: nome da empresa, ou os dados para cadastrá-lo se ainda não existir.
`status`	`string`	Status do orçamento: draft, sent, viewed, approved, rejected, expired, paid ou invoiced.
`total`	`number`	Valor na moeda indicada por `moneda`.
`moneda`	`string \| null`	Moeda ISO 4217.
`terminos`	`string \| null`	Rótulo legível do prazo no idioma da conta (“À vista”, “Net 45”); para comparar, use terminos_codigo.
`terminos_codigo`	`string \| null`	Código estável do prazo: contado ou net<N> (net7, net15, net30, net45, net60, net90).
`vigencia`	`string \| null`	Data ISO 8601.
`creada`	`string \| null`	Data ISO 8601.
`link_publico`	`string`	Link público absoluto do orçamento.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Somente leitura. Idioma em que foi enviado: es, en, pt, fr ou de. null enquanto for rascunho, que segue o idioma do cliente.
`notas`	`string \| null`	Notas internas; o cliente não as vê.
`aprobacion`	`object \| null`	Aprovação interna exigida por uma regra do negócio; null se não se aplicar.
`items`	`object[]`	Itens.
`descuento`	`object \| null`	Desconto no documento, aplicado antes dos impostos e distribuído entre os itens; null se não houver. subtotal já é líquido.
`eventos`	`object[]`	Lista de eventos ou tipos de evento. Vazia = todos.

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

Enviar, reenviar, aprovar, recusar ou marcar como pagoscope: write

Campo	Tipo	Descrição
`action` obrigatório	`"send" \| "resend" \| "approve" \| "reject" \| "mark_paid"`	Ação a executar; cada uma exige o status anterior correto e é idempotente com Idempotency-Key.
`payment_method`	`string`	Método de pagamento ao marcar como pago: 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');

Resposta: data

id string Identificador (UUID).

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

Excluir um rascunhoscope: write

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

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

Resposta: data

id string Identificador (UUID).

POST`/api/v1/cotizaciones/ia`

Sugerir itens a partir do texto de um pedidoscope: write

Campo	Tipo	Descrição
`texto` obrigatório	`string`	Texto livre do pedido.

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

Resposta: data

`items`	`any[]`	Itens.
`moneda`	`string`	Moeda ISO 4217 dos valores.

Clientes

GET`/api/v1/clientes`

Listar clientesscope: readPaginação por offset

Parâmetros: 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);
}

Resposta: data[]

`id`	`string`	Identificador (UUID).
`empresa`	`string`	Nome da empresa ou pessoa.
`contacto`	`string`	Nome da pessoa de contato.
`email`	`string`	E-mail.
`telefono`	`string`	Telefone com código internacional (DDI).
`rfc`	`string`	Identificação fiscal: RFC, NIF, EIN…
`terminos`	`string`	Rótulo legível das condições de pagamento.
`terminosCode`	`string`	Código das condições de pagamento: contado ou net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Limite de crédito do cliente, na moeda do negócio.
`nivel`	`string`	Nível ou segmento do cliente.
`descuentoPct`	`number`	Desconto padrão do cliente, em porcentagem.
`regimenFiscal`	`string`	Código de regime fiscal do SAT (México).
`usoCfdi`	`string`	Código de uso do CFDI (México).
`cpFiscal`	`string`	Código postal do domicílio fiscal (México).
`countryCode`	`string`	País ISO 3166-1 alfa-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Idioma dos documentos que o cliente recebe: es, en, pt, fr ou de; null = o da organização. Orçamentos e faturas guardam o idioma em que foram enviados ou emitidos; alterá-lo não reescreve o que já foi enviado. Outro valor responde 400 com field: language.

POST`/api/v1/clientes`

Criar um clientescope: write

Campo	Tipo	Descrição
`empresa` obrigatório	`string`	Nome da empresa ou pessoa.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Idioma dos documentos que o cliente recebe: es, en, pt, fr ou de; null = o da organização. Orçamentos e faturas guardam o idioma em que foram enviados ou emitidos; alterá-lo não reescreve o que já foi enviado. Outro valor responde 400 com 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": "…"
});

Resposta: data

id string Identificador (UUID).

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

Consultar um clientescope: read

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

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

Resposta: data

`id`	`string`	Identificador (UUID).
`empresa`	`string`	Nome da empresa ou pessoa.
`contacto`	`string`	Nome da pessoa de contato.
`email`	`string`	E-mail.
`telefono`	`string`	Telefone com código internacional (DDI).
`rfc`	`string`	Identificação fiscal: RFC, NIF, EIN…
`terminos`	`string`	Rótulo legível das condições de pagamento.
`terminosCode`	`string`	Código das condições de pagamento: contado ou net<N> (net7, net15, net30, net45, net60, net90).
`limite`	`number`	Limite de crédito do cliente, na moeda do negócio.
`nivel`	`string`	Nível ou segmento do cliente.
`descuentoPct`	`number`	Desconto padrão do cliente, em porcentagem.
`regimenFiscal`	`string`	Código de regime fiscal do SAT (México).
`usoCfdi`	`string`	Código de uso do CFDI (México).
`cpFiscal`	`string`	Código postal do domicílio fiscal (México).
`countryCode`	`string`	País ISO 3166-1 alfa-2.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Idioma dos documentos que o cliente recebe: es, en, pt, fr ou de; null = o da organização. Orçamentos e faturas guardam o idioma em que foram enviados ou emitidos; alterá-lo não reescreve o que já foi enviado. Outro valor responde 400 com field: language.

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

Atualizar os dados de contatoscope: write

Campo	Tipo	Descrição
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Idioma dos documentos que o cliente recebe: es, en, pt, fr ou de; null = o da organização. Orçamentos e faturas guardam o idioma em que foram enviados ou emitidos; alterá-lo não reescreve o que já foi enviado. Outro valor responde 400 com 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' });

Resposta: data

id string Identificador (UUID).

Produtos

GET`/api/v1/productos`

Listar produtosAceita pk_scope: readPaginação por offset

Parâmetros: 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);
}

Resposta: data[]

`id`	`string`	Identificador (UUID).
`sku`	`string`	Código interno do produto.
`nombre`	`string`	Nome.
`unidad`	`string`	Unidade de medida: peça, kg, hora…
`descripcion`	`string`	Descrição como o cliente a vê.
`precio`	`number`	Valor na moeda indicada por `moneda`.
`costo`	`number`	Nunca é exposto a uma chave publicável.
`activo`	`boolean`	false se estiver desativado: é mantido, mas não é usado.
`createdAt`	`string \| null`	Data ISO 8601.
`preciosVolumen`	`object[]`	Preços escalonados por quantidade.
`existencias`	`number \| null`	Unidades disponíveis; null se o estoque não é controlado.
`taxRate`	`number \| null`	Imposto sugerido ao adicionar o produto a um item, como fração de 0 a 1; null = o padrão da organização.
`claveSat`	`string \| null`	Código de produto ou serviço do SAT (c_ClaveProdServ, 8 dígitos) para o CFDI no México; null se não foi classificado.
`claveUnidadSat`	`string \| null`	Código de unidade do SAT (c_ClaveUnidad, como H87 ou E48) para o CFDI no México; null = deduzido da unidade.

POST`/api/v1/productos`

Criar um produtoscope: write

Campo	Tipo	Descrição
`nombre` obrigatório	`string`	Nome.

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

Resposta: data

id string Identificador (UUID).

Faturas

GET`/api/v1/facturas`

Listar faturasscope: readPaginação por cursor

Parâmetros: 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);
}

Resposta: data[]

`id`	`string`	Identificador (UUID).
`numero`	`string \| null`	Número da fatura na sua série.
`folio_fiscal`	`string \| null`	Identificador perante a autoridade fiscal (UUID do CFDI no México); null se não se aplicar.
`cliente`	`string \| null`	Cliente a quem o documento se destina: nome da empresa, ou os dados para cadastrá-lo se ainda não existir.
`estado`	`string`	draft, open, paid, void ou uncollectible.
`estado_fiscal`	`string`	Status da emissão: pending, issued, cancelled ou error.
`pais`	`string`	País ISO 3166-1 alfa-2.
`tipo`	`string`	Tipo de documento: cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice ou verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Como o documento é intitulado. factura_proforma é uma fatura pró-forma: não é uma fatura e não tem validade fiscal. Cobre o tipo proforma e, na Espanha, todo documento sem registro no Verifactu.
`moneda`	`string \| null`	Moeda ISO 4217.
`total`	`number`	Valor na moeda indicada por `moneda`.
`pagado`	`number`	Valor na moeda indicada por `moneda`.
`saldo`	`number`	Valor na moeda indicada por `moneda`.
`vence`	`string \| null`	Data ISO 8601.
`vencida`	`boolean`	true se a data de vencimento passou com saldo pendente.
`cotizacion_id`	`string \| null`	ID do orçamento relacionado.
`creada`	`string \| null`	Data ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Somente leitura. Idioma em que foi emitida: es, en, pt, fr ou de. null enquanto for rascunho.

POST`/api/v1/facturas`

Criar uma fatura em rascunhoscope: write

Campo	Tipo	Descrição
`cliente_id` obrigatório	`string`	ID de um cliente do cadastro.
`items` obrigatório	`object[]`	Itens.
`currency`	`string`	Moeda ISO 4217.
`due_date`	`string`	Data de vencimento, YYYY-MM-DD.
`service_date`	`string`	Data da prestação do serviço ou da entrega (Leistungsdatum), YYYY-MM-DD. Sem ela, a fatura indica que coincide com a data de emissão.
`service_date_end`	`string`	Fim do período de prestação, YYYY-MM-DD. Exige service_date e não pode ser anterior.
`notas`	`string`	Notas internas; o cliente não as vê.
`iva_incluido`	`boolean`	true se os preços informados já incluem o imposto.
`document_mode`	`"commercial" \| "fiscal"`	commercial ou fiscal. Sem ele, fiscal se o plano incluir e estiver habilitado no país; fiscal sem isso responde 400.
`fx_buffer_pct`	`number`	Margem de proteção em pontos percentuais sobre a taxa de câmbio de referência (2 = +2%); limitada a 25. Padrão 0.
`descuento`	`object \| null`	Desconto no documento antes dos impostos, distribuído entre os itens na proporção do valor de cada um. O Cord calcula o valor; null o remove.
`cupon`	`string`	Código de um cupom do negócio. O Cord valida a validade, a moeda e os usos; se for enviado, prevalece sobre descuento. É o único desconto aceito com uma chave publicável.
`buyer_reference`	`string`	Referência do comprador para suas contas a pagar (na Alemanha, o Leitweg-ID da administração pública). Vai na fatura eletrônica europeia (BT-10) e é exigida pela XRechnung. Sem ela, usa-se a do cliente. Se o endereço eletrônico do cliente for um Leitweg-ID (esquema 0204), seus dígitos de controle são verificados (ISO/IEC 7064 MOD 97-10) e um que não passe responde 400.
`purchase_order`	`string`	Número do pedido de compra do cliente (BT-13 da fatura eletrônica europeia).

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

Resposta: data

id string Identificador (UUID).

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

Consultar uma faturascope: read

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

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

Resposta: data

`id`	`string`	Identificador (UUID).
`numero`	`string \| null`	Número da fatura na sua série.
`folio_fiscal`	`string \| null`	Identificador perante a autoridade fiscal (UUID do CFDI no México); null se não se aplicar.
`cliente`	`string \| null`	Cliente a quem o documento se destina: nome da empresa, ou os dados para cadastrá-lo se ainda não existir.
`estado`	`string`	draft, open, paid, void ou uncollectible.
`estado_fiscal`	`string`	Status da emissão: pending, issued, cancelled ou error.
`pais`	`string`	País ISO 3166-1 alfa-2.
`tipo`	`string`	Tipo de documento: cfdi_40, cfdi_egreso, proforma, commercial_invoice, commercial_credit_note, verifactu_invoice ou verifactu_credit_note.
`documento`	`"factura" \| "factura_proforma" \| "nota_credito" \| "nota_debito"`	Como o documento é intitulado. factura_proforma é uma fatura pró-forma: não é uma fatura e não tem validade fiscal. Cobre o tipo proforma e, na Espanha, todo documento sem registro no Verifactu.
`moneda`	`string \| null`	Moeda ISO 4217.
`total`	`number`	Valor na moeda indicada por `moneda`.
`pagado`	`number`	Valor na moeda indicada por `moneda`.
`saldo`	`number`	Valor na moeda indicada por `moneda`.
`vence`	`string \| null`	Data ISO 8601.
`vencida`	`boolean`	true se a data de vencimento passou com saldo pendente.
`cotizacion_id`	`string \| null`	ID do orçamento relacionado.
`creada`	`string \| null`	Data ISO 8601.
`language`	`"es" \| "en" \| "pt" \| "fr" \| "de" \| null`	Somente leitura. Idioma em que foi emitida: es, en, pt, fr ou de. null enquanto for rascunho.
`subtotal`	`number`	Valor na moeda indicada por `moneda`.
`impuestos`	`number`	Valor na moeda indicada por `moneda`.
`moneda_contable`	`string \| null`	Moeda ISO 4217.
`tipo_cambio`	`number \| null`	Taxa de câmbio declarada da moeda de venda para a contábil; null se forem a mesma.
`total_contable`	`number \| null`	Total convertido para a moeda contábil.
`notas`	`string \| null`	Notas internas; o cliente não as vê.
`nota_credito_de`	`string \| null`	ID da fatura que esta nota de crédito corrige.
`emisor`	`any`	Dados fiscais do emissor.
`receptor`	`any`	Dados fiscais do cliente que recebe a fatura.
`descuento`	`object \| null`	Desconto no documento, aplicado antes dos impostos e distribuído entre os itens; null se não houver. subtotal já é líquido.
`conceptos`	`object[]`	Itens da fatura com seu imposto.
`pagos`	`object[]`	Pagamentos recebidos.

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

Emitir, enviar, cancelar, registrar um pagamento ou uma nota de créditoscope: write

Campo	Tipo	Descrição
`action` obrigatório	`"finalize" \| "send" \| "void" \| "payment" \| "credit_note"`	Ação a executar; cada uma exige o status anterior correto e é idempotente com Idempotency-Key.
`monto`	`number`	Valor na moeda indicada por moneda.
`moneda`	`string`	Moeda ISO 4217 dos valores.
`metodo`	`string`	Método de pagamento: transferencia, efectivo, tarjeta…
`referencia`	`string`	Referência do pagamento ou do provedor.
`motivo`	`string`	Motivo, escrito por uma pessoa.
`sin_comercio_exterior`	`boolean`	México, ao emitir (finalize): true confirma que um CFDI com mercadorias para um cliente no exterior não é uma exportação definitiva. Sem ele, essa emissão responde 409 com o código comercio_exterior, porque o Cord não gera o complemento de comércio exterior.

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

Resposta: data

id string Identificador (UUID).

Cobrança

GET`/api/v1/cobranza`

Contas a receberscope: read

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

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

Resposta: data

`resumen`	`any`	Totais em resumo.
`aging`	`any`	Contas a receber por antiguidade em quatro faixas fixas: vigente (a vencer), d30 (1–30 dias de atraso), d60 (31–60) e d60p (mais de 60). Cada uma traz key, label, monto e n.
`items`	`any[]`	Itens.
`clientes`	`any`	Saldo agrupado por cliente.

Eventos

GET`/api/v1/events`

Histórico de eventosscope: readPaginação por cursor

Parâmetros: 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);
}

Resposta: data[]

`id`	`string`	Identificador (UUID).
`type`	`string`	Tipo de evento, por exemplo quote.approved.
`object`	`string`	Tipo de objeto: quote, invoice, client, product, task, promise…
`object_id`	`string \| null`	ID do objeto a que se refere.
`data`	`object`	Conteúdo da resposta ou do evento.
`actor`	`string \| null`	Quem fez: user, api, mcp, client (o destinatário do link público) ou system.
`created_at`	`string`	Data de criação, ISO 8601.

Tarefas

POST`/api/v1/tareas`

Criar uma tarefascope: write

Campo	Tipo	Descrição
`titulo` obrigatório	`string`	O que precisa ser feito.
`due_date`	`string`	Data de vencimento, YYYY-MM-DD.
`cotizacion_id`	`string`	ID do orçamento relacionado.
`factura_id`	`string`	ID da fatura relacionada (o `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' });

Resposta: data

id string Identificador (UUID).

Workflows

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

Executar um workflow “Você executa” em orçamentos ou faturasscope: write

Campo	Tipo	Descrição
`objeto` obrigatório	`"quote" \| "invoice"`	Tipo de documento: quote (orçamento) ou invoice (fatura); deve coincidir com o gatilho do workflow.
`ids` obrigatório	`string[]`	Identificadores (UUID) dos documentos, de 1 a 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":["…"]}'

Resposta: data

`documentos`	`number`	Quantos dos documentos enviados existem na organização.
`corridas`	`number`	Quantas execuções começaram: um documento que não cumpre o filtro do workflow ou que já entrou antes não conta.

Webhooks

GET`/api/v1/webhooks`

Endpoints criados por esta chavescope: read

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

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

Resposta: data

`id`	`string`	Identificador (UUID).
`url`	`string`	URL HTTPS que recebe os eventos.
`eventos`	`string[]`	Lista de eventos ou tipos de evento. Vazia = todos.
`activo`	`boolean`	false se estiver desativado: é mantido, mas não é usado.
`created_at`	`string`	Data de criação, ISO 8601.

POST`/api/v1/webhooks`

Criar um endpoint (o segredo é retornado uma única vez)scope: write

Campo	Tipo	Descrição
`url` obrigatório	`string`	URL HTTPS que recebe os eventos.
`eventos`	`string[]`	Lista de eventos ou tipos de evento. Vazia = todos.

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

Resposta: data

`id`	`string`	Identificador (UUID).
`url`	`string`	URL HTTPS que recebe os eventos.
`eventos`	`string[]`	Lista de eventos ou tipos de evento. Vazia = todos.
`activo`	`boolean`	false se estiver desativado: é mantido, mas não é usado.
`created_at`	`string`	Data de criação, ISO 8601.
`secret`	`string`	Segredo para verificar a assinatura. É exibido uma única vez.

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

Excluir um endpointscope: write

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

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

Resposta: data

id string Identificador (UUID).

Elements

GET`/api/v1/elements/config`

Configuração que o Cord Elements exibeAceita pk_scope: read

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

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

Resposta: data

`object`	`"elements_config"`	Tipo de objeto: quote, invoice, client, product, task, promise…
`org`	`object`	Organização dona da chave.
`monedas`	`string[]`	Moedas que o negócio oferece nos orçamentos.
`impuestos`	`object`	Impostos do documento ou catálogo de impostos.
`terminos`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"[]`	Condições de pagamento: contado ou net<N> (N dias de prazo: 7, 15, 30, 45, 60 ou 90).
`terminos_default`	`"contado" \| "net7" \| "net15" \| "net30" \| "net45" \| "net60" \| "net90"`	Condições de pagamento padrão.
`vigencia_dias_default`	`number`	Validade padrão, em dias.
`fiscal`	`object`	Dados fiscais.

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

Itens gerados por IA em streaming (text/event-stream)Aceita pk_scope: write

Campo	Tipo	Descrição
`texto`	`string`	Texto livre do pedido.
`archivo`	`string`	JPG, PNG ou PDF, até 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"

Responde text/event-stream com os eventos item, done e error.

Modo de teste

POST`/api/v1/test_helpers/fiscal`

Forçar o resultado da próxima emissãoSomente sk_test_scope: write

Campo	Tipo	Descrição
`siguiente_resultado` obrigatório	`"exito" \| "pac_caido" \| "receptor_invalido" \| "certificado_vencido" \| "timbre_duplicado"`	Resultado da próxima emissão fiscal no ambiente de teste.

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

Resposta: data

siguiente_resultado string Resultado da próxima emissão fiscal no ambiente de teste.

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

Simular uma visualização ou o vencimentoSomente sk_test_scope: write

Campo	Tipo	Descrição
`accion` obrigatório	`"vista" \| "vencer"`	O que simular: vista (o cliente abre o link) ou vencer (o orçamento expira).

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

Resposta: data

id string Identificador (UUID).

POST`/api/v1/test_helpers/webhooks`

Disparar um webhookSomente sk_test_scope: write

Campo	Tipo	Descrição
`evento` obrigatório	`string`	Tipo de evento, por exemplo quote.approved.
`objeto_id`	`string`	ID de um orçamento ou fatura do ambiente de teste; sem ele, são usados dados de exemplo.

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

Resposta: data

`evento`	`string`	Tipo de evento, por exemplo quote.approved.
`datos`	`"real" \| "ejemplo"`	real se foram usados os dados do objeto indicado; ejemplo se foram gerados dados fictícios.

POST`/api/v1/test_helpers/listen`

Abrir uma sessão do cord listenSomente sk_test_scope: write

Campo	Tipo	Descrição
`eventos`	`string[]`	Lista de eventos ou tipos de evento. Vazia = todos.

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

Resposta: data

`id`	`string`	Identificador (UUID).
`secret`	`string`	Segredo para verificar a assinatura. É exibido uma única vez.
`eventos`	`string[]`	Lista de eventos ou tipos de evento. Vazia = todos.
`expira`	`string`	Data de expiração, ISO 8601.

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

Coletar os eventos da sessãoSomente sk_test_scope: write

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

Resposta: data

`event_id`	`string`	ID do evento; use-o para deduplicar.
`evento`	`string`	Tipo de evento, por exemplo quote.approved.
`body`	`string`	Corpo bruto do evento; encaminhe-o sem alterações para que a assinatura seja validada.
`headers`	`object`	Headers para encaminhar sem alterações, incluindo a assinatura X-Cord-Signature-V1.

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

Encerrar uma sessão do cord listenSomente sk_test_scope: write

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

Resposta: data

id string Identificador (UUID).

Configuração

POST`/api/v1/setup/plans`

Propor uma configuração da conta (uma pessoa a aprova em review_url)scope: write

Campo	Tipo	Descrição
`sitio`	`string`	Site do negócio, por exemplo seunegocio.com.
`descripcion`	`string`	Descrição do negócio: ramo de atividade, prazos de pagamento, impostos que cobra ou retém.
`archivo`	`object`	Lista de preços (Excel, CSV, PDF ou foto) em base64, até 3 MB.

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

Resposta: data

`object`	`"setup_plan"`	Tipo de objeto: quote, invoice, client, product, task, promise…
`id`	`string`	Identificador (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto aguarda a aprovação de uma pessoa em review_url.
`review_url`	`string`	Página em que uma pessoa com sessão iniciada revisa e aplica a proposta. A API nunca a aplica.

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

Status de uma proposta de configuraçãoscope: read

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

Resposta: data

`object`	`"setup_plan"`	Tipo de objeto: quote, invoice, client, product, task, promise…
`id`	`string`	Identificador (UUID).
`estado`	`"generando" \| "propuesto" \| "aplicado" \| "descartado" \| "fallido"`	propuesto aguarda a aprovação de uma pessoa em review_url.
`review_url`	`string`	Página em que uma pessoa com sessão iniciada revisa e aplica a proposta. A API nunca a aplica.

Conta

GET/api/v1/me

Orçamentos

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

Clientes

GET/api/v1/clientes

POST/api/v1/clientes

GET/api/v1/clientes/{id}

PATCH/api/v1/clientes/{id}

Produtos

GET/api/v1/productos

POST/api/v1/productos

Faturas

GET/api/v1/facturas

POST/api/v1/facturas

GET/api/v1/facturas/{id}

POST/api/v1/facturas/{id}

Cobrança

GET/api/v1/cobranza

Eventos

GET/api/v1/events

Tarefas

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

Modo de teste

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}

Configuração

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