Finance

Retrieve a Payment Statement Record

Work with Payment statement record.Retrieves the Payment statement record with the given ID.

get/admin/finance/bank-statements-records/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/finance/bank-statements-records/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The Id of the desired Payment statement record.

Response

bank_statements_process_idnumber required

Payment Statement ID

datetimestring

Datetime. Format: YYYY-MM-DD HH:II:SS

payment_datestring

Payment date. Format: YYYY-MM-DD

amountstring

Amount

statusstring

Status. Values: new, processed, canceled, error, ignored, deleted, manual_paired, pending, voided

pairing_1string

Customer ID

pairing_2string

Invoice number

pairing_3string

Pairing 3

additional_1string

Additional field 1

additional_2string

Additional field 2

additional_3string

Additional field 3

commentstring

Comment

customer_idnumber nullable

Customer ID

invoice_idnumber nullable

Invoice ID

credit_note_idnumber nullable

Credit note ID

request_idnumber nullable

Proforma invoice ID

payment_idnumber nullable

Payment ID

transaction_idnumber nullable

Transaction ID

idnumber

Payment Statement Record ID

Example response

[
  {
    "bank_statements_process_id": 1,
    "datetime": "2021-07-15 09:50:00",
    "payment_date": "2021-07-15",
    "amount": "10.0000",
    "status": "new",
    "pairing_1": "1",
    "pairing_2": "202001000118",
    "pairing_3": "",
    "additional_1": "",
    "additional_2": "",
    "additional_3": "",
    "comment": "Comment",
    "customer_id": 1,
    "invoice_id": 1,
    "credit_note_id": null,
    "request_id": null,
    "payment_id": null,
    "transaction_id": null,
    "id": 1
  }
]

Changes

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