DIdistru
Credit

Get a credit

Changed on

Get a single credit by its ID, scoped to your company. The response carries the credit's live computed status and remaining_balance alongside its stored fields. Returns 404 if no such credit exists for your company or it has been soft-deleted.

Required permission: credits_permissions_view. The authenticated user must also have access to the requested credit under their team restrictions, otherwise the request returns 403.

get/public/v1/credits/{id}

Request

  • Base URL
    https://app.distru.com
  • Auth
    HTTP bearer

Path parameters

idstring required

The credit's ID (as returned in the id field of a credit).

Response

A single credit

Example response

{
  "data": {
    "brand": {
      "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
      "name": "Retailer 1"
    },
    "company": {
      "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
      "name": "Retailer 1"
    },
    "credit_uses": [
      {
        "payment": {
          "company": {
            "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
            "name": "Retailer 1"
          }
        }
      }
    ],
    "payment": {
      "company": {
        "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
        "name": "Retailer 1"
      }
    },
    "return": {
      "company": {
        "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
        "name": "Retailer 1"
      }
    }
  }
}

Changes

  • e8b3a3d07ad5Revision changes
    • info

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

    • info

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

  • e8639f7dafedRevision changes
    • info

      added the optional property / to the response with the status