Sha256: 503f32675ec16a1f7e661d9288cc8b030f3d2333adb9a511cb4a8e0c7cfd1d83
Contents?: true
Size: 1.77 KB
Versions: 17
Compression:
Stored size: 1.77 KB
Contents
# Invoice
## Example Invoice Object
```
{
"id": 1,
"amount": 1.0,
"balance": 1.0,
"created_at": "2000-01-01T01:00:00Z",
"currency": "USD",
"download_uri": "https://url...",
"invoice_line_items": [
],
"method": "paypal",
"payment_line_items": [
],
"payment_reversed_at": "2000-01-01T01:00:00Z",
"payment_type": "",
"site_name": "My Site",
"type": "invoice",
"updated_at": "2000-01-01T01:00:00Z"
}
```
* `id` (int64): Line item Id
* `amount` (double): Line item amount
* `balance` (double): 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): Associated invoice line items
* `method` (string): Line item payment method
* `payment_line_items` (array): 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
* `updated_at` (date-time): Line item updated at
---
## List Invoices
```
Files::Invoice.list(
page: 1,
per_page: 1
)
```
### Parameters
* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
---
## Show Invoice
```
Files::Invoice.find(id)
```
### Parameters
* `id` (int64): Required - Invoice ID.
Version data entries
17 entries across 17 versions & 1 rubygems