REST API Estándar v1.0 Resumen de llamadas
La API estándar puede ser utilizada por cualquier cuenta de FacturaDirecta aplicándose en cada caso las restricciones según capacidades del plan contrato y permisos del usuario que accede a la API.
Facturas - /api/invoices
Conjunto de llamadas que permiten realizar acciones sobre las facturas de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/invoices.xml | Devuelve un listado de facturas permitiendo el filtrado por múltiples atributos |
| GET /api/invoices/#{id}.xml | Devuelve una factura con identificador #{id} |
| GET /api/invoices/#{id}.facturae | Devuelve una factura con identificador #{id} en formato FACTURAE |
| GET /api/invoices/#{id}.pdf | Devuelve una factura con identificador #{id} en formato PDF |
| PUT /api/invoices/#{id}.xml | Modifica los datos de una factura existente identificada por el identificador #{id} |
| POST /api/invoices.xml | Permite crear una nueva factura |
| DELETE /api/invoices/#{id}.xml | Elimina una factura existente identificada por el identificador #{id} |
| POST /api/invoices/send/#{id}.xml | Envía por email la factura con identificador #{id} al cliente |
| PUT /api/invoices.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear una nueva factura |
Vencimientos de facturas - /api/invoicePayments
Conjunto de llamadas que permiten realizar acciones sobre los vencimientos de las facturas emitidas desde una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/invoicePayments/#{id}.xml | Devuelve información de un vencimiento identificado por el identificador #{id} |
| PUT /api/invoicePayments/#{id}.xml | Modifica los datos de un vencimiento identificador por el identificador #{id} |
Clients - /api/clients
Conjunto de llamadas que permiten realizar acciones sobre los clientes de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/clients.xml | Devuelve un listado de clientes permitiendo el filtrado por múltiples atributos del clientes |
| GET /api/clients/#{id}.xml | Devuelve información de un cliente existente identificado por el identificador #{id} |
| POST /api/clients.xml | Permite crear un nuevo cliente |
| PUT /api/clients/#{id}.xml | Modifica los datos de un cliente existente identificado por el identificador #{id} |
| DELETE /api/clients/#{id}.xml | Elimina un cliente existente identificado por el identificador #{id} |
| PUT /api/clients.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo cliente |
Contactos de cliente - /api/clients/contacts
Conjunto de llamadas que permiten realizar acciones sobre los contactos asociados a los clientes.
| Recurso | Descripción |
|---|---|
| GET /api/clients/contacts.xml | Devuelve un listado de contactos de clientes |
| GET /api/clients/contacts/#{id}.xml | Devuelve información de un contacto existente identificado por el identificador #{id} |
| POST /api/clients/contacts.xml | Permite crear un nuevo contacto de cliente |
| PUT /api/clients/contacts/#{id}.xml | Modifica los datos de un contacto de cliente identificado por el identificador #{id} |
| DELETE /api/clients/contacts/#{id}.xml | Elimina un contacto de cliente identificado por el identificador #{id} |
| PUT /api/clients/contacts.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo contacto de cliente |
Facturas periódicas/recurrentes - /api/recurringInvoices
Conjunto de llamadas que permiten realizar acciones sobre las facturas periódicas de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/recurringInvoices.xml | Devuelve un listado de facturas periódicas permitiendo el filtrado por múltiples atributos |
| GET /api/recurringInvoices/#{id}.xml | Devuelve información de una factura periódica existente identificada por el identificador #{id} |
| PUT /api/recurringInvoices/#{id}.xml | Modifica los datos de una factura periódica existente identificada por el identificador #{id} |
| POST /api/recurringInvoices.xml | Permite crear una nueva factura periódica |
| DELETE /api/recurringInvoices/#{id}.xml | Elimina una factura periódica existente identificada por el identificador #{id} |
| PUT /api/recurringInvoices.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear una nueva factura periódica |
Gastos - /api/expenses
Conjunto de llamadas que permiten realizar acciones sobre los gastos de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/expenses.xml | Devuelve un listado de gastos |
| GET /api/expenses/#{id}.xml | Devuelve información de un gasto existente identificado por el identificador #{id} |
| PUT /api/expenses/#{id}.xml | Modifica los datos de un gasto existente identificado por el identificador #{id} |
| POST /api/expenses.xml | Permite crear un nuevo gasto |
| DELETE /api/expenses/#{id}.xml | Elimina un gasto existente identificado por el identificador #{id} |
| PUT /api/expenses.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo gasto |
Gastos (Categorías) - /api/expenses/categories
Conjunto de llamadas que permiten realizar acciones sobre las categorías de gastos de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/expenses/categories.xml | Devuelve un listado de categorías de proveedor |
| GET /api/expenses/categories/#{id}.xml | Devuelve información de una categoría de gasto existente identificado por el identificador #{id} |
| PUT /api/expenses/categories/#{id}.xml | Modifica los datos de una categoría de gasto existente identificado por el identificador #{id} |
| POST /api/expenses/categories.xml | Permite crear una nueva categoría de gasto |
| DELETE /api/expenses/categories/#{id}.xml | Elimina una categoría de gasto existente identificado por el identificador #{id} |
| PUT /api/expenses/categories.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear una nueva categoría de gasto |
Presupuestos - /api/estimates
Conjunto de llamadas que permiten realizar acciones sobre los presupuestos de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/estimates.xml | Devuelve un listado de presupuestos permitiendo el filtrado por múltiples atributos |
| GET /api/estimates/#{id}.xml | Devuelve un presupuesto con identificador #{id} |
| GET /api/estimates/#{id}.pdf | Devuelve un presupuesto con identificador #{id} en formato PDF |
| PUT /api/estimates/#{id}.xml | Modifica los datos de un presupuesto existente identificado por el identificador #{id} |
| POST /api/estimates.xml | Permite crear un nuevo presupuesto |
| DELETE /api/estimates/#{id}.xml | Elimina un presupuesto existente identificado por el identificador #{id} |
| GET /api/estimates/send/#{id}.xml | Envía por email la presupuesto con identificador #{id} al cliente |
| PUT /api/estimates.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo presupuesto |
Proveedores - /api/providers
Conjunto de llamadas que permiten realizar acciones sobre los proveedores de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/providers.xml | Devuelve un listado de proveedores permitiendo el filtrado por múltiples atributos |
| GET /api/providers/#{id}.xml | Devuelve información de un proveedor existente identificado por el identificador #{id} |
| PUT /api/providers/#{id}.xml | Modifica los datos de un proveedor existente identificado por el identificador #{id} |
| POST /api/providers.xml | Permite crear un nuevo proveedor |
| DELETE /api/providers/#{id}.xml | Elimina un proveedor existente identificado por el identificador #{id} |
| PUT /api/providers.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo proveedor |
Proveedores (contactos) - /api/providers/contacts
Conjunto de llamadas que permiten realizar acciones sobre los contactos de proveedores de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/providers/contacts.xml | Devuelve un listado de contactos de proveedor |
| GET /api/providers/contacts/#{id}.xml | Devuelve información de un contacto de proveedor existente identificado por el identificador #{id} |
| PUT /api/providers/contacts/#{id}.xml | Modifica los datos de un contacto de proveedor existente identificado por el identificador #{id} |
| POST /api/providers/contacts.xml | Permite crear un nuevo contacto de proveedor |
| DELETE /api/providers/contacts/#{id}.xml | Elimina un contacto de proveedor existente identificado por el identificador #{id} |
| PUT /api/providers/contacts.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo contacto de proveedor |
Productos - /api/products
Conjunto de llamadas que permiten realizar acciones sobre los productos de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/products.xml | Devuelve un listado de productos permitiendo el filtrado por múltiples atributos |
| GET /api/products/#{id}.xml | Devuelve información de un producto existente identificado por el identificador #{id} |
| PUT /api/products/#{id}.xml | Modifica los datos de un producto existente identificado por el identificador #{id} |
| POST /api/products.xml | Permite crear un nuevo producto |
| DELETE /api/products/#{id}.xml | Elimina un producto existente identificado por el identificador #{id} |
| PUT /api/products.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo producto |
Albaranes/Notas de entrega - /api/deliveryNotes
Conjunto de llamadas que permiten realizar acciones sobre los albaranes/notas de entrega de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/deliveryNotes.xml | Devuelve un listado de albaranes permitiendo el filtrado por múltiples atributos |
| GET /api/deliveryNotes/#{id}.xml | Devuelve un albarán con identificador #{id} |
| GET /api/deliveryNotes/#{id}.pdf | Devuelve un albarán con identificador #{id} en formato PDF |
| PUT /api/deliveryNotes/#{id}.xml | Modifica los datos de un albarán existente identificado por el identificador #{id} |
| POST /api/deliveryNotes.xml | Permite crear un nuevo albarán |
| DELETE /api/deliveryNotes/#{id}.xml | Elimina un albarán existente identificado por el identificador #{id} |
| GET /api/deliveryNotes/send/#{id}.xml | Envía por email el albarán con identificador #{id} al cliente |
| PUT /api/deliveryNotes.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo albarán |
Pedidos de cliente - /api/clientOrders
Conjunto de llamadas que permiten realizar acciones sobre los pedidos de cliente de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/clientOrders.xml | Devuelve un listado de pedidos de cliente permitiendo el filtrado por múltiples atributos |
| GET /api/clientOrders/#{id}.xml | Devuelve un pedido de cliente con identificador #{id} |
| GET /api/clientOrders/#{id}.pdf | Devuelve un pedido de cliente con identificador #{id} en formato PDF |
| PUT /api/clientOrders/#{id}.xml | Modifica los datos de un pedido de cliente existente identificado por el identificador #{id} |
| POST /api/clientOrders.xml | Permite crear un nuevo pedido de cliente |
| DELETE /api/clientOrders/#{id}.xml | Elimina un pedido de cliente existente identificado por el identificador #{id} |
| GET /api/clientOrders/send/#{id}.xml | Envía por email el pedido de cliente con identificador #{id} al cliente |
| PUT /api/clientOrders.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear un nuevo pedido de cliente |
Órdenes de compra - /api/purchaseOrders
Conjunto de llamadas que permiten realizar acciones sobre las órdenes de compra de una cuenta de FacturaDirecta.
| Recurso | Descripción |
|---|---|
| GET /api/purchaseOrders.xml | Devuelve un listado de órdenes de compra permitiendo el filtrado por múltiples atributos |
| GET /api/purchaseOrders/#{id}.xml | Devuelve una orden de compra con identificador #{id} |
| GET /api/purchaseOrders/#{id}.pdf | Devuelve una orden de compra con identificador #{id} en formato PDF |
| PUT /api/purchaseOrders/#{id}.xml | Modifica los datos de una orden de compra existente identificado por el identificador #{id} |
| POST /api/purchaseOrders.xml | Permite crear una nueva orden de compra |
| DELETE /api/purchaseOrders/#{id}.xml | Elimina una orden de compra existente identificada por el identificador #{id} |
| GET /api/purchaseOrders/send/#{id}.xml | Envía por email la orden de compra con identificador #{id} al cliente |
| PUT /api/purchaseOrders.xml | Devuelve una plantilla de la estructura en xml para poder utilizarla para crear una nueva orden de compra |