Skip to main content
GET
/
api
/
v1
/
credit_line_items
/
{id}
Get a credit line item
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/credit_line_items/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "credit_line_item",
    "attributes": {
      "created_at": "<string>",
      "updated_at": "<string>",
      "custom_fields": {},
      "transaction_date": "2023-12-25",
      "amount": 123,
      "description": "<string>",
      "category": "adjustment",
      "status": "active",
      "external_id": "EXT-12345",
      "term": "<string>",
      "comment": "<string>"
    },
    "relationships": {
      "profile": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "source": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.scholarlysoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: profile, source

Response

credit line item found

​
data
object
required