List 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 -X GET \
  https://www.digicert.com/services/v2/finance/balance-history \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
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)
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))

}
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

{
  "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.

NameReq/OptTypeDescription
container_idoptional*intID of the container to get the balance history for.
*Note: Required if there is more than one division in your account.
filters[{{property_name}}]optionalstringFilters 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:
sortoptionalstringSorts 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:
offsetoptionalintIndex of the first result to include in the response.
limitoptionalintTotal number of results to include in the response.

Response parameters

NameTypeDescription
adjustmentsarrayList of adjustments.
.. idstringAdjustment ID.
.. containerobjectDetails about the container that initiated the adjustment.
.. .. idintContainer ID.
.. .. namestringName of the container.
.. .. is_activeboolActive status of the container.
.. credit .. debitstringIf credit, the amount that was deposited into the account. If debit, the amount that was withdrawn from the account.
.. transaction_typestringType of adjustment that took place.
Possible values: See transaction_type column in the Transaction types table below.
.. receipt_idstringReceipt ID. Value of 0 is returned for all credit transactions.
.. transaction_datestringTimestamp of the adjustment.
Format:
YYYY-MM-DD hh:mm:ss
.. balance_afterstringAccount balance after adjustment took place.
.. expiration_datestringFor 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.
.. notestringNote about the adjustment.
.. currencystringCurrency unit for the adjustment.
pageobjectDetails about results. Modified using URL query strings.

Transaction types

adjust_typetransaction_type
1Charge
4Sale from Account Balance
8Credit Card Deposit
9Wire Deposit
11Deposit from Check
12Deposit from PO
13Credit for Commission Payment
15Purchase Order Payment
16Additional Name Purchase
18Credit for a revoked certificate
19Transfer of funds to another unit in the account
20Transfer of funds from another unit in the account
22Charge for Subaccount Order
23Refund for Subaccount Order
26Refund
27Account Funds Expiration
28Charge for unit order
29Refund for unit order