Account Line Items

An AccountLineItem is a single line item in the accounting ledger for a billing account. These include payments and invoices.

List Invoices

SDK Method

Files::Invoice.list

Return Object

List<AccountLineItem>

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

begin
  account_line_items = Files::Invoice.list
  account_line_items.auto_paging_each do |account_line_item|
    # Operate on account_line_item
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

List Payments

SDK Method

Files::Payment.list

Return Object

List<AccountLineItem>

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

begin
  account_line_items = Files::Payment.list
  account_line_items.auto_paging_each do |account_line_item|
    # Operate on account_line_item
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Invoice

SDK Method

Files::Invoice.find

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Invoice ID.

Example Request

begin
  account_line_item = Files::Invoice.find(id)
  # Operate on account_line_item
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Payment

SDK Method

Files::Payment.find

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Payment ID.

Example Request

begin
  account_line_item = Files::Payment.find(id)
  # Operate on account_line_item
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The AccountLineItem Object

Some of the methods above return a AccountLineItem object. The attributes of this object are listed below.

AttributeDescription
id
int64		Line item Id
amount
decimal		Line item amount
balance
decimal		Line item balance
created_at
date-time		Line item created at
currency
string		Line item currency
download_uri
string		Line item download uri
invoice_line_items
array(object)		Associated invoice line items
method
string		Line item payment method
payment_line_items
array(object)		Associated payment line items
payment_reversed_at
date-time		Date/time payment was reversed if applicable
payment_type
string		Type of payment if applicable
site_name
string		Site name this line item is for
type
string		Type of line item, either payment or invoice