POST v1/Payments
Create a list of Payments.
Request Information
URI Parameters
None.
Body Parameters
Collection of PaymentName | 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
[ { "id": 1, "createdDate": "2024-11-19T10:38:05.1801617+13:00", "modifiedDate": "2024-11-19T10:38:05.1801617+13:00", "paymentDate": "2024-11-19T10:38:05.1801617+13:00", "amount": 2.0, "method": "sample string 3", "isAuthorized": true, "transactionRef": "sample string 6", "comments": "sample string 7", "orderId": 8, "orderRef": "sample string 9", "paymentImportedRef": "sample string 10", "batchReference": "sample string 11", "reconcileDate": "2024-11-19T10:38:05.1801617+13:00", "branchId": 12, "orderType": "Undefined" }, { "id": 1, "createdDate": "2024-11-19T10:38:05.1801617+13:00", "modifiedDate": "2024-11-19T10:38:05.1801617+13:00", "paymentDate": "2024-11-19T10:38:05.1801617+13:00", "amount": 2.0, "method": "sample string 3", "isAuthorized": true, "transactionRef": "sample string 6", "comments": "sample string 7", "orderId": 8, "orderRef": "sample string 9", "paymentImportedRef": "sample string 10", "batchReference": "sample string 11", "reconcileDate": "2024-11-19T10:38:05.1801617+13:00", "branchId": 12, "orderType": "Undefined" } ]
Response Information
Resource Description
Collection of BatchResultItemName | 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
[ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ]