Formatos soportados

json

Errores

Code Description Metadata
401 Unauthorized
:status: status
:message: error_message
404 Not Found
:status: status
:message: error_message
500 Server crashed
:status: status
:message: error_message

Ejemplos

    === Respuesta del servidor cuando la factura se lográ timbrar, status: 200
{
  id: 17,
  invoice_status: {
        "id"=>2,
        "name"=>"Timbrada"
  },
  paid_status: "false",
  message: "La factura fue timbrada exitósamente"
  xml: "xml string",
  pdf_file: "pdf base 64"
}
    === Respuesta del servidor cuando la factura no se lográ timbrar, status: 200
{
  id: 16,
  invoice_status: {
        "id"=>1,
        "name"=>"Pendiente"
  },
  action_recommended: 1
  paid_status: "false",
  message: "No se logró timbrar la factura",
  error: "Ocurrió un problema, intente nuevamente en unos minutos. Contacte al administrador si persiste el problema"
}

Parámetros

Nombre del parámetro Descripción
id
requerido

id de la factura

Validations:

  • Must be a number.

invoice_status
requerido

Estatus de la factura

Validations:

  • Must be one of: Timbrada, No timbrada, Cancelada.

paid_status
requerido

Índica si la factura esta cobrada o no

Validations:

  • Must be one of: true, false.

name
requerido

Nombre del objeto (Cliente, Sucursal, Empresa)

Validations:

  • Must be String

address_attributes
opcional

Objeto que representa la direccion de una Sucursal)

Validations:

  • Must be Object

serie
requerido

Letra de serie para las facturas o las sucursales

Validations:

  • Must be String

folio
requerido

Número de folio para las facturas o las sucursales

Validations:

  • Must be a number.

xml
opcional

XML con la informacion de la factura

Validations:

  • Must be String

pdf_file
opcional

PDF con la información de la factura (base64)

Validations:

  • Must be String

message
requerido

Mensaje general que devuelve el servidor

Validations:

  • Must be String

error
opcional

Errores especificos

Validations:

  • Must be String