ISisometric

Organisation Credit Balance

Changed on

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

Request

  • Base URL
    https://api.isometric.com/registry/v0
  • URL
    https://api.isometric.com/registry/v0/organisations/{id}/credit_balance
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:org_1GB56M1ST1S0GVNA

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Response

Successful Response

Example response

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

Changes

  • 385518aba17dRevision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

  • f1623e0dc2e1Revision changes
    • info

      for the path request parameter id, the type was generalized from string to no type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status