Finance

Create a Payment

Creates a new Payment.

post/admin/finance/payments

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/finance/payments
  • Auth: HTTP basic

Request body

customer_idnumber required

Customer ID

invoice_idnumber nullable

Invoice ID

credit_note_idnumber nullable

Credit note ID

request_idnumber nullable

Request ID

transaction_idnumber

Transaction ID

payment_statement_idnumber nullable

Payment statement ID

payment_typestring required

Type ID. You can get it on page "Config / Finance / Payment methods"

receipt_numberstring required

Receipt Number

datestring required

Date. Format: YYYY-MM-DD

amountstring required

Sum

commentstring

Comment

is_sent'0' | '1'

Is sent

field_1string required

Field #1

field_2string required

Field #2

field_3string required

Field #3

field_4string required

Field #4

field_5string required

Field #5

notestring

Note

memostring

Memo

voidboolean

Voided payment

refund_payment_idnumber

Refund payment ID

Example request

{
  "customer_id": 1,
  "is_sent": "0"
}

Response

idnumber

Payment ID

Example response

{
  "id": 1
}

Changes

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