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\Model\Invoice::list;

Return Object

AccountLineItem[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

try {
  $account_line_items = \Files\Model\Invoice::list();
  foreach ($account_line_items as $account_line_item) {
    // Operate on $account_line_item
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

List Payments

SDK Method

\Files\Model\Payment::list;

Return Object

AccountLineItem[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

try {
  $account_line_items = \Files\Model\Payment::list();
  foreach ($account_line_items as $account_line_item) {
    // Operate on $account_line_item
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Invoice

SDK Method

\Files\Model\Invoice::find;

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Invoice ID.

Example Request

try {
  $account_line_item = \Files\Model\Invoice::find($id);
  // Operate on $account_line_item
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Payment

SDK Method

\Files\Model\Payment::find;

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Payment ID.

Example Request

try {
  $account_line_item = \Files\Model\Payment::find($id);
  // Operate on $account_line_item
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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