Mike.robski: 1 revision: Release 93

2014-05-08T07:34:16Z

1 revision: Release 93

Angel.dinev at 12:05, 11 April 2014

2014-04-11T12:05:04Z

New page

= GET /accounts/''{accountId}''/invoices =
Retrieves a list of all account's invoices__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/invoices</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== Request Headers ===
{{Authorization}}

== 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 account Id was not found.

=== Response Body ===
<nowiki>
{
{
"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"
}]
}
</nowiki>

==== 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 the individual payment method

; links - ''list''
: [[Hypermedia]] for this resource. Links to self

== Examples ==

=== GET paginated invoices list call ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/invoices?page=1&pageSize=3
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"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=3",
"rel" : "self"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/invoices?page=2&pageSize=3",
"rel" : "next"
},
{
"href" : "{{APIBaseURL}}/accounts/test731993/invoices?page=4&pageSize=3",
"rel" : "last"
}]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-invoicesInfo:GET - Revision history

Mike.robski: 1 revision: Release 93

Angel.dinev at 12:05, 11 April 2014