sale.payment.getFields
sale.payment.getFields()
The method returns payment fields.
Returned fields:
Field | Description |
---|---|
id | Payment ID. |
orderId | Order ID. |
paid | Flag for paid status: Y or N. |
datePaid | Payment date. |
empPaidId | Payer. |
paySystemId | Payment system ID. |
psStatus | Data, received from payment system: transaction status. |
psStatusCode | Data, received from payment system: transaction code. |
psInvoiceId | Payment ID within payment system. |
psStatusDescription | Data, received from payment system: transaction description. |
psStatusMessage | Data, received from payment system: message. |
psSum | Data, received from payment system: transaction amount. |
psCurrency | Data, received from payment system: currency. |
psResponseDate | Data, received from payment system: date of response from payment system. |
payVoucherNum | Number of payment document. |
payVoucherDate | Date of payment document. |
datePayBefore | Date until invoice must be paid (not used in online store). |
dateBill | Date of billing. |
xmlId | External ID. |
sum | Payment amount. |
priceCod | cash on delivery payment amount (for example, used for COD (collect on delivery) terms). |
currency | Currency. |
paySystemName | Payment system name. |
responsibleId | User ID, responsible for payment. |
empResponsibleId | User ID, who assigned a responsible user. |
dateResponsibleId | Date when responsible user was assigned. |
comments | Comment for payment. |
companyId | Company ID, that will receive payment. |
payReturnNum | Number of returns document. |
payReturnDate | Date of returns document. |
empReturnId | User ID who performed return. |
payReturnComment | Comment to return. |
isReturn | Item returned or not. |
marked | Payment marking |
dateMarked | Date of marking. |
empMarkedId | User who performed marking |
reasonMarked | Reason for marking. |
externalPayment | Flag Y/N: external payment. |
Parameters
No parameters.
Examples
BX24.callMethod( 'sale.payment.getFields', {}, function(result) { if(result.error()) console.error(result.error().ex); else console.log(result.data()); });
© «Bitrix24», 2001-2024