ModelInvoices module

PayPalPaymentMethod

PayPal Payment Method

A model in the Invoices module, with 14 members for templates, 11 API properties and 20 members for admin templates.

Invoices\Models\Frontend\PayPalPaymentMethod Invoices\Models\Api\PayPalPaymentMethod Invoices\Models\Backend\PayPalPaymentMethod Also in Invoices: Invoice InvoiceCustomFieldValue Item MockPayPaymentMethod PayPalDonatePaymentMethod Refund RefundItem StripePaymentMethod Transaction
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 14

Take no arguments.

# getClientId()
?string
Get the client id
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 11

Read-only values on the record.

# clientId
?string
Get the client id
# paymentServiceProviderName
string
Get the name of the payment service provider.
# paymentServiceProviderType
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# id
?int
# name
?string
# position
?int
# testMode
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# active
bool
# site
?Site

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 20

Take no arguments.

# getClientSecret() Admin only
?string
Get the client secret
# getClientId()
?string
Get the client id
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getMoveUrl() Admin only
?string
Get the url for moving the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getManageUrl() Admin only
?string
Get the url for managing records.