Finance

List all Payments

Returns a list of your Payments.

get/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

Response

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

idnumber

Payment ID

remind_amountnumber

Remind amount

real_create_datetimestring

Real create date. Format: YYYY-MM-DD H:i:s

added_by'system' | 'api' | 'admin'

Added by

added_by_idnumber

Added by ID

Example response

[
  {
    "customer_id": 1,
    "invoice_id": null,
    "credit_note_id": null,
    "request_id": null,
    "transaction_id": 0,
    "payment_statement_id": null,
    "payment_type": "",
    "receipt_number": "",
    "date": "",
    "amount": "",
    "comment": "",
    "is_sent": "0",
    "field_1": "",
    "field_2": "",
    "field_3": "",
    "field_4": "",
    "field_5": "",
    "note": "",
    "memo": "",
    "id": 1,
    "void": false,
    "remind_amount": 0,
    "real_create_datetime": "2024-05-27 15:30:35",
    "added_by": "api",
    "added_by_id": 1,
    "refund_payment_id": 0
  }
]

Changes

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