{"_id":"56b264a89621f20d00efb335","project":"56abd2434e4b730d009eb10a","category":{"_id":"56abd4c8f25f160d00e17f81","pages":["56abd52535138c0d005c94cb","56abd70e0b9e0b0d006162a9","56b0b7da36d2580d002477d3","56b0bff78f7a4f0d0029dd38","56b0cbcbce5f410d0056c9c6","56b0dfa64b05c50d001ceaba","56b10d3f6d004b170080666c","56b10e196d004b170080666f","56b1110d02f4bc0d006ce29d","56b11ab7f48f270d00e0dd69","56b2081d1bc8490d00701f0c","56b20ae3a5a1020d00cf4c49","56b20eb17ae4550d0006291e","56b21ae8f48f270d00e0de9e","56b224cd2d9646170059921a","56b230d065ddf50d0076ba4d","56b231653b6f690d00bdb6e4","56b238bd3b6f690d00bdb6f2","56b238f62db51f0d0044e4b6","56b239539621f20d00efb2af","56b24b2565ddf50d0076ba82","56b24bd9f48f270d00e0df0e","56b24c703b6f690d00bdb702","56b24e322d96461700599266","56b24e9f9621f20d00efb304","56b2579e9621f20d00efb319","56b2611f65ddf50d0076bab3","56b262379621f20d00efb331","56b264a89621f20d00efb335","56b2683494ab060d00067427","56b2687ba5a1020d00cf4cda","56b269c2a5a1020d00cf4cdf"],"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":32,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-29T21:08:24.369Z","from_sync":false,"order":9,"slug":"api","title":"Pagos"},"editedParams":true,"editedParams2":true,"__v":3,"parentDoc":null,"user":"56abd213d4432d1900eed227","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":20,"createdAt":"2016-01-29T20:57:39.712Z","releaseDate":"2016-01-29T20:57:39.712Z","categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":["5727737cba4cfe0e001a2b83","59e4b661334cf10026e3b14e"],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T20:35:52.676Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"json","code":"{\n  \"date\": \"2015-12-13\",\n  \"invoices\" : [\n    {\n      \"id\" : 6,\n      \"amount\" : 150\n    },\n    {\n      \"id\" :200,\n      \"amount\" : 500\n    }\n    ],\n  \"bankAccount\" : 1\n  }","name":"Pago a factura simple"},{"name":"Pago a factura completo","language":"json","code":"{\n  \"date\": \"2015-12-13\",\n  \"paymentMethod\": \"transfer\",\n  \"observations\": \"Observaciones del pago\",\n  \"anotation\": \"\",\n  \"client\": {\n    \"id\" : \"20\"\n    },\n  \"invoices\" : [\n    {\n      \"id\" : 6,\n      \"amount\" : 150,\n      \"retentions\" : [\n        {\n          \"id\" : 2,\n          \"amount\" : 50,\n          }\n        ]\n      }\n    ],\n  \"bankAccount\" : {\n    \"id\": 1\n    },\n  \"currency\" : {\n    \"code\" : \"USD\",\n    \"exchangeRate\" : 3200\n    }\n  }"},{"name":"Ingreso por cateogría","language":"json","code":"{\n  \"date\": \"2015-12-15\",\n  \"paymentMethod\": \"transfer\",\n  \"observations\": \"Pago papelería diciembre\",\n  \"anotation\": \"Notas del pago\",\n  \"client\" : 400,\n  \"type\" : \"in\",\n  \"bankAccount\" :1,\n   \"categories\" : [\n     {\n       \"id\" : 6,\n       \"quantity\" : 10,\n       \"observations\" : \"Resma papel tamaño carta\",\n       \"price\" : 15,\n       \"tax\" : [\n         {\n           \"id\" : 2\n         }\n        ]\n    } \n  ]\n}"}]},"method":"post","results":{"codes":[{"name":"Creación exitosa","status":201,"language":"json","code":"{\n  \"id\" : 1,\n  \"date\": \"2015-12-10\",\n  \"paymentMethod\": \"cash\",\n  \"observations\": \"Observaciones del pago\",\n  \"anotation\": \"Notas de mi pago\",\n  \"client\": {\n     \"id\" : \"20\",\n      \"name\" : \"Juan Carlos\",\n      \"phone\" : \"310-58-58\"\n  },\n  \"invoices\" : [\n    {\n        \"id\" : 6,\n        \"number\" : \"AL-12\",\n        \"date\" : \"2015-12-01\",\n        \"total\" : 150,\n        \"totalPaid\" :  100,\n        \"balance\": 50\n        },\n    {\n      \"id\" :200,\n      \"number\" : \"AL-17\",\n      \"date\" : \"2016-01-15\",\n      \"total\" : 100,\n      \"totalPaid\" :  30,\n      \"balance\": 70\n      }\n    ],\n  \"bankAccount\" : {\n    \"id\" : 2,\n    \"name\" : \"Bancolombia\",\n    \"type\" : \"bank\"\n    },\n  \"currency\" : {\n    \"code\" : \"USD\",\n    \"symbol\" : \"$\",\n    \"exchangeRate\" : 3200\n    }\n}"},{"code":"{ \n\t\"error\": \"La información para crear el modelo no existe o es inválida\",\n  \"code\" : 400\n}","name":"","status":400,"language":"json"},{"code":"{\n  \"id\" : 2,\n  \"date\": \"2015-12-15\",\n  \"paymentMethod\": \"transfer\",\n  \"observations\": \"Pago papelería diciembre\",\n  \"anotation\": \"\",\n  \"client\" : null,\n  \"type\" : \"in\",\n  \"bankAccount\" :{\n    \"id\" : 1,\n    \"name\" : \"Caja mejor\",\n    \"type\" : \"cash\"\n    },\n  \"categories\" : [\n    {\n      \"id\" : 6,\n      \"name\" : \"Papelería\",\n      \"quantity\" : 10,\n      \"observations\" : \"Resma papel tamaño carta\",\n      \"price\" : 15,\n      \"tax\" : [\n        {\n          \"id\" : 2,\n          \"name\" : \"IVA\",\n          \"description\" : \"Impuesto de valor agregado\",\n          \"percentage\" : 16,\n          \"status\" : \"active\"\n          }\n        ]\n      } \n    ]\n}","language":"json","status":201,"name":"Creación exitosa - Pago categoría"}]},"auth":"required","params":[{"_id":"56b0cbcbce5f410d0056c9c7","ref":"","in":"body","required":true,"desc":"Fecha de pago. Formato yyyy-MM-dd.","default":"","type":"yyyy-mm-dd","name":"date"},{"_id":"56b0cd936d004b17008065cf","ref":"","in":"body","required":true,"desc":"Objeto cuenta de banco que indica a dónde debe ingresar o de dónde debe salir el dinero para el pago. Este objeto debe contener el id del banco.","default":"","type":"mixed","name":"bankAccount"},{"_id":"56b0cd936d004b17008065ce","ref":"","in":"body","required":false,"desc":"Método de pago, las opciones posibles son: transfer, cash, deposit, check, credit-card, debit-card. Longitud máxima permitida: 15.","default":"","type":"string","name":"paymentMethod"},{"_id":"56b0cd936d004b17008065cd","ref":"","in":"body","required":false,"desc":"Observaciones del pago. No son visibles en el documento impreso. Longitud máxima permitida: 500.","default":"","type":"string","name":"observations"},{"_id":"56b0cd936d004b17008065cc","ref":"","in":"body","required":false,"desc":"Notas del pago. Visibles en el documento impreso. Longitud máxima permitida: 500.","default":"","type":"string","name":"anotation"},{"_id":"56b11166135ec20d00bafa04","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"string","name":"type"},{"_id":"56b0cd936d004b17008065cb","ref":"","in":"body","required":false,"desc":"Indica el cliente asociado al pago. Si el pago se realiza a facturas de compra o venta, todas las facturas deben pertenecer al mismo cliente. El objeto debe incluir el id del cliente que realiza o al cual se le realiza el pago.","default":"","type":"mixed","name":"client"},{"_id":"56b0cd936d004b17008065ca","ref":"","in":"body","required":false,"desc":"Array de objetos factura de venta que indica la(s) factura(s) de venta que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la factura a pagar; `amount (double, obligatorio)` : valor pagado; `retentions (array)` : array de objetos retención que indica las retenciones aplicadas en el pago de la factura.","default":"","type":"object","name":"invoices"},{"_id":"56b11233f48f270d00e0dd5d","ref":"","in":"body","required":false,"desc":"Array de objetos factura de compra que indica la(s) factura(s) de compra que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la factura a pagar; `amount (double, obligatorio)` : valor pagado; `retentions (array)` : array de objetos retención que indica las retenciones aplicadas en el pago de la factura de compra.","default":"","type":"object","name":"bills"},{"_id":"56b11233f48f270d00e0dd5c","ref":"","in":"body","required":false,"desc":"Array de objetos categoría que indica la(s) categoría(s) que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la categoría; `tax (objeto)` : objeto tax que indica el impuesto asociado; `quantity (double, obligatorio)`: cantidad de la categoría; `price (double, obligatorio)`: precio unitario pagado; `observations (string)`: observaciones de la categoría.","default":"","type":"object","name":"categories"},{"_id":"56b11233f48f270d00e0dd5b","ref":"","in":"body","required":false,"desc":"Array de objetos retención que indica las retenciones aplicadas en el pago, este atributo se envía únicamente cuando el pago está asociado a categorías y se realizaron retenciones. Cada objeto debe contener:  `id (number, obligatorio)`: Identificador de la retención que se desea asociar a la factura; `amount (double, obligatorio)`: valor retenido.","default":"","type":"object","name":"retentions"},{"_id":"56b11233f48f270d00e0dd5a","ref":"","in":"body","required":false,"desc":"Objeto que indica la moneda del pago y la tasa de cambio, se debe incluir si la empresa tiene activa la funcionalidad de multimoneda y si el pago se realiza en una moneda diferente a la principal de la empresa. Se debe tener en cuenta que solo se pueden pagar facturas de venta y de compra que tengan la misma moneda de la transacción.","default":"","type":"object","name":"currency"}],"url":"/payments"},"isReference":true,"order":3,"body":"","excerpt":"","slug":"crear-pago","type":"endpoint","title":"Crear pago"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

date:
required
yyyy-mm-dd
Fecha de pago. Formato yyyy-MM-dd.
bankAccount:
required
mixed
Objeto cuenta de banco que indica a dónde debe ingresar o de dónde debe salir el dinero para el pago. Este objeto debe contener el id del banco.
paymentMethod:
string
Método de pago, las opciones posibles son: transfer, cash, deposit, check, credit-card, debit-card. Longitud máxima permitida: 15.
observations:
string
Observaciones del pago. No son visibles en el documento impreso. Longitud máxima permitida: 500.
anotation:
string
Notas del pago. Visibles en el documento impreso. Longitud máxima permitida: 500.
type:
string
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.
client:
mixed
Indica el cliente asociado al pago. Si el pago se realiza a facturas de compra o venta, todas las facturas deben pertenecer al mismo cliente. El objeto debe incluir el id del cliente que realiza o al cual se le realiza el pago.
invoices:
object
Array de objetos factura de venta que indica la(s) factura(s) de venta que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la factura a pagar; `amount (double, obligatorio)` : valor pagado; `retentions (array)` : array de objetos retención que indica las retenciones aplicadas en el pago de la factura.
bills:
object
Array de objetos factura de compra que indica la(s) factura(s) de compra que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la factura a pagar; `amount (double, obligatorio)` : valor pagado; `retentions (array)` : array de objetos retención que indica las retenciones aplicadas en el pago de la factura de compra.
categories:
object
Array de objetos categoría que indica la(s) categoría(s) que se pagaron. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la categoría; `tax (objeto)` : objeto tax que indica el impuesto asociado; `quantity (double, obligatorio)`: cantidad de la categoría; `price (double, obligatorio)`: precio unitario pagado; `observations (string)`: observaciones de la categoría.
retentions:
object
Array de objetos retención que indica las retenciones aplicadas en el pago, este atributo se envía únicamente cuando el pago está asociado a categorías y se realizaron retenciones. Cada objeto debe contener: `id (number, obligatorio)`: Identificador de la retención que se desea asociar a la factura; `amount (double, obligatorio)`: valor retenido.
currency:
object
Objeto que indica la moneda del pago y la tasa de cambio, se debe incluir si la empresa tiene activa la funcionalidad de multimoneda y si el pago se realiza en una moneda diferente a la principal de la empresa. Se debe tener en cuenta que solo se pueden pagar facturas de venta y de compra que tengan la misma moneda de la transacción.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}