Organisation Credit Balance

Information about active and retired credits owned by the given organisation.

Includes total balances as well as balances split by orders, projects and suppliers.

GET /organisations/{id}/credit_balance

Organisation Credit Balance

cURL

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

200

{
  "order_balances": [
    {
      "order_id": "ord_1FAN3S3WV1S0B842",
      "total": {
        "active_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        },
        "retired_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        }
      }
    }
  ],
  "project_balances": [
    {
      "project_id": "prj_1CTWZQGKE1S0VAXA",
      "total": {
        "active_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        },
        "retired_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        }
      }
    }
  ],
  "supplier_balances": [
    {
      "supplier_id": "spl_1CC712KFS1S0YKPS",
      "total": {
        "active_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        },
        "retired_credits_total": {
          "credit_kgs": 123,
          "credits": 123
        }
      }
    }
  ],
  "total": {
    "active_credits_total": {
      "credit_kgs": 123,
      "credits": 123
    },
    "retired_credits_total": {
      "credit_kgs": 123,
      "credits": 123
    }
  }
}

Authorizations

Authorization · string · header · required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret · string · required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id · string · required

Required string length: 20 - 37

Examples:

"org_1GB56M1ST1S0GVNA"

"org_1CP8EQDNQSBXTMR2"

Response

200

application/json

Successful Response

order_balances · OrderCreditBalance · object[] · required

Show child attributes

project_balances · ProjectCreditBalance · object[] · required

Show child attributes

supplier_balances · SupplierCreditBalance · object[] · required

Show child attributes

total · CreditBalance · object · required

Show child attributes