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_sdk.invoice.list()

Return Object

ListObj[AccountLineItem]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import files_sdk

try:
  account_line_items = files_sdk.invoice.list()
  for account_line_item in account_line_items.auto_paging_iter():
    # Operate on account_line_item
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

List Payments

SDK Method

files_sdk.payment.list()

Return Object

ListObj[AccountLineItem]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import files_sdk

try:
  account_line_items = files_sdk.payment.list()
  for account_line_item in account_line_items.auto_paging_iter():
    # Operate on account_line_item
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Invoice

SDK Method

files_sdk.invoice.find()

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Invoice ID.

Example Request

import files_sdk

try:
  account_line_item = files_sdk.invoice.find(id)
  # Operate on account_line_item
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Payment

SDK Method

files_sdk.payment.find()

Return Object

AccountLineItem

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Payment ID.

Example Request

import files_sdk

try:
  account_line_item = files_sdk.payment.find(id)
  # Operate on account_line_item
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

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