--- title: "List balance history" source_url: https://dev.digicert.com/certcentral-apis/services-api/finance/list-balance-history.html api_method: GET api_endpoint: "/services/v2/finance/balance-history" api_url: "https://www.digicert.com/services/v2/finance/balance-history" --- **GET** `https://www.digicert.com/services/v2/finance/balance-history` Use this endpoint to list balance adjustment history for your account. ## Example requests and responses **cURL** ```bash curl -X GET \ https://www.digicert.com/services/v2/finance/balance-history \ -H 'Content-Type: application/json' \ -H 'X-DC-DEVKEY: {{api_key}}' ``` **Python** ```python import requests url = "https://www.digicert.com/services/v2/finance/balance-history" payload = "" headers = { 'X-DC-DEVKEY': "{{api_key}}", 'Content-Type': "application/json" } response = requests.request("GET", url, data=payload, headers=headers) print(response.text) ``` **Go** ```go package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://www.digicert.com/services/v2/finance/balance-history" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-DC-DEVKEY", "{{api_key}}") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` **NodeJS** ```javascript var request = require("request"); var options = { method: 'GET', url: 'https://www.digicert.com/services/v2/finance/balance-history', headers: { 'Content-Type': 'application/json', 'X-DC-DEVKEY': '{{api_key}}' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` ## 200 OK ```json { "adjustments": [ { "id": "5335328", "container": { "id": 123456, "name": "Example Company", "is_active": true }, "debit": "750.00", "transaction_type": "Charge", "transaction_date": "2021-01-21 15:21:34", "balance_after": "8500.15", "currency": "USD" }, { "id": "5533001", "container": { "id": 123456, "name": "Example Company", "is_active": true }, "credit": "1000.00", "transaction_type": "Credit Card Deposit", "transaction_date": "2021-01-21 15:20:18", "balance_after": "9250.15", "expiration_date": "2022-01-21 00:00:00", "currency": "USD" }, ], "page": { "total": 2, "limit": 1000, "offset": 0 } } ``` ## Filters and URL query parameters This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see [Services API - Filters, sorting, and pagination parameters](https://dev.digicert.com/md/certcentral-apis/services-api.md#filters-sorting-and-pagination-parameters).
| Name | Req/Opt | Type | Description |
|---|---|---|---|
| container_id | optional* | int | ID of the container to get the balance history for. *Note: Required if there is more than one division in your account. |
filters[{{property_name}}] |
optional | string | Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
|
| sort | optional | string | Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus ( -).To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties:
|
| offset | optional | int | Index of the first result to include in the response. |
| limit | optional | int | Total number of results to include in the response. |
| Name | Type | Description |
|---|---|---|
| adjustments | array | List of adjustments. |
| .. id | string | Adjustment ID. |
| .. container | object | Details about the container that initiated the adjustment. |
| .. .. id | int | Container ID. |
| .. .. name | string | Name of the container. |
| .. .. is_active | bool | Active status of the container. |
| .. credit .. debit | string | If credit, the amount that was deposited into the account. If debit, the amount that was withdrawn from the account. |
| .. transaction_type | string | Type of adjustment that took place. Possible values: See transaction_type column in the Transaction types table below. |
| .. receipt_id | string | Receipt ID. Value of 0 is returned for all credit transactions. |
| .. transaction_date | string | Timestamp of the adjustment. Format: YYYY-MM-DD hh:mm:ss |
| .. balance_after | string | Account balance after adjustment took place. |
| .. expiration_date | string | For deposits, we return the date and time (UTC) the funds expire. Format:YYYY-MM-DD hh:mm:ss Not returned for adjustments that debit your account balance. |
| .. note | string | Note about the adjustment. |
| .. currency | string | Currency unit for the adjustment. |
| page | object | Details about results. Modified using URL query strings. |
| adjust_type | transaction_type |
|---|---|
| 1 | Charge |
| 4 | Sale from Account Balance |
| 8 | Credit Card Deposit |
| 9 | Wire Deposit |
| 11 | Deposit from Check |
| 12 | Deposit from PO |
| 13 | Credit for Commission Payment |
| 15 | Purchase Order Payment |
| 16 | Additional Name Purchase |
| 18 | Credit for a revoked certificate |
| 19 | Transfer of funds to another unit in the account |
| 20 | Transfer of funds from another unit in the account |
| 22 | Charge for Subaccount Order |
| 23 | Refund for Subaccount Order |
| 26 | Refund |
| 27 | Account Funds Expiration |
| 28 | Charge for unit order |
| 29 | Refund for unit order |