GET api/v1/admin/accounts/{id}/purchases?StartDate={StartDate}&EndDate={EndDate}&Paid={Paid}&SoftwareVersion={SoftwareVersion}&Type={Type}
This method retrieves the credit purchases for the given account id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The Id of the account |
globally unique identifier |
Required |
StartDate |
Start Date for purchases. |
date |
None. |
EndDate |
End Date for purchases. |
date |
None. |
Paid |
Displays only paid invoices. |
boolean |
None. |
SoftwareVersion |
Sets the software version for the XML Gateway. |
string |
None. |
Type |
Displays only certain types of purchases |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Purchase details for the given account id.
ResponseOfAccountPurchasesViewModelName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfAccountPurchasesViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": { "BillingDetails": { "Address": "sample string 1", "Company": "sample string 2", "Email": "sample string 3", "Mobile": "sample string 4", "Phone": "sample string 5" }, "IsPurchaseAllowed": true, "IsPurchaseOrderRequired": true, "PurchaseOrder": "sample string 3", "Purchases": [ { "Currency": "sample string 1", "DatePurchased": "2024-09-07T07:21:46.8844005+00:00", "GrossTotal": 3.1, "ID": "70975346-0ca5-4f09-a510-3eeb6265689b", "InvoiceNumber": 1, "NetTotal": 5.1, "Paid": true, "PurchaseType": "sample string 7", "Quantity": 8.1, "Tax": 9.1, "UnitPrice": 10.1 }, { "Currency": "sample string 1", "DatePurchased": "2024-09-07T07:21:46.8844005+00:00", "GrossTotal": 3.1, "ID": "70975346-0ca5-4f09-a510-3eeb6265689b", "InvoiceNumber": 1, "NetTotal": 5.1, "Paid": true, "PurchaseType": "sample string 7", "Quantity": 8.1, "Tax": 9.1, "UnitPrice": 10.1 } ] } } }
application/xml, text/xml
Sample:
<ResponseOfAccountPurchasesViewModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <BillingDetails> <Address>sample string 1</Address> <Company>sample string 2</Company> <Email>sample string 3</Email> <Mobile>sample string 4</Mobile> <Phone>sample string 5</Phone> </BillingDetails> <IsPurchaseAllowed>true</IsPurchaseAllowed> <IsPurchaseOrderRequired>true</IsPurchaseOrderRequired> <PurchaseOrder>sample string 3</PurchaseOrder> <Purchases> <Purchase> <Currency>sample string 1</Currency> <DatePurchased>2024-09-07T07:21:46.8844005+00:00</DatePurchased> <GrossTotal>3.1</GrossTotal> <ID>70975346-0ca5-4f09-a510-3eeb6265689b</ID> <InvoiceNumber>1</InvoiceNumber> <NetTotal>5.1</NetTotal> <Paid>true</Paid> <PurchaseType>sample string 7</PurchaseType> <Quantity>8.1</Quantity> <Tax>9.1</Tax> <UnitPrice>10.1</UnitPrice> </Purchase> <Purchase> <Currency>sample string 1</Currency> <DatePurchased>2024-09-07T07:21:46.8844005+00:00</DatePurchased> <GrossTotal>3.1</GrossTotal> <ID>70975346-0ca5-4f09-a510-3eeb6265689b</ID> <InvoiceNumber>1</InvoiceNumber> <NetTotal>5.1</NetTotal> <Paid>true</Paid> <PurchaseType>sample string 7</PurchaseType> <Quantity>8.1</Quantity> <Tax>9.1</Tax> <UnitPrice>10.1</UnitPrice> </Purchase> </Purchases> </Detail> </ResponseData> </ResponseOfAccountPurchasesViewModel>