InvoicePaymentOptions
extends DataTransferObject
in package
implements
DataModel
In FreshBooks, invoices can be paid online via a variety of payment gateways setup on the sender’s account. In order for this to be available on an invoice, the online payments must be set up through a separate call after the invoice has been created.
While default payment options exist, they are not automatically applied to new invoices and must be retrieved and added manually.
Tags
Table of Contents
Interfaces
Constants
- RESPONSE_FIELD = 'payment_options'
Properties
- $allowPartialPayments : bool
- $entityId : string
- $entityType : string
- $gatewayName : string
- $hasAchTransfer : bool
- $hasAcssDebit : bool|null
- $hasBacsDebit : bool|null
- $hasCreditCard : bool
- $hasPaypalSmartCheckout : bool|null
- $hasSepaDebit : bool|null
Methods
- getContent() : array<string|int, mixed>
- Get the data as an array to POST or PUT to FreshBooks, removing any read-only fields.
Constants
RESPONSE_FIELD
public
mixed
RESPONSE_FIELD
= 'payment_options'
Properties
$allowPartialPayments
public
bool
$allowPartialPayments
If the client can use the gateway to pay part of the invoice or only the full amount.
$entityId
public
string
$entityId
invoice_id of the connected invoice.
Note: The API returns this as entity_id.
$entityType
public
string
$entityType
Eg. “invoices”.
$gatewayName
public
string
$gatewayName
Payment gateway name.
$hasAchTransfer
public
bool
$hasAchTransfer
If the invoice can accept ACH bank transfers.
$hasAcssDebit
public
bool|null
$hasAcssDebit
$hasBacsDebit
public
bool|null
$hasBacsDebit
$hasCreditCard
public
bool
$hasCreditCard
If the invoice can accept credit cards.
$hasPaypalSmartCheckout
public
bool|null
$hasPaypalSmartCheckout
$hasSepaDebit
public
bool|null
$hasSepaDebit
Methods
getContent()
Get the data as an array to POST or PUT to FreshBooks, removing any read-only fields.
public
getContent() : array<string|int, mixed>