Skip to main content
GET
/
api
/
v1
/
profiles
/
{profile_id}
/
credits
/
line_items
List line items for a profile
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{profile_id}/credits/line_items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "credit_line_item",
      "attributes": {
        "transaction_date": "2023-12-25",
        "amount": 123,
        "description": "<string>",
        "status": "active",
        "custom_fields": {},
        "category": "adjustment",
        "external_id": "EXT-12345",
        "term": "<string>",
        "comment": "<string>",
        "created_at": "<string>",
        "updated_at": "<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"
          }
        }
      }
    }
  ],
  "meta": {
    "page": {
      "size": 123
    },
    "total": 123
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}

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

profile_id
string
required

Query Parameters

include
string

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

sort
string

Sort order. Prefix with - for descending. Allowed: transaction_date, amount, created_at, updated_at

filter[key]
string

Filter results. Available filters: category, status, profile_id. Custom fields can also be filtered with filter[custom_fields.field_name].

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

line items found

data
object[]
required
meta
object