MuleSoft Connector for FreshBooks

Build 20.0.7587

Recurring

A list of recurring profile summaries. Credit card information must be tokenized before being submitted for auto-bill. Staff members can access recurring profiles for clients they are assigned to.

Table Specific Information

Select

The Classic API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

  • RecurringId
  • ClientId
  • Date
  • Updated
  • Autobill

Note: RecurringId cannot be used at the same time as the other columns.

Other filters are processed client side by the connector. See SupportEnhancedSQL for more information.

Contact Aggregate

Use the ContactAggregate field to flatten contact items into a single field. This XML aggregate contains additional Ids for contacts beyond the primary client associated with an invoice and can be inserted and updated directly using the proper XML formatting, as indicated by the example below:

INSERT INTO Recurring (ClientId, ContactAggregate)
VALUES ('123', '<contact><contact_id>456</contact_id></contact><contact><contact_id>789</contact_id></contact>')

Line Aggregate

Use the LineAggregate field to flatten line items into a single field. This XML aggregate contains all of the line items for an invoice and can be inserted and updated directly using the proper XML formatting, as indicated by the example below:

INSERT INTO Recurring (ClientId, LineAggregate)
VALUES ('123',
'<line><name>Yard Work</name><description>Mowed the lawn.</description>
<unit_cost>10</unit_cost><quantity>4</quantity>
<tax1_name></tax1_name><tax2_name></tax2_name>
<tax1_percent></tax1_percent><tax2_percent></tax2_percent><type></type></line>
<line><name>Giant Rock</name><description>It's a large rock.</description>
<unit_cost>200</unit_cost><quantity>1</quantity>
<tax1_name></tax1_name><tax2_name></tax2_name>
<tax1_percent></tax1_percent><tax2_percent></tax2_percent><type></type></line>')

Note: Updating these fields will remove all previously stored information.

Columns

Name Type ReadOnly Description
RecurringId [KEY] String True

The unique identifier of a recurring profile.

Frequency String True

The frequency of a recurring profile.

Occurrences Integer True

The number of occurrences of a recurring profile.

Stopped Boolean True

A value indicating whether or not a recurring profile is stopped.

ClientId String True

The Id of a client associated with a recurring profile.

ContactAggregate String True

An aggregate containing contact information associated with a recurring invoice. See the help file for the Recurring table for more information on inserting and updating to this field.

StaffId String True

The Id of a staff member associated with a recurring profile.

Organization String True

The name of the organization attached to a recurring profile.

FirstName String True

The first name attached to a recurring profile.

LastName String True

The last name attached to a recurring profile.

PrimaryStreet1 String True

The first line of a primary street address for a recurring profile.

PrimaryStreet2 String True

The second line of a primary street address for a recurring profile.

PrimaryCity String True

The primary city for a recurring profile.

PrimaryState String True

The primary state or province for a recurring profile.

PrimaryCountry String True

The primary country for a recurring profile.

PrimaryCode String True

The primary Postal/ZIP code for a recurring profile.

VatName String True

VAT name associated with a recurring profile.

VatNumber String True

VAT number associated with a recurring profile.

PONumber String True

The purchase order number associated with a profile.

Status String True

This field accepts one of the following values: sent, viewed, or draft. Defaults to draft.

Amount Decimal True

Total invoice amount, taxes included.

CurrencyCode String True

The currency code used for a recurring profile.

Language String True

The language used for a recurring profile.

Date Datetime True

The date associated with a recurring profile.

Notes String True

A custom note for a recurring profile.

Terms String True

The terms for a recurring profile.

Discount Decimal True

Discount applied to a recurring profile.

ReturnUri String True

Return URI for a recurring profile.

SendSnailMail Boolean True

A value indicating if sending by snail mail is enabled.

SendEmail Boolean True

A value indicating if sending by email is enabled.

Folder String True

Folder associated with a recurring profile.

AutobillGatewayName String True

Gateway name used by a recurring profile.

AutobillCardNumber String True

Card number used by a recurring profile.

AutobillCardName String True

Name on a card used by a recurring profile.

AutobillCardExpirationMonth String True

Expiration month on a card used by a recurring profile.

AutobillCardExpirationYear String True

Expiration year on a card used by a recurring profile.

LineAggregate String True

An aggregate of lines associated with a recurring invoice. See the help for the Recurring table for more information on inserting and updating to this field.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587