Skip to main content

Loan

A loan, aka a checkout from a license.

type Loan implements Node {
  id: ID!
  entityId: ID!
  status: LoanStatus!
  borrowerId: ID!
  transactionId: ID!
  notify: URI
  updatedAt: DateTime
  expires: DateTime
  license: License
  events(
  first: Int
  after: String
): LoanEventConnection!
}

Fields​

Loan.id ● ID! non-null scalar​

The unique identifier for that loan. Should be an URI.

Loan.entityId ● ID! non-null scalar​

The id of the entity which the loan was linked to at creation. Comes from a fulfillment of the license's target or entityId attribute.

Loan.status ● LoanStatus! non-null enum​

The current status of the loan.

Loan.borrowerId ● ID! non-null scalar​

The client-supplied borrower identifier.

Loan.transactionId ● ID! non-null scalar​

The client-supplied transaction identifier.

Loan.notify ● URI scalar​

The URI on which the consumer wants to be notified of loan state changes.

Loan.updatedAt ● DateTime scalar​

The date and time at which the loan was last modified.

Loan.expires ● DateTime scalar​

The date and time at which the loan expires.

Loan.license ● License object​

Reference to the parent license.

Loan.events ● LoanEventConnection! non-null object​

The list of events that have occurred for this loan that might have changed its status.

Loan.events.first ● Int scalar​

Returns the first n elements from the list.

Loan.events.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Interfaces​

Node interface​

An object with an ID.

Returned by​

loan query ● loanByTransactionId query

Member of​

Activation object ● EndLoanPayload object ● LoanEdge object ● RegisterDeviceInLoanPayload object