Accounts-accountId-invoicesInfo-filtered-status:GET
From Hostway API Documentation
GET /accounts/{accountId}/invoice?filterStatus={filterStatus}
Gets a list of account's invoices filtered by status
Contents |
Request
GET /accounts/{accountId}/invoices?filterStatus={filterStatus}
Parameters
- accountId - string
- The Id of the account.
- filterStatus - string
- Status of invoice. Possible values are: 'invoice_paid', 'invoice_unpaid', 'invoice_open'.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Status Code
- 200 OK
- Success
- 401 Unauthorized
- The supplied credentials are invalid or do not provide permissions for this operation.
- 403 Forbidden
- The user lacks the necessary permissions to access the resource
- 404 Not Found
- The accountId was not found.
Response Body
{
{
"list": [{
"status": "{status}",
"currency": "{currency}",
"amount": "{amount}",
"amountDue": "{amountDue}",
"description": "{description}",
"date": "{date}",
"statusName": "{statusName}",
"invoiceNumber": "{invoiceNumber}"
}],
"links" : [{
"href" : "https://api.hostway.com/accounts/{account_id}/invoices",
"rel" : "self"
}]
}
Parameters
- list - list
- A collection of dictionaries containing information about invoices
- status - string
- Status of invoice
- currency - string
- Currency of invoice
- ammount - string
- Amount of invoice
- amountDue - string
- Amount due of invoice
- description - string
- Description of invoice
- date - string
- Date of invoice
- statusName - string
- Status of invoice
- invoiceNumber - string
- Invoice number
- links - list
- Hypermedia for this resource. Links to self
Examples
GET paginated invoices list call
Request
GET {{APIBaseURL}}/accounts/test731993/invoices?filterStatus=invoice_paid&page=1&pageSize=5
Response
HTTP/1.1 200 OK
{
"list" : [ {
"status": "invoice_paid",
"currency": "USD",
"amount": "1023.7200",
"amountDue": "0.0000",
"description": "Invoice #SO-360704",
"date": "2011-04-19",
"statusName": "Invoice Paid",
"invoiceNumber": "SO-360704"
}],
"links" : [
{
"href" : "{{APIBaseURL}}/accounts/test731993/invoices?page=1&pageSize=5",
"rel" : "self"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/invoices?page=2&pageSize=5",
"rel" : "next"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/invoices?page=44&pageSize=5",
"rel" : "last"
}]
}
See also
