Synapcus Developers (EN)

Payment (pay)

Payment entity stors informations about payments for debitor as well as creditor invoices. 

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

Name

Type

Label

Description

form *

String

Form

Represents the entity form. Will always be "pay".

pay_amount *

Number


Represents the amount paid

pay_created_from *

String


The parent process type under which the folder has been created and referenced. (e.g. "sop")

pay_date *

Date/Time


Represents the creation date and time of the object.

pay_nr

Number


Represents the payment number in the chain.

pay_ord_unid *

String


The unique ID of the sell/buy-order under which the payment has been created and referenced.

pay_org_name *

String


Represents the organisation name who made the payment

pay_org_unid *

String


The unique ID of the organisation document

pay_proc_unid *

String


The unique ID of the process under which the payment has been created and referenced.

pay_state *

String


Represents the state of the payment as a code.

pay_state_text *

String


Represents the state of the payment as a label.

QEE classes level

The class representing the Payment is QEEPay

Inherits from: QEEObject

REST level

The endpoints dealing with Payment are:

xrPay (GET, POST, PUT, DELETE)

xrPays (GET, PUT, DELETE)