Receive a Payment

URL: https://api.kometsales.com/api/payment.receive

Method: POST

Content-Type: application/JSON

Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.

customerId (required)(integer:20)

Customer ID.

You can get this value from the customer.list API method.

locationCode (required)(string:20)

Company Location code.

Only applies to Multi-Location companies.

You can get this value from the location.list API method.

methodId (required)(integer:20)

Komet Sales internal Payment Method ID from the master list.

You can get this value from the payment.method.list API method.

date (required)(date)

Payment date.

Date format: YYYY-MM-DD

totalPayment (optional)(decimal:10,2)

Total payment amount.

The amount in this field must be equal to or greater than the total of every Invoice included in the request.

You can also use this field to create overpayments in the system by adding a higher total.

referenceNumber (optional)(string:100)

Check or reference number.

notes (optional)(string:200)

Payment notes.

invoices (optional)(array)

An array of Invoices that will receive payment.

invoiceNumber (optional)(integer:10)

Invoice number.

You can get this value from the invoice.details.list API method.

amount (required)(decimal:10,2)

Amount to pay to this Invoice.

discount (optional)(decimal:10,2)

Discount to apply to the order.

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

controlNumber (integer:20)

Payment control number.