Gastos (Categorías)
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 |
GET /api/expenses/categories.xml
Devuelve la lista de las 100 primeras categorías de gastos
curl -u 03334b0a261a2c355ae2db022a963d8e:x https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories.xml
Obtener la lista de las 100 siguientes categorías de gastos
curl -u 03334b0a261a2c355ae2db022a963d8e:x https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories.xml?start=100
Opciones de paginación de lista y límites de elementos
Por defecto la llamada devuelve los 100 primeros elementos. Para obtener la lista de más elementos o bien paginar las llamadas deben utilizarse los siguientes parámetros:
| Parámetros | Descripción |
|---|---|
| limit | Indica el número de entradas que devolverá la llamada (por defecto son 100 y se pueden listar hasta un máximo de 250 entradas en una sola llamda) |
| start | Indica la posición del primer elemento que se devolverá en la llamada (por defecto es el elemento de la posición 0) |
GET /api/expenses/categories/#{id}.xml
Obtener una categoría existente
Ejemplo para obtener una categoría de gasto con id=22
curl -u 03334b0a261a2c355ae2db022a963d8e:x https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories/22.xml
RESPUESTA SATISFACTORIA
<?xml version="1.0" encoding="UTF-8"?>
<category>
<id>22</id>
<name><![CDATA[Pedro]]></name>
</category>
RESPUESTA DE ERROR (no encontrado)
<?xml version="1.0" encoding="UTF-8"?>
<xml>
<httpStatus>404</httpStatus>
</xml>
PUT /api/expenses/categories/#{id}.xml
Modificar una categoría existente
Ejemplo para actualizar una categoría de gasto con id=22.
curl -u 03334b0a261a2c355ae2db022a963d8e:x -X PUT -H 'Accept: application/xml' -H 'Content-Type: application/xml'
-d "<?xml version='1.0' encoding='UTF-8'?>
<category>
<id>22</id>
<name><![CDATA[Consumibles UE]]></name>
</category>"
https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories/22.xml
POST /api/expenses/categories.xml
Crear un nuevo contacto
curl -u 03334b0a261a2c355ae2db022a963d8e:x -X POST -H 'Accept: application/xml' -H 'Content-Type: application/xml'
-d "<?xml version='1.0' encoding='UTF-8'?>
<category>
<name><![CDATA[Consumibles]]></name>
</category>"
https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories.xml
RESPUESTA SATISFACTORIA
<?xml version="1.0" encoding="UTF-8"?>
<contact>
<id>22</id>
<name><![CDATA[Consumibles]]></name>
</contact>
RESPUESTA DE ERROR
<?xml version="1.0" encoding="UTF-8"?> <xml> <httpStatus>400</httpStatus> <errorCode>INVALID_INPUT_DATA</errorCode> <errorMessage><![CDATA[Ya existe una categoría con el nombre indicado]]></errorMessage> </xml>
DELETE /api/expenses/categories/#{id}.xml
Eliminar una categoría existente
Ejemplo para eliminar una categoría de gasto con id=22
curl -u 03334b0a261a2c355ae2db022a963d8e:x -X DELETE https://[ACCOUNT_NAME].facturadirecta.com/api/expenses/categories/22.xml
RESPUESTA SATISFACTORIA
<?xml version="1.0" encoding="UTF-8"?>
<xml>
<httpStatus>200</httpStatus>
</xml>
RESPUESTA DE ERROR (no encontrado)
<?xml version="1.0" encoding="UTF-8"?>
<xml>
<httpStatus>404</httpStatus>
</xml>