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
curl -X GET \
  https://www.digicert.com/services/v2/finance/balance-history \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
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
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
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": "5",
      "container": {
        "id": 11223,
        "name": "Example Division",
        "is_active": true
      },
      "credit": "195.00",
      "transaction_type": "Credit",
      "receipt_id": "0",
      "transaction_date": "2018-10-18 08:47:53",
      "balance_after": "441.00",
      "note": "Payment for invoice #100001"
    },
    {
      "id": "4",
      "container": {
        "id": 11223,
        "name": "Example Division",
        "is_active": true
      },
      "credit": "98.00",
      "transaction_type": "Credit",
      "receipt_id": "0",
      "transaction_date": "2018-10-18 08:47:53",
      "balance_after": "246.00",
      "note": "Payment for invoice #100006"
    },
    {
      "id": "3",
      "container": {
        "id": 11223,
        "name": "Example Division",
        "is_active": true
      },
      "debit": "295.00",
      "transaction_type": "Sale from Account Balance",
      "receipt_id": "121214",
      "transaction_date": "2018-09-04 12:02:39",
      "balance_after": "148.00",
      "order_id": "12346",
      "note": "Auto-debit: enterprise order from account balance"
    },
    {
      "id": "2",
      "container": {
        "id": 11223,
        "name": "Example Division",
        "is_active": true
      },
      "debit": "157.00",
      "transaction_type": "Sale from Account Balance",
      "receipt_id": "121213",
      "transaction_date": "2018-09-04 12:02:06",
      "balance_after": "443.00",
      "order_id": "12345",
      "note": "Auto-debit: enterprise order from account balance"
    },
    {
      "id": "1",
      "container": {
        "id": 11223,
        "name": "Example Division",
        "is_active": true
      },
      "credit": "600.00",
      "transaction_type": "Credit",
      "receipt_id": "0",
      "transaction_date": "2018-08-15 09:21:53",
      "balance_after": "600.00",
      "note": "Initial deposit for account."
    },
  ],
  "page": {
    "total": 4,
    "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.

Name Req/Opt Type Description
container_id optional* int ID of the container to get the balance history for.
*Required if there is more than one division in your account.
filter[{{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:
  • filters[container_id]
  • filters[adjust_type] – Filters by transaction_type. For adjust_type to transaction_type mapping, see Transaction types.
  • filters[transaction_date]
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:
  • id
  • credit
  • debit
  • transaction_type
  • receipt_id
  • transaction_date
  • balance_after
  • order_id
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.

Response parameters

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: Credit, Sale from Account Balance
.. 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.
.. note string Note about the adjustment.
page object Details about results.
Modified using URL query strings.

Transaction types

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