Skip to main content
PATCH
/
api
/
v1
/
credits
/
line_items
/
{id}
Update a credit line item
curl --request PATCH \
  --url https://api.scholarlysoftware.com/api/v1/credits/line_items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "credit_line_item",
    "attributes": {
      "transaction_date": "2023-12-25",
      "amount": 123,
      "description": "<string>",
      "category": "adjustment",
      "status": "active",
      "external_id": "EXT-12345",
      "term": "<string>",
      "comment": "<string>"
    },
    "relationships": {
      "source": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}
'
{
  "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"
        }
      }
    }
  }
}

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

Credit Line Item UUID

Body

application/vnd.api+json
data
object
required

Response

credit line item updated with custom_fields overwriting existing value

data
object
required