Placeholders for the Payment and Guaranteed Payment entities

The following Placeholders are used for the Payment and Guaranteed Payment entities.

Entity Placeholder Description

Payment

payment.id

Payment ID

payment.payment_method

Payment method name

payment.document_number Payment number

payment.total Total amount of the Payment

payment.total_in_words Total amount of the Payment in words

payment.created_at Date and time of the Payment creation

payment.expiration_date Payment due date (DD.MM.YYYY)

payment.days_left Number of days prior to the end of the Payment expiration period

payment.status Current status of the Payment

payment.status.was Previous status of the Payment

payment.comment Additional information about the Payment

payment.subscriptions

Iterator that allows displaying an array of Subscriptions that are related to the Payment

{% for subscription in payment.subscriptions %}
<tr>
<td>{{ subscription.id }}</td>
<td>{{ subscription.name }}</td>
<td>{{ subscription.status }}</td>
</tr>
{% endfor %}

subscription.id	ID of the Subscription from the array of the Subscriptions related to the Payment
subscription.name	Name of the Subscription from the array of the Subscriptions related to the Payment
subscription.status	Status of the Subscription from the array of the Subscriptions related to the Payment

payment.orders List of the Orders linked to the Payment (separated by ";")

payment.order_charges

List of the Charges linked to the Payment (separated by ";"): description, quantity, unit_price, unit_price_without_tax, discount_amount, discounted_unit_price_without_tax, amount_without_tax, period, tax_percent, amount, discount_ids

payment.link Link to the Payments section of the Customer Control Payment filtered by the Payment number (for example, https://{{domain}}/accounts/{{account_id}}/payments?document_id=AP000000834)

payment.panel_link

Link to the Payment, in the Customer Control Panel

payment.downloadable Boolean; whether the link to the Payment is available

payment.receipt_url Link to the receipt

payment.plan_custom_attributes.item

Set of the custom attributes of the Payment (see Managing Attributes), where the item is a key of the attribute

payment.plan_resources_custom_attributes.item

Value of the attributes of the Plan resource, where the item is a key of the attribute

payment.invoice_from_date

Start date of the period of the postpaid Invoice linked to the Payment (DD.MM.YYYY)

payment.invoice_to_date End date of the period of the postpaid Invoice linked to the Payment (DD.MM.YYYY)

payment.invoice_document_number Invoice number linked to the Payment

payment.external_invoices_data

Iterator that allows displaying an array of third-party invoices linked to the Payment (see Managing Invoices for the Postpay model by a third-party ERP system)

{% for external_invoice in payment.external_invoices_data %}
<tr>
<td>{{external_invoice.link.name}}</td>
<td>{{external_invoice.link.data}}</td>
<td>{{external_invoice.file.name}}</td>
<td>{{external_invoice.file.data}}</td>
</tr>
{% endfor %}

A third-party invoice can be represented as a link or a file:

external_invoice.link.name	Third-party invoice file name from the link
external_invoice.link.data	Link to a third-party invoice
external_invoice.file.name	Third-party invoice file name
external_invoice.file.data	Third-party invoice file in the base64 encoding

Guaranteed Payment

guaranteed_payment.id

Guaranteed payment ID

guaranteed_payment.status Status of the Guaranteed payment

guaranteed_payment.total Total amount of the Guaranteed payment

guaranteed_payment.expiration_date Date and time of the Guaranteed payment

guaranteed_payment.days_left Number of days before the expiration date of the Guaranteed Payment