PUT v1/Payments

Update a Payments.

Request Information

URI Parameters

None.

Body Parameters

Collection of Payment

Name	Description	Type	Additional information
Id	The unique Cin7 payment Id.	integer	None.
CreatedDate	Created Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
ModifiedDate	Modified Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
PaymentDate	Payment Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
Amount	Payment Amount	decimal number	None.
Method	Payment Method	string	None.
IsAuthorized	Transaction Authorized	boolean	None.
TransactionRef	Transaction reference e.g. payment gateway transaction Id or ref	string	Max length: 50
Comments	Comments	string	Max length: 250
OrderId	The unique Cin7 sales order or purchase order Id.	integer	None.
OrderRef	A unique sales order or purchase order reference. (Read-only)	string	Max length: 30
PaymentImportedRef	Payment imported ref	string	None.
BatchReference	Batch Reference (Read-only)	string	None.
ReconcileDate	Reconcile date	date	None.
BranchId	Branch Id.	integer	None.
OrderType	Order Type.	OrderType	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "createdDate": "2025-11-26T05:54:49.9933676+13:00",
    "modifiedDate": "2025-11-26T05:54:49.9933676+13:00",
    "paymentDate": "2025-11-26T05:54:49.9933676+13:00",
    "amount": 1.0,
    "method": "sample string 2",
    "isAuthorized": true,
    "transactionRef": "sample string 5",
    "comments": "sample string 6",
    "orderId": 7,
    "orderRef": "sample string 8",
    "paymentImportedRef": "sample string 9",
    "batchReference": "sample string 10",
    "reconcileDate": "2025-11-26T05:54:49.9933676+13:00",
    "branchId": 11,
    "orderType": "Undefined"
  },
  {
    "id": 1,
    "createdDate": "2025-11-26T05:54:49.9933676+13:00",
    "modifiedDate": "2025-11-26T05:54:49.9933676+13:00",
    "paymentDate": "2025-11-26T05:54:49.9933676+13:00",
    "amount": 1.0,
    "method": "sample string 2",
    "isAuthorized": true,
    "transactionRef": "sample string 5",
    "comments": "sample string 6",
    "orderId": 7,
    "orderRef": "sample string 8",
    "paymentImportedRef": "sample string 9",
    "batchReference": "sample string 10",
    "reconcileDate": "2025-11-26T05:54:49.9933676+13:00",
    "branchId": 11,
    "orderType": "Undefined"
  }
]

Response Information

Resource Description

Collection of BatchResultItem

Name	Description	Type	Additional information
Index	The index at which the record was positioned in an insert or update.	integer	None.
Success	True if the record was successfully inserted or updated.	boolean	None.
Id	The record Id.	integer	None.
Code	The record code.	string	None.
Errors	A list of errors if the insert or update fails.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "index": 0,
    "success": true,
    "id": 1,
    "code": "SALE4-28",
    "errors": []
  },
  {
    "index": 1,
    "success": true,
    "id": 2,
    "code": "SALE5-29",
    "errors": []
  }
]