bookmark_borderFreshbooks Feed Meta

Introduction

The Feed Object meta for the Freshbooks add-on is an associative array containing the properties which determine how the add-on should process the form submission.

$feed['meta'] = array(
	'feedName'                                => 'Your Feed Name',
	'email'                                   => '2',
	'updateClient'                            => true,
	'feed_condition_conditional_logic'        => true,
	'feed_condition_conditional_logic_object' => array(
		'conditionalLogic' => array(),
	),
);

Usage

We recommend accessing the $feed meta using the rgar() or rgars() functions e.g.

$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

  • feedName string

    The feed name which appears on the add-ons feeds tab.

  • email string

    The ID of the field containing the client’s email address.

  • updateClient boolean

    Update an existing client if email addresses match.

  • firstName string

    The ID of the field containing the client’s first name.

  • lastName string

    The ID of the field containing the client’s last name.

  • organization string

    The ID of the field containing the client’s organization.

  • address string

    The ID of the field containing the client’s address.

  • phone string

    The ID of the field containing the client’s phone number.

  • fax string

    The ID of the field containing the client’s fax number.

  • notes string

    The note which should be added to the client. Merge tags supported.

  • alsoCreate string

    Should an invoice or estimate be created. Possible values: invoice, estimate or neither

  • feed_condition_conditional_logic boolean

    Is the feed condition (conditional logic) setting enabled. Default is false.

  • feed_condition_conditional_logic_object array

    An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

Invoice/Estimate Properties

  • sendByEmail boolean

    Should the invoice/estimate be automatically emailed to the client, instead of being left in Draft form.

  • createPayment boolean

    Only applicable when creating an invoice and also using a payment add-on with a product transaction. Once the user has completed his/her payment transaction, a Freshbooks payment for the invoice amount will automatically be created, changing the invoice status to Paid.

  • poNumber string

    The ID of the field containing the purchase order number.

  • discount integer

    The discount percentage which should be applied to the total invoice/estimate cost.

  • lineItems string

    Create one or more line item(s) for your invoice or estimate. Possible values: fixed, pricing or dynamic

  • notes2 string

    The note which should be added to the invoice or estimate. Merge tags supported.

  • terms string

    The terms which should be added to the invoice or estimate.

Fixed/Dynamic Line Items Properties

  • item array

    An indexed array containing the Freshbooks item ids for each line item.

  • description array

    An indexed array containing the description for each line item.

  • cost array

    An indexed array containing the cost for each line item. With lineItems set to dynamic this would contain a field ID instead.

  • quantity array

    An indexed array containing the quantity for each line item. With lineItems set to dynamic this would contain a field ID instead.