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

Invoice.list()

Return Object

AccountLineItem[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import Invoice from 'files.com/lib/models/Invoice';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const accountLineItems = await Invoice.list();
  for (const accountLineItem of accountLineItems) {
    // Operate on accountLineItem
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

List Payments

SDK Method

Payment.list()

Return Object

AccountLineItem[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import Payment from 'files.com/lib/models/Payment';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const accountLineItems = await Payment.list();
  for (const accountLineItem of accountLineItems) {
    // Operate on accountLineItem
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Invoice

SDK Method

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 Invoice from 'files.com/lib/models/Invoice';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const accountLineItem = await Invoice.find(id);
  // Operate on accountLineItem
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Payment

SDK Method

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 Payment from 'files.com/lib/models/Payment';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const accountLineItem = await Payment.find(id);
  // Operate on accountLineItem
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw 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