Mike.robski: 1 revision: Release 95

2014-07-02T05:58:01Z

1 revision: Release 95

Velimira.metodieva: /* GET invoice */

2014-06-13T14:28:00Z

GET invoice

New page

= GET /accounts/''{accountId}''/invoces/''{invoiceId}'' =
Retrieves an individual invoice.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/invoces/''{invoiceId}''</code>

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

; invoiceId - ''string''
: The Id of the invoice.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}
; Accept - ''HTTP Accept header. Possible values are application/json, application/pdf. If omitted json will be returned'' [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]

== 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 or invoice was not found

=== Response Body ===
<nowiki>
{
"status": "{status}",
"currency": "{currency}",
"amount": "{amount}",
"amountDue": "{amountDue}",
"description": "{description}",
"links": [{
"href": "https://api.hostway.com/accounts/{accountId}/invoices/{invoiceId}/",
"rel": "self"
}],
"date": "{date}",
"statusName": "{statusName}",
"invoiceNumber": "{invoiceNumber}"
}
</nowiki>

==== Parameters ====
; 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 invoice ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/invoices/123456
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "invoice_paid",
"currency": "USD",
"amount": "1113.7500",
"amountDue": "0.0000",
"description": "Invoice #123456",
"links": [
{
"href": "{{APIBaseURL}}/accounts/test731993/invoices/123456/",
"rel": "self"
}
],
"date": "2011-11-10",
"statusName": "Invoice Paid",
"invoiceNumber": "123456"
}
</nowiki>

=== GET invoice PDF ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/invoices/123456
Accept: application/pdf
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
'''Content-Type : application/pdf'''
<nowiki>
%PDF-1.4
....
%%EOF
</nowiki>

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

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

Accounts-accountId-invoicesInfo-invoiceId:GET - Revision history

Mike.robski: 1 revision: Release 95

Velimira.metodieva: /* GET invoice */