Overview
Error Handling

Methods

API Documentation (API Version v1)

Billing/Invoice/

DESCRIPTION

An invoice is a record of specific charges owed by the customer for a set of services. A bill is a point of communication with a customer. When Liquid Web bills a customer, it gathers any outstanding invoices, generates any new invoices if needed and sends them to the customer.

There are three ways an invoice could be generated:

  1. Any time a service is added or removed from an account an invoice is generated.

  2. During the normal billing time for an account, an invoice is generated for the upcoming month.

  3. For certain services where it is impossible to know how much to charge until we know the usage for the service, we charge for the previous month's usage. If an account has charges for any of those services (backups, bandwidth overages, etc), an additional invoice will be generated for those services only.

**** NOTE ****

Bills related methods have been moved to billing->bill

In order to help clear up confusion, we have made an effort to separate bills and invoices. Originally, to try and make things simpler, we attempted to make bills and invoices appear more like one thing. This, unfortunately, did not work as well as intended. In making things more transparent, the API methods involving Bills and Invoices have been refined. In order to maintain backwards compatibility, the version 1 (v1) methods will continue to refer to bills rather than invoices. Moving forward, including the bleed version, the methods will be referring solely to invoices. This means that a list method called as v1 will return different data than the bleed version.

Exceptions to this rule: Any method that only existed as a bleed method prior to the separation of bills and invoices. For example, the "next" method is related to bills not invoices and is a bleed-only method due to when it was introduced. These methods have been completely moved to billing->bill and are no longer available under billing->invoice.

details

URL:

https://api.stormondemand.com/v1/Billing/Invoice/details

Description:

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
accnt

A valid account number, up to 6 digits in length.

The account number a given bill is associated with.

bill_date

A valid date in YYYY-MM-DD format.

The date a given bill was created.

due

A monetary value, such as -$.05, 0.05, or -5.00

The amount remaining due on a given bill.

end_date

A valid date in YYYY-MM-DD format.

The end date of a date range for a given bill covering all invoices associated with the bill.

id

A valid id number (a positive integer).

The unique id of a given bill.

lineitem_groupsAn array of associative arrays containing
 
description

A string of text, containing no newlines or other control characters.

Description for a line item group.

end_date

A valid date in YYYY-MM-DD format.

The end of the date range the line item group currently being viewed covers.

line_itemsAn array of associative arrays containing
 
charged_amountA monetary value, such as -$.05, 0.05, or -5.00* Optional
end_date

A valid date in YYYY-MM-DD format.

The date the billing period was ended for this specific line item.

item_description

A string of text, containing no newlines or other control characters.

Description of the specific line item

quantity

A non-negative integer value (i.e. 0 and up).

The number of units being charged for on this line item.

* Optional
start_date

A valid date in YYYY-MM-DD format.

The date the billing period was started for this specific line item.

overdue

A boolean value (0 or 1).

Defines if this bill is considered overdue or not.

* Optional
start_date

A valid date in YYYY-MM-DD format.

The start of the date range the line item group currently being viewed covers.

subtotal

A monetary value, such as -$.05, 0.05, or -5.00

The sum total of all line items in a given line item group.

payments

An array of associative arrays containing

An array containing a list of payments associated with a bill. Each element of the array is an associative array containing the following fields:

 
account

A string of text, containing no newlines or other control characters.

The account the recorded payment was associated with.

amount

A monetary value, such as -$.05, 0.05, or -5.00

The amount the payment was recorded for.

paid_date

A valid date in YYYY-MM-DD format.

The date the payment was recorded on.

type

A string of text, containing no newlines or other control characters.

The type of payment received.

start_date

A valid date in YYYY-MM-DD format.

The start date of a date range for a given bill covering all invoices associated with the bill.

status

A single word, consisting of only letters, digits, hyphens, and underscores.

The status of a given bill (new, authorized, voided, refuneded, etc).

total

A monetary value, such as -$.05, 0.05, or -5.00

The total amount a bill is for after summing all the invoices on it.

type

A single word, consisting of only letters and digits.

Defines the payment method being used when a bill was created (ie, check or credit card).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.stormondemand.com/v1/Billing/Invoice/list

Description:

v1

Deprecated. This method has been moved to billing->bill->list

Returns a list of all the bills for the logged in account. Bills are created at your regular billing date, but are also created for one-off items like creating or cloning a server.

bleed

Returns a list of all the invoices for the logged in account.

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accnt

A valid account number, up to 6 digits in length.

The account number a given bill is associated with.

bill_date

A valid date in YYYY-MM-DD format.

The date a given bill was created.

due

A monetary value, such as -$.05, 0.05, or -5.00

The amount remaining due on a given bill.

end_date

A valid date in YYYY-MM-DD format.

The end date of a date range for a given bill covering all invoices associated with the bill.

id

A valid id number (a positive integer).

The unique id of a given bill.

payments

An array of associative arrays containing

An array containing a list of payments associated with a bill. Each element of the array is an associative array containing the following fields:

 
account

A string of text, containing no newlines or other control characters.

The account the recorded payment was associated with.

amount

A monetary value, such as -$.05, 0.05, or -5.00

The amount the payment was recorded for.

paid_date

A valid date in YYYY-MM-DD format.

The date the payment was recorded on.

type

A string of text, containing no newlines or other control characters.

The type of payment received.

start_date

A valid date in YYYY-MM-DD format.

The start date of a date range for a given bill covering all invoices associated with the bill.

status

A single word, consisting of only letters, digits, hyphens, and underscores.

The status of a given bill (new, authorized, voided, refuneded, etc).

total

A monetary value, such as -$.05, 0.05, or -5.00

The total amount a bill is for after summing all the invoices on it.

type

A single word, consisting of only letters and digits.

Defines the payment method being used when a bill was created (ie, check or credit card).

page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

next

URL:

https://api.stormondemand.com/v1/Billing/Invoice/next

Description:

Parameters:

No Values Defined

Returns:

FieldType
accnt

A valid account number, up to 6 digits in length.

The account number a given bill is associated with.

bill_date

A valid date in YYYY-MM-DD format.

The date a given bill was created.

due

A monetary value, such as -$.05, 0.05, or -5.00

The amount remaining due on a given bill.

end_date

A valid date in YYYY-MM-DD format.

The end date of a date range for a given bill covering all invoices associated with the bill.

lineitem_groupsAn array of associative arrays containing
 
description

A string of text, containing no newlines or other control characters.

Description for a line item group.

end_date

A valid date in YYYY-MM-DD format.

The end of the date range the line item group currently being viewed covers.

line_itemsAn array of associative arrays containing
 
charged_amountA monetary value, such as -$.05, 0.05, or -5.00* Optional
end_date

A valid date in YYYY-MM-DD format.

The date the billing period was ended for this specific line item.

item_description

A string of text, containing no newlines or other control characters.

Description of the specific line item

quantity

A non-negative integer value (i.e. 0 and up).

The number of units being charged for on this line item.

* Optional
start_date

A valid date in YYYY-MM-DD format.

The date the billing period was started for this specific line item.

overdue

A boolean value (0 or 1).

Defines if this bill is considered overdue or not.

* Optional
start_date

A valid date in YYYY-MM-DD format.

The start of the date range the line item group currently being viewed covers.

subtotal

A monetary value, such as -$.05, 0.05, or -5.00

The sum total of all line items in a given line item group.

payments

An array of associative arrays containing

An array containing a list of payments associated with a bill. Each element of the array is an associative array containing the following fields:

 
account

A string of text, containing no newlines or other control characters.

The account the recorded payment was associated with.

amount

A monetary value, such as -$.05, 0.05, or -5.00

The amount the payment was recorded for.

paid_date

A valid date in YYYY-MM-DD format.

The date the payment was recorded on.

type

A string of text, containing no newlines or other control characters.

The type of payment received.

start_date

A valid date in YYYY-MM-DD format.

The start date of a date range for a given bill covering all invoices associated with the bill.

total

A monetary value, such as -$.05, 0.05, or -5.00

The total amount a bill is for after summing all the invoices on it.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types