Accounts-accountId-invoices-invoiceId-transactions:GET - Revision history

Mike.robski: 1 revision: Release 105

2015-04-03T17:50:00Z

1 revision: Release 105

Charles.rydholm: /* URI Parameters */

2015-03-23T14:14:35Z

URI Parameters

Mike.robski: 1 revision: Release 93

2014-05-08T07:34:16Z

1 revision: Release 93

Velimira.metodieva: /* GET /accounts/{accountId}/invoices/{invoiceID}/transctions */

2014-04-25T13:38:36Z

GET /accounts/{accountId}/invoices/{invoiceID}/transctions

New page

= GET /accounts/{accountId}/invoices/{invoiceId}/transctions =
Retrieves a list of transactions for a specific account and and invoice
__TOC__

== Request ==
<code>GET /accounts/{accountId}/invoices/{invoiceId}/transctions</code>

==== Request Parameters ====
; accountId - ''string''
: The user account owning the invoice
; invoiceId - ''string''
: The specific invoice for which the call will retrieve the list

=== URI Parameters ===

; filterFrom - ''date''
: Only transactions having startDate after the value of the parameter will be returned

; filterTo - ''date''
: Only transactions having startDate before the value of the parameter will be returned

; filterType - ''string''
: Only transactions having type matching the value of the parameter will be returned. Possible values are: 'charge', 'credit', 'discount'

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed values are '''amount''', '''from''', '''to'''

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''

== Response ==

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The account or invoice does not exist.

=== Response Body ===
<nowiki>
{
"list": [
{
"startDate": "{startDate}",
"endDate": {endDate},
"currency": {currency},
"amount": "{amount}",
"description": "{description}",
"date": "{date}",
"productSpecification": "{productSpecification}",
"serviceNumber": "{serviceNumber}",
"type": "{type}",
"number": "{number}"
}
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== Parameters ====
; startDate - ''string''
: Start date of transaction

; endDate - ''string''
: End date of transaction

; currency - ''string''
: Currency of transaction

; amount - ''string''
: Amount of transaction

; description - ''string''
: Description of transaction

; date - ''string''
: Date of transaction

; productSpecification - ''string''
: Product specification of transaction

; serviceNumber - ''string''
: Service number of transaction

; type - ''string''
: Type of transaction. Possible values are: 'charge', 'credit', 'discount'

; number - ''string''
: Number of transaction

; href - ''string''
: Link to other resources relevant to the mailboxes lists

; rel - ''string''
: Type of relation to the resource for the provided link

== Examples ==

=== Success scenario ===
'''Request'''
<nowiki>
GET /accounts/test-account/invoices/111111/transactions/
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"startDate": "2011-06-19",
"amount": 34.65,
"endDate": "2011-07-18",
"description": "Usage Fee test@test.com Rate Type = Exchange mailbox usage, Usage amount = 7",
"currency": "USD", "date": "2011-11-10",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test-acount-000001311f19185dc1df5d10000a000a000800",
"serviceNumber": "test-account-0000013128ec0f17330329ef000a000a000800",
"type": "charge",
"number": 101378490
},
...
],
"links": [
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=1&pageSize=100", "rel": "self"},
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=2&pageSize=100", "rel": "next"},
{"href": "{{APIBaseURL}}/accounts/test-account/invoices/111111/transactions?page=5&pageSize=100", "rel": "last"}
]
}
</nowiki>

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

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

@@ Line 1: / Line 1: @@
-= GET /accounts/{accountId}/invoices/{invoiceId}/transctions =
+= GET /accounts/{accountId}/invoices/{invoiceId}/transactions =
 Retrieves a list of transactions for a specific account and and invoice
 __TOC__
 == Request ==
-<code>GET /accounts/{accountId}/invoices/{invoiceId}/transctions</code>
+<code>GET /accounts/{accountId}/invoices/{invoiceId}/transactions</code>
 ==== Request Parameters ====
@@ Line 35: / Line 35: @@
 : The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''
 == Response ==
@@ Line 62: / Line 64: @@
              "serviceNumber": "{serviceNumber}",
              "type": "{type}",
-             "number": "{number}"
+             "number": "{number}",
+         }
      ],
@@ Line 104: / Line 107: @@
 ; number - ''string''
 : Number of transaction
 ; href - ''string''
@@ Line 132: / Line 138: @@
              "serviceNumber": "test-account-0000013128ec0f17330329ef000a000a000800",
              "type": "charge",
-             "number": 101378490
+             "number": 101378490,
        },
        ...
@@ Line 143: / Line 150: @@
+}
   </nowiki>
 == See also ==