Comandos del CLI

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_invoice_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_invoice_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_invoice_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_invoice_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear una factura (JSON por stdin o –data).

main.draft decide si nace borrador (true) o emitida (false). Emitirla le asigna número y, si la empresa tiene VeriFactu o TicketBAI activos, genera el registro de facturación y lo envía a la AEAT o a la Diputación Foral en ese momento: ya no vuelve a ser borrador y solo se puede anular, rectificar o subsanar. Si se omite, se aplica sales.newInvoiceMode de la empresa, que puede ser final: envíalo siempre.

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “payments”} Contrato completo: facturadirecta describe create_invoice

Eliminar una factura

Contrato completo: facturadirecta describe delete_invoice

Generar Facturae XML de una factura

Contrato completo: facturadirecta describe create_invoice_facturae

Obtener una factura por UUID

Contrato completo: facturadirecta describe get_invoice

Listar facturas

Contrato completo: facturadirecta describe list_invoices

Registra uno o varios cobros de la factura (JSON por stdin o –data: {“payments”: [{“bank”: “ban_…”, “amount”: …, “date”: “AAAA-MM-DD”}]}).

Si el cobro o pago corresponde a un movimiento del extracto bancario, o la cuenta está en una moneda distinta de la de la empresa y de la del documento, no lo registres aquí: concilia el movimiento con “facturadirecta statements reconcile-new –data ‘{“document”:"”}’". El movimiento queda conciliado y la API calcula la diferencia de cambio.

Cuerpo (–data o stdin): {“payments” (obligatorio), “related”} Contrato completo: facturadirecta describe create_invoice_payments

Generar PDF de una factura

Contrato completo: facturadirecta describe create_invoice_pdf

Enviar una factura por email (JSON por stdin o –data)

Cuerpo (–data o stdin): {“from”, “to”, “cc”, “bcc”, “subject”, “html”, “sendFacturae”, “continueWithoutFacturae”} Contrato completo: facturadirecta describe send_invoice

Crear factura sustitutiva (JSON por stdin o –data)

Cuerpo (–data o stdin): {“contact” (obligatorio), “substitutedInvoices” (obligatorio), “docNumber”, “date”, “notes”, “internalNotes”, “tags”} Contrato completo: facturadirecta describe create_substitution_invoice

Actualizar etiquetas de una factura (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_invoice_tags

Actualizar una factura (JSON por stdin o –data). Sustituye el contenido: parte de la lectura, cambia lo necesario y reenvía el content completo.

Pasar main.draft a false emite la factura y pasar main.voided a true la anula; con VeriFactu o TicketBAI activos, las dos operaciones generan registros que se envían a Hacienda y no se pueden revertir. Una factura ya emitida con VeriFactu solo admite cambios subsanables (verifactuOperation.subsanacion) y con TicketBAI no admite cambios en su contenido.

Cuerpo (–data o stdin): {“content” (obligatorio), “syncContactData”, “verifactuOperation”, “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_invoice

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_estimate_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_estimate_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_estimate_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_estimate_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear un presupuesto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”} Contrato completo: facturadirecta describe create_estimate

Eliminar un presupuesto

Contrato completo: facturadirecta describe delete_estimate

Obtener un presupuesto por UUID

Contrato completo: facturadirecta describe get_estimate

Listar presupuestos

Contrato completo: facturadirecta describe list_estimates

Generar PDF de un presupuesto

Contrato completo: facturadirecta describe create_estimate_pdf

Enviar un presupuesto por email (JSON por stdin o –data)

Cuerpo (–data o stdin): {“from”, “to”, “cc”, “bcc”, “subject”, “html”} Contrato completo: facturadirecta describe send_estimate

Actualizar etiquetas (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_estimate_tags

Actualizar un presupuesto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “syncContactData”, “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_estimate

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_delivery_note_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_delivery_note_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_delivery_note_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_delivery_note_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear un albarán (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”} Contrato completo: facturadirecta describe create_delivery_note

Eliminar un albarán

Contrato completo: facturadirecta describe delete_delivery_note

Obtener un albarán por UUID

Contrato completo: facturadirecta describe get_delivery_note

Listar albaranes

Contrato completo: facturadirecta describe list_delivery_notes

Generar PDF de un albarán

Contrato completo: facturadirecta describe create_delivery_note_pdf

Enviar un albarán por email (JSON por stdin o –data)

Cuerpo (–data o stdin): {“from”, “to”, “cc”, “bcc”, “subject”, “html”} Contrato completo: facturadirecta describe send_delivery_note

Actualizar etiquetas (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_delivery_note_tags

Actualizar un albarán (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “syncContactData”, “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_delivery_note

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_recurring_invoice_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_recurring_invoice_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_recurring_invoice_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_recurring_invoice_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear una factura recurrente (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”} Contrato completo: facturadirecta describe create_recurring_invoice

Eliminar una factura recurrente

Contrato completo: facturadirecta describe delete_recurring_invoice

Obtener una factura recurrente por UUID

Contrato completo: facturadirecta describe get_recurring_invoice

Listar facturas recurrentes

Contrato completo: facturadirecta describe list_recurring_invoices

Generar PDF de una factura recurrente

Contrato completo: facturadirecta describe create_recurring_invoice_pdf

Actualizar etiquetas (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_recurring_invoice_tags

Actualizar una factura recurrente (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “syncContactData”, “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_recurring_invoice

Crear un contacto (datos en JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”} Contrato completo: facturadirecta describe create_contact

Eliminar un contacto

Contrato completo: facturadirecta describe delete_contact

Obtener un contacto por UUID

Contrato completo: facturadirecta describe get_contact

Listar contactos

Contrato completo: facturadirecta describe list_contacts

Actualizar etiquetas de un contacto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_contact_tags

Actualizar un contacto (datos en JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_contact

Crear un producto (datos en JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio)} Contrato completo: facturadirecta describe create_product

Eliminar un producto

Contrato completo: facturadirecta describe delete_product

Obtener un producto por UUID

Contrato completo: facturadirecta describe get_product

Listar productos

Contrato completo: facturadirecta describe list_products

Actualizar un producto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio)} Contrato completo: facturadirecta describe update_product

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_bill_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_bill_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_bill_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_bill_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear un gasto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “fromInbox”} Contrato completo: facturadirecta describe create_bill

Eliminar un gasto

Contrato completo: facturadirecta describe delete_bill

Obtener un gasto por UUID

Contrato completo: facturadirecta describe get_bill

Listar gastos

Contrato completo: facturadirecta describe list_bills

Registra uno o varios pagos del gasto (JSON por stdin o –data: {“payments”: [{“bank”: “ban_…”, “amount”: …, “date”: “AAAA-MM-DD”}]}).

Si el cobro o pago corresponde a un movimiento del extracto bancario, o la cuenta está en una moneda distinta de la de la empresa y de la del documento, no lo registres aquí: concilia el movimiento con “facturadirecta statements reconcile-new –data ‘{“document”:"”}’". El movimiento queda conciliado y la API calcula la diferencia de cambio.

Cuerpo (–data o stdin): {“payments” (obligatorio), “related”} Contrato completo: facturadirecta describe create_bill_payments

Actualizar etiquetas de un gasto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_bill_tags

Actualizar un gasto (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_bill

Vincular uploads existentes al documento

Contrato completo: facturadirecta describe add_payroll_attachments

Eliminar un adjunto por su índice

Contrato completo: facturadirecta describe delete_payroll_attachment

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_payroll_attachments

Subir y vincular archivos locales al documento

Operaciones de la API: create_upload, commit_upload, add_payroll_attachments. Contrato de cada una: facturadirecta describe <acción>

Crear una nómina (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “payments”, “fromInbox”} Contrato completo: facturadirecta describe create_payroll

Eliminar una nómina

Contrato completo: facturadirecta describe delete_payroll

Obtener una nómina por UUID

Contrato completo: facturadirecta describe get_payroll

Listar nóminas

Contrato completo: facturadirecta describe list_payrolls

Registra uno o varios pagos de la nómina (JSON por stdin o –data: {“payments”: [{“bank”: “ban_…”, “amount”: …, “date”: “AAAA-MM-DD”}]}).

Si el cobro o pago corresponde a un movimiento del extracto bancario, o la cuenta está en una moneda distinta de la de la empresa y de la del documento, no lo registres aquí: concilia el movimiento con “facturadirecta statements reconcile-new –data ‘{“document”:"”}’". El movimiento queda conciliado y la API calcula la diferencia de cambio.

Cuerpo (–data o stdin): {“payments” (obligatorio), “related”} Contrato completo: facturadirecta describe create_payroll_payments

Actualizar etiquetas de una nómina (JSON por stdin o –data)

Cuerpo (–data o stdin): {“tags” (obligatorio), “tagsOperation” (obligatorio)} Contrato completo: facturadirecta describe update_payroll_tags

Actualizar una nómina (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio), “tags”, “tagsOperation”} Contrato completo: facturadirecta describe update_payroll

Obtiene un banco o cuenta de tesorería, con la misma forma que cada elemento del listado.

Con –related se añaden bajo related el saldo contable (balance: el de la pantalla de bancos, el que sirve para la contabilidad), el saldo según la entidad (linkedBalance: el último que informó el banco, con su fecha; informativo), el estado de la conexión automática (link, sin credenciales) y los movimientos pendientes de conciliar (statements). –related admite varios valores, repetido o separado por comas. –balance-date da el saldo contable al cierre de ese día (y pide balance por sí sola).

El id de cada banco (ban_…) está en content.uuid.

Contrato completo: facturadirecta describe get_bank

Lista los bancos y cuentas de tesorería activos de la empresa.

Con –related se añaden bajo related el saldo contable (balance: el de la pantalla de bancos, el que sirve para la contabilidad), el saldo según la entidad (linkedBalance: el último que informó el banco, con su fecha; informativo), el estado de la conexión automática (link, sin credenciales) y los movimientos pendientes de conciliar (statements). –related admite varios valores, repetido o separado por comas. –balance-date da el saldo contable al cierre de ese día (y pide balance por sí sola).

El id de cada banco (ban_…) está en content.uuid.

Contrato completo: facturadirecta describe list_banks

Crear un método de pago (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio)} Contrato completo: facturadirecta describe create_payment_method

Eliminar un método de pago

Contrato completo: facturadirecta describe delete_payment_method

Obtener un método de pago por UUID

Contrato completo: facturadirecta describe get_payment_method

Listar métodos de pago

Contrato completo: facturadirecta describe list_payment_methods

Actualizar un método de pago (JSON por stdin o –data)

Cuerpo (–data o stdin): {“content” (obligatorio)} Contrato completo: facturadirecta describe update_payment_method

Activo, patrimonio neto y pasivo a –date (por defecto, el 31 de diciembre del año en curso), con los epígrafes del Plan General Contable. –compare añade el saldo al final del periodo anterior o en la misma fecha del año anterior; –breakdown, el saldo al final de cada mes, trimestre o año desde –start-date. Si no cuadra aparece la fila ‘imbalance’ y un aviso en diagnostics.

Contrato completo: facturadirecta describe get_balance_sheet

Epígrafes del Plan General Contable con las cifras y opciones del informe de la web. –detail summary|accounts|full; –breakdown y –compare como en accounting results; –revenue-share añade el porcentaje sobre la cifra de negocios. Sin el módulo de Contabilidad la API responde que el plan no lo incluye.

Contrato completo: facturadirecta describe get_profit_loss

Ventas facturadas, compras y gastos, nóminas, amortizaciones, diferencias de cambio y otros ingresos o gastos del periodo, con los totales y el beneficio: las cifras del panel de inicio y del informe «Resumen de resultados» de la web. –breakdown reparte el periodo en meses, trimestres o años (–total añade el periodo completo); –compare añade el periodo anterior o el mismo del año anterior (–difference, –variance). Como máximo 5 años.

Contrato completo: facturadirecta describe get_results_summary

Facturas, gastos, nóminas y movimientos de una categoría del resumen en el periodo, con su tipo, fecha e importe. Con la categoría y las fechas de una columna de accounting results, la suma es la cifra de esa celda.

Contrato completo: facturadirecta describe list_results_detail

Saldo anterior, debe, haber y saldo final de cada cuenta en el periodo. –account filtra por prefijo (‘6’ = gastos, ‘430’ = clientes); –third-party con el id de un contacto, producto o banco da solo sus apuntes (–third-party-detail añade su fila bajo cada cuenta); –groups 1,3 añade subtotales. Pagina con –limit y –offset; totals son los del periodo completo.

Contrato completo: facturadirecta describe list_trial_balance

El fichero con el diseño de registro BOE del modelo guardado, el mismo que descarga el botón «Descargar fichero AEAT» de la web; se genera una vez y se reutiliza mientras el modelo no cambie. La presentación sigue haciéndose desde la Sede de la AEAT. El 390 no tiene fichero y responde 404.

Contrato completo: facturadirecta describe create_tax_declaration_aeat_file

Listar adjuntos del documento

Contrato completo: facturadirecta describe get_tax_declaration_attachments

Devuelve el modelo con sus casillas (boxes) tal como se escriben en el fichero de la AEAT: key es el número oficial de la casilla o la clave de control, title el texto del formulario y value el importe, código o texto. –related records añade, en las informativas, los registros por tercero (datos personales de terceros); –related journal, el asiento contable. El IBAN sale enmascarado salvo con el scope banks:readIban.

Contrato completo: facturadirecta describe get_tax_declaration

Lista los modelos guardados con su sobre: modelo, ejercicio, periodo, resultado (positivo a ingresar, negativo a compensar o devolver; vacío en las informativas), si tiene fichero AEAT y cuántos adjuntos. Las casillas solo salen con –related boxes (un 303 trae unas sesenta: pide pocas filas) y el asiento contable con –related journal. La fecha de un modelo es el último día de su periodo.

Contrato completo: facturadirecta describe list_tax_declarations

El PDF que imprime la web, generado una vez y reutilizado mientras el modelo no cambie. No es el fichero de presentación de la AEAT (aeat-file) ni los adjuntos del modelo (attachments list).

Contrato completo: facturadirecta describe create_tax_declaration_pdf

Datos fiscales y de contacto, moneda, idioma y zona horaria, modo borrador o definitivo de facturas y gastos, impuestos, numeración, fechas de inicio y bloqueo contable, VeriFactu y TicketBAI, remitentes de email, stock, portal de clientes, canales de entrada de la bandeja (buzón por correo y Google Drive) y módulos del plan. Cambia muy poco: consúltala al empezar a trabajar con una empresa.

inbox.email.address es el buzón de la bandeja: todo correo que llegue a esa dirección entra en la bandeja sin verificar el remitente, así que no la publiques. Es solo lectura; la configuración se cambia en la web (content.webUrl, también con –url).

Contrato completo: facturadirecta describe get_company_settings

Ver series configuradas para un tipo de documento (invoice, estimate, deliveryNote, clientOrder, purchaseOrder)

Contrato completo: facturadirecta describe get_series

Ver impuestos de compras configurados

Contrato completo: facturadirecta describe get_purchases_taxes

Ver impuestos de ventas configurados

Contrato completo: facturadirecta describe get_sales_taxes

Ver temas de diseño disponibles

Contrato completo: facturadirecta describe get_themes

Crear un endpoint (JSON por stdin o –data)

Cuerpo (–data o stdin): {“name” (obligatorio), “url” (obligatorio), “events” (obligatorio)} Contrato completo: facturadirecta describe create_public_webhook_endpoint

Eliminar un endpoint

Contrato completo: facturadirecta describe delete_public_webhook_endpoint

Desactivar un endpoint

Contrato completo: facturadirecta describe disable_public_webhook_endpoint

Activar un endpoint

Contrato completo: facturadirecta describe enable_public_webhook_endpoint

Obtener un endpoint

Contrato completo: facturadirecta describe get_public_webhook_endpoint

Listar endpoints

Contrato completo: facturadirecta describe list_public_webhook_endpoints

Rotar el secreto de un endpoint

Contrato completo: facturadirecta describe rotate_public_webhook_endpoint_secret

Actualizar un endpoint (JSON por stdin o –data)

Cuerpo (–data o stdin): {“name”, “url”, “events”} Contrato completo: facturadirecta describe update_public_webhook_endpoint

Obtener un evento

Contrato completo: facturadirecta describe get_public_webhook_event

Listar eventos

Contrato completo: facturadirecta describe list_public_webhook_events

Reintentar envío de un evento

Contrato completo: facturadirecta describe retry_public_webhook_event

Crear una API key (JSON por stdin o –data)

Cuerpo (–data o stdin): {“name” (obligatorio), “scopes” (obligatorio)} Contrato completo: facturadirecta describe create_public_api_key

Eliminar una API key

Contrato completo: facturadirecta describe delete_public_api_key

Obtener una API key por UUID

Contrato completo: facturadirecta describe get_public_api_key

Listar API keys

Contrato completo: facturadirecta describe list_public_api_keys

Obtener un extracto bancario por UUID

Contrato completo: facturadirecta describe get_statement

Listar extractos bancarios

Contrato completo: facturadirecta describe list_statements

Conciliar un extracto bancario (JSON por stdin o –data)

Cuerpo (–data o stdin): {“transactionId” (obligatorio)} Contrato completo: facturadirecta describe reconcile_statement

Crea un asiento contable y lo concilia con el movimiento del extracto en una sola llamada.

Para cobrar o pagar una factura de venta, un gasto o una nómina con este movimiento, envía solo {“document”: “”} (inv_, bil_ o par_): la API construye el asiento, también cuando el banco o el documento están en otra moneda (apunte del banco en su moneda con su contravalor, documento saldado a su tipo de cambio y diferencia de cambio en su cuenta). Añade amount (en la moneda del documento) solo para un cobro o pago parcial con documento y banco en monedas distintas. Usa lines (excluyente con document) solo para movimientos sin documento, como comisiones o traspasos. Si el cobro o pago ya está registrado, usa “statements reconcile” con su transactionId.

Cuerpo (–data o stdin): {“document”, “amount”, “lines”, “title”} Contrato completo: facturadirecta describe reconcile_statement_with_new_transaction

Desconciliar un extracto bancario

Contrato completo: facturadirecta describe unreconcile_statement

Sellar un upload presigned tras el PUT a S3

Contrato completo: facturadirecta describe commit_upload

Solicitar un slot de upload (devuelve URL presigned + uploadId)

Contrato completo: facturadirecta describe create_upload

Subir un archivo local (create + PUT S3 + commit) y mostrar el uploadId

Operaciones de la API: create_upload, commit_upload. Contrato de cada una: facturadirecta describe <acción>

Subir un archivo a la bandeja (upload + create)

Operaciones de la API: create_upload, commit_upload, create_inbox_item. Contrato de cada una: facturadirecta describe <acción>

Archivar un item de la bandeja

Contrato completo: facturadirecta describe delete_inbox_item

Obtener un item de la bandeja por UUID

Contrato completo: facturadirecta describe get_inbox_item

Listar items de la bandeja de entrada

Contrato completo: facturadirecta describe list_inbox_items

Generar propuesta de factura de compra a partir de un item de la bandeja

Contrato completo: facturadirecta describe propose_bill

Generar propuesta de nómina a partir de un item de la bandeja

Contrato completo: facturadirecta describe propose_payroll

Generar propuesta de ticket de compra a partir de un item de la bandeja

Contrato completo: facturadirecta describe propose_ticket

Ver perfil de usuario y empresas disponibles

Contrato completo: facturadirecta describe get_profile