Topics

Transaction History

Overview

Using the API, you can query the transaction history for your BoxBrownie.com account to return all credit transactions within a specified time frame. Credit amounts will be returned in your currency.

Retrieve Transaction History

GET /api/v2/account/getTransactionHistory

Endpoint: https://www.boxbrownie.com/api/v2/account/getTransactionHistory
HTTP Method: GET
Requires Authentication? Yes
Required Parameters:
Optional Parameters:
(string) startDate [datetime],
(string) endDate [datetime],
(int) page,
(int) maxResults,
(string) responseFormat [json|xml]

You may retrieve transaction history records for your BoxBrownie.com account using this endpoint. You may optionally specify a startDate and/or endDate supplied as a datetime string. Most datetime formats are supported.

For result sets that exceed the maxResults value, you may specify a page number to retrieve data from outside the initial result set.

Note: maxResults has a maximum value of 1000.

Example Response

URLhttps://www.boxbrownie.com/api/v2/account/getTransactionHistory

{
  "page": "1",
  "totalPages": "2",
  "transactionHistory": [
    {
      "transactionDate": "2024-03-19 15:11:34",
      "transactionAmount": "-7.00",
      "transactionDescription": "My Photo Editing",
      "transactionUser": "John Smith",
      "jobReference": "J888492240117"
    },
    {
      "transactionDate": "2024-03-19 15:10:33",
      "transactionAmount": "-7.00",
      "transactionDescription": "My Photo Editing",
      "transactionUser": "John Smith",
      "jobReference": "J274155156352"
    },
    {
      "transactionDate": "2024-03-18 12:27:20",
      "transactionAmount": "-67.00",
      "transactionDescription": "My Virtual Staging Job",
      "transactionUser": "John Smith",
      "jobReference": "VS649793368453"
    },
    ...
  ]
}

URLhttps://www.boxbrownie.com/api/v2/account/getTransactionHistory?responseFormat=xml

<?xml version="1.0"?>
<response>
    <page>1</page>
    <totalPages>2</totalPages>
    <transactionHistory>
        <transactionDate>2024-03-19 15:11:34</transactionDate>
        <transactionAmount>-7.00</transactionAmount>
        <transactionDescription>My Photo Editing</transactionDescription>
        <transactionUser>John Smith</transactionUser>
        <jobReference>J888492240117</jobReference>
    </transactionHistory>
    <transactionHistory>
        <transactionDate>2024-03-19 15:10:33</transactionDate>
        <transactionAmount>-7.00</transactionAmount>
        <transactionDescription>My Photo Editing</transactionDescription>
        <transactionUser>John Smith</transactionUser>
        <jobReference>J274155156352</jobReference>
    </transactionHistory>
    <transactionHistory>
        <transactionDate>2024-03-18 12:27:20</transactionDate>
        <transactionAmount>-67.00</transactionAmount>
        <transactionDescription>My Virtual Staging Job</transactionDescription>
        <transactionUser>John Smith</transactionUser>
        <jobReference>VS649793368453</jobReference>
    </transactionHistory>
    ...
</response>

URLhttps://www.boxbrownie.com/api/v2/account/getTransactionHistory?startDate=2024-03-19 00:00:00

{
  "page": "1",
  "totalPages": "1",
  "transactionHistory": [
    {
      "transactionDate": "2024-03-19 15:11:34",
      "transactionAmount": "-7.00",
      "transactionDescription": "My Photo Editing",
      "transactionUser": "John Smith",
      "jobReference": "J888492240117"
    },
    {
      "transactionDate": "2024-03-19 15:10:33",
      "transactionAmount": "-7.00",
      "transactionDescription": "My Photo Editing",
      "transactionUser": "John Smith",
      "jobReference": "J274155156352"
    }
  ]
}

URLhttps://www.boxbrownie.com/api/v2/account/getTransactionHistory?startDate=2024-03-19 00:00:00&responseFormat=xml

<?xml version="1.0"?>
<response>
    <page>1</page>
    <totalPages>1</totalPages>
    <transactionHistory>
        <transactionDate>2024-03-19 15:11:34</transactionDate>
        <transactionAmount>-7.00</transactionAmount>
        <transactionDescription>My Photo Editing</transactionDescription>
        <transactionUser>John Smith</transactionUser>
        <jobReference>J888492240117</jobReference>
    </transactionHistory>
    <transactionHistory>
        <transactionDate>2024-03-19 15:10:33</transactionDate>
        <transactionAmount>-7.00</transactionAmount>
        <transactionDescription>My Photo Editing</transactionDescription>
        <transactionUser>John Smith</transactionUser>
        <jobReference>J274155156352</jobReference>
    </transactionHistory>
</response>