Class: FreshBooks::Recurring

Inherits:
Base
  • Object
show all
Defined in:
lib/freshbooks/recurring.rb

Overview

Create a new recurring profile.

The method arguments are nearly identical to invoice.create, but include four new fields:

  • occurrences Number of invoices to generate, with zero (0) being infinite

  • frequency Rate at which to generate invoices - can be one of ‘weekly’, ‘2 weeks’, ‘4 weeks’, ‘monthly’, ‘2 months’, ‘3 months’, ‘6 months’, ‘yearly’, ‘2 years’

  • stopped This profile is no longer generating invoices (1 - stopped, 0 - active)

  • send_email Notify client by email each time a new invoice is generated (1 or 0)

  • send_snail_mail Send a copy of your invoice by snail mail, each time it’s generated (1 or 0)

Method Summary

Methods inherited from Base

actions, #api_action, #api_delete_action, #api_get_action, #api_list_action, attribute, attributes, belongs_to, define_class_method, establish_connection!, has_many, #initialize, new_from_xml, node_name, #to_xml

Constructor Details

This class inherits a constructor from FreshBooks::Base