CarbonAPI Documentation
API ReferenceExpense Categorisation

Get the results of a batch of transactions

Retrieve the contents of a categorisation batch, by batch id. For more information, see: Categorising Expenses Guide. For a guide on the taxonomy returned, see: Expense Categorisation Taxonomy.

GET
/transaction/batch/{batchId}
x-api-key<token>

In: header

Scope: api_key

Path Parameters

batchIdstring

Response Body

curl -X GET "https://api.aws-au.carbonapi.io/transaction/batch/string"
{
  "id": "string",
  "status": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "transactions": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "code": "I_FLIGHTS_AIR_TRAVEL",
      "confidence": 95.82,
      "potentialFactors": [
        {
          "code": "string",
          "similarity": 0
        }
      ],
      "co2e": 114.5,
      "emissionFactor": {
        "name": "Flights and Air Travel",
        "source": "CarbonAPI Example Factor Source",
        "sourceUrl": "https://www.carbonapi.io"
      }
    }
  ]
}