{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/payments/:id","auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"id","type":"int","default":"","desc":"Identificador del pago que se desea editar. Se debe enviar en la URL","required":true,"in":"path","ref":"","_id":"57758f79ece8a00e00a15b34"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de pago. Formato yyyy-MM-dd.","required":false,"in":"body","ref":"","_id":"56b0cbcbce5f410d0056c9c7"},{"name":"bankAccount","type":"mixed","default":"","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.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065cf"},{"name":"paymentMethod","type":"string","default":"","desc":"Método de pago, las opciones posibles son: transfer, cash, deposit, check, credit-card, debit-card. Longitud máxima permitida: 15.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065ce"},{"name":"paymentMethod","type":"string","default":"","desc":"Para México. Las opciones posibles son: `cash` Efectivo, `debit-card` Tarjeta de débito, `credit-card` Tarjeta de crédito, `service-card` Tarjeta de servicios, `transfer` Transferencia electrónica de fondos, `check` Cheque nominativo, `electronic-wallet` Monedero electrónico, `electronic-money` Dinero electrónico, `grocery-voucher` Vale de despensa, `dation-payment` Dación en pago, `subrogation-payment` Pago por subrogación, `allocation-payment` Pago por consignación, `forgiveness` Condonación, `compensation` Compensación, `novation` Novación, `misunderstanding` Confusión, `debt-remission` Remisión de deuda, `prescription-or-expiration` Prescripción o caducidad, `creditor-satisfaction` A satisfacción del acreedor.","required":true,"in":"body","ref":"","_id":"5e1d2d43d8016c00674b49e9"},{"name":"observations","type":"string","default":"","desc":"Observaciones del pago. No son visibles en el documento impreso. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065cd"},{"name":"anotation","type":"string","default":"","desc":"Notas del pago. Visibles en el documento impreso. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065cc"},{"name":"client","type":"mixed","default":"","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.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065cb"},{"name":"invoices","type":"object","default":"","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.","required":false,"in":"body","ref":"","_id":"56b0cd936d004b17008065ca"},{"name":"bills","type":"object","default":"","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.","required":false,"in":"body","ref":"","_id":"56b11233f48f270d00e0dd5d"},{"name":"categories","type":"object","default":"","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.","required":false,"in":"body","ref":"","_id":"56b11233f48f270d00e0dd5c"},{"name":"retentions","type":"object","default":"","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.","required":false,"in":"body","ref":"","_id":"56b11233f48f270d00e0dd5b"},{"name":"currency","type":"object","default":"","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.","required":false,"in":"body","ref":"","_id":"56b11233f48f270d00e0dd5a"},{"name":"costCenter","type":"mixed","default":"","desc":"Objeto que indica el id del centro de costo asociado. Se puede enviar directamente el id del centro de costo en este atributo o enviarlo como objeto.","required":false,"in":"body","ref":"","_id":"5ea9d4aa5401f70042483f3f"}],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Editar pago","type":"endpoint","slug":"editar-pago","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.\"\n}\n[/block]\nPor ejemplo para editar la fecha de creación de un pago se debe enviar el siguiente JSON:\n\n```\n{\n\"date\" : \"2016-02-27\"\n}```\n\nPara eliminar algún dato del pago enviar el atributo en null, así:\n```\n{\n\"observations\" : null\n}```\n\nSe retorna el pago que se ha modificado.\n\nSe debe tener en cuenta que el tipo del pago no puede se modificado, es decir, un pago tipo in, no puede editarse a tipo out.","updates":[],"order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57758f79ece8a00e00a15b33","editedParams2":true,"__v":3,"category":{"sync":{"isSync":false,"url":""},"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"],"title":"Pagos","slug":"api","order":9,"from_sync":false,"reference":true,"_id":"56abd4c8f25f160d00e17f81","createdAt":"2016-01-29T21:08:24.369Z","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":32},"createdAt":"2016-06-30T21:30:33.918Z","githubsync":"","parentDoc":null,"project":"56abd2434e4b730d009eb10a","editedParams":true,"user":"56abd213d4432d1900eed227","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":39,"createdAt":"2016-01-29T20:57:39.712Z"}}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Identificador del pago que se desea editar. Se debe enviar en la URL

Body Params

date:
yyyy-mm-dd
Fecha de pago. Formato yyyy-MM-dd.
bankAccount:
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.
paymentMethod:
required
string
Para México. Las opciones posibles son: `cash` Efectivo, `debit-card` Tarjeta de débito, `credit-card` Tarjeta de crédito, `service-card` Tarjeta de servicios, `transfer` Transferencia electrónica de fondos, `check` Cheque nominativo, `electronic-wallet` Monedero electrónico, `electronic-money` Dinero electrónico, `grocery-voucher` Vale de despensa, `dation-payment` Dación en pago, `subrogation-payment` Pago por subrogación, `allocation-payment` Pago por consignación, `forgiveness` Condonación, `compensation` Compensación, `novation` Novación, `misunderstanding` Confusión, `debt-remission` Remisión de deuda, `prescription-or-expiration` Prescripción o caducidad, `creditor-satisfaction` A satisfacción del acreedor.
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.
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.
costCenter:
mixed
Objeto que indica el id del centro de costo asociado. Se puede enviar directamente el id del centro de costo en este atributo o enviarlo como objeto.

Documentation

[block:callout] { "type": "warning", "title": "Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos." } [/block] Por ejemplo para editar la fecha de creación de un pago se debe enviar el siguiente JSON: ``` { "date" : "2016-02-27" }``` Para eliminar algún dato del pago enviar el atributo en null, así: ``` { "observations" : null }``` Se retorna el pago que se ha modificado. Se debe tener en cuenta que el tipo del pago no puede se modificado, es decir, un pago tipo in, no puede editarse a tipo out.

User Information

Try It Out

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