v1

latestOpenAPI 3.0.32026-07-24398641.3 MB

Notas de débito

Crear una nota de débito

Este endpoint permite registrar una nueva nota de débito en la aplicación

post/debit-notes

Request body

datestring date required

Fecha de la nota de débito.

numberstring

Número del folio la nota débito. Es obligatorio para las siguientes versiones: Chile, Colombia, Costa Rica, España, México, Panamá, Perú, USA, Internacional.

prefixstring

Prefijo del folio de la nota débito

observationsstring

Observaciones de la nota de débito.

termsConditionsstring

Términos y condiciones de la nota de débito.

commentsstring[]

Arreglo de strings con cada uno de los comentarios que se desean asociar.

Example request

{
  "date": "2019-02-12",
  "number": "9001",
  "prefix": "20191202",
  "observations": "Estas son las observaciones de la nota de débito.",
  "termsConditions": "Limite garantía de 1 año",
  "warehouse": 1,
  "items": [
    {
      "id": 1,
      "tax": [
        {
          "id": 6,
          "name": "IVA",
          "percentage": 16,
          "description": "Impuesto de valor agregado",
          "type": "IVA",
          "status": "active"
        }
      ]
    }
  ],
  "categories": [
    {
      "id": 1,
      "tax": [
        {
          "id": 6,
          "name": "IVA",
          "percentage": 16,
          "description": "Impuesto de valor agregado",
          "type": "IVA",
          "status": "active"
        }
      ]
    }
  ],
  "refunds": [
    {
      "date": "2019-02-12",
      "account": 1,
      "amount": 20,
      "observations": "Esta devolución se realizo en persona"
    }
  ],
  "bills": [
    {
      "id": "21",
      "amount": 20
    }
  ],
  "currency": {
    "code": "USD",
    "exchangeRate": 2950
  },
  "costCenter": 1,
  "comments": [
    "Este es un comentario"
  ]
}

Response

Se obtiene un objeto que describe una nota de débito

idnumber

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

datestring yyyy-mm-dd

Fecha de la nota débito

observationsstring

Observaciones de la nota débito. No visibles en el documento impreso o PDF.

termsConditionsstring

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

clientobject

Objeto que contiene la información del cliente asociado a la nota débito.

totalnumber

Total de la nota débito. Se debe tener en cuenta que el total de la nota débito es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la nota débito y conforma la suma de los items y categorías asociados a la nota débito.

balancenumber

Saldo pendiente por aplicar a la nota débito. Es la resta del total menos el totalApplied.

totalAppliednumber

Total aplicado a la nota débito. Esta conformado por la sumatoria de todos los reembolsos y facturas de proveedor asociados a la nota débito.

decimalPrecisionnumber

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

Example response

{
  "id": 10,
  "date": "2019-09-11",
  "observations": "Se han modificado los precios de los items de la nota de crédito.",
  "termsConditions": "Limite garantía de 1 año.",
  "numberTemplate": {
    "id": "1223",
    "prefix": "ND123",
    "number": "456",
    "documentType": "debitNote"
  },
  "warehouse": {
    "id": 1,
    "name": "Bodega 1"
  },
  "total": 12500.45,
  "balance": 12000.45,
  "totalApplied": 500,
  "decimalPrecision": 2,
  "items": [
    {
      "id": 1,
      "name": "Billetera",
      "discount": 20,
      "description": "Billetera de cuero negro",
      "tax": [
        {
          "id": 6,
          "name": "IVA",
          "percentage": 16,
          "description": "Impuesto de valor agregado",
          "type": "IVA",
          "status": "active"
        }
      ]
    }
  ],
  "categories": [
    {
      "id": 1,
      "name": "Servicios y Honorarios Profesionales",
      "discount": 20,
      "observations": "Servicio de limpieza y mantenimiento de equipos de computo",
      "tax": [
        {
          "id": 6,
          "name": "IVA",
          "percentage": 16,
          "description": "Impuesto de valor agregado",
          "type": "IVA",
          "status": "active"
        }
      ]
    }
  ],
  "refunds": [
    {
      "id": 1,
      "number": "121",
      "amount": 4000,
      "date": "2019-09-11",
      "bankAccount": {
        "id": 1,
        "name": "Caja general",
        "type": "cash"
      },
      "observations": "Observacion acerca del  reembolso",
      "anotation": "Anotación acerca del  reembolso",
      "type": "in",
      "paymentMethod": "transfer",
      "currency": {
        "code": "USD",
        "symbol": "$",
        "exchangeRate": 2950
      }
    }
  ],
  "bills": [
    {
      "id": 1,
      "prefix": "FP12",
      "number": "13",
      "date": "2019-02-12",
      "dueDate": "2019-02-12",
      "observations": "Estas son las observaciones de mi factura.",
      "termsConditions": "Limite garantía de 1 año",
      "status": "open",
      "total": 12500.45,
      "balance": 12000.45,
      "amount": 2000
    }
  ],
  "currency": {
    "code": "USD",
    "symbol": "$",
    "exchangeRate": 2950
  }
}