Payments

Update a Payments.

put/api/v1/Payments

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/Payments
  • Auth: none declared

Request body

idinteger

The unique Cin7 payment Id.

createdDatestring date-time nullable

Created Date UTC: yyyy-MM-dd HH:mm:ss

modifiedDatestring date-time nullable

Modified Date UTC: yyyy-MM-dd HH:mm:ss

paymentDatestring date-time nullable

Payment Date UTC: yyyy-MM-dd HH:mm:ss

amountnumber double nullable

Payment Amount

methodstring nullable

Payment Method

directioninteger

Payment direction: 1 receive payment or -1 pay/refund

isAuthorizedboolean

Transaction Authorized

transactionRefstring nullable

Transaction reference e.g. payment gateway transaction Id or ref

commentsstring nullable

Comments

orderIdinteger

The unique Cin7 sales order or purchase order Id.

orderRefstring nullable

A unique sales order or purchase order reference. (Read-only)

paymentImportedRefstring nullable

Payment imported ref

batchReferencestring nullable

Batch Reference (Read-only)

reconcileDatestring date-time nullable

Reconcile date

branchIdinteger

Branch Id.

orderType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

Order type enumeration

Response

OK

successboolean

​True if the record was successfully inserted or updated.

idinteger nullable

The record Id.

codestring nullable

The record code.

errorsstring[] nullable

A list of errors if the insert or update fails.

indexinteger

​The index at which the record was positioned in an insert or update.

Changes

No recorded changes to this operation across all 1 revision of this API.