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

The payment ID

payment.payment_method

The payment method name

payment.document_number The payment number

payment_document_number The number of a payment for a sales order, renewal order, or change order linked to a manual operation

payment.total The total amount of the payment

payment.total_in_words The total amount of the payment in words

payment.created_at The date and time of the payment creation

payment.expiration_date The date when a payment, if not completed, gets the Expired status (DD.MM.YYYY)

payment.due_date The latest date for completing a payment (DD.MM.YYYY). Calculated as payment.expiration_date minus 1 day

payment.days_left The number of days prior to the end of the payment expiration period

payment.status The current status of the payment

payment.status.was The previous status of the payment

payment.comment Additional information about the payment

payment.subscriptions

An 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	The ID of the subscription from the array of the subscriptions related to the payment
subscription.name	The name of the subscription from the array of the subscriptions related to the payment
subscription.status	The status of the subscription from the array of the subscriptions related to the payment

payment.orders

The list of the orders linked to the payment

{% for order in payment.orders %}
  order
{% endfor %}

payment.order_charges

The list of the charges linked to the payment

{% for order_charge in payment.order_charges %}
  order_charge
{% endfor %}

Charge attributes: description, quantity, unit_price, unit_price_in_original_currency, unit_price_without_tax, discount_amount, discount_amount_in_original_currency, discounted_unit_price_without_tax, amount_in_original_currency, amount_without_tax, period, tax_percent, amount, discount_ids, operate_from, operate_to, resource_name

payment.order_charges.size The number of charges in a PDF receipt

payment.grouped_order_charges

The list of the grouped charges linked to the payment (parameters are set for the first charge in a group if not specified otherwise): id; name; description; unit_price (price); amount (specified as the total amount for a group); duration (period); discount_ids; discount_amount (specified as the total amount for a group); quantity (specified as the total amount for a group); operate_from; operate_to; type; plan_id; plan_resource_id; unit_price_without_tax; discounted_unit_price_without_tax; amount_without_tax (specified as the total amount for a group); unit_price_with_discount; tax_percent.

Charges are grouped if have the following identical parameters:

reseller_id
account_id
subscription_id
resource_id
operate_from
operate_to
duration
unit_price
status
type
taxes_amount
discount_id
original_amount_currency
currency_rate
currency_unit

payment.grouped_order_charges.size The number of grouped charges in a PDF receipt

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

payment.panel_link

The link to the payment in the Customer Control Panel

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

payment.receipt_url The link to the receipt

payment.plan_custom_attributes.item

The set of the custom attributes of the payment (see Managing attributes, where item is the key of the attribute

payment.plan_resources_custom_attributes.item

The value of the attributes of the plan resource where item is the key of the attribute

payment.invoice_from_date

The start date of the period of the postpaid Invoice linked to the payment (DD.MM.YYYY)

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

payment.invoice_document_number The invoice number linked to the payment

payment.external_invoices_data

An 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

payment.invoices_total The total of all invoices linked to a payment (taxes included)

payment.invoices_external_total The total of all external totals of invoices issued by a third-party ERP system and linked to a payment (see Managing invoices for the Postpay model by a third-party ERP system)

payment.invoices_currency_external_total The currency code of the first among all invoices issued by a third-party ERP system and linked to a payment (see Managing invoices for the Postpay model by a third-party ERP system)

Guaranteed payment

guaranteed_payment.id

The guaranteed payment ID

guaranteed_payment.status The status of the guaranteed payment

guaranteed_payment.total The total amount of the guaranteed payment

guaranteed_payment.expiration_date The date and time of the guaranteed payment

guaranteed_payment.days_left The number of days before the expiration date of the guaranteed payment