Get a credit

GET

/public/v1/credits/{id}

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.

Authorization

Bearer

headerAuthorizationBearer <token>

API token generated in Distru (Settings → Distru API). Send it on every request as Authorization: Bearer YOUR_API_TOKEN.

Path Parameters

id*string

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

Response Body

A single credit

*/*

response

A single credit wrapped in a data envelope

data?

Store credit held by a customer that can be applied toward what they owe. Credits can be issued manually or generated automatically (for example from a return or an invoice overpayment).

Example Request

curl -X GET 'https://app.distru.com/public/v1/credits/92b25701-5fd4-4d40-b6ce-141f06608ec0'

Example Request

curl -X GET 'https://app.distru.com/public/v1/credits/92b25701-5fd4-4d40-b6ce-141f06608ec0'

Example ResponseSchema

{
  "data": {
    "amount": "100",
    "brand": null,
    "canceled_datetime": null,
    "company": {
      "id": "00000000-0000-0000-0000-0000000001e2",
      "name": "Company 1347",
      "updated_datetime": "2026-10-13T15:03:30.042231Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "[email protected]",
      "full_name": "FirstName4156 LastName4157",
      "id": "00000000-0000-0000-0000-000000000820",
      "inserted_datetime": "2026-10-13T15:03:30.047710Z",
      "role": {
        "id": "00000000-0000-0000-0000-000000000863",
        "name": "Admin 2146"
      },
      "updated_datetime": "2026-10-13T15:03:30.047710Z"
    },
    "credit_number": "CRT-00000069",
    "credit_uses": [
      {
        "amount": "25",
        "credit": {
          "amount": "100",
          "credit_number": "CRT-00000069",
          "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",
          "source": "USER"
        },
        "id": "59a898b9-89b4-4607-80f7-1feb0b4caa68",
        "inserted_datetime": "2026-10-13T15:03:30.057792Z",
        "payment": {
          "amount": "10",
          "company": {
            "id": "00000000-0000-0000-0000-0000000001de",
            "name": "Company 1333",
            "updated_datetime": "2026-10-13T15:03:29.978597Z"
          },
          "credit_uses": [
            {
              "amount": "25",
              "credit": {
                "amount": "100",
                "credit_number": "CRT-00000069",
                "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",
                "source": "USER"
              },
              "id": "59a898b9-89b4-4607-80f7-1feb0b4caa68"
            }
          ],
          "description": null,
          "fully_paid_with_credits": false,
          "id": "00000000-0000-0000-0000-00000000002a",
          "inserted_datetime": "2026-10-13T15:03:30.004999Z",
          "invoice": {
            "id": "00000000-0000-0000-0000-00000000002c",
            "invoice_number": "Invoice #43",
            "status": "NOT_PAID",
            "total": "32.00"
          },
          "overpayment_credits": [],
          "payment_date": "2026-10-13T15:03:30.003314Z",
          "payment_datetime": "2026-10-13T15:03:30.003314Z",
          "payment_method": {
            "active": true,
            "deleted_at": null,
            "id": "00000000-0000-0000-0000-00000000003c",
            "inserted_datetime": "2026-10-13T15:03:30.002221Z",
            "name": "Payment Method 59",
            "qb_payment_method_id": null,
            "type": "CREDIT_CARD",
            "updated_datetime": "2026-10-13T15:03:30.002221Z"
          },
          "payment_number": "Payment #41",
          "payment_type": "INVOICE",
          "purchase": null,
          "quickbooks_deposit_account_id": null,
          "status": "POSTED",
          "updated_datetime": "2026-10-13T15:03:30.004999Z"
        }
      }
    ],
    "deleted_in_qbo": false,
    "external_note": "External note",
    "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",
    "inserted_datetime": "2026-10-13T15:03:30.051278Z",
    "internal_note": "Internal note",
    "original_amount": "150",
    "owner": null,
    "payment": null,
    "qb_credit_memo_id": null,
    "qb_payment_id": null,
    "qb_sync_status": null,
    "remaining_balance": "75",
    "return": null,
    "source": "USER",
    "status": "ACTIVE",
    "updated_datetime": "2026-10-13T15:03:30.055079Z"
  }
}

{  "data": {    "amount": "100",    "brand": null,    "canceled_datetime": null,    "company": {      "id": "00000000-0000-0000-0000-0000000001e2",      "name": "Company 1347",      "updated_datetime": "2026-10-13T15:03:30.042231Z"    },    "creator": {      "banned": false,      "deleted_at": null,      "email": "[email protected]",      "full_name": "FirstName4156 LastName4157",      "id": "00000000-0000-0000-0000-000000000820",      "inserted_datetime": "2026-10-13T15:03:30.047710Z",      "role": {        "id": "00000000-0000-0000-0000-000000000863",        "name": "Admin 2146"      },      "updated_datetime": "2026-10-13T15:03:30.047710Z"    },    "credit_number": "CRT-00000069",    "credit_uses": [      {        "amount": "25",        "credit": {          "amount": "100",          "credit_number": "CRT-00000069",          "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",          "source": "USER"        },        "id": "59a898b9-89b4-4607-80f7-1feb0b4caa68",        "inserted_datetime": "2026-10-13T15:03:30.057792Z",        "payment": {          "amount": "10",          "company": {            "id": "00000000-0000-0000-0000-0000000001de",            "name": "Company 1333",            "updated_datetime": "2026-10-13T15:03:29.978597Z"          },          "credit_uses": [            {              "amount": "25",              "credit": {                "amount": "100",                "credit_number": "CRT-00000069",                "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",                "source": "USER"              },              "id": "59a898b9-89b4-4607-80f7-1feb0b4caa68"            }          ],          "description": null,          "fully_paid_with_credits": false,          "id": "00000000-0000-0000-0000-00000000002a",          "inserted_datetime": "2026-10-13T15:03:30.004999Z",          "invoice": {            "id": "00000000-0000-0000-0000-00000000002c",            "invoice_number": "Invoice #43",            "status": "NOT_PAID",            "total": "32.00"          },          "overpayment_credits": [],          "payment_date": "2026-10-13T15:03:30.003314Z",          "payment_datetime": "2026-10-13T15:03:30.003314Z",          "payment_method": {            "active": true,            "deleted_at": null,            "id": "00000000-0000-0000-0000-00000000003c",            "inserted_datetime": "2026-10-13T15:03:30.002221Z",            "name": "Payment Method 59",            "qb_payment_method_id": null,            "type": "CREDIT_CARD",            "updated_datetime": "2026-10-13T15:03:30.002221Z"          },          "payment_number": "Payment #41",          "payment_type": "INVOICE",          "purchase": null,          "quickbooks_deposit_account_id": null,          "status": "POSTED",          "updated_datetime": "2026-10-13T15:03:30.004999Z"        }      }    ],    "deleted_in_qbo": false,    "external_note": "External note",    "id": "99295fb2-0432-4346-9566-1fda6f85c1ca",    "inserted_datetime": "2026-10-13T15:03:30.051278Z",    "internal_note": "Internal note",    "original_amount": "150",    "owner": null,    "payment": null,    "qb_credit_memo_id": null,    "qb_payment_id": null,    "qb_sync_status": null,    "remaining_balance": "75",    "return": null,    "source": "USER",    "status": "ACTIVE",    "updated_datetime": "2026-10-13T15:03:30.055079Z"  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body