Descripción general

Endpoint /credit-notes

Las notas crédito son documentos que el vendedor genera para indicarle al cliente que tiene un saldo a su favor, bien sea para acreditar la devolución de un valor determinado o para que la empresa pueda corregir errores en las facturas ya generadas de una manera sencilla. El saldo a favor del cliente podrá ser usado en compras posteriores.

Una remisión contiene los siguientes atributos:

Nombre

Tipo

Descripción

Ejemplo

id

Integer

Identificador único que representa una nota de crédito específica. La aplicación lo asigna automáticamente.

10

date

String. Formato yyyy-MM-dd

Fecha de la nota de crédito.

2019-09-11

dueDate

String. Formato yyyy-MM-dd

Fecha de vencimiento de la nota de crédito.

2019-10-11

observations

String

Observaciones de la nota de crédito. No visibles en el documento impreso o PDF.

Se han modificado los precios de los items de la nota de crédito.

anotation

String

Notas de la nota de crédito, visibles en el documento impreso o PDF.

La nota de crédito tiene validez por dos meses después de emitida.

termsConditions

String

Términos y condiciones aplicables a la nota de crédito. Visibles en el documento impreso o PDF.

Limite garantía de 1 año.

status

String

Estado de la nota de crédito, las opciones posibles son:

  • open : La nota de crédito esta disponible para aplica.
  • void: La nota de crédito está anulada.

open

client

Object

Objeto que contiene la información del cliente asociado a la nota de crédito.

{
"id": 1,
"name": "Coorporación Alegrate",                        "identification": "159.549.847",
"email": "[email protected]",                      "phonePrimary": "999-99-99",
"phoneSecondary": "",
"fax": "",
"mobile": "(333) 555-55-55",
"address" : {
   "address" : "Calle principal #45",
    "city" : "Barcelona"
  }
}

numberTemplate

Object

Objeto que contiene la información de la numeración de la nota de crédito. Contiene los siguientes atributos:

  • id : Identificador del numberTemplate.
  • prefix : Prefijo de la Factura.
  • number: Número de la factura.
  • documentType: Tipo de la numeración.
{
"id" : 1,
"prefix" : "A-",
"number" : 520,
"documentType" : "creditNote"
}

warehouse

Object

Objeto que contiene la información de la bodega de la nota de crédito. Contiene los siguientes atributos:

  • id: Identificador de la bodega.
  • name: Nombre de la bodega.
  • observations: Observaciones de la bodega.
  • isDefault: True, si es la bodega predeterminada.
  • address: Dirección fisica de la bodega.
  • status: Estado de la bodega.
"warehouse": {
     "id": "1",
      "name": "Principal",
      "observations": null,
      "isDefault": true,
       "address": "Carrera 1 
                         #2-40,
       "status": "active"
}

total

Double

Total de la nota de crédito. Se debe tener en cuenta que el total de la nota de crédito es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la nota de crédito.

12500.45

balance

Double

Saldo pendiente por aplicar a la nota de crédito.

12000.45

totalApplied

Double

Total aplicado a la factura.

500.00

decimalPrecision

Integer

Precisión decimal de la nota de crédito.

2

items

Array

Array de objetos Item, que contiene los productos o servicios asociados a la nota de crédito.
Cada objeto contiene los siguientes atributos:

  • id: Identificador del producto o servicio vendido.
  • name: Nombre del producto o servicio.
  • description: Descripción del producto o servicio.
  • reference: Referencia del producto o servicio
  • discount: Porcentaje de descuento aplicado al producto.
  • tax: Array de objetos tax que indican los impuestos aplicados al producto o servicio al momento de la venta.
  • price: Precio de venta del producto o servicio.
  • quantity: Cantidad vendida del producto o servicio.
  • total: Total del producto (no incluye impuestos).

En la versión de Costa Rica se puede exonerar el primer impuesto para facturación electrónica, agregando un objeto 'exoneración' dentro del objeto 'tax'. Para ver información de como se forma el objeto exoneración, clic aquí.

[
{
"id": 1,
"name": "Billetera",
"description": "Billetera de cuero negro",
"reference": "REF-005",
"discount" : 10,
"tax" : [
{
"id" : 6,
"name" : "IVA",
"percentage" : 16,
"description" : "Impuesto de valor agregado",
"type": "IVA",
"status": "active"
}
],
"price" : 80,
"quantity" : 5
},
"total" : 360

refunds

Array

Array que contiene los desembolsos realizados en la nota de crédito.

"refunds": [
{
"id": "8",
"number": "4",
"date": "2020-04-01",
"account": {
"id": "2",
"name": "Banco 1"
},
"amount": 100,
"observations": "dslkjs dlkjsdkj dsds"
}
]

invoices

Array

Array que contiene las facturas de venta asociadas a la nota de crédito.

"invoices": [
{
"id": "254",
"prefix": "Q",
"number": "253",
"date": "2020-03-30",
"dueDate": "2020-03-30",
"amount": 1000,
"total": 1000,
"balance": 0
}
]

currency

Object

Objeto que incluye la información de la moneda asociada a la nota de crédito.
Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.

Este objeto contiene:

  • code : Código ISO de la moneda asociada a la empresa.
  • exchangeRate: Tasa de cambio.
  • symbol: Simbolo de la moneda.
"currency": {
"code": "EUR",
"symbol": "€",
"exchangeRate": "300.00000000"
}
```

stamp (México)

Object

Solo para versión Alegra México.
Incluye la información del timbre de la nota de crédito.

Este objeto contiene:

  • uuid: Identificador entregado por el SAT de la factura.
  • satSeal: Sello del SAT.
  • stampDate: Fecha de timbre.
  • cfdSeal: Sello del CFDI.
  • satCertificateNumber: Número de certificado del SAT.
  • expeditionPlace: Lugar de expedición de la factura.
  • certificateNumber: Número serial del certificado utilizado para timbrar la factura.
  • datetime: Fecha y hora de generación de la factura.
  • paymentMethod: Método de pago de la factura
  • accountNumber: Número de cuenta.
{
"uuid":"FFBCDF3E-29AC-4AA6-A361-F6366240C86B",
"satSeal":"SNTfGm0gpPn6GLiDb",
"stampDate":"2016-02-02 08:58:36",
"cfdSeal":"2YRTP14R1xOewGNRIJu",
"satCertificateNumber":"20001000000100005761",
"expeditionPlace":"Ixmiquilpan, Hidalgo",
"certificateNumber":12221000000100005761,
"datetime":"2016-02-02 08:58:34",
"paymentMethod":"credit-card",
"accountNumber": "123456"
}

stamp (Perú)

Object

Solo para versión Alegra Perú.
Incluye la información de la emisión de la nota de crédito.

Este objeto contiene:

  • generateStamp: Indica si se desea emitir la factura.
  • legalStatus: Indica el estado legal ante la
    entidad reguladora
  • date: Fecha en la que se emitió la factura.
  • entityResponse: Respuesta de SUNAT
    *electronicInvoicingVersion: Versión de facturación electrónica con la que se emitió la factura.
  • barCodeContent: Contenido del código QR
{
"legalStatus": "Comprobante aceptado",
"date": "2019-06-13 17:10:41",
"entityResponse": "La Factura numero F025-00000048, ha sido aceptada ",         "electronicInvoicingVersion": "2.1",
"barCodeContent": ""
}

stamp (Costa Rica)

Object

Solo para versión Alegra Costa Rica.
Incluye la información de la emisión de la nota de crédito.

Este objeto contiene:

  • legalStatus: Indica el estado legal ante la
    entidad reguladora. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí.
  • uuid: Indica la clave del comprobante emitido.
  • date: Fecha en la que se emitió la factura.
  • entityResponse: Respuesta de Hacienda
    *electronicInvoicingVersion: Versión de facturación electrónica con la que se emitió la factura.
  • barCodeContent: Contenido del código QR
  • generateStamp: Indica si se desea emitir la factura.
{
"legalStatus":"ACCEPTED",
"uuid":"50623071900011319081300100001010000030106198617620",
"date": "2019-07-23 15:08:39",
"entityResponse": "Este comprobante fue aceptado en el ambiente de pruebas, por lo cual no tiene validez para fines tributarios\n\ncodigo, mensaje, fila, columna\n-37, \"Estimado obligado tributario los datos suministrados en provincia, cantón y distrito del 'emisor' no concuerdan con la información registrada en la Dirección General de Tributación, favor proceder actualizar sus datos.\", 0, 0\n",
"electronicInvoicingVersion": "4.3",
"barCodeContent": ""
}

stamp (Colombia)

Object

Solo para versión Alegra Colombia.

Incluye la información de la expedición de la nota de crédito.

Este objeto contiene:

  • legalStatus: Indica el estado legal ante la
    entidad reguladora. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí.
  • cufe: Indica el CUFE del comprobante emitido.
  • date: Indica la fecha de emisión del comprobante.
  • generateStamp: Indica si se desea expedir la factura.
{
 "legalStatus": "ACCEPTED",
 "cufe": "3cce4690bdfa5a7de0986438aa6c077793c6274d",
"date": "2019-10-15 15:46:35"
}

stamp (Argentina)

Object

Solo para versión Alegra Argentina.

Incluye la información de la emisión de la nota de crédito.

Este objeto contiene:

  • date: Indica la fecha de emisión del comprobante.
  • entityResponse: Respuesta AFIP.
  • cae: Código de autorización electrónico.
  • caeDueDate: Fecha de vencimiento del cae.
{
"date": "2019-11-17 19:43:12",
"entityResponse": "10017 - Factura individual, DocTipo: 80, DocNro 30111111118 no se encuentra registrado en los padrones de AFIP o se encuentra inactivo.",
"cae": "69466799098047",
"caeDueDate": "2019-11-27"
}

stamp (Chile)

Object

Solo para versión Alegra Chile.

Indica si se debe emitir la nota de crédito.

Este objeto contiene:

  • generateStamp: Indica si se debe emitir el documento.

{
"generateStamp": true
}

stamp (Panamá)

Object

Solo para versión Alegra Panamá.

Indica si se debe emitir la nota de crédito.

Este objeto contiene:

  • generateStamp: Indica si se debe emitir el documento.

{
"generateStamp": true
}

saleCondition (Argentina)

String

Solo para versión Alegra Argentina.

Indica la condición de la venta, los valores posibles son:
CASH (Efectivo), DEBIT_CARD (Tarjeta Debito, CREDIT_CARD (Tarjeta Crédito),
DEPOSIT (Depósito),
TRANSFER (Transferencia)

CASH

saleCondition (Costa Rica)

String

Solo para versión Alegra Costa Rica

Indica la condición de la nota de crédito.

CASH

saleCondition (Panamá)

String

Solo para versión Alegra Panamá.

Indica la forma de pago, los valores posibles son:
CREDIT(Crédito), CASH(Contado), CREDIT_CARD (Tarjeta Crédito),
DEBIT_CARD (Tarjeta Débito),
LOYALTY(Tarjeta de Fidelización),
VOUCHER(Vale),
GIFT_CARD(Tarjeta de Regalo), OTHER (Otra).

Si se envía OTHER se debe enviar adicionalmente otro parámetro llamado saleConditionDescription donde se indique la descripción de la otra forma de pago.

CASH

economicActivity (Costa Rica)

Integer

Solo para versión Alegra Costa Rica

Indica el código de la actividad económica asociada a la nota de crédito. Si no se envía, se asignará por defecto el código de la actividad económica de la compañía.

11218

saleConcept (Argentina)

String

Solo para versión Alegra Argentina

Indica el concepto de venta asociado a la nota de crédito. Las opciones posibles son:

PRODUCTS (Productos), SERVICES (Servicios), PRODUCTS_SERVICES (Productos y Servicios). Si se desea emitir la factura, este atributo se vuelve obligatorio.

PRODUCTS

startDateService (Argentina)

Date

Solo para versión Alegra Argentina

Indica la fecha de inicio de la nota de crédito. Si se desea emitir la nota, este atributo se vuelve obligatorio.

2018-09-09

endDateService (Argentina)

Date

Solo para versión Alegra Argentina

Indica la fecha final de la nota de crédito. Si se desea emitir la nota, este atributo se vuelve obligatorio.

2018-10-09

type (Colombia, Costa Rica, Perú y Panamá)

String

Solo para versión Alegra Colombia, Alegra Costa Rica y Alegra Perú

Tipo de la nota de crédito.

VOID_ELECTRONIC_INVOICE (Colombia, Costa Rica, Perú)

CREDIT_NOTE_FE (Panamá)

cause (Costa Rica y Perú)

String

Descripción de la razón por la cual se genera la nota de crédito.

Devolución de productos en mal estado

comments

Array

Arreglo comments con la información de cada uno de los comentarios de la nota de crédito.

{
"id": 1,
"idCompany": "2",
"idUser": "2",
"userName": "Usuario",
"comment": "mi primer comment",
"createdAt": "02/09/2020 10:01:13",
 "updatedAt": "02/09/2020 10:01:13",
"publishedAt": "02/09/2020 10:01"
}