ISisometric

Create Transfer

Changed on

Transfer credits from specific batches, in whole or with splits. All credit batches must originate from the same supplier and be owned by the current organisation.

post/transfers

Request

  • Base URL
    https://api.isometric.com/registry/v0
  • URL
    https://api.isometric.com/registry/v0/transfers
  • Auth
    HTTP bearer

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Request body

from_organisation_idstring required

The ID of the organisation that is sending the credits. Typically this would be your own organisation ID.

to_organisation_idstring required

The ID of the organisation that will receive the credits.

supplier_idstring required

All credits in a transfer must originate from the same supplier.

notesstring nullable required

A publicly visible note stored with the credit transfer.

Example request

{
  "credit_batch_quantities": [
    {
      "credit_batch_id": "ctb_1DRBTYA8Q1S07CBY",
      "credit_quantity_kg": 1000
    }
  ],
  "from_organisation_id": "org_1GB56M1ST1S0GVNA",
  "to_organisation_id": "org_1GB56M1ST1S0GVNA",
  "supplier_id": "spl_1CC712KFS1S0YKPS",
  "notes": "Transferred with care."
}

Response

Successful Response

idstring required
transferred_atstring date-time required
notesstring nullable required

Example response

{
  "id": "tfr_1FJGWSY271S0QSMR",
  "from_organisation": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "to_organisation": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  }
}

Changes

  • f1623e0dc2e1Revision changes
    • info

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

    • info

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

  • 656267cf681cRevision changes
    • breaking

      the / response property's maxLength was increased from 36 to 37 for the response status

    • breaking

      the response property's maxLength was increased from 36 to 37 for the response status

    • breaking

      the / response property's maxLength was increased from 36 to 37 for the response status

    • info

      the // request property's maxLength was increased from 36 to 37

    • info

      the request property's maxLength was increased from 36 to 37

    • info

      the request property's maxLength was increased from 36 to 37

    • info

      the request property's maxLength was increased from 36 to 37