v1

latestOpenAPI 3.0.32026-07-24398641.3 MB

Pagos

Crear un nuevo pago

Este endpoint permite registrar un nuevo pago en la aplicación

post/payments

Request body

datestring yyyy-mm-dd required

Fecha de pago. Formato yyyy-MM-dd.

Método de pago

observationsstring

Observaciones del pago. No son visibles en el documento impreso.

anotationstring

Notas del pago. Visibles en el documento impreso.

type'in' | 'out'

Indica si la transaccion es de ingreso o egreso. Las opciones posibles son 'in' si el pago es un ingreso o 'out' si es un egreso. Este atributo es obligatorio cuando el pago se realiza a una categoría.

commentsstring[]

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

Example request

{
  "date": "2019-02-12",
  "bankAccount": {
    "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/bankAccount/example"
  },
  "paymentMethod": "cash",
  "observations": "Este pago se realizo en persona",
  "anotation": "Pago sujeto a XYZ",
  "client": {
    "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/client/example"
  },
  "invoices": [
    {
      "id": 1,
      "amount": 10,
      "retentions": [
        {
          "id": 1,
          "name": "Retención del IVA",
          "percentage": 20,
          "amount": 20,
          "currency": {
            "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/currency/example"
          }
        }
      ]
    }
  ],
  "bills": [
    {
      "id": 1,
      "amount": 10,
      "retentions": [
        {
          "id": 1,
          "name": "Retención del IVA",
          "percentage": 20,
          "amount": 20,
          "currency": {
            "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/currency/example"
          }
        }
      ]
    }
  ],
  "categories": [
    {
      "id": 5008,
      "tax": {
        "id": 6
      },
      "quantity": 10
    }
  ],
  "retentions": [
    {
      "id": 1,
      "amount": 20
    }
  ],
  "currency": {
    "$ref": "#/paths/~1payments/post/responses/201/content/application~1json/schema/properties/currency/example"
  },
  "costCenter": 1,
  "comments": [
    "Este es un comentario"
  ]
}

Response

Se obtiene un objeto que describe un pago

idinteger

Identificador único que representa un pago. La aplicación lo asigna automáticamente.

numberstring

Número del recibo de caja o comprobante de egreso.

datestring yyyy-mm-dd

Fecha de pago. Formato yyyy-MM-dd.

Método de pago

observationsstring

Observaciones del pago. No son visibles en el documento impreso.

anotationstring

Notas del pago. Visibles en el documento impreso.

typestring

Indica si el pago es de ingreso o egreso.

status'open' | 'void'

Estado del pago, las opciones posibles son: open - Estado normal del pago & void - El pago se encuentra anulado.

amountnumber

Valor total asociado en el pago

bankAccountAmountnumber

Valor total que ingresó a la cuenta de banco asociada. Solo se incluye este parámetro en pagos que tengan la misma moneda principal de la compañía pero que la cuenta de banco tiene una moneda diferente. Este valor se da en la moneda configurada en la cuenta de banco.

voucherNumber (Colombia)string

Indica el número del recibo de caja, valido solo para operaciones de tipo IN.Solo para Colombia

Example response

{
  "id": 12,
  "bankAccount": {
    "id": "1",
    "name": "Bancolombia",
    "type": "bank"
  },
  "date": "2015-12-10",
  "paymentMethod": "transfer",
  "observations": "Observaciones del pago",
  "anotation": "Notas de mi pago",
  "type": "in",
  "status": "open",
  "client": {
    "id": "20",
    "name": "Juan Carlos",
    "phone": "310-58-58"
  },
  "amount": 7500.85,
  "bankAccountAmount": 230.6,
  "invoices": [
    {
      "id": "6",
      "number": "AL-12",
      "date": "2015-12-01",
      "total": "150",
      "amount": "100"
    }
  ],
  "bills": [
    {
      "id": "6",
      "number": "COMPRA-12",
      "date": "2016-02-01",
      "total": "9000",
      "amount": "8500"
    }
  ],
  "categories": [
    {
      "id": 6,
      "name": "Papelería",
      "quantity": 10,
      "observations": "Resma papel tamaño carta",
      "price": 15,
      "tax": [
        {
          "id": 6,
          "name": "IVA",
          "percentage": 16,
          "description": "Impuesto de valor agregado"
        }
      ],
      "total": 150
    }
  ],
  "retentions": [
    {
      "id": 1,
      "name": "Compras",
      "percentage": 3.5,
      "amount": 21.315
    }
  ],
  "currency": {
    "code": "USD",
    "symbol": "$",
    "exchangeRate": 2950
  },
  "appliedAdvances": [
    {
      "id": "234",
      "number": "234",
      "date": "2019-11-21",
      "dueDate": "2019-11- 21",
      "total": 1110,
      "totalPaid": 40,
      "balance": 1070,
      "amount": 40
    }
  ],
  "costCenter": {
    "id": "2",
    "code": "CC01",
    "name": "Centro de costo ventas general",
    "description": "Ingresos y gastos de ventas generales",
    "status": "active"
  },
  "voucherNumber (Colombia)": "AB123456",
  "comments": [
    {
      "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"
    }
  ]
}