¡Bienvenido a Actiun!

El API de Actiun es un servicio que te permite acceder a tu cuenta para conectar aplicaciones externas y tener acceso instantaneo a tu información.

Para poder tener acceso al API debes crear tu cuenta en Actiun. Crea tu cuenta aquí

En esta documentación encontraras los endpoints con los cuales podrás interacturar.

Petición

El URL base para todos los recursos es: https://api.actiun.com

Páginación

Ejemplo de llamada

curl --include "https://api.actiun.com/invoices?page=5" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Type: application/json; charset=utf-8
Etag: W/"a6cb020fadde98f283d5c30f7d483013"
Link: <http://api.actiun.com/invoices?page=1>; rel="first",
  <http://api.actiun.com/invoices?page=4>; rel="prev",
  <http://api.actiun.com/invoices?page=207>; rel="last",
  <http://api.actiun.com/invoices?page=6>; rel="next"
Per-Page: 25
Total: 5154
# ...

Todos los endpoints que sean un listado de objetos serán paginados autmaticamente. Cada página constará de 25 registros por página.

Puedes especificar que página deseas acceder utilizando el parametro de page en el URL del endpoint.

GET /clients?page=2

Si el parámetro page es omitido se entegará la primer página disponible usando el valor 1.

La información relacionada a la paginación se encuentra disponible en los headers de respuesta.

Autenticación

curl "https://api.actiun.com/clients" \
  -H "Authorization: {LLAVE_PRIVADA}"

Actiun utiliza Basic Access como método de autenticación. Todos los request que se realicen deben incluir el header Authorization.

Contactos

Los contactos representan los clientes y proveedores los cuales se encuentran asociados a tu cuenta.

Objeto Contacto

Un contacto contiene los siguientes atributos:

Atributo	Descripción
`id` integer	Identificador único que representa un contacto.
`name` string	Nombre del contacto.
`identification` string	Número de identificación utilizado para la facturación. Ej. RFC, cédula, etc.
`billing_address_email` string	El correo o correos electrónicos a donde se envian las facturas. En caso de tener varios correos deben ir separados por una coma.
`alias` string	Sobrenombre que se le desee agregar para futuras referencias de busquedar por nombre.
`bill_with_parent` boolean	Si el contacto tiene una cuenta padre, se desea facturar con la información fiscal y dirección de dicho contacto.
`bill_with_shipping` boolean	En caso de que el contacto tenga una dirección fisica y se desee utilizar la misma direccón para su facturación.
`billing_address` object	La dirección fiscal del contacto.
`shipping_address` object	La dirección física del contacto.

Consultar un Contacto

Definición

GET https://api.actiun.com/contacts/{CONTACT_ID}

Ejemplo de llamada

curl "https://api.actiun.com/contacts/1" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "contact": {
    "id": 2145,
    "name": "ACME SA DE CV",
    "identification": "ACM131115G35",
    "billing_address_email": "compras@spt.com.mx",
    "alias": "",
    "bill_with_parent": false,
    "bill_with_shipping": false,
    "parent": null,
    "billing_address": {
      "street": "MANUEL  ALVAREZ  BRAVO",
      "street_2": null,
      "outdoor_number": "902",
      "interior_number": "",
      "neighborhood": "PASEO  REAL",
      "city": "GENERAL ESCOBEDO",
      "state": "NLE",
      "country": "MX",
      "zipcode": "66072",
      "full": "MANUEL  ALVAREZ  BRAVO, 902, PASEO  REAL, C.P. 66072 GENERAL ESCOBEDO, Nuevo León, México"
    },
    "shipping_address": {
      "street": "AV CUCHARAS",
      "street_2": null,
      "outdoor_number": "100",
      "interior_number": "",
      "neighborhood": "PARQUE  IND  ESCOBEDO",
      "city": "GENERAL ESCOBEDO",
      "state": "NLE",
      "country": "MX",
      "zipcode": "66072",
      "full": "AV CUCHARAS, 100, PARQUE  IND  ESCOBEDO, C.P. 66072 GENERAL ESCOBEDO, Nuevo León, México"
    }
  }
}

Endpoint que permite consultar un contacto registrado en la aplicación.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del contacto que deseas obtener la información.

Lista de Contactos

Definición

GET https://api.actiun.com/contacts

Ejemplo de llamada

curl "https://api.actiun.com/contacts" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "contacts": [
    {
      "id": 1,
      "name": "ACME SA DE CV",
      "identification": "ACM120412I11",
      "alias" : ""
    },
    {
      "id": 2,
      "name": "ACME SA DE CV",
      "identification": "ACM120412I11",
      "alias" : ""
    }
  ]
}

Endpoint que permite consultar un listado de los contactos registrados.

Argumentos

Parámetro	Descripción
`query` string	Cadena de texto que se quiere utilizar para buscar los contactos que en el nombre contienen dicho texto.

Crear Contacto

Definición

POST https://api.actiun.com/contacts

Ejemplo de llamada

curl "https://api.actiun.com/contacts" \
  -X POST \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json" \
  -d '{ "contact": {
   "name": "Empresa Patito SA de CV",
   "identification": "ACM131115G35"
}}'

Resultado

{
  "contact": {
    "id": 50,
    "name": "Empresa Patito SA de CV",
    "identification": "ACM131115G35",
    "billing_address_email": null,
    "alias": null,
    "bill_with_parent": false,
    "bill_with_shipping": true,
    "depth": 0,
    "credit_days": 0,
    "payment_method_id": null,
    "payment_type_id": null,
    "account_number": null,
    "parent": null,
    "billing_address": null,
    "shipping_address": null
  }
}

Endpoint que permite crear un nuevo contacto.

Argumentos

Parámetro	Descripción
`name` string, requerido	Nombre del Contacto.
`identification` string, requerido	Número de identificación utilizado para la facturación. Ej. RFC, cédula, etc.
`billing_address_email` string, opcional	El correo o correos electrónicos a donde se envian las facturas. En caso de tener varios correos deben ir separados por una coma.
`alias` string, opcional	Sobrenombre que se le desee agregar para futuras referencias de busquedar por nombre.

Editar Contacto

Definición

PUT https://api.actiun.com/contacts/{CONTACT_ID}

Ejemplo de llamada

curl https://api.actiun.com/contacts/50 \
    -X PUT \
    -H "Authorization: {LLAVE_PRIVADA}" \
    -H "Content-Type: application/json" \
    -d '{ "contact": {
  "alias": "Cuack cuack",
  "billing_address_email": "macpato@millonario.com"
}}'

Resultado

{
  "contact": {
    "id": 50,
    "name": "Empresa Patito SA de CV",
    "identification": "ACM131115G35",
    "billing_address_email": "macpato@millonario.com",
    "alias": "Cuack cuack",
    "bill_with_parent": false,
    "bill_with_shipping": true,
    "depth": 0,
    "credit_days": 0,
    "payment_method_id": null,
    "payment_type_id": null,
    "account_number": null,
    "parent": null,
    "billing_address": null,
    "shipping_address": null
  }
}

Endpoint que permite editar un contacto existente.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del contacto que deseas actualizar

Eliminar Contacto

Definición

DELETE https://api.actiun.com/contacts/{CONTACT_ID}

Ejemplo de llamada

curl "https://api.actiun.com/contacts/50" \
  -X DELETE
  -H "Authorization: {LLAVE_PRIVADA}"

Endpoint que te permite borrar un contacto. Si el cliente cuenta con información relacionada como facturas de ventas, facturas de gastos u otro documento, este no será eliminado en su totalidad solo será marcado como eliminado (soft delete) y no aparecerá en las busquedás principales.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del contacto que deseas eliminar

Productos o Servicios

Los productos o servicios representan lo que tu negocios vende y/o compra.

Se considera a los productos como algo que puede ser tangible y que tienes disponible a la venta. Además que este puede tener un inventario disponible en tu negocio. Todos los productos debener tener una unidad de medida como (piezas, centimetros, litros, metros, etc.), una cantidad incial de productos disponbles (en caso que desees llevar un control del inventairo del producto) y el costo unitario.

Por otro lado los servicios contiene casi la misma información pero no se controla el inventario.

Objeto Producto o Servicio

Un producto o servicio contiene los siguientes atributos:

Atributo	Descripción
`id` integer	Identificador único que representa un producto o servicio.
`name` string	Nombre del producto o servicio.
`description` string	Descripción del producto o servicio.
`price` decimal	El precio producto o servicio.
`units` string	La unidad de medida relacionada al producto o servicio.
`sku` string	Código único que consiste en letras y números que identifican características de cada producto, como su fabricación, marca, estilo, color y talla.
`inventory` object	La información relacionada al inventario del producto.
`taxes` array	La información de los impuestos relacionados del producto o servicio.
`product_key` object	Indica la clave del producto o servicio basada en el catálogo del SAT de productos o servicios.
`unit_key` object	Indica la clave de unidad de medida del producto o servicio basada en el catálogo del SAT de medidas.

Consultar un Producto o Servicio

Definición

GET https://api.actiun.com/items/{ITEM_ID}

Ejemplo de llamada

curl "https://api.actiun.com/items/1" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "item": {
    "id": 1,
    "name": "Bolígrafo de Punta Fina",
    "description": "Bolígrafo de Punta Fina Color Rojo Marca Patito",
    "price": 10.0,
    "units": "Pieza",
    "sku": "",
    "discount": null,
    "inventory": {},
    "taxes": [
      {
        "id": 1,
        "percentage": 16,
        "name": "IVA",
        "description": null,
        "category": "federal"
      }
    ],
    "product_key": {
      "id": 26865,
      "name": "Bolígrafos",
      "value": "44121701"
    },
    "unit_key": {
      "id": 1730,
      "name": "Pieza",
      "value": "H87"
    }
  }
}

Endpoint que permite consultar un producto o servicio registrado.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del producto o servicio que deseas obtener la información.

Lista de Productos o Servicios

Definición

GET https://api.actiun.com/items

Ejemplo de llamada

curl "https://api.actiun.com/items" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "items": [
    {
      "id": 1,
      "name": "Bolígrafo de Punta Fina",
      "description": "Bolígrafo de Punta Fina Color Rojo Marca Patito",
      "price": 10.0,
      "units": "Pieza",
      "sku": "",
      "discount": null,
      "inventory": {},
      "taxes": [
        {
          "id": 1,
          "percentage": 16,
          "name": "IVA",
          "description": null,
          "category": "federal"
        }
      ],
      "product_key": {
        "id": 26865,
        "name": "Bolígrafos",
        "value": "44121701"
      },
      "unit_key": {
        "id": 1730,
        "name": "Pieza",
        "value": "H87"
      }
    }
  ]
}

Endpoint que permite consultar un listado de los contactos registrados.

Argumentos

Parámetro	Descripción
`query` string	Cadena de texto que se quiere utilizar para buscar los productos o servicios que en el nombre o descripción contienen dicho texto

Crear Producto o Servicio

Definición

POST https://api.actiun.com/items

Ejemplo de llamada básica

curl "https://api.actiun.com/items" \
  -X POST \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json" \
  -d '{ "item": {
   "name": "Lápiz No. 2",
   "price": 8.50,
   "product_key_code": "44121706",
   "unit_key_code": "H87"
  }}'

Resultado

{
  "items": {
    "id": 50,
    "name": "Lápiz No. 2",
    "description": null,
    "price": 8.5,
    "units": "Pieza",
    "sku": null,
    "discount": null,
    "inventory": {},
    "taxes": [],
    "images": [],
    "product_key": {
      "id": 26870,
      "name": "Lápices de madera",
      "value": "44121706"
    },
    "unit_key": {
      "id": 1730,
      "name": "Pieza",
      "value": "H87"
    }
  }
}

Endpoint que permite crear un nuevo contacto.

Argumentos

Parámetro	Descripción
name string, requerido	Nombre del producto o servicio.
descripton string, opcional	descripción del producto o servicio.
price decimal, requerido	El precio de venta del producto o servicio.
units string, requerido	La unidad de medida relacionada al producto o servicio.
sku string, opcional	Código único que consiste en letras y números que identifican características de cada producto, como su fabricación, marca, estilo, color y talla.
product_key_code string, requerido	Representa el número de la clave de producto o ClaveProdServ que se encuentra en el catálogo del SAT.
unit_key_code string, requerido	Representa el número de la clave de las unidades de producto o ClaveUnidad que se encuentra en el catálogo del SAT.

Editar Producto o Servicio

Definición

PUT https://api.actiun.com/items/{ITEM_ID}

Ejemplo de llamada

curl https://api.actiun.com/items/50 \
    -X PUT \
    -H "Authorization: {LLAVE_PRIVADA}" \
    -H "Content-Type: application/json" \
    -d '{ "item": {
  "description": "Lapiz de Madera",
  "price": 9.5"
}}'

Resultado

{
  "item": {
    "id": 50,
    "name": "Lápiz No. 2",
    "description": "Lapiz No.3 de Madera",
    "price": 10,
    "units": "Pieza",
    "sku": null,
    "discount": null,
    "inventory": {},
    "taxes": [],
    "product_key": {
      "id": 26870,
      "name": "Lápices de madera",
      "value": "44121706"
    },
    "unit_key": {
      "id": 1730,
      "name": "Pieza",
      "value": "H87"
    }
  }
}

Endpoint que permite editar un contacto existente.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del producto o servicio que deseas actualizar
`name` string, requerido	Nombre del producto o servicio.
`descripton` string, opcional	descripción del producto o servicio.
`price` decimal, requerido	El precio de venta del producto o servicio.
`units` string, requerido	La unidad de medida relacionada al producto o servicio.
`sku` string, opcional	Código único que consiste en letras y números que identifican características de cada producto, como su fabricación, marca, estilo, color y talla.
`product_key_code` string, requerido	Representa el número de la clave de producto o ClaveProdServ que se encuentra en el catálogo del SAT.
`unit_key_code` string, requerido	Representa el número de la clave de las unidades de producto o ClaveUnidad que se encuentra en el catálogo del SAT.

Eliminar Producto o Servicio

Definición

DELETE https://api.actiun.com/items/{ITEM_ID}

Ejemplo de llamada

curl "https://api.actiun.com/items/50" \
  -X DELETE
  -H "Authorization: {LLAVE_PRIVADA}"

Resultado (204 No Content)

Endpoint que te permite borrar un producto o servicio que este relacionada a la empresa.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador del producto o servicio que deseas eliminar.

Facturas de Venta

Los facturas de venta son los documentos representan las ventas de tu empresa. Las facturas deben estar asociadas a un contacto y deben tener al menos un producto o servicio a facturar.

La factura de venta puede tener solo un estatus a la vez, y los significados son los siguientes:

drafted - La factura de venta todavía se encuentra en proceso de confirmación.
stamping - La factura de venta se esta siendo enviada al SAT para timbrarse.
opened - La factura de venta ya fue timbrada, y esta pendiente de ser pagada por su cliente.
sent - La factura de venta ya fue timbrada, y esta fue enviada a su cliente. Esto sucede automáticamente al enviar la factura por correo electrónico.
viewed - La factura de venta ya fue timbrada, fue enviada a tu cliente por correo electrónico y este descargo los archivos del PDF, XML o visito la página de la información de la factura.
paid - La factura de venta fue marcada como pagada para llevar el registro de que dicho ingreso ya fue efectivamente cobrado.
partial - La factura de venta fue marcada como pagada para llevar el registro de que dicho ingreso ya fue parcialmente cobrado y todavía hay un saldo pendiente.
voided - La factura de venta fue cancelada y se envia la solicitud de cancelación al SAT.

Objeto Factura de Venta

Un Factura de Venta contiene los siguientes atributos:

Atributo		Descripción
`id` integer		Identificador único que representa una factura de venta.
`date` date		Fecha de la factura.
`due_at` date		Fecha de vencimiento de la factura. Que se calcula utilizando la opción due_offset_days.
`client` object		Objeto que contiene la información del cliente asociado a la factura.
`status` string		Estado de la factura de venta. Los posibles estatus son los siguientes: `drafted`, `stamping`, `opened`, `sent`, `viewed`, `paid`, `partial` y `voided`.
`kind` string		Representa si el documento es un ingreso o egreso.
`prefix` string		Es la serie que se esta utilizando en la factura de venta.
`number` string		Es el número consecutivo que se esta utilizando en la factura de venta.
`description` string		Notas de la factura, visibles en el documento impreso o PDF.
`total` decimal		El total de la factura.
`total_paid` decimal		El saldo pendinte por pagar de la factura.
`cfdi_use` object		Datos sobre el uso que le dará al cliente al CFDI de la factura de venta.
`payment_method` string		Indica el método de pago de la factura.
`account_number` string		Indica el número de cuenta o tarjeta de pago. Debe tener mínimo 4 caracteres.
`currency` object		Objeto que contiene la información de la moneda asociada a la factura. El objecto contiene lo siguiente: currency: Identificador de la divisa basado en el ISO 4217 que se utilizo para generar la factura. symbol: Simboló de la divisa utilizada en la factura.. exchange_rate: Tipo de cambio que se utilizo para la factura.
`line_items` array		Array de las lineas de captura de la factua de venta. Cada linea esta asociada a un producto o servicio previamente registrado en Actiun. Cada objeto contiene los siguientes atributos: id: Identificador de la línea de captura. name: Nombre del producto o servicio. description: Descripción del producto o servicio. price: Precio de venta del producto o servicio. quantity: Cantidad vendida del producto o servicio. discount: Porcentaje de descuento aplicado al producto. subtotal: Subtotal de la línea de captura (no incluye impuestos). taxes: Array de objetos taxes que indican los impuestos aplicados al producto o servicio al momento de la venta. retentions: Array de objetos retentions que indican las retenciones aplicados al producto o servicio al momento de la venta.
`attachments` array		Array de los archivos adjuntos que tenga la factura de venta. Cada objeto contiene los siguientes atributos: type: Tipo de formato del documento. download_url: La página para descargar el documento.
`stamp` object		Objeto que contiene la información del timbre fiscal de la factura. El objecto contiene lo siguiente: sat_uuid: Identificador entregado por el SAT de la factura. sat_certificate_number: Número de certificado del SAT. sat_stamp: Sello del SAT. cfd_stamp: Sello del CFDI. stamped_date: La fecha del timbre en el SAT.

Consultar un Factura de Venta

Definición

GET https://api.actiun.com/invoices/{INVOICE_ID}

Ejemplo de llamada

curl "https://api.actiun.com/invoices/150" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "invoice": {
    "id": 74740,
    "status": "opened",
    "prefix": "A",
    "kind": "income",
    "number": "13804",
    "subtotal": 100,
    "total": 116,
    "payment_method": "Por definir",
    "account_number": null,
    "currency": {
      "code": "USD",
      "symbol": "$",
      "exchange_rate": 18.6574
    },
    "created_at": "2018-03-09T16:09:48.314-06:00",
    "updated_at": "2018-03-09T16:37:48.043-06:00",
    "attachments": [
      {
        "type": "Pdf",
        "download_url": "http://app.actiun.test/documents/pdf/f898dc15-06a1-4d83-9c9a-c8a127993ff3"
      },
      {
        "type": "Xml",
        "download_url": "http://app.actiun.test/documents/xml/f898dc15-06a1-4d83-9c9a-c8a127993ff3"
      }
    ],
    "description": null,
    "line_items": [
      {
        "id": 166707,
        "name": "Servicios de organización de transportes",
        "description": "WEIGHT SCALING / PESAJE",
        "price": 100,
        "quantity": 1,
        "discount": 0,
        "subtotal": 100,
        "units": "Actividad",
        "item_id": 2251,
        "taxes": [
          {
            "id": 2,
            "percentage": 0,
            "name": "IVA",
            "description": null,
            "category": "federal"
          }
        ],
        "retentions": []
      }
    ],
    "stamp": {
      "sat_uuid": "90E59622-FCCC-4838-A792-5916AB8C81AB",
      "sat_certificate_number": "00001000000403442064",
      "sat_stamp": "gFaKe9/eqDTbSZ8jXLnKsRz3A0s4emWDptsBH5Ut64OiH8yGB+uvMUibqT2vJt1acAYTfLrCILDGfWnbOMoXyULYm00ocIRcfif8i8XS36aW69u/LXY0ZJbjw5WMtbBTlkMssIYNGFuwJo7rfljhbSTB0AkVAnRetAgKz0fseiJBY4+C2M0wbsniziVL7+FUaqL3whetP54GZ+1s1p3pBQnIp/l2/ctKx+Xv5mSif4/g45Nxg/vSLPjYeKIAJspctc8KHgSLLx6vxV+a9DRaO4yAyVaaMxQIGJnF8FyocU8TPi3HryHuLtrOdyyoxNaKdRjzhb7n0jx5YCUihMNMng==",
      "cfd_stamp": "IDLGVswAH7M2MmiTU1KIl2G4KjWZXkfb6U86TZ68z5x/pksDBOpk0OqW+iDFHMbbrGgqwmlPS97JDi5vCqogNLM1GELaY02O3HeOd6N76SA/FKAPHAprZJnbXaL3vCcIN0oIqvWszfyQ9L5vKSqHu9RtVkdZ1b6j+9PuQ7EWs8S8xrtdSI1+shwzyEFaVmU3atW2Ub9/Ltx6sqG3odpaDM9BycmmO2IRR8VH8xoi2BW9M5MHLvXIo1ouxx9KrNmggUjvVzQlwWXRfJYZrfs3GvXYNKSHxP91Qx6t4OlhQfhmCPFbwhE/A3t7C55xRqo237lab2TNizrOOPW0ZZPdBg==",
      "stamped_date": "2018-03-09T16:37:46.000-06:00"
    },
    "client": {
      "id": 10819,
      "name": "ACME SA DE CV",
      "identification": "XEXX010101000",
      "billing_address_email": "facturacion@acme.com",
      "alias": null,
      "bill_with_parent": false,
      "bill_with_shipping": true,
      "depth": 0
    },
    "cfdi_use": {
      "name": "Gastos en general",
      "value": "G03"
    }
  }
}

Endpoint que permite consultar una factura de venta registrada.

Argumentos

Parámetro	Descripción
`id` requerido	El identificador de la factura de venta que deseas obtener la información.

Lista de Facturas de Venta

Definición

GET https://api.actiun.com/invoices

Ejemplo de llamada

curl "https://api.actiun.com/invoices" \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Content-Type: application/json"

Resultado

{
  "invoices": [
    {
      "id": 74787,
      "status": "opened",
      "prefix": "A",
      "number": 1300,
      "date": "2018-03-12",
      "due_at": "2018-03-12",
      "due_offset_days": "0",
      "kind": "income",
      "subtotal": 4500,
      "total": 5220,
      "payment_method": "Transferencia electrónica",
      "account_number": "4036",
      "currency": {
        "code": "MXN",
        "symbol": "$",
        "exchange_rate": 1
      },
      "created_at": "2018-03-14T14:19:47.218-06:00",
      "updated_at": "2018-03-14T14:19:53.544-06:00",
      "attachments": [
        {
          "type": "Pdf",
          "download_url": "http://app.actiun.test/documents/pdf/ff70b672-7b93-4295-adb8-77f94c68a529"
        },
        {
          "type": "Xml",
          "download_url": "http://app.actiun.test/documents/xml/ff70b672-7b93-4295-adb8-77f94c68a529"
        }
      ],
      "description": null,
      "line_items": [
        {
          "id": 166822,
          "name": "Horas de Desarrollo de Página Web",
          "description": "Desarrollo personalziado de páina web www.acme.com.mx",
          "price": 450,
          "quantity": 10,
          "discount": 0,
          "subtotal": 4500,
          "units": "Horas",
          "item_id": 2300,
          "taxes": [
            {
              "id": 1,
              "percentage": 16,
              "name": "IVA",
              "description": null,
              "category": "federal"
            }
          ],
          "retentions": []
        }
      ],
      "stamp": {
        "sat_uuid": "90E59622-FCCC-4838-A792-5916AB8C81AB",
        "sat_certificate_number": "00001000000403442064",
        "sat_stamp": "gFaKe9/eqDTbSZ8jXLnKsRz3A0s4emWDptsBH5Ut64OiH8yGB+uvMUibqT2vJt1acAYTfLrCILDGfWnbOMoXyULYm00ocIRcfif8i8XS36aW69u/LXY0ZJbjw5WMtbBTlkMssIYNGFuwJo7rfljhbSTB0AkVAnRetAgKz0fseiJBY4+C2M0wbsniziVL7+FUaqL3whetP54GZ+1s1p3pBQnIp/l2/ctKx+Xv5mSif4/g45Nxg/vSLPjYeKIAJspctc8KHgSLLx6vxV+a9DRaO4yAyVaaMxQIGJnF8FyocU8TPi3HryHuLtrOdyyoxNaKdRjzhb7n0jx5YCUihMNMng==",
        "cfd_stamp": "IDLGVswAH7M2MmiTU1KIl2G4KjWZXkfb6U86TZ68z5x/pksDBOpk0OqW+iDFHMbbrGgqwmlPS97JDi5vCqogNLM1GELaY02O3HeOd6N76SA/FKAPHAprZJnbXaL3vCcIN0oIqvWszfyQ9L5vKSqHu9RtVkdZ1b6j+9PuQ7EWs8S8xrtdSI1+shwzyEFaVmU3atW2Ub9/Ltx6sqG3odpaDM9BycmmO2IRR8VH8xoi2BW9M5MHLvXIo1ouxx9KrNmggUjvVzQlwWXRfJYZrfs3GvXYNKSHxP91Qx6t4OlhQfhmCPFbwhE/A3t7C55xRqo237lab2TNizrOOPW0ZZPdBg==",
        "stamped_date": "2018-03-10T18:30:00.000-06:00"
      },
      "client": {
          "id": 10819,
          "name": "ACME SA DE CV",
          "identification": "XEXX010101000",
          "billing_address_email": "facturacion@acme.com",
          "alias": null,
          "bill_with_parent": false,
          "bill_with_shipping": true,
          "depth": 0
      },
      "cfdi_use": {
          "name": "Gastos en general",
          "value": "G03"
      }
    },
   {...},
   {...}
  ]
}

Endpoint que permite consultar un listado de los contactos registrados.

Argumentos

Parámetro	Descripción
`order_direction` string	Orden ascendente o descendente en el cual se quieren retornar las facturas. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
`order_field` string	Campo por el cual se desea ordenar las facturas, las opciones posibles son id, date, due_at, status, created_at.

Crear Factura de Venta

Definición

POST https://api.actiun.com/invoices

Ejemplo de llamada básica

curl "https://api.actiun.com/invoices" \
  -X POST \
  -H "Authorization: {LLAVE_PRIVADA}" \
  -H "Cache-Control: no-cache" \
  -H "Content-Type: application/json" \
  -H "Postman-Token: 5e2c8505-26ce-4b1a-bb59-2cc58154bee1" \
  -d '{ "invoice": {
    "date": "2018-03-12",
    "due_offset_days": "30",
    "client_id": 10819,
    "payment_method_code": "wire-transfer",
    "cfdi_use_code": "G03",
    "line_items": [
        {"item_id": 1400, "price": 2200, "quantity": 1, "taxes": [{"tax_id": 1}] }
    ]
}}'

Resultado

{
  "invoice": {
    "id": 74787,
    "status": "opened",
    "prefix": "A",
    "number": 13814,
    "date": "2018-03-12",
    "due_at": "2018-04-11",
    "due_offset_days": "30",
    "kind": "income",
    "subtotal": 2200,
    "total": 2552,
    "payment_method": "Tarjeta de crédito",
    "account_number": "8101",
    "currency": {
      "code": "MXN",
      "symbol": "$",
      "exchange_rate": 1
    },
    "created_at": "2018-03-14T14:19:47.218-06:00",
    "updated_at": "2018-03-14T14:19:53.544-06:00",
    "attachments": [
      {
        "type": "Pdf",
        "download_url": "http://app.actiun.test/documents/pdf/ff70b672-7b93-4295-adb8-77f94c68a529"
      },
      {
        "type": "Xml",
        "download_url": "http://app.actiun.test/documents/xml/ff70b672-7b93-4295-adb8-77f94c68a529"
      }
    ],
    "description": null,
    "line_items": [
      {
        "id": 166822,
        "name": "Memoria Ram",
        "description": "RAM de 1600mhz modelo DDR3",
        "price": 2200,
        "quantity": 1,
        "discount": 0,
        "subtotal": 2200,
        "units": "Pieza",
        "item_id": 1400,
        "taxes": [
          {
            "id": 1,
            "percentage": 16,
            "name": "IVA",
            "description": null,
            "category": "federal"
          }
        ],
        "retentions": []
      }
    ],
    "stamp": {
      "sat_uuid": "90E59622-FCCC-4838-A792-5916AB8C81AB",
      "sat_certificate_number": "00001000000403442064",
      "sat_stamp": "gFaKe9/eqDTbSZ8jXLnKsRz3A0s4emWDptsBH5Ut64OiH8yGB+uvMUibqT2vJt1acAYTfLrCILDGfWnbOMoXyULYm00ocIRcfif8i8XS36aW69u/LXY0ZJbjw5WMtbBTlkMssIYNGFuwJo7rfljhbSTB0AkVAnRetAgKz0fseiJBY4+C2M0wbsniziVL7+FUaqL3whetP54GZ+1s1p3pBQnIp/l2/ctKx+Xv5mSif4/g45Nxg/vSLPjYeKIAJspctc8KHgSLLx6vxV+a9DRaO4yAyVaaMxQIGJnF8FyocU8TPi3HryHuLtrOdyyoxNaKdRjzhb7n0jx5YCUihMNMng==",
      "cfd_stamp": "IDLGVswAH7M2MmiTU1KIl2G4KjWZXkfb6U86TZ68z5x/pksDBOpk0OqW+iDFHMbbrGgqwmlPS97JDi5vCqogNLM1GELaY02O3HeOd6N76SA/FKAPHAprZJnbXaL3vCcIN0oIqvWszfyQ9L5vKSqHu9RtVkdZ1b6j+9PuQ7EWs8S8xrtdSI1+shwzyEFaVmU3atW2Ub9/Ltx6sqG3odpaDM9BycmmO2IRR8VH8xoi2BW9M5MHLvXIo1ouxx9KrNmggUjvVzQlwWXRfJYZrfs3GvXYNKSHxP91Qx6t4OlhQfhmCPFbwhE/A3t7C55xRqo237lab2TNizrOOPW0ZZPdBg==",
      "stamped_date": "2018-03-10T18:30:00.000-06:00"
    },
    "client": {
        "id": 10819,
        "name": "ACME SA DE CV",
        "identification": "XEXX010101000",
        "billing_address_email": "facturacion@acme.com",
        "alias": null,
        "bill_with_parent": false,
        "bill_with_shipping": true,
        "depth": 0
    },
    "cfdi_use": {
        "name": "Gastos en general",
        "value": "G03"
    }
  }
}

Endpoint que permite crear una nueva factura.

Argumentos

Parámetro	Descripción
`client_id` integer, requerido	El identificador del contacto que al cuál se le desea asociar la factura.
`date` date, opcional	Representa la fecha a la factura. Se debe utilizar el formato YYYY-MM-DD. En caso de no especificar se utilizará el día en curso.
`due_offset_days`	string
`currency_code` string, opcional	Representa el tipo de divisa a utilizar en la factura. El valor por defecto es `MXN`. Se deben utilizar los identificadores de divisa según el ISO 4217.
`exchange_rate`	decimal
`type_code` string, opcional	Representa el tipo de factura que se desea emitir. El valor por defecto es `FACT`. Utiliza los siguientes valores: `FACT` - Factura, `ARR` - Recibo de arrendamiento, `DON` - Recibo de donativos, `HON` - Recibo de honorarios.
`payment_method_code` string, requerido	Representa el valor del método de pago de la factura. Lo posibles valores son `wire-transfer` - Transferencia electrónica de fondos, `cash` - Efectivo, `check` - Cheque, `credit-card` - Tarjeta de crédito, `debit-card` - Tarjeta de débito, `electronic-wallet` - Monedero electrónico, `electronic-money` - Dinero Electrónico, `grocery-voucher` - Vales de Despensa, `service-card` - Tarjeta de Servicio, `other` - Por definir, `novation` - Novación, `confusion` - Confusión, `debt-remission` - Remisión de deuda, `prescription-or-expiration` - Prescripción o caducidad y `creditor` - A satisfacción del acreedor. Si el payment_type es `PPD` solo admite el paymentMethod `other` - Por Definir.
`payment_type_code` string, opcional	Representa el método de pago de la factura. Admite los valores `PUE` para Pago en Una sola Exhibición y `PPD` para Pago en Parcialidades o Diferido. El valor por defecto es `PUE`.

Errores

Código de Error	Significado
400	Bad Request -- El request está mal formado. La información para crear el recurso no existe o es inválida.
401	Unauthorized -- Credenciales no válidas.
404	Not Found -- El objeto que buscas no existe.
405	Method Not Allowed -- Operación no permitida. Ocurre cuando el método del request es inválido para el endpoint requerido.
429	Too Many Requests -- Has hecho muchas peticiones por lo que debes bajar el intervalo de solicitudes.
500	Internal Server Error -- Ocurrió un error en la aplicación.
503	Service Unavailable -- La applicación se encuentra en mantenimiento.