Class: Recurly::Resources::Invoice

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::Invoice

Defined in:

lib/recurly/resources/invoice.rb

Instance Attribute Summary

• #account ⇒ AccountMini

  Account mini details.

• #address ⇒ InvoiceAddress
• #balance ⇒ Float

  The outstanding balance remaining on this invoice.

• #billing_info_id ⇒ String

  The ‘billing_info_id` is the value that represents a specific billing info for an end customer.

• #business_entity_id ⇒ String

  Unique ID to identify the business entity assigned to the invoice.

• #closed_at ⇒ DateTime

  Date invoice was marked paid or failed.

• #collection_method ⇒ String

  An automatic invoice means a corresponding transaction is run using the account’s billing information at the same time the invoice is created.

• #created_at ⇒ DateTime

  Created at.

• #credit_payments ⇒ Array[CreditPayment]

  Credit payments.

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #customer_notes ⇒ String

  This will default to the Customer Notes text specified on the Invoice Settings.

• #discount ⇒ Float

  Total discounts applied to this invoice.

• #due_at ⇒ DateTime

  Date invoice is due.

• #dunning_campaign_id ⇒ String

  Unique ID to identify the dunning campaign used when dunning the invoice.

• #dunning_events_sent ⇒ Integer

  Number of times the event was sent.

• #final_dunning_event ⇒ Boolean

  Last communication attempt.

• #has_more_line_items ⇒ Boolean

  Identifies if the invoice has more line items than are returned in ‘line_items`.

• #id ⇒ String

  Invoice ID.

• #line_items ⇒ Array[LineItem]

  Line Items.

• #net_terms ⇒ Integer

  Integer paired with ‘Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due.

• #net_terms_type ⇒ String

  Optionally supplied string that may be either ‘net` or `eom` (end-of-month).

• #number ⇒ String

  If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001).

• #object ⇒ String

  Object type.

• #origin ⇒ String

  The event that created the invoice.

• #paid ⇒ Float

  The total amount of successful payments transaction on this invoice.

• #po_number ⇒ String

  For manual invoicing, this identifies the PO number associated with the subscription.

• #previous_invoice_id ⇒ String

  On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.

• #reference_only_currency_conversion ⇒ ReferenceOnlyCurrencyConversion

  Reference Only Currency Conversion.

• #refundable_amount ⇒ Float

  The refundable amount on a charge invoice.

• #shipping_address ⇒ ShippingAddress
• #state ⇒ String

  Invoice state.

• #subscription_ids ⇒ Array[String]

  If the invoice is charging or refunding for one or more subscriptions, these are their IDs.

• #subtotal ⇒ Float

  The summation of charges and credits, before discounts and taxes.

• #subtotal_after_discount ⇒ Float

  The summation of charges and credits, after discounts applied.

• #tax ⇒ Float

  The total tax on this invoice.

• #tax_info ⇒ TaxInfo

  Only for merchants using Recurly’s In-The-Box taxes.

• #terms_and_conditions ⇒ String

  This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin.

• #total ⇒ Float

  The final total on this invoice.

• #transactions ⇒ Array[Transaction]

  Transactions.

• #type ⇒ String

  Invoices are either charge, credit, or legacy invoices.

• #updated_at ⇒ DateTime

  Last updated at.

• #used_tax_service ⇒ Boolean

  Will be ‘true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.

• #uuid ⇒ String

  Invoice UUID.

• #vat_number ⇒ String

  VAT registration number for the customer on this invoice.

• #vat_reverse_charge_notes ⇒ String

  VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#account ⇒ AccountMini

# File 'lib/recurly/resources/invoice.rb', line 11

define_attribute :account, :AccountMini

#address ⇒ InvoiceAddress

# File 'lib/recurly/resources/invoice.rb', line 15

define_attribute :address, :InvoiceAddress

#balance ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 19

define_attribute :balance, Float

#billing_info_id ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 23

define_attribute :billing_info_id, String

#business_entity_id ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 27

define_attribute :business_entity_id, String

#closed_at ⇒ DateTime

# File 'lib/recurly/resources/invoice.rb', line 31

define_attribute :closed_at, DateTime

#collection_method ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 35

define_attribute :collection_method, String

#created_at ⇒ DateTime

# File 'lib/recurly/resources/invoice.rb', line 39

define_attribute :created_at, DateTime

#credit_payments ⇒ Array[CreditPayment]

# File 'lib/recurly/resources/invoice.rb', line 43

define_attribute :credit_payments, Array, { :item_type => :CreditPayment }

#currency ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 47

define_attribute :currency, String

#customer_notes ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 51

define_attribute :customer_notes, String

#discount ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 55

define_attribute :discount, Float

#due_at ⇒ DateTime

# File 'lib/recurly/resources/invoice.rb', line 59

define_attribute :due_at, DateTime

#dunning_campaign_id ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 63

define_attribute :dunning_campaign_id, String

#dunning_events_sent ⇒ Integer

# File 'lib/recurly/resources/invoice.rb', line 67

define_attribute :dunning_events_sent, Integer

#final_dunning_event ⇒ Boolean

# File 'lib/recurly/resources/invoice.rb', line 71

define_attribute :final_dunning_event, :Boolean

#has_more_line_items ⇒ Boolean

# File 'lib/recurly/resources/invoice.rb', line 75

define_attribute :has_more_line_items, :Boolean

#id ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 79

define_attribute :id, String

#line_items ⇒ Array[LineItem]

# File 'lib/recurly/resources/invoice.rb', line 83

define_attribute :line_items, Array, { :item_type => :LineItem }

#net_terms ⇒ Integer

# File 'lib/recurly/resources/invoice.rb', line 87

define_attribute :net_terms, Integer

#net_terms_type ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 91

define_attribute :net_terms_type, String

#number ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 95

define_attribute :number, String

#object ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 99

define_attribute :object, String

#origin ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 103

define_attribute :origin, String

#paid ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 107

define_attribute :paid, Float

#po_number ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 111

define_attribute :po_number, String

#previous_invoice_id ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 115

define_attribute :previous_invoice_id, String

#reference_only_currency_conversion ⇒ ReferenceOnlyCurrencyConversion

# File 'lib/recurly/resources/invoice.rb', line 119

define_attribute :reference_only_currency_conversion, :ReferenceOnlyCurrencyConversion

#refundable_amount ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 123

define_attribute :refundable_amount, Float

#shipping_address ⇒ ShippingAddress

# File 'lib/recurly/resources/invoice.rb', line 127

define_attribute :shipping_address, :ShippingAddress

#state ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 131

define_attribute :state, String

#subscription_ids ⇒ Array[String]

# File 'lib/recurly/resources/invoice.rb', line 135

define_attribute :subscription_ids, Array, { :item_type => String }

#subtotal ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 139

define_attribute :subtotal, Float

#subtotal_after_discount ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 143

define_attribute :subtotal_after_discount, Float

#tax ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 147

define_attribute :tax, Float

#tax_info ⇒ TaxInfo

# File 'lib/recurly/resources/invoice.rb', line 151

define_attribute :tax_info, :TaxInfo

#terms_and_conditions ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 155

define_attribute :terms_and_conditions, String

#total ⇒ Float

# File 'lib/recurly/resources/invoice.rb', line 159

define_attribute :total, Float

#transactions ⇒ Array[Transaction]

# File 'lib/recurly/resources/invoice.rb', line 163

define_attribute :transactions, Array, { :item_type => :Transaction }

#type ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 167

define_attribute :type, String

#updated_at ⇒ DateTime

# File 'lib/recurly/resources/invoice.rb', line 171

define_attribute :updated_at, DateTime

#used_tax_service ⇒ Boolean

# File 'lib/recurly/resources/invoice.rb', line 175

define_attribute :used_tax_service, :Boolean

#uuid ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 179

define_attribute :uuid, String

#vat_number ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 183

define_attribute :vat_number, String

#vat_reverse_charge_notes ⇒ String

# File 'lib/recurly/resources/invoice.rb', line 187

define_attribute :vat_reverse_charge_notes, String