CaseHub API Reference

API Endpoints

https://api.casehub.dk/graphql

Headers

Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

`accountsReport`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an AccountsReportConfig

Arguments

Name	Description
`portfolioId` - `String!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query accountsReport(
  $portfolioId: String!,
  $org: Org!,
  $org: Org!
) {
  accountsReport(
    portfolioId: $portfolioId,
    org: $org,
    org: $org
  ) {
    portfolioId
    columns {
      columnTitle
      columns {
        ... on AccountsReportConfigCostColumn {
          ...AccountsReportConfigCostColumnFragment
        }
        ... on AccountsReportConfigAccountSumColumn {
          ...AccountsReportConfigAccountSumColumnFragment
        }
      }
    }
  }
}

Variables

{
  "portfolioId": "abc123",
  "org": "acme"
}

Response

{
  "data": {
    "accountsReport": {
      "portfolioId": "xyz789",
      "columns": [AccountsReportConfigColumnGroup]
    }
  }
}

Queries

`accountsReportExport`

Description

The following permissions are required: One of the following:

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')
All of the following:
- entityIds must be a non-empty array
- the subject 'org' (derived from the argument 'org') must have the 'org' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')
- the subject 'user' (derived from the current caller's auth) must have the 'dealer_reader' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')

Response

Returns a Uri!

Arguments

Name	Description
`bound` - `YearMonth`
`portfolioId` - `String!`
`expirationStatus` - `LoanAndLeaseExpirationStatus`	A filter that determines if the search should only return contracts with the specified expiration status
`regTaxType` - `LoandAndLeaseRegTaxType`	A filter that determines if the search should only return contracts with the specified reg tax type
`warningType` - `LoandAndLeaseWarningType`	A filter that determines if the search should only return contracts with the specified warning on them
`hasWarning` - `Boolean!`	A filter that determines if the search should only return contracts with warnings on them. Default = `false`
`contractStatus` - `LoanAndLeaseContractStatus`	An optional contract status to filter by
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`

Example

Query

query accountsReportExport(
  $bound: YearMonth,
  $portfolioId: String!,
  $expirationStatus: LoanAndLeaseExpirationStatus,
  $regTaxType: LoandAndLeaseRegTaxType,
  $warningType: LoandAndLeaseWarningType,
  $hasWarning: Boolean!,
  $contractStatus: LoanAndLeaseContractStatus,
  $reverseSearch: String,
  $search: String,
  $org: Org!,
  $entityIds: [UUID!],
  $org: Org!,
  $entityIds: [UUID!]
) {
  accountsReportExport(
    bound: $bound,
    portfolioId: $portfolioId,
    expirationStatus: $expirationStatus,
    regTaxType: $regTaxType,
    warningType: $warningType,
    hasWarning: $hasWarning,
    contractStatus: $contractStatus,
    reverseSearch: $reverseSearch,
    search: $search,
    org: $org,
    entityIds: $entityIds,
    org: $org,
    entityIds: $entityIds
  )
}

Variables

{
  "bound": "2007-12",
  "portfolioId": "abc123",
  "expirationStatus": "PENDING_CUSTOMER",
  "regTaxType": "PROPORTIONATE",
  "warningType": "ANY",
  "hasWarning": false,
  "contractStatus": "DRAFT",
  "reverseSearch": null,
  "search": "abc123",
  "org": "acme",
  "entityIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Response

{
  "data": {
    "accountsReportExport": "https://domain.com/resource"
  }
}

Queries

`bookingReport`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Uri!

Arguments

Name	Description
`portfolioId` - `[String!]!`	Empty portfolioId will generate the report for all portfolios. Default = `[]`
`bookingDate` - `LocalDate!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query bookingReport(
  $portfolioId: [String!]!,
  $bookingDate: LocalDate!,
  $org: Org!,
  $org: Org!
) {
  bookingReport(
    portfolioId: $portfolioId,
    bookingDate: $bookingDate,
    org: $org,
    org: $org
  )
}

Variables

{
  "portfolioId": [""],
  "bookingDate": "2020-07-19",
  "org": "acme"
}

Response

{
  "data": {
    "bookingReport": "https://domain.com/resource"
  }
}

Queries

`creditlinkCaseByExternalId`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCase

Arguments

Name	Description
`externalId` - `ExternalId!`	The user caller provided id that the entity relates to, this us ordinarily used to reconnect entities in the system with a user system.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkCaseByExternalId(
  $externalId: ExternalId!,
  $org: Org!,
  $org: Org!
) {
  creditlinkCaseByExternalId(
    externalId: $externalId,
    org: $org,
    org: $org
  ) {
    caseId
    externalId
    dealerName
    assetName
    monthlyPayment
    psd2Provider
    sendLink
    comments {
      text
      author
      user {
        ...UserFragment
      }
    }
    approverDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    debtorDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    computed {
      income {
        ...CreditlinkDisposableIncomeIncomeFragment
      }
      home {
        ...CreditlinkDisposableIncomeHomeFragment
      }
      vehicle {
        ...CreditlinkDisposableIncomeVehicleFragment
      }
      misc {
        ...CreditlinkDisposableIncomeMiscFragment
      }
    }
    status
    primaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    secondaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    other {
      ... on CreditlinkPerson {
        ...CreditlinkPersonFragment
      }
      ... on CreditlinkCompany {
        ...CreditlinkCompanyFragment
      }
    }
    retention
  }
}

Variables

{
  "externalId": "0110293",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkCaseByExternalId": {
      "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
      "externalId": "0110293",
      "dealerName": "xyz789",
      "assetName": "xyz789",
      "monthlyPayment": "28391719239482739937.1939459927192",
      "psd2Provider": "NORDIGEN",
      "sendLink": true,
      "comments": [CreditlinkComment],
      "approverDisposableIncome": CreditlinkUserDisposableIncome,
      "debtorDisposableIncome": CreditlinkUserDisposableIncome,
      "computed": CreditlinkDisposableIncome,
      "status": "OPEN",
      "primaryDebtor": CreditlinkPerson,
      "secondaryDebtor": CreditlinkPerson,
      "other": [CreditlinkPerson],
      "retention": 1654109791
    }
  }
}

Queries

`creditlinkCaseForDebtor`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCase

Arguments

Name	Description
`code` - `UUID!`	The debtor link code
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkCaseForDebtor(
  $code: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkCaseForDebtor(
    code: $code,
    org: $org,
    org: $org
  ) {
    caseId
    externalId
    dealerName
    assetName
    monthlyPayment
    psd2Provider
    sendLink
    comments {
      text
      author
      user {
        ...UserFragment
      }
    }
    approverDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    debtorDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    computed {
      income {
        ...CreditlinkDisposableIncomeIncomeFragment
      }
      home {
        ...CreditlinkDisposableIncomeHomeFragment
      }
      vehicle {
        ...CreditlinkDisposableIncomeVehicleFragment
      }
      misc {
        ...CreditlinkDisposableIncomeMiscFragment
      }
    }
    status
    primaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    secondaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    other {
      ... on CreditlinkPerson {
        ...CreditlinkPersonFragment
      }
      ... on CreditlinkCompany {
        ...CreditlinkCompanyFragment
      }
    }
    retention
  }
}

Variables

{
  "code": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkCaseForDebtor": {
      "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
      "externalId": "0110293",
      "dealerName": "abc123",
      "assetName": "abc123",
      "monthlyPayment": "28391719239482739937.1939459927192",
      "psd2Provider": "NORDIGEN",
      "sendLink": true,
      "comments": [CreditlinkComment],
      "approverDisposableIncome": CreditlinkUserDisposableIncome,
      "debtorDisposableIncome": CreditlinkUserDisposableIncome,
      "computed": CreditlinkDisposableIncome,
      "status": "OPEN",
      "primaryDebtor": CreditlinkPerson,
      "secondaryDebtor": CreditlinkPerson,
      "other": [CreditlinkPerson],
      "retention": 1654109791
    }
  }
}

Queries

`creditlinkClientConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkClientConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkClientConfig(
  $org: Org!,
  $org: Org!
) {
  creditlinkClientConfig(
    org: $org,
    org: $org
  ) {
    leasingIntroText
    loanIntroText
    privacyPolicyLink
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "creditlinkClientConfig": {
      "leasingIntroText": "xyz789",
      "loanIntroText": "abc123",
      "privacyPolicyLink": "xyz789"
    }
  }
}

Queries

`creditlinkCreditroGetCaseData`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCreditroCaseData

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkCreditroGetCaseData(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkCreditroGetCaseData(
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    status {
      ... on CreditlinkCreditroCaseStatusSuccess {
        ...CreditlinkCreditroCaseStatusSuccessFragment
      }
      ... on CreditlinkCreditroCaseStatusFailure {
        ...CreditlinkCreditroCaseStatusFailureFragment
      }
      ... on CreditlinkCreditroCaseStatusPreRequest {
        ...CreditlinkCreditroCaseStatusPreRequestFragment
      }
      ... on CreditlinkCreditroCaseStatusPending {
        ...CreditlinkCreditroCaseStatusPendingFragment
      }
    }
  }
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkCreditroGetCaseData": {
      "status": CreditlinkCreditroCaseStatusSuccess
    }
  }
}

Queries

`creditlinkCreditroGetConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCreditroConfigOut

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkCreditroGetConfig(
  $org: Org!,
  $org: Org!
) {
  creditlinkCreditroGetConfig(
    org: $org,
    org: $org
  ) {
    enabled
    customerTypeId
    customerServiceId
    clientManagerEmail
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "creditlinkCreditroGetConfig": {
      "enabled": true,
      "customerTypeId": "xyz789",
      "customerServiceId": "xyz789",
      "clientManagerEmail": "john@gmail.com"
    }
  }
}

Queries

`creditlinkGetPersonAddress`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [CreditlinkPersonAddressResponse!]!

Arguments

Name	Description
`cpr` - `Cpr!`	The CPR of the person to query for
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkGetPersonAddress(
  $cpr: Cpr!,
  $org: Org!,
  $org: Org!
) {
  creditlinkGetPersonAddress(
    cpr: $cpr,
    org: $org,
    org: $org
  ) {
    ... on CreditlinkPersonAddressError {
      message
    }
    ... on CreditlinkPersonAddressSuccess {
      name
      cpr
      address
      postalCode
      city
    }
  }
}

Variables

{
  "cpr": "0810972032",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkGetPersonAddress": [
      CreditlinkPersonAddressError
    ]
  }
}

Queries

`creditlinkMonthioGetCaseData`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkMonthioCaseData

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkMonthioGetCaseData(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkMonthioGetCaseData(
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    status {
      ... on CreditlinkMonthioCaseStatusSuccess {
        ...CreditlinkMonthioCaseStatusSuccessFragment
      }
      ... on CreditlinkMonthioCaseStatusFailure {
        ...CreditlinkMonthioCaseStatusFailureFragment
      }
      ... on CreditlinkMonthioCaseStatusPreRequest {
        ...CreditlinkMonthioCaseStatusPreRequestFragment
      }
      ... on CreditlinkMonthioCaseStatusPending {
        ...CreditlinkMonthioCaseStatusPendingFragment
      }
    }
  }
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkMonthioGetCaseData": {
      "status": CreditlinkMonthioCaseStatusSuccess
    }
  }
}

Queries

`creditlinkMonthioGetConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkMonthioConfigOut

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkMonthioGetConfig(
  $org: Org!,
  $org: Org!
) {
  creditlinkMonthioGetConfig(
    org: $org,
    org: $org
  ) {
    enabled
    smartCheckConfigurationId
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "creditlinkMonthioGetConfig": {
      "enabled": true,
      "smartCheckConfigurationId": 123
    }
  }
}

Queries

`creditlinkNotificationConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkNotificationConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkNotificationConfig(
  $org: Org!,
  $org: Org!
) {
  creditlinkNotificationConfig(
    org: $org,
    org: $org
  ) {
    mailSenderMail
    smsSenderName
    mailTemplatePlaintext
    mailTemplateHtml
    smsTemplate
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "creditlinkNotificationConfig": {
      "mailSenderMail": "john@gmail.com",
      "smsSenderName": "abc123",
      "mailTemplatePlaintext": "xyz789",
      "mailTemplateHtml": "xyz789",
      "smsTemplate": "xyz789"
    }
  }
}

Queries

`creditlinkReport`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a DisplayableResource!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query creditlinkReport(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkReport(
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    resource
    contentType
    thumbnail
  }
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkReport": {
      "resource": "https://domain.com/resource",
      "contentType": "abc123",
      "thumbnail": "https://domain.com/resource"
    }
  }
}

Queries

`cvrCompanyData`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [CvrData!]!

Arguments

Name	Description
`tail` - `[Cvr!]!`	Default = `[]`
`head` - `Cvr!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query cvrCompanyData(
  $tail: [Cvr!]!,
  $head: Cvr!,
  $org: Org!,
  $org: Org!
) {
  cvrCompanyData(
    tail: $tail,
    head: $head,
    org: $org,
    org: $org
  ) {
    name
    cvr
    address
    postalCode
    city
    district
    companyCreationDate
    companyType
    bindingAgreement
    management {
      participantType
      name
      address
      postalCode
      participantFunction
      city
      district
      ownershipPercentage
    }
    boardMembers {
      participantType
      name
      address
      postalCode
      participantFunction
      city
      district
      ownershipPercentage
    }
    owners {
      participantType
      name
      address
      postalCode
      participantFunction
      city
      district
      ownershipPercentage
    }
    participants {
      participantType
      name
      address
      postalCode
      participantFunction
      city
      district
      ownershipPercentage
    }
  }
}

Variables

{
  "tail": [""],
  "head": "35890270",
  "org": "acme"
}

Response

{
  "data": {
    "cvrCompanyData": [
      {
        "name": "xyz789",
        "cvr": "35890270",
        "address": "xyz789",
        "postalCode": "abc123",
        "city": "abc123",
        "district": "xyz789",
        "companyCreationDate": "2020-07-19",
        "companyType": "xyz789",
        "bindingAgreement": "abc123",
        "management": [CvrParticipant],
        "boardMembers": [CvrParticipant],
        "owners": [CvrParticipant],
        "participants": [CvrParticipant]
      }
    ]
  }
}

Queries

`cvrFreeTextSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [CvrSearchResult!]!

Arguments

Name	Description
`searchQuery` - `String!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query cvrFreeTextSearch(
  $searchQuery: String!,
  $org: Org!,
  $org: Org!
) {
  cvrFreeTextSearch(
    searchQuery: $searchQuery,
    org: $org,
    org: $org
  ) {
    cvr
    name
  }
}

Variables

{
  "searchQuery": "abc123",
  "org": "acme"
}

Response

{
  "data": {
    "cvrFreeTextSearch": [
      {
        "cvr": "35890270",
        "name": "xyz789"
      }
    ]
  }
}

Queries

`dmrEntries`

Description

May return multiple entries for each VIN. The entries are from DMR.

Response

Returns [DmrEntry!]!

Arguments

Name	Description
`regNos` - `[String!]!`	Default = `[]`
`vins` - `[String!]!`	Default = `[]`

Example

Query

query dmrEntries(
  $regNos: [String!]!,
  $vins: [String!]!
) {
  dmrEntries(
    regNos: $regNos,
    vins: $vins
  ) {
    ident
    typeNumber
    typeName
    usageNumber
    usageName
    leasingValidFrom
    leasingValidTo
    status
    statusDate
    firstRegistrationDate
    vin
    makeNumber
    makeName
    modelNumber
    modelName
    variantNumber
    variantName
    versionNumber
    versionName
    colorNumber
    colorName
    propulsionNumber
    propulsionName
    kmPerLiter
    co2Emission
    registrationStatus
    registrationStatusDate
    registrationNumber
  }
}

Variables

{"regNos": [""], "vins": [""]}

Response

{
  "data": {
    "dmrEntries": [
      {
        "ident": "xyz789",
        "typeNumber": 9223372036854776000,
        "typeName": "xyz789",
        "usageNumber": 9223372036854776000,
        "usageName": "xyz789",
        "leasingValidFrom": "2020-07-19",
        "leasingValidTo": "2020-07-19",
        "status": "xyz789",
        "statusDate": 1654109791,
        "firstRegistrationDate": "2020-07-19",
        "vin": "abc123",
        "makeNumber": 9223372036854776000,
        "makeName": "xyz789",
        "modelNumber": 9223372036854776000,
        "modelName": "abc123",
        "variantNumber": 9223372036854776000,
        "variantName": "abc123",
        "versionNumber": 9223372036854776000,
        "versionName": "abc123",
        "colorNumber": 9223372036854776000,
        "colorName": "xyz789",
        "propulsionNumber": 9223372036854776000,
        "propulsionName": "xyz789",
        "kmPerLiter": Double,
        "co2Emission": Double,
        "registrationStatus": "xyz789",
        "registrationStatusDate": 1654109791,
        "registrationNumber": "abc123"
      }
    ]
  }
}

Queries

`ephemeralUploadUrl`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an EphemeralUrls!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query ephemeralUploadUrl(
  $org: Org!,
  $org: Org!
) {
  ephemeralUploadUrl(
    org: $org,
    org: $org
  ) {
    uploadUrl
    downloadUrl
    reference
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "ephemeralUploadUrl": {
      "uploadUrl": "https://domain.com/resource",
      "downloadUrl": "https://domain.com/resource",
      "reference": EphemeralReference
    }
  }
}

Queries

`eskatConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an EskatConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query eskatConfig(
  $org: Org!,
  $org: Org!
) {
  eskatConfig(
    org: $org,
    org: $org
  ) {
    cvr
    apiId
    leasingConsentCode
    loanConsentCode
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "eskatConfig": {
      "cvr": "35890270",
      "apiId": "xyz789",
      "leasingConsentCode": "abc123",
      "loanConsentCode": "abc123"
    }
  }
}

Queries

`eskatData`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an ESkatDerivedData!

Arguments

Name	Description
`lamport` - `Lamport!`	A version of the data.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query eskatData(
  $lamport: Lamport!,
  $org: Org!,
  $org: Org!
) {
  eskatData(
    lamport: $lamport,
    org: $org,
    org: $org
  ) {
    summary {
      debt {
        ...ESkatDebtFragment
      }
      income {
        ...ESkatIncomeResultFragment
      }
      annualTaxReturn {
        ...ESkatAnnualTaxReturnFragment
      }
      disposableIncome {
        ...ESkatDIFragment
      }
      totals {
        ...ESkatTotalsFragment
      }
    }
    pdf
    raw
  }
}

Variables

{"lamport": 42, "org": "acme"}

Response

{
  "data": {
    "eskatData": {
      "summary": ESkatSummary,
      "pdf": "https://domain.com/resource",
      "raw": "https://domain.com/resource"
    }
  }
}

Queries

`eskatToken`

Description

the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a String!

Arguments

Name	Description
`completionUrl` - `Uri!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

query eskatToken(
  $completionUrl: Uri!,
  $org: Org!,
  $caseId: UUID!
) {
  eskatToken(
    completionUrl: $completionUrl,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "completionUrl": "https://domain.com/resource",
  "org": "acme",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Response

{"data": {"eskatToken": "xyz789"}}

Queries

`loanAndLeaseCollectionPeriod`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseCollectionPeriod!

Arguments

Name	Description
`extended` - `Boolean!`
`org` - `Org!`	The organization which the action relates to.

Example

Query

query loanAndLeaseCollectionPeriod(
  $extended: Boolean!,
  $org: Org!
) {
  loanAndLeaseCollectionPeriod(
    extended: $extended,
    org: $org
  ) {
    now
    period
    minBankDay
    maxBankDay
    deadline
  }
}

Variables

{"extended": true, "org": "acme"}

Response

{
  "data": {
    "loanAndLeaseCollectionPeriod": {
      "now": 1654109791,
      "period": "2007-12",
      "minBankDay": "2020-07-19",
      "maxBankDay": "2020-07-19",
      "deadline": 1654109791
    }
  }
}

Queries

`loanAndLeaseContractSearchExport`

Description

The following permissions are required: One of the following:

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')
All of the following:
- entityIds must be a non-empty array
- the subject 'org' (derived from the argument 'org') must have the 'org' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')
- the subject 'user' (derived from the current caller's auth) must have the 'dealer_reader' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')

Response

Returns a Uri!

Arguments

Name	Description
`portfolioIds` - `[String!]`
`expirationStatus` - `LoanAndLeaseExpirationStatus`	A filter that determines if the search should only return contracts with the specified expiration status
`regTaxType` - `LoandAndLeaseRegTaxType`	A filter that determines if the search should only return contracts with the specified reg tax type
`warningType` - `LoandAndLeaseWarningType`	A filter that determines if the search should only return contracts with the specified warning on them
`hasWarning` - `Boolean!`	A filter that determines if the search should only return contracts with warnings on them. Default = `false`
`contractStatus` - `LoanAndLeaseContractStatus`	An optional contract status to filter by
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`

Example

Query

query loanAndLeaseContractSearchExport(
  $portfolioIds: [String!],
  $expirationStatus: LoanAndLeaseExpirationStatus,
  $regTaxType: LoandAndLeaseRegTaxType,
  $warningType: LoandAndLeaseWarningType,
  $hasWarning: Boolean!,
  $contractStatus: LoanAndLeaseContractStatus,
  $reverseSearch: String,
  $search: String,
  $org: Org!,
  $entityIds: [UUID!],
  $org: Org!,
  $entityIds: [UUID!]
) {
  loanAndLeaseContractSearchExport(
    portfolioIds: $portfolioIds,
    expirationStatus: $expirationStatus,
    regTaxType: $regTaxType,
    warningType: $warningType,
    hasWarning: $hasWarning,
    contractStatus: $contractStatus,
    reverseSearch: $reverseSearch,
    search: $search,
    org: $org,
    entityIds: $entityIds,
    org: $org,
    entityIds: $entityIds
  )
}

Variables

{
  "portfolioIds": ["xyz789"],
  "expirationStatus": "PENDING_CUSTOMER",
  "regTaxType": "PROPORTIONATE",
  "warningType": "ANY",
  "hasWarning": false,
  "contractStatus": "DRAFT",
  "reverseSearch": null,
  "search": "abc123",
  "org": "acme",
  "entityIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Response

{
  "data": {
    "loanAndLeaseContractSearchExport": "https://domain.com/resource"
  }
}

Queries

`loanAndLeasePreviewCollection`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePreviewCollectionOutcome!

Arguments

Name	Description
`invoiceIds` - `[UUID!]!`
`extended` - `Boolean!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query loanAndLeasePreviewCollection(
  $invoiceIds: [UUID!]!,
  $extended: Boolean!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePreviewCollection(
    invoiceIds: $invoiceIds,
    extended: $extended,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePreviewCollectionError {
      error
    }
    ... on LoanAndLeasePreviewCollectionStructuredErrors {
      errors {
        ... on LoanAndLeaseGenerationErrorGenericEmissionError {
          ...LoanAndLeaseGenerationErrorGenericEmissionErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsError {
          ...LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorUnknownError {
          ...LoanAndLeaseGenerationErrorUnknownErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorDebtorError {
          ...LoanAndLeaseGenerationErrorDebtorErrorFragment
        }
      }
    }
    ... on LoanAndLeasePreviewCollectionResult {
      data
    }
  }
}

Variables

{
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "extended": true,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePreviewCollection": LoanAndLeasePreviewCollectionError
  }
}

Queries

`node`

Response

Returns a Node

Arguments

Name	Description
`id` - `ID!`

Example

Query

query node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{"id": 4}

Response

{"data": {"node": {"id": 4}}}

Queries

`nodes`

Response

Returns [Node]!

Arguments

Name	Description
`id` - `[ID!]!`

Example

Query

query nodes($id: [ID!]!) {
  nodes(id: $id) {
    id
  }
}

Variables

{"id": [4]}

Response

{"data": {"nodes": [{"id": 4}]}}

Queries

`nordigenAggregatedData`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [NordigenAggregatedData!]!

Arguments

Name	Description
`userId` - `UserId!`	A user id.
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query nordigenAggregatedData(
  $userId: UserId!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  nordigenAggregatedData(
    userId: $userId,
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    userId
    values {
      total
      months
    }
    maxMonth
    months
    accounts {
      values {
        ...NordigenAggregatedValuesFragment
      }
      requisitionId
      institutionId
      accountId
      accountTitle
      income {
        ...NordigenAggregatedBySignFragment
      }
      expense {
        ...NordigenAggregatedBySignFragment
      }
      transactions {
        ...NordigenTransactionFragment
      }
    }
  }
}

Variables

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "nordigenAggregatedData": [
      {
        "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
        "values": NordigenAggregatedValues,
        "maxMonth": "2007-12",
        "months": 123,
        "accounts": [NordigenAccount]
      }
    ]
  }
}

Queries

`nordigenCategories`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [NordigenCategory!]!

Arguments

Name	Description
`userId` - `UserId!`	A user id.
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query nordigenCategories(
  $userId: UserId!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  nordigenCategories(
    userId: $userId,
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    categoryId
    title
  }
}

Variables

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "nordigenCategories": [
      {"categoryId": 987, "title": "abc123"}
    ]
  }
}

Queries

`nordigenInstitutions`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [NordigenInstitution!]!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query nordigenInstitutions(
  $org: Org!,
  $org: Org!
) {
  nordigenInstitutions(
    org: $org,
    org: $org
  ) {
    institutionId
    name
    logo
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "nordigenInstitutions": [
      {
        "institutionId": NordigenInstitutionId,
        "name": "xyz789",
        "logo": "https://domain.com/resource"
      }
    ]
  }
}

Queries

`organization`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an Organization!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query organization(
  $org: Org!,
  $org: Org!
) {
  organization(
    org: $org,
    org: $org
  ) {
    users {
      id
      name
      email
      globalRoles
      organizations {
        ...OrganizationFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
    me {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
    name
    computedRoles
    mutableRoles
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "organization": {
      "users": [User],
      "organizationUsers": [OrganizationUser],
      "me": OrganizationUser,
      "name": "acme",
      "computedRoles": ["ANYONE"],
      "mutableRoles": ["ADMIN"]
    }
  }
}

Queries

`portfolioEconomicConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioEconomicConfig!]!

Arguments

Name	Description
`portfolioIds` - `[String!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query portfolioEconomicConfig(
  $portfolioIds: [String!]!,
  $org: Org!,
  $org: Org!
) {
  portfolioEconomicConfig(
    portfolioIds: $portfolioIds,
    org: $org,
    org: $org
  ) {
    portfolioId
    contractDimensionFamily
    constantDimensionFamilies {
      dimensionFamily
      constant
    }
  }
}

Variables

{
  "portfolioIds": ["abc123"],
  "org": "acme"
}

Response

{
  "data": {
    "portfolioEconomicConfig": [
      {
        "portfolioId": "xyz789",
        "contractDimensionFamily": 987,
        "constantDimensionFamilies": [
          ConstantDimensionFamily
        ]
      }
    ]
  }
}

Queries

`previewCollectionV2`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Uri!

Arguments

Name	Description
`cert` - `CollectablesCertificateInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query previewCollectionV2(
  $cert: CollectablesCertificateInput!,
  $org: Org!,
  $org: Org!
) {
  previewCollectionV2(
    cert: $cert,
    org: $org,
    org: $org
  )
}

Variables

{
  "cert": CollectablesCertificateInput,
  "org": "acme"
}

Response

{
  "data": {
    "previewCollectionV2": "https://domain.com/resource"
  }
}

Queries

`reportingConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a ReportingConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query reportingConfig(
  $org: Org!,
  $org: Org!
) {
  reportingConfig(
    org: $org,
    org: $org
  ) {
    expirationWarningDays
  }
}

Variables

{"org": "acme"}

Response

{"data": {"reportingConfig": {"expirationWarningDays": 987}}}

Queries

`user`

Response

Returns a User!

Example

Query

query user {
  user {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Response

{
  "data": {
    "user": {
      "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
      "name": "xyz789",
      "email": "john@gmail.com",
      "globalRoles": ["ADMIN"],
      "organizations": [Organization],
      "organizationUsers": [OrganizationUser]
    }
  }
}

Queries

`users`

Response

Returns [User!]!

Arguments

Name	Description
`ids` - `[UserId!]!`

Example

Query

query users($ids: [UserId!]!) {
  users(ids: $ids) {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Variables

{
  "ids": [
    "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
  ]
}

Response

{
  "data": {
    "users": [
      {
        "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
        "name": "xyz789",
        "email": "john@gmail.com",
        "globalRoles": ["ADMIN"],
        "organizations": [Organization],
        "organizationUsers": [OrganizationUser]
      }
    ]
  }
}

Queries

`webhookDashboard`

Description

the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an AppPortalAccess!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

query webhookDashboard(
  $org: Org!,
  $org: Org!
) {
  webhookDashboard(
    org: $org,
    org: $org
  ) {
    url
    token
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "webhookDashboard": {
      "url": "https://domain.com/resource",
      "token": "abc123"
    }
  }
}

Mutations

`addEntityRoles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`roles` - `[MutableEntityRole!]!`
`entityId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation addEntityRoles(
  $roles: [MutableEntityRole!]!,
  $entityId: UUID!,
  $org: Org!,
  $org: Org!
) {
  addEntityRoles(
    roles: $roles,
    entityId: $entityId,
    org: $org,
    org: $org
  )
}

Variables

{
  "roles": ["DEALER"],
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"addEntityRoles": true}}

Mutations

`addRoles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a User!

Arguments

Name	Description
`role` - `[MutableRole!]!`
`userId` - `UserId!`	A user id.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation addRoles(
  $role: [MutableRole!]!,
  $userId: UserId!,
  $org: Org!,
  $org: Org!
) {
  addRoles(
    role: $role,
    userId: $userId,
    org: $org,
    org: $org
  ) {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Variables

{
  "role": ["ADMIN"],
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "org": "acme"
}

Response

{
  "data": {
    "addRoles": {
      "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
      "name": "abc123",
      "email": "john@gmail.com",
      "globalRoles": ["ADMIN"],
      "organizations": [Organization],
      "organizationUsers": [OrganizationUser]
    }
  }
}

Mutations

`changeLoanAndLeaseAnnuityEnds`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`annuityEnds` - `[LoanAndLeaseContractAnnuityEndInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation changeLoanAndLeaseAnnuityEnds(
  $annuityEnds: [LoanAndLeaseContractAnnuityEndInput!]!,
  $org: Org!,
  $org: Org!
) {
  changeLoanAndLeaseAnnuityEnds(
    annuityEnds: $annuityEnds,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "annuityEnds": [LoanAndLeaseContractAnnuityEndInput],
  "org": "acme"
}

Response

{
  "data": {
    "changeLoanAndLeaseAnnuityEnds": LoanAndLeaseContractUpdateError
  }
}

Mutations

`changeLoanAndLeaseEntities`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`entities` - `[LoanAndLeaseContractChangeEntitiesInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation changeLoanAndLeaseEntities(
  $entities: [LoanAndLeaseContractChangeEntitiesInput!]!,
  $org: Org!,
  $org: Org!
) {
  changeLoanAndLeaseEntities(
    entities: $entities,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "entities": [LoanAndLeaseContractChangeEntitiesInput],
  "org": "acme"
}

Response

{
  "data": {
    "changeLoanAndLeaseEntities": LoanAndLeaseContractUpdateError
  }
}

Mutations

`changeLoanAndLeaseInterestRates`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`interestRates` - `[LoanAndLeaseContractInterestRateInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation changeLoanAndLeaseInterestRates(
  $interestRates: [LoanAndLeaseContractInterestRateInput!]!,
  $org: Org!,
  $org: Org!
) {
  changeLoanAndLeaseInterestRates(
    interestRates: $interestRates,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "interestRates": [
    LoanAndLeaseContractInterestRateInput
  ],
  "org": "acme"
}

Response

{
  "data": {
    "changeLoanAndLeaseInterestRates": LoanAndLeaseContractUpdateError
  }
}

Mutations

`changeLoanAndLeaseResidualValues`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`residualValues` - `[LoanAndLeaseContractResidualValueInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation changeLoanAndLeaseResidualValues(
  $residualValues: [LoanAndLeaseContractResidualValueInput!]!,
  $org: Org!,
  $org: Org!
) {
  changeLoanAndLeaseResidualValues(
    residualValues: $residualValues,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "residualValues": [
    LoanAndLeaseContractResidualValueInput
  ],
  "org": "acme"
}

Response

{
  "data": {
    "changeLoanAndLeaseResidualValues": LoanAndLeaseContractUpdateError
  }
}

Mutations

`createAssets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreateAssetResult!

Arguments

Name	Description
`assets` - `[AssetInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createAssets(
  $assets: [AssetInput!]!,
  $org: Org!,
  $org: Org!
) {
  createAssets(
    assets: $assets,
    org: $org,
    org: $org
  ) {
    ... on AssetCreationFailure {
      errors {
        ... on AssetCreationAssetNoMustBeDefined {
          ...AssetCreationAssetNoMustBeDefinedFragment
        }
        ... on AssetCreationDuplicateAssetNo {
          ...AssetCreationDuplicateAssetNoFragment
        }
        ... on AssetCreationDuplicateVin {
          ...AssetCreationDuplicateVinFragment
        }
        ... on AssetCreationAssetNoAlreadyExists {
          ...AssetCreationAssetNoAlreadyExistsFragment
        }
        ... on AssetCreationVinAlreadyExists {
          ...AssetCreationVinAlreadyExistsFragment
        }
      }
    }
    ... on AssetCreationSuccess {
      assets {
        ...AssetFragment
      }
    }
  }
}

Variables

{
  "assets": [AssetInput],
  "org": "acme"
}

Response

{"data": {"createAssets": AssetCreationFailure}}

Mutations

`createLoanAndLeaseContracts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [UUID!]!

Arguments

Name	Description
`contracts` - `[LoanAndLeaseContractCreateInput!]!`	Must be non-empty
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createLoanAndLeaseContracts(
  $contracts: [LoanAndLeaseContractCreateInput!]!,
  $org: Org!,
  $org: Org!
) {
  createLoanAndLeaseContracts(
    contracts: $contracts,
    org: $org,
    org: $org
  )
}

Variables

{
  "contracts": [LoanAndLeaseContractCreateInput],
  "org": "acme"
}

Response

{
  "data": {
    "createLoanAndLeaseContracts": [
      "a79dd2da-a9b2-4394-9c11-36c375346bc7"
    ]
  }
}

Mutations

`createLoanAndLeaseContractsInEconomic`

Description

Creates existing loan and lease contracts in economic. The number of contract ids must be larger than 0. The output order is the same as the input order.

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseCreateContractInEconomicOutcome!

Arguments

Name	Description
`contracts` - `[LoanAndLeaseContractCreateInEconomicItemInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createLoanAndLeaseContractsInEconomic(
  $contracts: [LoanAndLeaseContractCreateInEconomicItemInput!]!,
  $org: Org!,
  $org: Org!
) {
  createLoanAndLeaseContractsInEconomic(
    contracts: $contracts,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseCreateContractInEconomicError {
      type
    }
    ... on LoanAndLeaseCreateContractInEconomicResult {
      outcome {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "contracts": [
    LoanAndLeaseContractCreateInEconomicItemInput
  ],
  "org": "acme"
}

Response

{
  "data": {
    "createLoanAndLeaseContractsInEconomic": LoanAndLeaseCreateContractInEconomicError
  }
}

Mutations

`createLoanAndLeaseCreditorEntitiesInEconomic`

Description

Creates existing loan and lease entities in economic as creditors (suppliers). The number of entity ids must be larger than 0. The output order is the same as the input order.

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseCreateEntityInEconomicOutcome!

Arguments

Name	Description
`data` - `[LoanAndLeaseEntityCreateCreditorInEconomicItemInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createLoanAndLeaseCreditorEntitiesInEconomic(
  $data: [LoanAndLeaseEntityCreateCreditorInEconomicItemInput!]!,
  $org: Org!,
  $org: Org!
) {
  createLoanAndLeaseCreditorEntitiesInEconomic(
    data: $data,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseCreateEntityInEconomicError {
      type
    }
    ... on LoanAndLeaseCreateEntityInEconomicResult {
      outcome {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
  }
}

Variables

{
  "data": [
    LoanAndLeaseEntityCreateCreditorInEconomicItemInput
  ],
  "org": "acme"
}

Response

{
  "data": {
    "createLoanAndLeaseCreditorEntitiesInEconomic": LoanAndLeaseCreateEntityInEconomicError
  }
}

Mutations

`createLoanAndLeaseEntities`

Description

Creates loan and lease entities. The size of the input entities must be non-empty (the sum of the sizes of people and companies). The output order is the same as the input order.

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseCreationOutcome!

Arguments

Name	Description
`companies` - `[LoanAndLeaseCreateCompanyInput!]!`
`people` - `[LoanAndLeaseCreatePersonInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createLoanAndLeaseEntities(
  $companies: [LoanAndLeaseCreateCompanyInput!]!,
  $people: [LoanAndLeaseCreatePersonInput!]!,
  $org: Org!,
  $org: Org!
) {
  createLoanAndLeaseEntities(
    companies: $companies,
    people: $people,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseCreationError {
      type
    }
    ... on LoanAndLeaseCreationResult {
      outcome {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
  }
}

Variables

{
  "companies": [LoanAndLeaseCreateCompanyInput],
  "people": [LoanAndLeaseCreatePersonInput],
  "org": "acme"
}

Response

{
  "data": {
    "createLoanAndLeaseEntities": LoanAndLeaseCreationError
  }
}

Mutations

`createLoanAndLeaseEntitiesInEconomic`

Description

Creates existing loan and lease entities in economic. The number of entity ids must be larger than 0. The output order is the same as the input order.

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseCreateEntityInEconomicOutcome!

Arguments

Name	Description
`entities` - `[LoanAndLeaseEntityCreateInEconomicItemInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createLoanAndLeaseEntitiesInEconomic(
  $entities: [LoanAndLeaseEntityCreateInEconomicItemInput!]!,
  $org: Org!,
  $org: Org!
) {
  createLoanAndLeaseEntitiesInEconomic(
    entities: $entities,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseCreateEntityInEconomicError {
      type
    }
    ... on LoanAndLeaseCreateEntityInEconomicResult {
      outcome {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
  }
}

Variables

{
  "entities": [
    LoanAndLeaseEntityCreateInEconomicItemInput
  ],
  "org": "acme"
}

Response

{
  "data": {
    "createLoanAndLeaseEntitiesInEconomic": LoanAndLeaseCreateEntityInEconomicError
  }
}

Mutations

`createUser`

Description

Creates a new user with the given permission to the given organization. The user is by default managed by the supplied organization. the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a User!

Arguments

Name	Description
`roles` - `[MutableRole!]!`	Default = `[]`
`user` - `NewUserInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createUser(
  $roles: [MutableRole!]!,
  $user: NewUserInput!,
  $org: Org!,
  $org: Org!
) {
  createUser(
    roles: $roles,
    user: $user,
    org: $org,
    org: $org
  ) {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Variables

{
  "roles": [""],
  "user": NewUserInput,
  "org": "acme"
}

Response

{
  "data": {
    "createUser": {
      "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
      "name": "abc123",
      "email": "john@gmail.com",
      "globalRoles": ["ADMIN"],
      "organizations": [Organization],
      "organizationUsers": [OrganizationUser]
    }
  }
}

Mutations

`createV2Portfolio`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a PortfolioV2UpsertOutcome!

Arguments

Name	Description
`portfolio` - `PortfolioV2Input!`
`portfolioId` - `String!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation createV2Portfolio(
  $portfolio: PortfolioV2Input!,
  $portfolioId: String!,
  $org: Org!,
  $org: Org!
) {
  createV2Portfolio(
    portfolio: $portfolio,
    portfolioId: $portfolioId,
    org: $org,
    org: $org
  ) {
    ... on PortfolioV2UpsertErrorPortfolioNotFound {
      portfolioId
    }
    ... on PortfolioV2UpsertSuccess {
      portfolio {
        ...PortfolioV2Fragment
      }
    }
  }
}

Variables

{
  "portfolio": PortfolioV2Input,
  "portfolioId": "xyz789",
  "org": "acme"
}

Response

{
  "data": {
    "createV2Portfolio": PortfolioV2UpsertErrorPortfolioNotFound
  }
}

Mutations

`creditlinkAppendProofOfIdentity`

Description

Appends proof of identity to case on current user. the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a Boolean!

Arguments

Name	Description
`rest` - `[EphemeralReference!]!`	Default = `[]`
`first` - `EphemeralReference!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation creditlinkAppendProofOfIdentity(
  $rest: [EphemeralReference!]!,
  $first: EphemeralReference!,
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkAppendProofOfIdentity(
    rest: $rest,
    first: $first,
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "rest": [""],
  "first": EphemeralReference,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkAppendProofOfIdentity": true}}

Mutations

`creditlinkApproverCloseCase`

Description

Closes the case as the approver. Note that the resulting status is dependent of the user's role. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCaseStatus!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkApproverCloseCase(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkApproverCloseCase(
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkApproverCloseCase": "OPEN"}}

Mutations

`creditlinkApproverDisposableIncome`

Description

Updates the approver disposable income of a case the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`disposableIncome` - `CreditlinkInputUserDisposableIncome!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkApproverDisposableIncome(
  $disposableIncome: CreditlinkInputUserDisposableIncome!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkApproverDisposableIncome(
    disposableIncome: $disposableIncome,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "disposableIncome": CreditlinkInputUserDisposableIncome,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkApproverDisposableIncome": 42}}

Mutations

`creditlinkApproverReopenCase`

Description

Closes the reopens as the approver. Note that the resulting status is dependent of the user's role. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCaseStatus!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkApproverReopenCase(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkApproverReopenCase(
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkApproverReopenCase": "OPEN"}}

Mutations

`creditlinkClientConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`clientConfig` - `InputCreditlinkClientConfig!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkClientConfig(
  $clientConfig: InputCreditlinkClientConfig!,
  $org: Org!,
  $org: Org!
) {
  creditlinkClientConfig(
    clientConfig: $clientConfig,
    org: $org,
    org: $org
  )
}

Variables

{
  "clientConfig": InputCreditlinkClientConfig,
  "org": "acme"
}

Response

{"data": {"creditlinkClientConfig": 42}}

Mutations

`creditlinkComment`

Description

Adds a comment to the case the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`comment` - `String!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkComment(
  $comment: String!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkComment(
    comment: $comment,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "comment": "abc123",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkComment": 42}}

Mutations

`creditlinkComplianceAnswer`

Description

Sets compliance answer for case on current user. the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a Boolean!

Arguments

Name	Description
`recentLoans` - `Boolean!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation creditlinkComplianceAnswer(
  $recentLoans: Boolean!,
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkComplianceAnswer(
    recentLoans: $recentLoans,
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "recentLoans": true,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkComplianceAnswer": true}}

Mutations

`creditlinkCreditroCreateConfig`

Description

Set or create Creditro secrets and config the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCreditroConfigOut

Arguments

Name	Description
`secrets` - `CreditlinkCreditroSecrets`
`config` - `CreditlinkCreditroConfigIn`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkCreditroCreateConfig(
  $secrets: CreditlinkCreditroSecrets,
  $config: CreditlinkCreditroConfigIn,
  $org: Org!,
  $org: Org!
) {
  creditlinkCreditroCreateConfig(
    secrets: $secrets,
    config: $config,
    org: $org,
    org: $org
  ) {
    enabled
    customerTypeId
    customerServiceId
    clientManagerEmail
  }
}

Variables

{
  "secrets": CreditlinkCreditroSecrets,
  "config": CreditlinkCreditroConfigIn,
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkCreditroCreateConfig": {
      "enabled": true,
      "customerTypeId": "xyz789",
      "customerServiceId": "xyz789",
      "clientManagerEmail": "john@gmail.com"
    }
  }
}

Mutations

`creditlinkDebtorCloseCase`

Description

Closes the case as the provided debtor role. Note that the resulting status is dependent of the user's role. the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a CreditlinkCaseStatus!

Arguments

Name	Description
`role` - `CreditlinkDisposableIncomeRole!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation creditlinkDebtorCloseCase(
  $role: CreditlinkDisposableIncomeRole!,
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkDebtorCloseCase(
    role: $role,
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "role": "PRIMARY_DEBTOR",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkDebtorCloseCase": "OPEN"}}

Mutations

`creditlinkDebtorDisposableIncome`

Description

Updates the debtor disposable income of a case the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a Boolean!

Arguments

Name	Description
`disposableIncome` - `CreditlinkInputUserDisposableIncome!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation creditlinkDebtorDisposableIncome(
  $disposableIncome: CreditlinkInputUserDisposableIncome!,
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkDebtorDisposableIncome(
    disposableIncome: $disposableIncome,
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "disposableIncome": CreditlinkInputUserDisposableIncome,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkDebtorDisposableIncome": true}}

Mutations

`creditlinkDeleteCase`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkDeleteCase(
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkDeleteCase(
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkDeleteCase": true}}

Mutations

`creditlinkMonthioCreateConfig`

Description

Set or create Monthio secrets and config the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkMonthioConfigOut

Arguments

Name	Description
`secrets` - `CreditlinkMonthioSecrets`
`config` - `CreditlinkMonthioConfigIn`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkMonthioCreateConfig(
  $secrets: CreditlinkMonthioSecrets,
  $config: CreditlinkMonthioConfigIn,
  $org: Org!,
  $org: Org!
) {
  creditlinkMonthioCreateConfig(
    secrets: $secrets,
    config: $config,
    org: $org,
    org: $org
  ) {
    enabled
    smartCheckConfigurationId
  }
}

Variables

{
  "secrets": CreditlinkMonthioSecrets,
  "config": CreditlinkMonthioConfigIn,
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkMonthioCreateConfig": {
      "enabled": true,
      "smartCheckConfigurationId": 987
    }
  }
}

Mutations

`creditlinkNotificationConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`notificationConfig` - `InputCreditlinkNotificationConfig!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkNotificationConfig(
  $notificationConfig: InputCreditlinkNotificationConfig!,
  $org: Org!,
  $org: Org!
) {
  creditlinkNotificationConfig(
    notificationConfig: $notificationConfig,
    org: $org,
    org: $org
  )
}

Variables

{
  "notificationConfig": InputCreditlinkNotificationConfig,
  "org": "acme"
}

Response

{"data": {"creditlinkNotificationConfig": 42}}

Mutations

`creditlinkProofOfIdentityStatus`

Description

Sets proof of identity status for case on current user. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`status` - `CreditlinkProofOfIdentityStatus!`
`itemId` - `Long!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkProofOfIdentityStatus(
  $status: CreditlinkProofOfIdentityStatus!,
  $itemId: Long!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkProofOfIdentityStatus(
    status: $status,
    itemId: $itemId,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "status": "APPROVED",
  "itemId": 9223372036854776000,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkProofOfIdentityStatus": true}}

Mutations

`creditlinkRetentionDate`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`retention` - `Instant!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkRetentionDate(
  $retention: Instant!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkRetentionDate(
    retention: $retention,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "retention": 1654109791,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkRetentionDate": true}}

Mutations

`creditlinkRevokeConsent`

Description

the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a Boolean!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation creditlinkRevokeConsent(
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkRevokeConsent(
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkRevokeConsent": true}}

Mutations

`creditlinkSendEmail`

Description

Sends the email to the users regardless of any previously sent emails. Attempting to send an email to a userId that does not exist or have an email address will result in an error. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`rest` - `[UserId!]!`	Default = `[]`
`userId` - `UserId!`	A user id.
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkSendEmail(
  $rest: [UserId!]!,
  $userId: UserId!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkSendEmail(
    rest: $rest,
    userId: $userId,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "rest": [""],
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkSendEmail": true}}

Mutations

`creditlinkSendSms`

Description

Sends the sms to the users regardless of any previously sent sms's. Attempting to send an sms to a userId that does not exist or have an phone number will result in an error. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`rest` - `[UserId!]!`	Default = `[]`
`userId` - `UserId!`	A user id.
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkSendSms(
  $rest: [UserId!]!,
  $userId: UserId!,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkSendSms(
    rest: $rest,
    userId: $userId,
    caseId: $caseId,
    org: $org,
    org: $org
  )
}

Variables

{
  "rest": [""],
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"creditlinkSendSms": true}}

Mutations

`creditlinkSetUsers`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCase

Arguments

Name	Description
`otherUpdateCompanies` - `[UpdateCreditlinkCompany!]!`	Default = `[]`
`otherCompanies` - `[InputCreditlinkCompany!]!`	Default = `[]`
`otherPersons` - `[UpdateCreditlinkPerson!]!`	Default = `[]`
`secondaryDebtor` - `UpdateCreditlinkPerson`
`primaryDebtor` - `UpdateCreditlinkPerson`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkSetUsers(
  $otherUpdateCompanies: [UpdateCreditlinkCompany!]!,
  $otherCompanies: [InputCreditlinkCompany!]!,
  $otherPersons: [UpdateCreditlinkPerson!]!,
  $secondaryDebtor: UpdateCreditlinkPerson,
  $primaryDebtor: UpdateCreditlinkPerson,
  $caseId: UUID!,
  $org: Org!,
  $org: Org!
) {
  creditlinkSetUsers(
    otherUpdateCompanies: $otherUpdateCompanies,
    otherCompanies: $otherCompanies,
    otherPersons: $otherPersons,
    secondaryDebtor: $secondaryDebtor,
    primaryDebtor: $primaryDebtor,
    caseId: $caseId,
    org: $org,
    org: $org
  ) {
    caseId
    externalId
    dealerName
    assetName
    monthlyPayment
    psd2Provider
    sendLink
    comments {
      text
      author
      user {
        ...UserFragment
      }
    }
    approverDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    debtorDisposableIncome {
      disposableIncome {
        ...CreditlinkDisposableIncomeFragment
      }
      adults
      children
      expensePct
    }
    computed {
      income {
        ...CreditlinkDisposableIncomeIncomeFragment
      }
      home {
        ...CreditlinkDisposableIncomeHomeFragment
      }
      vehicle {
        ...CreditlinkDisposableIncomeVehicleFragment
      }
      misc {
        ...CreditlinkDisposableIncomeMiscFragment
      }
    }
    status
    primaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    secondaryDebtor {
      userId
      pep {
        ...PepGroupFragment
      }
      euSanctions {
        ...SanctionedEntityFragment
      }
      name
      cpr
      email
      phone
      psd2Status
      badDebtEnabled
      financialCrimeEnabled
      taxInfoEnabled
      psd2Enabled
      proofOfIdentityEnabled
      eSkatStatus {
        ... on CreditlinkESkatStatusCompleted {
          ...CreditlinkESkatStatusCompletedFragment
        }
        ... on CreditlinkESkatStatusRunning {
          ...CreditlinkESkatStatusRunningFragment
        }
        ... on CreditlinkESkatStatusFailed {
          ...CreditlinkESkatStatusFailedFragment
        }
      }
      badDebt {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on BadDebtResult {
          ...BadDebtResultFragment
        }
      }
      financialCrime {
        ... on RegisterError {
          ...RegisterErrorFragment
        }
        ... on FinancialCrimeResult {
          ...FinancialCrimeResultFragment
        }
      }
      complianceAnswer {
        ...ComplianceAnswerFragment
      }
      proofOfIdentity {
        ...CreditlinkProofOfIdentityFragment
      }
      financialCrimeStatus {
        ... on CreditlinkFinancialCrimeStatusCompleted {
          ...CreditlinkFinancialCrimeStatusCompletedFragment
        }
        ... on CreditlinkFinancialCrimeStatusEnumCase {
          ...CreditlinkFinancialCrimeStatusEnumCaseFragment
        }
      }
      badDebtStatus {
        ... on CreditlinkBadDebtStatusFailed {
          ...CreditlinkBadDebtStatusFailedFragment
        }
        ... on CreditlinkBadDebtStatusCompleted {
          ...CreditlinkBadDebtStatusCompletedFragment
        }
        ... on CreditlinkBadDebtStatusEnumCase {
          ...CreditlinkBadDebtStatusEnumCaseFragment
        }
      }
      requisitions {
        ...NordigenRequisitionFragment
      }
      hasUserInteraction
      externalId
    }
    other {
      ... on CreditlinkPerson {
        ...CreditlinkPersonFragment
      }
      ... on CreditlinkCompany {
        ...CreditlinkCompanyFragment
      }
    }
    retention
  }
}

Variables

{
  "otherUpdateCompanies": [""],
  "otherCompanies": [""],
  "otherPersons": [""],
  "secondaryDebtor": UpdateCreditlinkPerson,
  "primaryDebtor": UpdateCreditlinkPerson,
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkSetUsers": {
      "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
      "externalId": "0110293",
      "dealerName": "abc123",
      "assetName": "abc123",
      "monthlyPayment": "28391719239482739937.1939459927192",
      "psd2Provider": "NORDIGEN",
      "sendLink": true,
      "comments": [CreditlinkComment],
      "approverDisposableIncome": CreditlinkUserDisposableIncome,
      "debtorDisposableIncome": CreditlinkUserDisposableIncome,
      "computed": CreditlinkDisposableIncome,
      "status": "OPEN",
      "primaryDebtor": CreditlinkPerson,
      "secondaryDebtor": CreditlinkPerson,
      "other": [CreditlinkPerson],
      "retention": 1654109791
    }
  }
}

Mutations

`creditlinkZenixUrl`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Uri!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditlinkZenixUrl(
  $org: Org!,
  $org: Org!
) {
  creditlinkZenixUrl(
    org: $org,
    org: $org
  )
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "creditlinkZenixUrl": "https://domain.com/resource"
  }
}

Mutations

`creditratingCase`

Description

Creates a new case, the returned UUID is the id of the case, and can be used to query the case after creation. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCaseCreationResult!

Arguments

Name	Description
`case` - `InputCreditlinkCase!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation creditratingCase(
  $case: InputCreditlinkCase!,
  $org: Org!,
  $org: Org!
) {
  creditratingCase(
    case: $case,
    org: $org,
    org: $org
  ) {
    ... on CreditlinkCaseCreationError {
      errorType
    }
    ... on CreditlinkCaseCreated {
      caseId
      case {
        ...CreditlinkCaseFragment
      }
    }
  }
}

Variables

{
  "case": InputCreditlinkCase,
  "org": "acme"
}

Response

{
  "data": {
    "creditratingCase": CreditlinkCaseCreationError
  }
}

Mutations

`cvrSecrets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`password` - `String!`
`username` - `String!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation cvrSecrets(
  $password: String!,
  $username: String!,
  $org: Org!,
  $org: Org!
) {
  cvrSecrets(
    password: $password,
    username: $username,
    org: $org,
    org: $org
  )
}

Variables

{
  "password": "xyz789",
  "username": "abc123",
  "org": "acme"
}

Response

{"data": {"cvrSecrets": true}}

Mutations

`disposableIncomeConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`config` - `InputDisposableIncomeConfig!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation disposableIncomeConfig(
  $config: InputDisposableIncomeConfig!,
  $org: Org!,
  $org: Org!
) {
  disposableIncomeConfig(
    config: $config,
    org: $org,
    org: $org
  )
}

Variables

{
  "config": InputDisposableIncomeConfig,
  "org": "acme"
}

Response

{"data": {"disposableIncomeConfig": 42}}

Mutations

`doCollectV2`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`cert` - `CollectablesCertificateInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation doCollectV2(
  $cert: CollectablesCertificateInput!,
  $org: Org!,
  $org: Org!
) {
  doCollectV2(
    cert: $cert,
    org: $org,
    org: $org
  )
}

Variables

{
  "cert": CollectablesCertificateInput,
  "org": "acme"
}

Response

{"data": {"doCollectV2": true}}

Mutations

`dowJonesSecrets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`secrets` - `DowJonesSecrets!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation dowJonesSecrets(
  $secrets: DowJonesSecrets!,
  $org: Org!,
  $org: Org!
) {
  dowJonesSecrets(
    secrets: $secrets,
    org: $org,
    org: $org
  )
}

Variables

{
  "secrets": DowJonesSecrets,
  "org": "acme"
}

Response

{"data": {"dowJonesSecrets": 42}}

Mutations

`eskatConfig`

Description

Set config the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`config` - `InputEskatConfig!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation eskatConfig(
  $config: InputEskatConfig!,
  $org: Org!,
  $org: Org!
) {
  eskatConfig(
    config: $config,
    org: $org,
    org: $org
  )
}

Variables

{
  "config": InputEskatConfig,
  "org": "acme"
}

Response

{"data": {"eskatConfig": 42}}

Mutations

`eskatPkcs`

Description

Set PKCS the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`pkcs` - `InputEskatPkcs!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation eskatPkcs(
  $pkcs: InputEskatPkcs!,
  $org: Org!,
  $org: Org!
) {
  eskatPkcs(
    pkcs: $pkcs,
    org: $org,
    org: $org
  )
}

Variables

{
  "pkcs": InputEskatPkcs,
  "org": "acme"
}

Response

{"data": {"eskatPkcs": 42}}

Mutations

`loanAndLeaseAddContractComment`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseAddContractCommentResult!]!

Arguments

Name	Description
`comments` - `[LoanAndLeaseAddContractCommentInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseAddContractComment(
  $comments: [LoanAndLeaseAddContractCommentInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseAddContractComment(
    comments: $comments,
    org: $org,
    org: $org
  ) {
    contractId
    comments {
      comment
      created
      createdBy
      author {
        ...UserFragment
      }
    }
  }
}

Variables

{
  "comments": [LoanAndLeaseAddContractCommentInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseAddContractComment": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "comments": [LoanAndLeaseContractComment]
      }
    ]
  }
}

Mutations

`loanAndLeaseAddContractFiles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an AddContractFilesOutcome!

Arguments

Name	Description
`contractFiles` - `[ContractFileInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseAddContractFiles(
  $contractFiles: [ContractFileInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseAddContractFiles(
    contractFiles: $contractFiles,
    org: $org,
    org: $org
  ) {
    ... on AddContractFilesSuccess {
      contracts {
        ...LoanAndLeaseContractFragment
      }
    }
    ... on AddContractFilesContractNotFoundError {
      contracts {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "contractFiles": [ContractFileInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseAddContractFiles": AddContractFilesSuccess
  }
}

Mutations

`loanAndLeaseAddRepresentatives`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseAddRepresentativeOutcome!

Arguments

Name	Description
`representatives` - `[LoanAndLeaseAddRepresentative!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseAddRepresentatives(
  $representatives: [LoanAndLeaseAddRepresentative!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseAddRepresentatives(
    representatives: $representatives,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseAddRepresentativeSuccess {
      representativeIds
    }
    ... on LoanAndLeaseAddRepresentativeErrorWrapper {
      error
    }
  }
}

Variables

{
  "representatives": [LoanAndLeaseAddRepresentative],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseAddRepresentatives": LoanAndLeaseAddRepresentativeSuccess
  }
}

Mutations

`loanAndLeaseContractRetention`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`contractRetentions` - `[LoanAndLeaseContractRetentionInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseContractRetention(
  $contractRetentions: [LoanAndLeaseContractRetentionInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseContractRetention(
    contractRetentions: $contractRetentions,
    org: $org,
    org: $org
  )
}

Variables

{
  "contractRetentions": [
    LoanAndLeaseContractRetentionInput
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseContractRetention": true}}

Mutations

`loanAndLeaseCreatePortfolios`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePortfolioCreationOutcome!

Arguments

Name	Description
`portfolios` - `[LoanAndLeaseCreatePortfolioInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseCreatePortfolios(
  $portfolios: [LoanAndLeaseCreatePortfolioInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseCreatePortfolios(
    portfolios: $portfolios,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePortfolios {
      portfolios {
        ...LoanAndLeasePortfolioFragment
      }
    }
    ... on LoanAndLeasePortfolioCreationError {
      error
    }
  }
}

Variables

{
  "portfolios": [LoanAndLeaseCreatePortfolioInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseCreatePortfolios": LoanAndLeasePortfolios
  }
}

Mutations

`loanAndLeaseDiscardInvoices`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`invoiceIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseDiscardInvoices(
  $invoiceIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseDiscardInvoices(
    invoiceIds: $invoiceIds,
    org: $org,
    org: $org
  )
}

Variables

{
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseDiscardInvoices": true}}

Mutations

`loanAndLeaseDiscardTransactionGroups`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`transactionGroupIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseDiscardTransactionGroups(
  $transactionGroupIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseDiscardTransactionGroups(
    transactionGroupIds: $transactionGroupIds,
    org: $org,
    org: $org
  )
}

Variables

{
  "transactionGroupIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseDiscardTransactionGroups": true}}

Mutations

`loanAndLeaseDoBooking`

Description

If no errors are returned, the booking was successful. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseBookingError

Arguments

Name	Description
`mailSelections` - `[LoanAndLeaseInvoiceSelectionInput!]!`	A subset of invoices that will be emailed to the customer. Default = `[]`
`bookingParams` - `[LoanAndLeaseBookingParamsInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseDoBooking(
  $mailSelections: [LoanAndLeaseInvoiceSelectionInput!]!,
  $bookingParams: [LoanAndLeaseBookingParamsInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseDoBooking(
    mailSelections: $mailSelections,
    bookingParams: $bookingParams,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseStructuredBookingError {
      errors {
        ... on LoanAndLeaseBookingParamsNotNewestError {
          ...LoanAndLeaseBookingParamsNotNewestErrorFragment
        }
        ... on LoanAndLeaseContractMissingDimensionNoError {
          ...LoanAndLeaseContractMissingDimensionNoErrorFragment
        }
        ... on LoanAndLeaseCostMissingConfigError {
          ...LoanAndLeaseCostMissingConfigErrorFragment
        }
        ... on LoanAndLeaseCostMissingProductNoError {
          ...LoanAndLeaseCostMissingProductNoErrorFragment
        }
        ... on LoanAndLeaseEntityMissingDebtorNoError {
          ...LoanAndLeaseEntityMissingDebtorNoErrorFragment
        }
        ... on LoanAndLeaseContractNotActiveError {
          ...LoanAndLeaseContractNotActiveErrorFragment
        }
        ... on LoanAndLeaseInvalidContractStateError {
          ...LoanAndLeaseInvalidContractStateErrorFragment
        }
      }
    }
    ... on LoanAndLeaseSimpleBookingError {
      type
    }
  }
}

Variables

{
  "mailSelections": [""],
  "bookingParams": [LoanAndLeaseBookingParamsInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseDoBooking": LoanAndLeaseStructuredBookingError
  }
}

Mutations

`loanAndLeaseEntityRetention`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`entityRetentions` - `[LoanAndLeaseEntityRetentionInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseEntityRetention(
  $entityRetentions: [LoanAndLeaseEntityRetentionInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntityRetention(
    entityRetentions: $entityRetentions,
    org: $org,
    org: $org
  )
}

Variables

{
  "entityRetentions": [LoanAndLeaseEntityRetentionInput],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseEntityRetention": true}}

Mutations

`loanAndLeaseForceRefresh`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseMirrorLastRefreshed

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseForceRefresh(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseForceRefresh(
    org: $org,
    org: $org
  ) {
    mostRecentStatus
    lastRefreshed
    lastSuccessfulRefresh
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseForceRefresh": {
      "mostRecentStatus": "RUNNING",
      "lastRefreshed": 1654109791,
      "lastSuccessfulRefresh": 1654109791
    }
  }
}

Mutations

`loanAndLeasePbsCollect`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an LoanAndLeasePBSCollectionOutcome!

Arguments

Name	Description
`invoiceIds` - `[UUID!]!`
`extended` - `Boolean!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeasePbsCollect(
  $invoiceIds: [UUID!]!,
  $extended: Boolean!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePbsCollect(
    invoiceIds: $invoiceIds,
    extended: $extended,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePBSCollectionStructuredResult {
      errors {
        ... on LoanAndLeaseGenerationErrorGenericEmissionError {
          ...LoanAndLeaseGenerationErrorGenericEmissionErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsError {
          ...LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorUnknownError {
          ...LoanAndLeaseGenerationErrorUnknownErrorFragment
        }
        ... on LoanAndLeaseGenerationErrorDebtorError {
          ...LoanAndLeaseGenerationErrorDebtorErrorFragment
        }
      }
    }
    ... on LoanAndLeasePBSCollectionError {
      error
    }
  }
}

Variables

{
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "extended": true,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePbsCollect": LoanAndLeasePBSCollectionStructuredResult
  }
}

Mutations

`loanAndLeasePortfolioRetention`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`portfolioRetentions` - `[LoanAndLeasePortfolioRetentionInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeasePortfolioRetention(
  $portfolioRetentions: [LoanAndLeasePortfolioRetentionInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePortfolioRetention(
    portfolioRetentions: $portfolioRetentions,
    org: $org,
    org: $org
  )
}

Variables

{
  "portfolioRetentions": [
    LoanAndLeasePortfolioRetentionInput
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeasePortfolioRetention": true}}

Mutations

`loanAndLeaseRemoveContractFiles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a RemoveContractFilesError!

Arguments

Name	Description
`fileIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseRemoveContractFiles(
  $fileIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseRemoveContractFiles(
    fileIds: $fileIds,
    org: $org,
    org: $org
  ) {
    ... on RemoveContractFilesSuccess {
      contracts {
        ...LoanAndLeaseContractFragment
      }
    }
    ... on RemoveContractFilesFilesNotFoundError {
      fileIds
    }
  }
}

Variables

{
  "fileIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseRemoveContractFiles": RemoveContractFilesSuccess
  }
}

Mutations

`loanAndLeaseRemoveRepresentativeUser`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'loanandlease/representative' resource (derived from the argument 'representativeUsers')

Response

Returns a Boolean!

Arguments

Name	Description
`representativeUsers` - `[LoanAndLeaseRepresentativeUser!]!`
`representativeUsers` - `[LoanAndLeaseRepresentativeUser!]!`

Example

Query

mutation loanAndLeaseRemoveRepresentativeUser(
  $representativeUsers: [LoanAndLeaseRepresentativeUser!]!,
  $representativeUsers: [LoanAndLeaseRepresentativeUser!]!
) {
  loanAndLeaseRemoveRepresentativeUser(
    representativeUsers: $representativeUsers,
    representativeUsers: $representativeUsers
  )
}

Variables

{"representativeUsers": [LoanAndLeaseRepresentativeUser]}

Response

{"data": {"loanAndLeaseRemoveRepresentativeUser": true}}

Mutations

`loanAndLeaseRemoveRepresentatives`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseRemoveRepresentativeError

Arguments

Name	Description
`representatives` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseRemoveRepresentatives(
  $representatives: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseRemoveRepresentatives(
    representatives: $representatives,
    org: $org,
    org: $org
  )
}

Variables

{
  "representatives": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseRemoveRepresentatives": "REPRESENTATIVE_NOT_FOUND"}}

Mutations

`loanAndLeaseRetryInvoices`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`invoiceIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseRetryInvoices(
  $invoiceIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseRetryInvoices(
    invoiceIds: $invoiceIds,
    org: $org,
    org: $org
  )
}

Variables

{
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseRetryInvoices": true}}

Mutations

`loanAndLeaseRetryTransactions`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`transactionIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseRetryTransactions(
  $transactionIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseRetryTransactions(
    transactionIds: $transactionIds,
    org: $org,
    org: $org
  )
}

Variables

{
  "transactionIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseRetryTransactions": true}}

Mutations

`loanAndLeaseRunPBSDFile`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`uri` - `Uri!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseRunPBSDFile(
  $uri: Uri!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseRunPBSDFile(
    uri: $uri,
    org: $org,
    org: $org
  )
}

Variables

{
  "uri": "https://domain.com/resource",
  "org": "acme"
}

Response

{"data": {"loanAndLeaseRunPBSDFile": true}}

Mutations

`loanAndLeaseSendInvoiceMail`

Description

Returns the list of missing invoice ids. If the list is empty, the invoices were successfully enqueued. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [UUID!]!

Arguments

Name	Description
`invoiceIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseSendInvoiceMail(
  $invoiceIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseSendInvoiceMail(
    invoiceIds: $invoiceIds,
    org: $org,
    org: $org
  )
}

Variables

{
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseSendInvoiceMail": [
      "a79dd2da-a9b2-4394-9c11-36c375346bc7"
    ]
  }
}

Mutations

`loanAndLeaseSetBaseRate`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseBaseRate!]!

Arguments

Name	Description
`baseRate` - `[LoanAndLeaseBaseRateInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseSetBaseRate(
  $baseRate: [LoanAndLeaseBaseRateInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseSetBaseRate(
    baseRate: $baseRate,
    org: $org,
    org: $org
  ) {
    baseRateId
    date
    baseRate
    id
  }
}

Variables

{
  "baseRate": [LoanAndLeaseBaseRateInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseSetBaseRate": [
      {
        "baseRateId": "xyz789",
        "date": "2020-07-19",
        "baseRate": "28391719239482739937.1939459927192",
        "id": 4
      }
    ]
  }
}

Mutations

`loanAndLeaseSetPrtRate`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeasePrtRate!]!

Arguments

Name	Description
`prtRate` - `[LoanAndLeasePrtRateInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseSetPrtRate(
  $prtRate: [LoanAndLeasePrtRateInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseSetPrtRate(
    prtRate: $prtRate,
    org: $org,
    org: $org
  ) {
    date
    prtRate
    id
  }
}

Variables

{
  "prtRate": [LoanAndLeasePrtRateInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseSetPrtRate": [
      {
        "date": "2020-07-19",
        "prtRate": "28391719239482739937.1939459927192",
        "id": 4
      }
    ]
  }
}

Mutations

`loanAndLeaseUpdatePortfolioCosts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePortfolioUpdateOutcome!

Arguments

Name	Description
`costs` - `[LoanAndLeaseUpdatePortfolioCostInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseUpdatePortfolioCosts(
  $costs: [LoanAndLeaseUpdatePortfolioCostInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseUpdatePortfolioCosts(
    costs: $costs,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePortfolios {
      portfolios {
        ...LoanAndLeasePortfolioFragment
      }
    }
    ... on LoanAndLeasePortfolioUpdateError {
      error
    }
  }
}

Variables

{
  "costs": [LoanAndLeaseUpdatePortfolioCostInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseUpdatePortfolioCosts": LoanAndLeasePortfolios
  }
}

Mutations

`loanAndLeaseUpdatePortfolios`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePortfolioUpdateOutcome!

Arguments

Name	Description
`portfolios` - `[LoanAndLeasePortfolioInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation loanAndLeaseUpdatePortfolios(
  $portfolios: [LoanAndLeasePortfolioInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseUpdatePortfolios(
    portfolios: $portfolios,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePortfolios {
      portfolios {
        ...LoanAndLeasePortfolioFragment
      }
    }
    ... on LoanAndLeasePortfolioUpdateError {
      error
    }
  }
}

Variables

{
  "portfolios": [LoanAndLeasePortfolioInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseUpdatePortfolios": LoanAndLeasePortfolios
  }
}

Mutations

`loanAndleaseAddRepresentativeUser`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'loanandlease/representative' resource (derived from the argument 'representativeUsers')

Response

Returns a Boolean!

Arguments

Name	Description
`representativeUsers` - `[LoanAndLeaseRepresentativeUser!]!`
`representativeUsers` - `[LoanAndLeaseRepresentativeUser!]!`

Example

Query

mutation loanAndleaseAddRepresentativeUser(
  $representativeUsers: [LoanAndLeaseRepresentativeUser!]!,
  $representativeUsers: [LoanAndLeaseRepresentativeUser!]!
) {
  loanAndleaseAddRepresentativeUser(
    representativeUsers: $representativeUsers,
    representativeUsers: $representativeUsers
  )
}

Variables

{"representativeUsers": [LoanAndLeaseRepresentativeUser]}

Response

{"data": {"loanAndleaseAddRepresentativeUser": true}}

Mutations

`moveBooking`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`rebookings` - `[MovedBookingInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation moveBooking(
  $rebookings: [MovedBookingInput!]!,
  $org: Org!,
  $org: Org!
) {
  moveBooking(
    rebookings: $rebookings,
    org: $org,
    org: $org
  )
}

Variables

{
  "rebookings": [MovedBookingInput],
  "org": "acme"
}

Response

{"data": {"moveBooking": true}}

Mutations

`nordigenLink`

Description

the subject 'user' (derived from the current caller's auth) must have the 'invite' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a Uri!

Arguments

Name	Description
`institutionId` - `NordigenInstitutionId!`
`redirectUri` - `Uri!`
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

mutation nordigenLink(
  $institutionId: NordigenInstitutionId!,
  $redirectUri: Uri!,
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  nordigenLink(
    institutionId: $institutionId,
    redirectUri: $redirectUri,
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  )
}

Variables

{
  "institutionId": NordigenInstitutionId,
  "redirectUri": "https://domain.com/resource",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "nordigenLink": "https://domain.com/resource"
  }
}

Mutations

`nordigenSecrets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`oAuthConfig` - `InputNordigenOAuthConfig`
`callbackUri` - `Uri!`
`secrets` - `NordigenSecrets!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation nordigenSecrets(
  $oAuthConfig: InputNordigenOAuthConfig,
  $callbackUri: Uri!,
  $secrets: NordigenSecrets!,
  $org: Org!,
  $org: Org!
) {
  nordigenSecrets(
    oAuthConfig: $oAuthConfig,
    callbackUri: $callbackUri,
    secrets: $secrets,
    org: $org,
    org: $org
  )
}

Variables

{
  "oAuthConfig": InputNordigenOAuthConfig,
  "callbackUri": "https://domain.com/resource",
  "secrets": NordigenSecrets,
  "org": "acme"
}

Response

{"data": {"nordigenSecrets": 42}}

Mutations

`portfolioEconomicConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioEconomicConfig!]!

Arguments

Name	Description
`configs` - `[PortfolioEconomicConfigInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation portfolioEconomicConfig(
  $configs: [PortfolioEconomicConfigInput!]!,
  $org: Org!,
  $org: Org!
) {
  portfolioEconomicConfig(
    configs: $configs,
    org: $org,
    org: $org
  ) {
    portfolioId
    contractDimensionFamily
    constantDimensionFamilies {
      dimensionFamily
      constant
    }
  }
}

Variables

{
  "configs": [PortfolioEconomicConfigInput],
  "org": "acme"
}

Response

{
  "data": {
    "portfolioEconomicConfig": [
      {
        "portfolioId": "xyz789",
        "contractDimensionFamily": 123,
        "constantDimensionFamilies": [
          ConstantDimensionFamily
        ]
      }
    ]
  }
}

Mutations

`refetchDmrAsset`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a RefetchDmrAssetResult!

Arguments

Name	Description
`assets` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation refetchDmrAsset(
  $assets: UUID!,
  $org: Org!,
  $org: Org!
) {
  refetchDmrAsset(
    assets: $assets,
    org: $org,
    org: $org
  ) {
    asset {
      assetId
      vin
      makeModel
      regNo
      firstRegDate
      assetNo
      hasVat
      hasRegTax
      color
      comment
      mileage
      retention {
        ...AssetRetentionFragment
      }
      dmr {
        ...DmrEntryFragment
      }
      dmrAdhoc {
        ...DmrAdhocResultsFragment
      }
      mostRecentDmr {
        ...UnifiedDmrEntryFragment
      }
      id
    }
    status
  }
}

Variables

{
  "assets": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "refetchDmrAsset": {"asset": Asset, "status": true}
  }
}

Mutations

`refetchDmrAssets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [RefetchDmrAssetResult!]!

Arguments

Name	Description
`assets` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation refetchDmrAssets(
  $assets: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  refetchDmrAssets(
    assets: $assets,
    org: $org,
    org: $org
  ) {
    asset {
      assetId
      vin
      makeModel
      regNo
      firstRegDate
      assetNo
      hasVat
      hasRegTax
      color
      comment
      mileage
      retention {
        ...AssetRetentionFragment
      }
      dmr {
        ...DmrEntryFragment
      }
      dmrAdhoc {
        ...DmrAdhocResultsFragment
      }
      mostRecentDmr {
        ...UnifiedDmrEntryFragment
      }
      id
    }
    status
  }
}

Variables

{
  "assets": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "refetchDmrAssets": [{"asset": Asset, "status": true}]
  }
}

Mutations

`removeEntityRoles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`roles` - `[MutableEntityRole!]!`
`entityId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation removeEntityRoles(
  $roles: [MutableEntityRole!]!,
  $entityId: UUID!,
  $org: Org!,
  $org: Org!
) {
  removeEntityRoles(
    roles: $roles,
    entityId: $entityId,
    org: $org,
    org: $org
  )
}

Variables

{
  "roles": ["DEALER"],
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{"data": {"removeEntityRoles": true}}

Mutations

`removeRoles`

Description

the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a User!

Arguments

Name	Description
`role` - `[MutableRole!]!`
`userId` - `UserId!`	A user id.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation removeRoles(
  $role: [MutableRole!]!,
  $userId: UserId!,
  $org: Org!,
  $org: Org!
) {
  removeRoles(
    role: $role,
    userId: $userId,
    org: $org,
    org: $org
  ) {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Variables

{
  "role": ["ADMIN"],
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "org": "acme"
}

Response

{
  "data": {
    "removeRoles": {
      "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
      "name": "abc123",
      "email": "john@gmail.com",
      "globalRoles": ["ADMIN"],
      "organizations": [Organization],
      "organizationUsers": [OrganizationUser]
    }
  }
}

Mutations

`reportingConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a ReportingConfig!

Arguments

Name	Description
`reportingConfig` - `ReportingConfigInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation reportingConfig(
  $reportingConfig: ReportingConfigInput!,
  $org: Org!,
  $org: Org!
) {
  reportingConfig(
    reportingConfig: $reportingConfig,
    org: $org,
    org: $org
  ) {
    expirationWarningDays
  }
}

Variables

{
  "reportingConfig": ReportingConfigInput,
  "org": "acme"
}

Response

{"data": {"reportingConfig": {"expirationWarningDays": 123}}}

Mutations

`resetPassword`

Description

Resets the users password. Returns null if the user is not modifiable. the subject 'user' (derived from the current caller's auth) must have the 'manage' relation to the 'user' resource (derived from the argument 'userId')

Response

Returns a User

Arguments

Name	Description
`password` - `String!`
`userId` - `UserId!`	A user id.
`userId` - `UserId!`	A user id.

Example

Query

mutation resetPassword(
  $password: String!,
  $userId: UserId!,
  $userId: UserId!
) {
  resetPassword(
    password: $password,
    userId: $userId,
    userId: $userId
  ) {
    id
    name
    email
    globalRoles
    organizations {
      users {
        ...UserFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
      me {
        ...OrganizationUserFragment
      }
      name
      computedRoles
      mutableRoles
    }
    organizationUsers {
      organization {
        ...OrganizationFragment
      }
      user {
        ...UserFragment
      }
      computedRoles
      mutableRoles
      id
    }
  }
}

Variables

{
  "password": "xyz789",
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
}

Response

{
  "data": {
    "resetPassword": {
      "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
      "name": "abc123",
      "email": "john@gmail.com",
      "globalRoles": ["ADMIN"],
      "organizations": [Organization],
      "organizationUsers": [OrganizationUser]
    }
  }
}

Mutations

`rkiSecrets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Lamport!

Arguments

Name	Description
`secrets` - `RkiSecrets!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation rkiSecrets(
  $secrets: RkiSecrets!,
  $org: Org!,
  $org: Org!
) {
  rkiSecrets(
    secrets: $secrets,
    org: $org,
    org: $org
  )
}

Variables

{
  "secrets": RkiSecrets,
  "org": "acme"
}

Response

{"data": {"rkiSecrets": 42}}

Mutations

`setAccountsReportConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`configs` - `[AccountsReportConfigInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setAccountsReportConfig(
  $configs: [AccountsReportConfigInput!]!,
  $org: Org!,
  $org: Org!
) {
  setAccountsReportConfig(
    configs: $configs,
    org: $org,
    org: $org
  )
}

Variables

{
  "configs": [AccountsReportConfigInput],
  "org": "acme"
}

Response

{"data": {"setAccountsReportConfig": true}}

Mutations

`setAssetRetentions`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`retentions` - `[AssetRetentionInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setAssetRetentions(
  $retentions: [AssetRetentionInput!]!,
  $org: Org!,
  $org: Org!
) {
  setAssetRetentions(
    retentions: $retentions,
    org: $org,
    org: $org
  )
}

Variables

{
  "retentions": [AssetRetentionInput],
  "org": "acme"
}

Response

{"data": {"setAssetRetentions": true}}

Mutations

`setAssets`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a SetAssetResult!

Arguments

Name	Description
`assets` - `[AssetUpdateInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setAssets(
  $assets: [AssetUpdateInput!]!,
  $org: Org!,
  $org: Org!
) {
  setAssets(
    assets: $assets,
    org: $org,
    org: $org
  ) {
    ... on AssetUpdateError {
      errors {
        ... on AssetUpdateAssetNoMustBeDefined {
          ...AssetUpdateAssetNoMustBeDefinedFragment
        }
        ... on AssetUpdateAssetNoAlreadyExists {
          ...AssetUpdateAssetNoAlreadyExistsFragment
        }
        ... on AssetUpdateVinAlreadyExists {
          ...AssetUpdateVinAlreadyExistsFragment
        }
        ... on AssetUpdateDuplicateVin {
          ...AssetUpdateDuplicateVinFragment
        }
        ... on AssetUpdateDuplicateAssetNo {
          ...AssetUpdateDuplicateAssetNoFragment
        }
        ... on AssetUpdateIdDoesNotExist {
          ...AssetUpdateIdDoesNotExistFragment
        }
      }
    }
    ... on AssetUpdateSuccess {
      assets {
        ...AssetFragment
      }
    }
  }
}

Variables

{
  "assets": [AssetUpdateInput],
  "org": "acme"
}

Response

{"data": {"setAssets": AssetUpdateError}}

Mutations

`setCosts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioV2ContractWithCosts!]!

Arguments

Name	Description
`costs` - `[PortfolioV2ContractCostInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setCosts(
  $costs: [PortfolioV2ContractCostInput!]!,
  $org: Org!,
  $org: Org!
) {
  setCosts(
    costs: $costs,
    org: $org,
    org: $org
  ) {
    contractId
    costs {
      id
      costId
      amount
      activation {
        ... on PortfolioV2ActivationTimeAt {
          ...PortfolioV2ActivationTimeAtFragment
        }
        ... on PortfolioV2ActivationTimeTermination {
          ...PortfolioV2ActivationTimeTerminationFragment
        }
        ... on PortfolioV2ActivationTimeStart {
          ...PortfolioV2ActivationTimeStartFragment
        }
      }
      periodicity {
        ... on PortfolioV2PeriodicityPeriodic {
          ...PortfolioV2PeriodicityPeriodicFragment
        }
        ... on PortfolioV2PeriodicityOnce {
          ...PortfolioV2PeriodicityOnceFragment
        }
      }
      entityId
    }
    id
  }
}

Variables

{
  "costs": [PortfolioV2ContractCostInput],
  "org": "acme"
}

Response

{
  "data": {
    "setCosts": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "costs": [PortfolioV2CostInstance],
        "id": 4
      }
    ]
  }
}

Mutations

`setEconomicConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`config` - `EconomicConfigInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setEconomicConfig(
  $config: EconomicConfigInput!,
  $org: Org!,
  $org: Org!
) {
  setEconomicConfig(
    config: $config,
    org: $org,
    org: $org
  )
}

Variables

{
  "config": EconomicConfigInput,
  "org": "acme"
}

Response

{"data": {"setEconomicConfig": true}}

Mutations

`setEconomicConfigToken`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`token` - `String`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setEconomicConfigToken(
  $token: String,
  $org: Org!,
  $org: Org!
) {
  setEconomicConfigToken(
    token: $token,
    org: $org,
    org: $org
  )
}

Variables

{
  "token": "xyz789",
  "org": "acme"
}

Response

{"data": {"setEconomicConfigToken": true}}

Mutations

`setFTPServerConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`ftpConfig` - `FTPServerConfigInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setFTPServerConfig(
  $ftpConfig: FTPServerConfigInput!,
  $org: Org!,
  $org: Org!
) {
  setFTPServerConfig(
    ftpConfig: $ftpConfig,
    org: $org,
    org: $org
  )
}

Variables

{
  "ftpConfig": FTPServerConfigInput,
  "org": "acme"
}

Response

{"data": {"setFTPServerConfig": true}}

Mutations

`setLoanAndLeaseContractCosts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`costs` - `LoanAndLeaseContractCostsInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setLoanAndLeaseContractCosts(
  $costs: LoanAndLeaseContractCostsInput!,
  $org: Org!,
  $org: Org!
) {
  setLoanAndLeaseContractCosts(
    costs: $costs,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "costs": LoanAndLeaseContractCostsInput,
  "org": "acme"
}

Response

{
  "data": {
    "setLoanAndLeaseContractCosts": LoanAndLeaseContractUpdateError
  }
}

Mutations

`setLoanAndLeaseEntities`

Description

Updates loan and lease entities. The number of input entities must be larger than 0. The output order is the same as the input order.

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseUpdateOutcome!

Arguments

Name	Description
`companies` - `[LoanAndLeaseCompanyUpdate!]!`
`people` - `[LoanAndLeasePersonUpdate!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setLoanAndLeaseEntities(
  $companies: [LoanAndLeaseCompanyUpdate!]!,
  $people: [LoanAndLeasePersonUpdate!]!,
  $org: Org!,
  $org: Org!
) {
  setLoanAndLeaseEntities(
    companies: $companies,
    people: $people,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseUpdateError {
      type
    }
    ... on LoanAndLeaseUpdateResult {
      outcome {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
  }
}

Variables

{
  "companies": [LoanAndLeaseCompanyUpdate],
  "people": [LoanAndLeasePersonUpdate],
  "org": "acme"
}

Response

{
  "data": {
    "setLoanAndLeaseEntities": LoanAndLeaseUpdateError
  }
}

Mutations

`setOrgConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`config` - `OrgConfigInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setOrgConfig(
  $config: OrgConfigInput!,
  $org: Org!,
  $org: Org!
) {
  setOrgConfig(
    config: $config,
    org: $org,
    org: $org
  )
}

Variables

{
  "config": OrgConfigInput,
  "org": "acme"
}

Response

{"data": {"setOrgConfig": true}}

Mutations

`setPBSConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`pbsConfig` - `PBSConfigInput!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation setPBSConfig(
  $pbsConfig: PBSConfigInput!,
  $org: Org!,
  $org: Org!
) {
  setPBSConfig(
    pbsConfig: $pbsConfig,
    org: $org,
    org: $org
  )
}

Variables

{
  "pbsConfig": PBSConfigInput,
  "org": "acme"
}

Response

{"data": {"setPBSConfig": true}}

Mutations

`updateCosts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioV2ContractWithCosts!]!

Arguments

Name	Description
`updates` - `[UpdateCosts!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation updateCosts(
  $updates: [UpdateCosts!]!,
  $org: Org!,
  $org: Org!
) {
  updateCosts(
    updates: $updates,
    org: $org,
    org: $org
  ) {
    contractId
    costs {
      id
      costId
      amount
      activation {
        ... on PortfolioV2ActivationTimeAt {
          ...PortfolioV2ActivationTimeAtFragment
        }
        ... on PortfolioV2ActivationTimeTermination {
          ...PortfolioV2ActivationTimeTerminationFragment
        }
        ... on PortfolioV2ActivationTimeStart {
          ...PortfolioV2ActivationTimeStartFragment
        }
      }
      periodicity {
        ... on PortfolioV2PeriodicityPeriodic {
          ...PortfolioV2PeriodicityPeriodicFragment
        }
        ... on PortfolioV2PeriodicityOnce {
          ...PortfolioV2PeriodicityOnceFragment
        }
      }
      entityId
    }
    id
  }
}

Variables

{
  "updates": [UpdateCosts],
  "org": "acme"
}

Response

{
  "data": {
    "updateCosts": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "costs": [PortfolioV2CostInstance],
        "id": "4"
      }
    ]
  }
}

Mutations

`updateLoanAndLeaseContracts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractUpdateOutcome!

Arguments

Name	Description
`contracts` - `[LoanAndLeaseContractUpdateInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

mutation updateLoanAndLeaseContracts(
  $contracts: [LoanAndLeaseContractUpdateInput!]!,
  $org: Org!,
  $org: Org!
) {
  updateLoanAndLeaseContracts(
    contracts: $contracts,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeaseContractUpdateError {
      type
    }
    ... on LoanAndLeaseContractUpdateSuccess {
      data {
        ...LoanAndLeaseContractFragment
      }
    }
  }
}

Variables

{
  "contracts": [LoanAndLeaseContractUpdateInput],
  "org": "acme"
}

Response

{
  "data": {
    "updateLoanAndLeaseContracts": LoanAndLeaseContractUpdateError
  }
}

Types

AccountsReportConfig

Fields

Field Name	Description
`portfolioId` - `String!`
`columns` - `[AccountsReportConfigColumnGroup!]!`

Example

{
  "portfolioId": "abc123",
  "columns": [AccountsReportConfigColumnGroup]
}

Types

AccountsReportConfigAccountSumColumn

Fields

Field Name	Description
`period` - `AccountsReportConfigPeriod!`
`accountIds` - `[String!]!`
`productIds` - `[String!]!`
`mirrorAccounts` - `[Long!]!`
`columnTitle` - `String`

Example

{
  "period": "ACCOUNTING_YEAR_STATUS_START",
  "accountIds": ["xyz789"],
  "productIds": ["abc123"],
  "mirrorAccounts": [9223372036854776000],
  "columnTitle": "xyz789"
}

Types

AccountsReportConfigAccountSumColumnInput

Fields

Input Field	Description
`columnTitle` - `String`
`mirrorAccounts` - `[Long!]!`
`productIds` - `[String!]!`
`accountIds` - `[String!]!`
`period` - `AccountsReportConfigPeriod!`

Example

{
  "columnTitle": "xyz789",
  "mirrorAccounts": [9223372036854776000],
  "productIds": ["xyz789"],
  "accountIds": ["xyz789"],
  "period": "ACCOUNTING_YEAR_STATUS_START"
}

Types

AccountsReportConfigColumn

Types

Union Types
`AccountsReportConfigCostColumn`
`AccountsReportConfigAccountSumColumn`

Example

AccountsReportConfigCostColumn

Types

AccountsReportConfigColumnGroup

Fields

Field Name	Description
`columnTitle` - `String!`
`columns` - `[AccountsReportConfigColumn!]!`

Example

{
  "columnTitle": "xyz789",
  "columns": [AccountsReportConfigCostColumn]
}

Types

AccountsReportConfigColumnGroupInput

Fields

Input Field	Description
`columns` - `[AccountsReportConfigColumnInput!]!`
`columnTitle` - `String!`

Example

{
  "columns": [AccountsReportConfigColumnInput],
  "columnTitle": "xyz789"
}

Types

AccountsReportConfigColumnInput

Description

Exactly one of the fields must be provided, (input union)

Fields

Input Field	Description
`cost` - `AccountsReportConfigCostColumnInput`
`accountSum` - `AccountsReportConfigAccountSumColumnInput`

Example

{
  "cost": AccountsReportConfigCostColumnInput,
  "accountSum": AccountsReportConfigAccountSumColumnInput
}

Types

AccountsReportConfigCostColumn

Fields

Field Name	Description
`costId` - `String!`

Example

{"costId": "xyz789"}

Types

AccountsReportConfigCostColumnInput

Fields

Input Field	Description
`costId` - `String!`

Example

{"costId": "abc123"}

Types

AccountsReportConfigInput

Fields

Input Field	Description
`columns` - `[AccountsReportConfigColumnGroupInput!]!`
`portfolioId` - `String!`

Example

{
  "columns": [AccountsReportConfigColumnGroupInput],
  "portfolioId": "xyz789"
}

Types

AccountsReportConfigPeriod

Values

Enum Value	Description
`ACCOUNTING_YEAR_STATUS_START`
`ACCOUNTING_YEAR_STATUS_END`
`ACCOUNTING_YEAR_TOTAL_CHANGE`
`ACCOUNTING_YEAR_MONTH_CHANGE`
`MONTH_STATUS_START`
`MONTH_STATUS_END`
`MONTH_CHANGE`

Example

"ACCOUNTING_YEAR_STATUS_START"

Types

AddContractFilesContractNotFoundError

Fields

Field Name	Description
`contracts` - `[LoanAndLeaseContract!]!`

Example

{"contracts": [LoanAndLeaseContract]}

Types

AddContractFilesOutcome

Types

Union Types
`AddContractFilesSuccess`
`AddContractFilesContractNotFoundError`

Example

AddContractFilesSuccess

Types

AddContractFilesSuccess

Fields

Field Name	Description
`contracts` - `[LoanAndLeaseContract!]!`

Example

{"contracts": [LoanAndLeaseContract]}

Types

AnnuityType

Values

Enum Value	Description
`BEGIN`
`END`

Example

"BEGIN"

Types

AppPortalAccess

Fields

Field Name	Description
`url` - `Uri!`
`token` - `String!`

Example

{
  "url": "https://domain.com/resource",
  "token": "abc123"
}

Types

Asset

Description

Requires the caller to have the 'reader' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`assetId` - `UUID!`
`vin` - `String`
`makeModel` - `String`
`regNo` - `String`
`firstRegDate` - `LocalDate`
`assetNo` - `Int`
`hasVat` - `Boolean!`
`hasRegTax` - `Boolean!`
`color` - `String`
`comment` - `String`
`mileage` - `Int`
`retention` - `AssetRetention`
`dmr` - `[DmrEntry!]!`
`dmrAdhoc` - `DmrAdhocResults`
`mostRecentDmr` - `UnifiedDmrEntry`
`id` - `ID!`

Example

{
  "assetId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "vin": "abc123",
  "makeModel": "abc123",
  "regNo": "xyz789",
  "firstRegDate": "2020-07-19",
  "assetNo": 123,
  "hasVat": true,
  "hasRegTax": true,
  "color": "xyz789",
  "comment": "xyz789",
  "mileage": 123,
  "retention": AssetRetention,
  "dmr": [DmrEntry],
  "dmrAdhoc": DmrAdhocResults,
  "mostRecentDmr": UnifiedDmrEntry,
  "id": 4
}

Types

AssetCreationAssetNoAlreadyExists

Fields

Field Name	Description
`vin` - `Int!`
`conflicting` - `Asset!`

Example

{"vin": 987, "conflicting": Asset}

Types

AssetCreationAssetNoMustBeDefined

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

AssetCreationDuplicateAssetNo

Fields

Field Name	Description
`assetNo` - `Int!`

Example

{"assetNo": 987}

Types

AssetCreationDuplicateVin

Fields

Field Name	Description
`vin` - `String!`

Example

{"vin": "xyz789"}

Types

AssetCreationError

Types

Union Types
`AssetCreationAssetNoMustBeDefined`
`AssetCreationDuplicateAssetNo`
`AssetCreationDuplicateVin`
`AssetCreationAssetNoAlreadyExists`
`AssetCreationVinAlreadyExists`

Example

AssetCreationAssetNoMustBeDefined

Types

AssetCreationFailure

Fields

Field Name	Description
`errors` - `[AssetCreationError!]!`

Example

{"errors": [AssetCreationAssetNoMustBeDefined]}

Types

AssetCreationSuccess

Fields

Field Name	Description
`assets` - `[Asset!]!`

Example

{"assets": [Asset]}

Types

AssetCreationVinAlreadyExists

Fields

Field Name	Description
`vin` - `String!`
`conflicting` - `Asset!`

Example

{
  "vin": "xyz789",
  "conflicting": Asset
}

Types

AssetInput

Fields

Input Field	Description
`mileage` - `Int`
`comment` - `String`
`color` - `String`
`hasRegTax` - `Boolean!`
`hasVat` - `Boolean!`
`assetNo` - `Int`
`firstRegDate` - `LocalDate`
`regNo` - `String`
`makeModel` - `String`
`vin` - `String`

Example

{
  "mileage": 987,
  "comment": "xyz789",
  "color": "xyz789",
  "hasRegTax": true,
  "hasVat": true,
  "assetNo": 123,
  "firstRegDate": "2020-07-19",
  "regNo": "xyz789",
  "makeModel": "xyz789",
  "vin": "abc123"
}

Types

AssetRetention

Fields

Field Name	Description
`contractRelations` - `[LoanAndLeaseContract!]!`
`hidden` - `Boolean!`
`retainUntil` - `Instant`
`hasConflicts` - `Boolean!`

Example

{
  "contractRelations": [LoanAndLeaseContract],
  "hidden": true,
  "retainUntil": 1654109791,
  "hasConflicts": true
}

Types

AssetRetentionInput

Fields

Input Field	Description
`retentionInput` - `LoanAndLeaseRetentionInput!`
`id` - `UUID!`

Example

{
  "retentionInput": LoanAndLeaseRetentionInput,
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

AssetUpdateAssetNoAlreadyExists

Fields

Field Name	Description
`inserted` - `Asset!`
`assetNo` - `Int!`
`conflicting` - `Asset!`

Example

{
  "inserted": Asset,
  "assetNo": 123,
  "conflicting": Asset
}

Types

AssetUpdateAssetNoMustBeDefined

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

AssetUpdateDuplicateAssetNo

Fields

Field Name	Description
`assetNo` - `Int!`

Example

{"assetNo": 987}

Types

AssetUpdateDuplicateVin

Fields

Field Name	Description
`vin` - `String!`

Example

{"vin": "xyz789"}

Types

AssetUpdateError

Fields

Field Name	Description
`errors` - `[SetAssetError!]!`

Example

{"errors": [AssetUpdateAssetNoMustBeDefined]}

Types

AssetUpdateIdDoesNotExist

Fields

Field Name	Description
`id` - `UUID!`

Example

{
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

AssetUpdateInput

Fields

Input Field	Description
`input` - `AssetInput!`
`id` - `UUID!`

Example

{
  "input": AssetInput,
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

AssetUpdateSuccess

Fields

Field Name	Description
`assets` - `[Asset!]!`

Example

{"assets": [Asset]}

Types

AssetUpdateVinAlreadyExists

Fields

Field Name	Description
`inserted` - `Asset!`
`vin` - `String!`
`conflicting` - `Asset!`

Example

{
  "inserted": Asset,
  "vin": "xyz789",
  "conflicting": Asset
}

Types

BadDebtEntry

Fields

Field Name	Description
`entryId` - `String!`
`creditor` - `String`
`dateOfTransmission` - `LocalDate`
`dateOfRemoval` - `LocalDate`
`foundation` - `String!`
`amount` - `BigDecimal`

Example

{
  "entryId": "xyz789",
  "creditor": "abc123",
  "dateOfTransmission": "2020-07-19",
  "dateOfRemoval": "2020-07-19",
  "foundation": "xyz789",
  "amount": "28391719239482739937.1939459927192"
}

Types

BadDebtResponse

Types

Union Types
`RegisterError`
`BadDebtResult`

Example

RegisterError

Types

BadDebtResult

Fields

Field Name	Description
`name` - `String`
`entries` - `[BadDebtEntry!]!`
`timestamp` - `Instant!`

Example

{
  "name": "xyz789",
  "entries": [BadDebtEntry],
  "timestamp": 1654109791
}

Types

BadDebtStatus

Types

Union Types
`CreditlinkBadDebtStatusFailed`
`CreditlinkBadDebtStatusCompleted`
`CreditlinkBadDebtStatusEnumCase`

Example

CreditlinkBadDebtStatusFailed

Types

BigDecimal

Description

The BigDecimal scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

"28391719239482739937.1939459927192"

Types

BigInt

Description

The BigInt scalar type represents non-fractional signed whole numeric values. BigInt can represent values of arbitrary size.

Example

{}

Types

Bookable

Fields

Field Name	Description
`bookingDate` - `LocalDate!`
`periodStart` - `LocalDate!`
`periodEnd` - `LocalDate`
`amount` - `BigDecimal!`

Example

{
  "bookingDate": "2020-07-19",
  "periodStart": "2020-07-19",
  "periodEnd": "2020-07-19",
  "amount": "28391719239482739937.1939459927192"
}

Types

BookingType

Types

Union Types
`BookingTypeTransaction`
`BookingTypeInvoice`

Example

BookingTypeTransaction

Types

BookingTypeInvoice

Fields

Field Name	Description
`invoice` - `LoanAndLeaseInvoiceGroup!`

Example

{"invoice": LoanAndLeaseInvoiceGroup}

Types

BookingTypeTransaction

Fields

Field Name	Description
`group` - `LoanAndLeaseTransactionGroup!`
`transaction` - `LoanAndLeaseTransactionEntry!`

Example

{
  "group": LoanAndLeaseTransactionGroup,
  "transaction": LoanAndLeaseTransactionEntry
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

Collectables

Fields

Field Name	Description
`certificate` - `CollectablesCertificate!`
`collectables` - `[LoanAndLeaseInvoiceGroup!]!`

Example

{
  "certificate": CollectablesCertificate,
  "collectables": [LoanAndLeaseInvoiceGroup]
}

Types

CollectablesCertificate

Fields

Field Name	Description
`token` - `CollectionToken!`
`hash` - `String!`

Example

{
  "token": CollectionToken,
  "hash": "abc123"
}

Types

CollectablesCertificateInput

Fields

Input Field	Description
`hash` - `String!`
`token` - `CollectionTokenInput!`

Example

{
  "hash": "abc123",
  "token": CollectionTokenInput
}

Types

CollectionCalendarMonth

Fields

Field Name	Description
`month` - `YearMonth!`
`normalDeadline` - `Instant!`
`extendedDeadline` - `Instant!`
`invoicingPeriod` - `YearMonth!`
`bankDays` - `[LocalDate!]!`
`minBankDay` - `LocalDate!`
`maxBankDay` - `LocalDate!`
`deadlineStart` - `Instant!`

Example

{
  "month": "2007-12",
  "normalDeadline": 1654109791,
  "extendedDeadline": 1654109791,
  "invoicingPeriod": "2007-12",
  "bankDays": ["2020-07-19"],
  "minBankDay": "2020-07-19",
  "maxBankDay": "2020-07-19",
  "deadlineStart": 1654109791
}

Types

CollectionToken

Fields

Field Name	Description
`timestamp` - `Instant!`
`timeStatus` - `collectionTimeStatus!`
`calendar` - `CollectionCalendarMonth!`

Example

{
  "timestamp": 1654109791,
  "timeStatus": "TOO_EARLY",
  "calendar": CollectionCalendarMonth
}

Types

CollectionTokenInput

Fields

Input Field	Description
`month` - `YearMonth!`
`timestamp` - `Instant!`

Example

{
  "month": "2007-12",
  "timestamp": 1654109791
}

Types

CompanyIdentifier

Types

Union Types
`CountrySpecificValue`
`DanishCompanyIdentifier`

Example

CountrySpecificValue

Types

CompanyIdentifierInput

Description

Either a danish company identifier or a country specific value must be specified. Specifying both is not allowed and will result in an error.

Fields

Input Field	Description
`countrySpecificValue` - `CountrySpecificValueInput`
`danishCompanyIdentifier` - `Cvr`

Example

{
  "countrySpecificValue": CountrySpecificValueInput,
  "danishCompanyIdentifier": "35890270"
}

Types

ComplianceAnswer

Fields

Field Name	Description
`recentLoans` - `Boolean!`

Example

{"recentLoans": true}

Types

ComputedRole

Description

A role that is immutable and derived from the mutable roles

Values

Enum Value	Description
`ANYONE`	Translates to the 'anyone' role
`READER`	Translates to the 'reader' role
`MANAGER`	Translates to the 'manager' role
`CONTRACT_READER`	Translates to the 'contract_reader' role
`CONFIG`	Translates to the 'config' role

Example

"ANYONE"

Types

ConstantDimensionFamily

Fields

Field Name	Description
`dimensionFamily` - `Int!`
`constant` - `Int!`

Example

{"dimensionFamily": 123, "constant": 987}

Types

ConstantDimensionFamilyInput

Fields

Input Field	Description
`constant` - `Int!`
`dimensionFamily` - `Int!`

Example

{"constant": 987, "dimensionFamily": 123}

Types

ContractFile

Fields

Field Name	Description
`file` - `File!`
`category` - `ContractFileCategory!`
`caption` - `String`
`created` - `Instant!`
`author` - `User`

Example

{
  "file": File,
  "category": "OTHER",
  "caption": "xyz789",
  "created": 1654109791,
  "author": User
}

Types

ContractFileCategory

Values

Enum Value	Description
`OTHER`

Example

"OTHER"

Types

ContractFileInput

Fields

Input Field	Description
`category` - `ContractFileCategory!`
`file` - `FileInput!`
`contractId` - `UUID!`

Example

{
  "category": "OTHER",
  "file": FileInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

ContractPortfolioCount

Fields

Field Name	Description
`portfolioId` - `String!`
`count` - `Long!`

Example

{
  "portfolioId": "xyz789",
  "count": 9223372036854776000
}

Types

ContractPortfolioCounts

Fields

Field Name	Description
`all` - `Long!`
`entries` - `[ContractPortfolioCount!]!`

Example

{
  "all": 9223372036854776000,
  "entries": [ContractPortfolioCount]
}

Types

ContractType

Types

Union Types
`ContractTypeEconomic`
`ContractTypeGeneric`

Example

ContractTypeEconomic

Types

ContractTypeEconomic

Fields

Field Name	Description
`dimensionNo` - `Int`
`department` - `EconomicDepartmentResult`

Example

{"dimensionNo": 123, "department": EconomicDepartment}

Types

ContractTypeGeneric

Fields

Field Name	Description
`contractNumber` - `String`

Example

{"contractNumber": "xyz789"}

Types

CountryCode

Types

Union Types
`KnownCountryCode`
`UnknownCountryCode`

Example

KnownCountryCode

Types

CountryCodeInput

Description

Either a known country code or an unknown country code must be specified. Specifying both is not allowed and will result in an error.

Fields

Input Field	Description
`knownCountryCode` - `KnownCountryCodeType`
`unknownCountryCode` - `String`

Example

{
  "knownCountryCode": "DK",
  "unknownCountryCode": "xyz789"
}

Types

CountrySpecificValue

Fields

Field Name	Description
`countryCode` - `String!`
`value` - `String!`

Example

{
  "countryCode": "xyz789",
  "value": "abc123"
}

Types

CountrySpecificValueInput

Fields

Input Field	Description
`value` - `String!`
`countryCode` - `String!`

Example

{
  "value": "abc123",
  "countryCode": "xyz789"
}

Types

Cpr

Description

The Cpr scalar type is a valid danish Cpr.

Example

"0810972032"

Types

CreateAssetResult

Types

Union Types
`AssetCreationFailure`
`AssetCreationSuccess`

Example

AssetCreationFailure

Types

CreateCreditlinkCompany

Fields

Input Field	Description
`externalId` - `ExternalId`
`financialCrimeEnabled` - `Boolean!`
`badDebtEnabled` - `Boolean!`
`phone` - `Phone`
`email` - `Email`
`cvr` - `Cvr!`
`name` - `String!`

Example

{
  "externalId": "0110293",
  "financialCrimeEnabled": true,
  "badDebtEnabled": true,
  "phone": "29400888",
  "email": "john@gmail.com",
  "cvr": "35890270",
  "name": "xyz789"
}

Types

CreateCreditlinkPerson

Fields

Input Field	Description
`externalId` - `ExternalId`
`creditroContact` - `Boolean!`
`proofOfIdentityEnabled` - `Boolean`
`psd2Enabled` - `Boolean!`
`taxInfoEnabled` - `Boolean!`
`financialCrimeEnabled` - `Boolean!`
`badDebtEnabled` - `Boolean!`
`phone` - `Phone`
`email` - `Email`
`cpr` - `Cpr`
`name` - `String!`

Example

{
  "externalId": "0110293",
  "creditroContact": true,
  "proofOfIdentityEnabled": true,
  "psd2Enabled": true,
  "taxInfoEnabled": true,
  "financialCrimeEnabled": true,
  "badDebtEnabled": true,
  "phone": "29400888",
  "email": "john@gmail.com",
  "cpr": "0810972032",
  "name": "abc123"
}

Types

CreditlinkBadDebtStatusCompleted

Fields

Field Name	Description
`data` - `BadDebtResult!`	Lazily fetches the underlying data

Example

{"data": BadDebtResult}

Types

CreditlinkBadDebtStatusEnum

Values

Enum Value	Description
`PENDING`

Example

"PENDING"

Types

CreditlinkBadDebtStatusEnumCase

Fields

Field Name	Description
`enumCase` - `CreditlinkBadDebtStatusEnum!`

Example

{"enumCase": "PENDING"}

Types

CreditlinkBadDebtStatusFailed

Fields

Field Name	Description
`error` - `RegisterError!`	Lazily fetches the underlying error

Example

{"error": RegisterError}

Types

CreditlinkCase

Fields

Field Name	Description
`caseId` - `UUID!`
`externalId` - `ExternalId`
`dealerName` - `String!`
`assetName` - `String!`
`monthlyPayment` - `BigDecimal!`
`psd2Provider` - `CreditlinkPSD2Provider!`
`sendLink` - `Boolean!`
`comments` - `[CreditlinkComment!]!`
`approverDisposableIncome` - `CreditlinkUserDisposableIncome`
`debtorDisposableIncome` - `CreditlinkUserDisposableIncome`
`computed` - `CreditlinkDisposableIncome`
`status` - `CreditlinkCaseStatus!`
`primaryDebtor` - `CreditlinkPerson`
`secondaryDebtor` - `CreditlinkPerson`
`other` - `[CreditlinkEntity!]!`
`retention` - `Instant`

Example

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "externalId": "0110293",
  "dealerName": "abc123",
  "assetName": "abc123",
  "monthlyPayment": "28391719239482739937.1939459927192",
  "psd2Provider": "NORDIGEN",
  "sendLink": true,
  "comments": [CreditlinkComment],
  "approverDisposableIncome": CreditlinkUserDisposableIncome,
  "debtorDisposableIncome": CreditlinkUserDisposableIncome,
  "computed": CreditlinkDisposableIncome,
  "status": "OPEN",
  "primaryDebtor": CreditlinkPerson,
  "secondaryDebtor": CreditlinkPerson,
  "other": [CreditlinkPerson],
  "retention": 1654109791
}

Types

CreditlinkCaseCreated

Fields

Field Name	Description
`caseId` - `UUID!`
`case` - `CreditlinkCase!`

Example

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "case": CreditlinkCase
}

Types

CreditlinkCaseCreationError

Fields

Field Name	Description
`errorType` - `CreditlinkCaseCreationErrorType!`

Example

{"errorType": "EXTERNAL_ID_ALREADY_EXISTS"}

Types

CreditlinkCaseCreationErrorType

Values

Enum Value	Description
`EXTERNAL_ID_ALREADY_EXISTS`

Example

"EXTERNAL_ID_ALREADY_EXISTS"

Types

CreditlinkCaseCreationResult

Types

Union Types
`CreditlinkCaseCreationError`
`CreditlinkCaseCreated`

Example

CreditlinkCaseCreationError

Types

CreditlinkCaseDeletedEvent

Fields

Field Name	Description
`org` - `Org!`
`caseId` - `UUID!`

Example

{
  "org": "acme",
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

CreditlinkCaseEvent

Types

Union Types
`CreditlinkCaseSubscribedEvent`
`CreditlinkCaseUpdatedEvent`
`CreditlinkCaseDeletedEvent`

Example

CreditlinkCaseSubscribedEvent

Types

CreditlinkCaseStatus

Values

Enum Value	Description
`OPEN`
`MISSING_PRIMARY`
`MISSING_SECONDARY`
`MISSING_APPROVER`
`CLOSED`

Example

"OPEN"

Types

CreditlinkCaseSubscribedEvent

Fields

Field Name	Description
`case` - `CreditlinkCase`

Example

{"case": CreditlinkCase}

Types

CreditlinkCaseUpdatedEvent

Fields

Field Name	Description
`case` - `CreditlinkCase!`

Example

{"case": CreditlinkCase}

Types

CreditlinkCasesEvent

Types

Union Types
`CreditlinkCasesEventSubscribed`
`CreditlinkCasesEventUpdate`

Example

CreditlinkCasesEventSubscribed

Types

CreditlinkCasesEventSubscribed

Fields

Field Name	Description
`org` - `Org!`
`bundles` - `[CreditlinkCase!]!`

Example

{
  "org": "acme",
  "bundles": [CreditlinkCase]
}

Types

CreditlinkCasesEventUpdate

Fields

Field Name	Description
`org` - `Org!`
`new` - `[CreditlinkCase!]!`
`orderedIds` - `[UUID!]!`
`removed` - `[UUID!]!`

Example

{
  "org": "acme",
  "new": [CreditlinkCase],
  "orderedIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "removed": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Types

CreditlinkClientConfig

Fields

Field Name	Description
`leasingIntroText` - `String`
`loanIntroText` - `String`
`privacyPolicyLink` - `String`

Example

{
  "leasingIntroText": "xyz789",
  "loanIntroText": "xyz789",
  "privacyPolicyLink": "abc123"
}

Types

CreditlinkComment

Fields

Field Name	Description
`text` - `String!`
`author` - `String!`
`user` - `User`

Example

{
  "text": "xyz789",
  "author": "abc123",
  "user": User
}

Types

CreditlinkCompany

Fields

Field Name	Description
`userId` - `UserId!`
`euSanctions` - `[SanctionedEntity!]!`
`name` - `String!`
`cvr` - `Cvr!`
`email` - `Email`
`phone` - `Phone`
`badDebtEnabled` - `Boolean!`
`financialCrimeEnabled` - `Boolean!`
`cvrData` - `CvrData`
`annualReports` - `[CvrAnnualReport!]!`	The annual reports are always sorted by year in ascending order.
`cvrDataStatus` - `CvrStatus`
`financialCrimeStatus` - `FinancialCrimeStatus`
`badDebtStatus` - `BadDebtStatus`
`hasUserInteraction` - `Boolean!`
`externalId` - `ExternalId`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "euSanctions": [SanctionedEntity],
  "name": "abc123",
  "cvr": "35890270",
  "email": "john@gmail.com",
  "phone": "29400888",
  "badDebtEnabled": true,
  "financialCrimeEnabled": true,
  "cvrData": CvrData,
  "annualReports": [CvrAnnualReport],
  "cvrDataStatus": CreditlinkCvrStatusCompleted,
  "financialCrimeStatus": CreditlinkFinancialCrimeStatusCompleted,
  "badDebtStatus": CreditlinkBadDebtStatusFailed,
  "hasUserInteraction": true,
  "externalId": "0110293"
}

Types

CreditlinkCreditroCaseData

Fields

Field Name	Description
`status` - `CreditlinkCreditroCaseStatus!`

Example

{"status": CreditlinkCreditroCaseStatusSuccess}

Types

CreditlinkCreditroCaseStatus

Types

Union Types
`CreditlinkCreditroCaseStatusSuccess`
`CreditlinkCreditroCaseStatusFailure`
`CreditlinkCreditroCaseStatusPreRequest`
`CreditlinkCreditroCaseStatusPending`

Example

CreditlinkCreditroCaseStatusSuccess

Types

CreditlinkCreditroCaseStatusFailure

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkCreditroCaseStatusPending

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkCreditroCaseStatusPreRequest

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkCreditroCaseStatusSuccess

Fields

Field Name	Description
`creditroId` - `String!`

Example

{"creditroId": "xyz789"}

Types

CreditlinkCreditroConfigIn

Fields

Input Field	Description
`clientManagerEmail` - `Email!`
`customerServiceId` - `String!`
`customerTypeId` - `String!`
`enabled` - `Boolean!`

Example

{
  "clientManagerEmail": "john@gmail.com",
  "customerServiceId": "xyz789",
  "customerTypeId": "xyz789",
  "enabled": true
}

Types

CreditlinkCreditroConfigOut

Fields

Field Name	Description
`enabled` - `Boolean!`
`customerTypeId` - `String!`
`customerServiceId` - `String!`
`clientManagerEmail` - `Email!`

Example

{
  "enabled": true,
  "customerTypeId": "xyz789",
  "customerServiceId": "xyz789",
  "clientManagerEmail": "john@gmail.com"
}

Types

CreditlinkCreditroFlag

Description

This is a deprecated flag, use the other flag instead

Values

Enum Value	Description
`DISABLED`
`CREATE_AND_NOTIFY`

Example

"DISABLED"

Types

CreditlinkCreditroSecrets

Fields

Input Field	Description
`apiToken` - `String!`

Example

{"apiToken": "xyz789"}

Types

CreditlinkCvrStatusCompleted

Fields

Field Name	Description
`cvrData` - `CvrData`
`annualReports` - `[CvrAnnualReport!]!`

Example

{
  "cvrData": CvrData,
  "annualReports": [CvrAnnualReport]
}

Types

CreditlinkCvrStatusEnum

Values

Enum Value	Description
`PENDING`
`FAILED`

Example

"PENDING"

Types

CreditlinkCvrStatusEnumCase

Fields

Field Name	Description
`enumCase` - `CreditlinkCvrStatusEnum!`

Example

{"enumCase": "PENDING"}

Types

CreditlinkDisposableIncome

Fields

Field Name	Description
`income` - `CreditlinkDisposableIncomeIncome!`
`home` - `CreditlinkDisposableIncomeHome!`
`vehicle` - `CreditlinkDisposableIncomeVehicle!`
`misc` - `CreditlinkDisposableIncomeMisc!`

Example

{
  "income": CreditlinkDisposableIncomeIncome,
  "home": CreditlinkDisposableIncomeHome,
  "vehicle": CreditlinkDisposableIncomeVehicle,
  "misc": CreditlinkDisposableIncomeMisc
}

Types

CreditlinkDisposableIncomeHome

Fields

Field Name	Description
`rentAndMortgage` - `BigDecimal!`
`utilities` - `BigDecimal!`
`propertyTax` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "rentAndMortgage": "28391719239482739937.1939459927192",
  "utilities": "28391719239482739937.1939459927192",
  "propertyTax": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

CreditlinkDisposableIncomeIncome

Fields

Field Name	Description
`salary` - `BigDecimal!`
`salary2` - `BigDecimal!`
`unemploymentBenefits` - `BigDecimal!`
`childBenefits` - `BigDecimal!`
`housingBenefits` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "salary": "28391719239482739937.1939459927192",
  "salary2": "28391719239482739937.1939459927192",
  "unemploymentBenefits": "28391719239482739937.1939459927192",
  "childBenefits": "28391719239482739937.1939459927192",
  "housingBenefits": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

CreditlinkDisposableIncomeMisc

Fields

Field Name	Description
`unemploymentFund` - `BigDecimal!`
`insurances` - `BigDecimal!`
`childCare` - `BigDecimal!`
`subscriptions` - `BigDecimal!`
`otherLoans` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "unemploymentFund": "28391719239482739937.1939459927192",
  "insurances": "28391719239482739937.1939459927192",
  "childCare": "28391719239482739937.1939459927192",
  "subscriptions": "28391719239482739937.1939459927192",
  "otherLoans": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

CreditlinkDisposableIncomeRole

Values

Enum Value	Description
`PRIMARY_DEBTOR`
`SECONDARY_DEBTOR`

Example

"PRIMARY_DEBTOR"

Types

CreditlinkDisposableIncomeVehicle

Fields

Field Name	Description
`monthlyPayment` - `BigDecimal!`
`fuel` - `BigDecimal!`
`ownershipTax` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "monthlyPayment": "28391719239482739937.1939459927192",
  "fuel": "28391719239482739937.1939459927192",
  "ownershipTax": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

CreditlinkESkatStatusCompleted

Fields

Field Name	Description
`userId` - `UserId!`
`lamport` - `Lamport!`
`derivedData` - `ESkatDerivedData!`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "lamport": 42,
  "derivedData": ESkatDerivedData
}

Types

CreditlinkESkatStatusFailed

Fields

Field Name	Description
`userId` - `UserId!`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
}

Types

CreditlinkESkatStatusRunning

Fields

Field Name	Description
`userId` - `UserId!`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
}

Types

CreditlinkEntity

Types

Union Types
`CreditlinkPerson`
`CreditlinkCompany`

Example

CreditlinkPerson

Types

CreditlinkFilter

Values

Enum Value	Description
`AWAITING_CUSTOMER`
`AWAITING_ASSESSMENT`
`ERROR`
`DONE`

Example

"AWAITING_CUSTOMER"

Types

CreditlinkFinancialCrimeStatusCompleted

Fields

Field Name	Description
`data` - `FinancialCrimeResult!`	Lazily fetches the underlying data

Example

{"data": FinancialCrimeResult}

Types

CreditlinkFinancialCrimeStatusEnum

Values

Enum Value	Description
`PENDING`
`FAILED`

Example

"PENDING"

Types

CreditlinkFinancialCrimeStatusEnumCase

Fields

Field Name	Description
`enumCase` - `CreditlinkFinancialCrimeStatusEnum!`

Example

{"enumCase": "PENDING"}

Types

CreditlinkInputCreditroFlag

Fields

Input Field	Description
`dummy` - `Boolean!`	This field facilitates forwards compatibility

Example

{"dummy": true}

Types

CreditlinkInputDisposableIncome

Fields

Input Field	Description
`misc` - `CreditlinkInputDisposableIncomeMisc!`
`vehicle` - `CreditlinkInputDisposableIncomeVehicle!`
`home` - `CreditlinkInputDisposableIncomeHome!`
`income` - `CreditlinkInputDisposableIncomeIncome!`

Example

{
  "misc": CreditlinkInputDisposableIncomeMisc,
  "vehicle": CreditlinkInputDisposableIncomeVehicle,
  "home": CreditlinkInputDisposableIncomeHome,
  "income": CreditlinkInputDisposableIncomeIncome
}

Types

CreditlinkInputDisposableIncomeHome

Fields

Input Field	Description
`other` - `BigDecimal!`
`propertyTax` - `BigDecimal!`
`utilities` - `BigDecimal!`
`rentAndMortgage` - `BigDecimal!`

Example

{
  "other": "28391719239482739937.1939459927192",
  "propertyTax": "28391719239482739937.1939459927192",
  "utilities": "28391719239482739937.1939459927192",
  "rentAndMortgage": "28391719239482739937.1939459927192"
}

Types

CreditlinkInputDisposableIncomeIncome

Fields

Input Field	Description
`other` - `BigDecimal!`
`housingBenefits` - `BigDecimal!`
`childBenefits` - `BigDecimal!`
`unemploymentBenefits` - `BigDecimal!`
`salary2` - `BigDecimal!`
`salary` - `BigDecimal!`

Example

{
  "other": "28391719239482739937.1939459927192",
  "housingBenefits": "28391719239482739937.1939459927192",
  "childBenefits": "28391719239482739937.1939459927192",
  "unemploymentBenefits": "28391719239482739937.1939459927192",
  "salary2": "28391719239482739937.1939459927192",
  "salary": "28391719239482739937.1939459927192"
}

Types

CreditlinkInputDisposableIncomeMisc

Fields

Input Field	Description
`other` - `BigDecimal!`
`otherLoans` - `BigDecimal!`
`subscriptions` - `BigDecimal!`
`childCare` - `BigDecimal!`
`insurances` - `BigDecimal!`
`unemploymentFund` - `BigDecimal!`

Example

{
  "other": "28391719239482739937.1939459927192",
  "otherLoans": "28391719239482739937.1939459927192",
  "subscriptions": "28391719239482739937.1939459927192",
  "childCare": "28391719239482739937.1939459927192",
  "insurances": "28391719239482739937.1939459927192",
  "unemploymentFund": "28391719239482739937.1939459927192"
}

Types

CreditlinkInputDisposableIncomeVehicle

Fields

Input Field	Description
`other` - `BigDecimal!`
`ownershipTax` - `BigDecimal!`
`fuel` - `BigDecimal!`
`monthlyPayment` - `BigDecimal!`

Example

{
  "other": "28391719239482739937.1939459927192",
  "ownershipTax": "28391719239482739937.1939459927192",
  "fuel": "28391719239482739937.1939459927192",
  "monthlyPayment": "28391719239482739937.1939459927192"
}

Types

CreditlinkInputMonthioFlag

Fields

Input Field	Description
`smartCheckConfigurationid` - `Int`
`consumerId` - `String`

Example

{
  "smartCheckConfigurationid": 123,
  "consumerId": "xyz789"
}

Types

CreditlinkInputUserDisposableIncome

Fields

Input Field	Description
`expensePct` - `BigDecimal!`
`children` - `Int!`
`adults` - `Int!`
`disposableIncome` - `CreditlinkInputDisposableIncome!`

Example

{
  "expensePct": "28391719239482739937.1939459927192",
  "children": 987,
  "adults": 123,
  "disposableIncome": CreditlinkInputDisposableIncome
}

Types

CreditlinkMonthioCaseData

Fields

Field Name	Description
`status` - `CreditlinkMonthioCaseStatus!`

Example

{"status": CreditlinkMonthioCaseStatusSuccess}

Types

CreditlinkMonthioCaseStatus

Types

Union Types
`CreditlinkMonthioCaseStatusSuccess`
`CreditlinkMonthioCaseStatusFailure`
`CreditlinkMonthioCaseStatusPreRequest`
`CreditlinkMonthioCaseStatusPending`

Example

CreditlinkMonthioCaseStatusSuccess

Types

CreditlinkMonthioCaseStatusFailure

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkMonthioCaseStatusPending

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkMonthioCaseStatusPreRequest

Fields

Field Name	Description
`dummy` - `Boolean!`

Example

{"dummy": true}

Types

CreditlinkMonthioCaseStatusSuccess

Fields

Field Name	Description
`monthioId` - `String!`
`monthioParringId` - `String`

Example

{
  "monthioId": "abc123",
  "monthioParringId": "xyz789"
}

Types

CreditlinkMonthioConfigIn

Fields

Input Field	Description
`smartCheckConfigurationId` - `Int!`
`enabled` - `Boolean!`

Example

{"smartCheckConfigurationId": 987, "enabled": true}

Types

CreditlinkMonthioConfigOut

Fields

Field Name	Description
`enabled` - `Boolean!`
`smartCheckConfigurationId` - `Int!`

Example

{"enabled": true, "smartCheckConfigurationId": 123}

Types

CreditlinkMonthioFlag

Description

This is a deprecated flag, use the other flag instead

Values

Enum Value	Description
`DISABLED`
`CREATE_AND_NOTIFY`

Example

"DISABLED"

Types

CreditlinkMonthioSecrets

Fields

Input Field	Description
`clientSecret` - `String!`
`clientId` - `String!`

Example

{
  "clientSecret": "abc123",
  "clientId": "abc123"
}

Types

CreditlinkNotificationConfig

Fields

Field Name	Description
`mailSenderMail` - `Email!`
`smsSenderName` - `String!`
`mailTemplatePlaintext` - `String!`
`mailTemplateHtml` - `String!`
`smsTemplate` - `String!`

Example

{
  "mailSenderMail": "john@gmail.com",
  "smsSenderName": "abc123",
  "mailTemplatePlaintext": "xyz789",
  "mailTemplateHtml": "abc123",
  "smsTemplate": "xyz789"
}

Types

CreditlinkPSD2Provider

Values

Enum Value	Description
`NORDIGEN`
`TINK`
`AIIA`
`ZENIX`

Example

"NORDIGEN"

Types

CreditlinkPSD2Status

Values

Enum Value	Description
`FAILED`
`RUNNING`
`COMPLETED`

Example

"FAILED"

Types

CreditlinkPerson

Fields

Field Name	Description
`userId` - `UserId!`
`pep` - `[PepGroup!]!`
`euSanctions` - `[SanctionedEntity!]!`
`name` - `String!`
`cpr` - `Cpr`
`email` - `Email`
`phone` - `Phone`
`psd2Status` - `CreditlinkPSD2Status`
`badDebtEnabled` - `Boolean!`
`financialCrimeEnabled` - `Boolean!`
`taxInfoEnabled` - `Boolean!`
`psd2Enabled` - `Boolean!`
`proofOfIdentityEnabled` - `Boolean!`
`eSkatStatus` - `ESkatStatus`
`badDebt` - `BadDebtResponse`
`financialCrime` - `FinancialCrimeResponse`
`complianceAnswer` - `ComplianceAnswer`
`proofOfIdentity` - `[CreditlinkProofOfIdentity!]!`
`financialCrimeStatus` - `FinancialCrimeStatus`
`badDebtStatus` - `BadDebtStatus`
`requisitions` - `[NordigenRequisition!]!`
`hasUserInteraction` - `Boolean!`
`externalId` - `ExternalId`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "pep": [PepGroup],
  "euSanctions": [SanctionedEntity],
  "name": "xyz789",
  "cpr": "0810972032",
  "email": "john@gmail.com",
  "phone": "29400888",
  "psd2Status": "FAILED",
  "badDebtEnabled": true,
  "financialCrimeEnabled": true,
  "taxInfoEnabled": true,
  "psd2Enabled": true,
  "proofOfIdentityEnabled": true,
  "eSkatStatus": CreditlinkESkatStatusCompleted,
  "badDebt": RegisterError,
  "financialCrime": RegisterError,
  "complianceAnswer": ComplianceAnswer,
  "proofOfIdentity": [CreditlinkProofOfIdentity],
  "financialCrimeStatus": CreditlinkFinancialCrimeStatusCompleted,
  "badDebtStatus": CreditlinkBadDebtStatusFailed,
  "requisitions": [NordigenRequisition],
  "hasUserInteraction": true,
  "externalId": "0110293"
}

Types

CreditlinkPersonAddressError

Fields

Field Name	Description
`message` - `String!`

Example

{"message": "xyz789"}

Types

CreditlinkPersonAddressResponse

Types

Union Types
`CreditlinkPersonAddressError`
`CreditlinkPersonAddressSuccess`

Example

CreditlinkPersonAddressError

Types

CreditlinkPersonAddressSuccess

Fields

Field Name	Description
`name` - `String!`
`cpr` - `Cpr!`
`address` - `String!`
`postalCode` - `String!`
`city` - `String!`

Example

{
  "name": "abc123",
  "cpr": "0810972032",
  "address": "abc123",
  "postalCode": "xyz789",
  "city": "abc123"
}

Types

CreditlinkProofOfIdentity

Fields

Field Name	Description
`itemId` - `Long!`
`item` - `Uri!`
`resource` - `DisplayableResource!`
`status` - `CreditlinkProofOfIdentityStatus`

Example

{
  "itemId": 9223372036854776000,
  "item": "https://domain.com/resource",
  "resource": DisplayableResource,
  "status": "APPROVED"
}

Types

CreditlinkProofOfIdentityStatus

Values

Enum Value	Description
`APPROVED`
`REJECTED`

Example

"APPROVED"

Types

CreditlinkSort

Values

Enum Value	Description
`EXTERNAL_ID`
`PRIMARY_DEBTOR`
`ASSET_NAME`
`DEALER_NAME`
`CREATED`

Example

"EXTERNAL_ID"

Types

CreditlinkUserDisposableIncome

Fields

Field Name	Description
`disposableIncome` - `CreditlinkDisposableIncome!`
`adults` - `Int!`
`children` - `Int!`
`expensePct` - `BigDecimal!`

Example

{
  "disposableIncome": CreditlinkDisposableIncome,
  "adults": 123,
  "children": 123,
  "expensePct": "28391719239482739937.1939459927192"
}

Types

Cvr

Description

The Cvr scalar type is a valid danish Cvr.

Example

"35890270"

Types

CvrAnnualReport

Fields

Field Name	Description
`cvr` - `Cvr!`
`startDate` - `LocalDate!`
`endDate` - `LocalDate!`
`grossIncome` - `BigInt`
`ordinaryBusinessIncome` - `BigInt`
`netIncome` - `BigInt`
`equity` - `BigInt`
`proposedDividend` - `BigInt`
`assets` - `BigInt`
`pdf` - `DisplayableResource`
`xml` - `DisplayableResource!`
`xhtml` - `DisplayableResource`

Example

{
  "cvr": "35890270",
  "startDate": "2020-07-19",
  "endDate": "2020-07-19",
  "grossIncome": {},
  "ordinaryBusinessIncome": {},
  "netIncome": {},
  "equity": {},
  "proposedDividend": {},
  "assets": {},
  "pdf": DisplayableResource,
  "xml": DisplayableResource,
  "xhtml": DisplayableResource
}

Types

CvrData

Fields

Field Name	Description
`name` - `String!`
`cvr` - `Cvr!`
`address` - `String!`
`postalCode` - `String!`
`city` - `String!`
`district` - `String`
`companyCreationDate` - `LocalDate!`
`companyType` - `String!`
`bindingAgreement` - `String!`
`management` - `[CvrParticipant!]!`
`boardMembers` - `[CvrParticipant!]!`
`owners` - `[CvrParticipant!]!`
`participants` - `[CvrParticipant!]!`

Example

{
  "name": "xyz789",
  "cvr": "35890270",
  "address": "xyz789",
  "postalCode": "xyz789",
  "city": "abc123",
  "district": "xyz789",
  "companyCreationDate": "2020-07-19",
  "companyType": "abc123",
  "bindingAgreement": "xyz789",
  "management": [CvrParticipant],
  "boardMembers": [CvrParticipant],
  "owners": [CvrParticipant],
  "participants": [CvrParticipant]
}

Types

CvrParticipant

Fields

Field Name	Description
`participantType` - `CvrParticipantType!`
`name` - `String!`
`address` - `String!`
`postalCode` - `String!`
`participantFunction` - `String`
`city` - `String!`
`district` - `String`
`ownershipPercentage` - `OwnershipPercentage`

Example

{
  "participantType": "PERSON",
  "name": "xyz789",
  "address": "abc123",
  "postalCode": "xyz789",
  "participantFunction": "xyz789",
  "city": "xyz789",
  "district": "xyz789",
  "ownershipPercentage": "OWNERSHIP_0_05"
}

Types

CvrParticipantType

Values

Enum Value	Description
`PERSON`
`COMPANY`
`PRODUCTION_ENTITY`
`OTHER`

Example

"PERSON"

Types

CvrSearchResult

Fields

Field Name	Description
`cvr` - `Cvr!`
`name` - `String!`

Example

{
  "cvr": "35890270",
  "name": "xyz789"
}

Types

CvrStatus

Types

Union Types
`CreditlinkCvrStatusCompleted`
`CreditlinkCvrStatusEnumCase`

Example

CreditlinkCvrStatusCompleted

Types

DanishCompanyIdentifier

Fields

Field Name	Description
`cvr` - `Cvr!`

Example

{"cvr": "35890270"}

Types

DanishPersonIdentifier

Fields

Field Name	Description
`cpr` - `Cpr!`

Example

{"cpr": "0810972032"}

Types

DisplayableResource

Description

A resource for which the caller may request thumbnails

Fields

Field Name	Description
`resource` - `Uri!`
`contentType` - `String`
`thumbnail` - `Uri`	The url to lazily generate a thumbnail in requested dimensions at http://api.casehub.dk/thumbnails/...?signature=abc123&width=1024&height=1024. The caller must always supply the query parameters for height and width. Some content-types require more information, such as pdf-documents, which expect a &page=2 parameter. If the caller is unsure of the content-type, then it is recommended to supply all content-type related flags. You can always expect the url to contain a signature, thus the only responsability of the caller is applying thumbnail related parameters.

Example

{
  "resource": "https://domain.com/resource",
  "contentType": "xyz789",
  "thumbnail": "https://domain.com/resource"
}

Types

DisposableIncomeConfig

Fields

Field Name	Description
`indicativeAmountSingle` - `BigDecimal!`
`indicativeAmountCouple` - `BigDecimal!`
`indicativeAmountPerChild` - `BigDecimal!`

Example

{
  "indicativeAmountSingle": "28391719239482739937.1939459927192",
  "indicativeAmountCouple": "28391719239482739937.1939459927192",
  "indicativeAmountPerChild": "28391719239482739937.1939459927192"
}

Types

DisposableIncomeConfigEvent

Types

Union Types
`DisposableIncomeConfigSubscribedEvent`
`DisposableIncomeConfigUpdatedEvent`

Example

DisposableIncomeConfigSubscribedEvent

Types

DisposableIncomeConfigSubscribedEvent

Fields

Field Name	Description
`org` - `Org!`
`currentConfig` - `DisposableIncomeConfig`

Example

{
  "org": "acme",
  "currentConfig": DisposableIncomeConfig
}

Types

DisposableIncomeConfigUpdatedEvent

Fields

Field Name	Description
`org` - `Org!`
`newConfig` - `DisposableIncomeConfig!`

Example

{
  "org": "acme",
  "newConfig": DisposableIncomeConfig
}

Types

DmrAdhocRequest

Fields

Field Name	Description
`timestamp` - `Instant!`
`query` - `String!`
`response` - `DmrAdhocResponse`	If there is no response, the request has failed.

Example

{
  "timestamp": 1654109791,
  "query": "xyz789",
  "response": DmrAdhocResponse
}

Types

DmrAdhocResponse

Fields

Field Name	Description
`vin` - `String`
`makeModel` - `String`
`vehicleType` - `String`
`vehicleModified` - `LocalDate`
`regNo` - `String`
`firstRegDate` - `LocalDate`
`usage` - `String`
`registrationModified` - `LocalDate`
`leasingPeriodStart` - `LocalDate`
`leasingPeriodEnd` - `LocalDate`
`certificateId` - `String`
`electricalUsageMeasurement` - `String`
`fossilFuelUsage` - `String`
`electricalUsage` - `String`

Example

{
  "vin": "xyz789",
  "makeModel": "xyz789",
  "vehicleType": "xyz789",
  "vehicleModified": "2020-07-19",
  "regNo": "abc123",
  "firstRegDate": "2020-07-19",
  "usage": "abc123",
  "registrationModified": "2020-07-19",
  "leasingPeriodStart": "2020-07-19",
  "leasingPeriodEnd": "2020-07-19",
  "certificateId": "abc123",
  "electricalUsageMeasurement": "xyz789",
  "fossilFuelUsage": "xyz789",
  "electricalUsage": "xyz789"
}

Types

DmrAdhocResults

Fields

Field Name	Description
`newest` - `DmrAdhocRequest!`
`newestSuccessful` - `DmrAdhocRequest`

Example

{
  "newest": DmrAdhocRequest,
  "newestSuccessful": DmrAdhocRequest
}

Types

DmrEntry

Fields

Field Name	Description
`ident` - `String!`
`typeNumber` - `Long!`
`typeName` - `String!`
`usageNumber` - `Long`
`usageName` - `String`
`leasingValidFrom` - `LocalDate`
`leasingValidTo` - `LocalDate`
`status` - `String!`
`statusDate` - `Instant!`
`firstRegistrationDate` - `LocalDate`
`vin` - `String!`
`makeNumber` - `Long!`
`makeName` - `String!`
`modelNumber` - `Long!`
`modelName` - `String!`
`variantNumber` - `Long`
`variantName` - `String`
`versionNumber` - `Long`
`versionName` - `String`
`colorNumber` - `Long`
`colorName` - `String`
`propulsionNumber` - `Long`
`propulsionName` - `String`
`kmPerLiter` - `Double`
`co2Emission` - `Double`
`registrationStatus` - `String`
`registrationStatusDate` - `Instant`
`registrationNumber` - `String`

Example

{
  "ident": "abc123",
  "typeNumber": 9223372036854776000,
  "typeName": "abc123",
  "usageNumber": 9223372036854776000,
  "usageName": "xyz789",
  "leasingValidFrom": "2020-07-19",
  "leasingValidTo": "2020-07-19",
  "status": "abc123",
  "statusDate": 1654109791,
  "firstRegistrationDate": "2020-07-19",
  "vin": "xyz789",
  "makeNumber": 9223372036854776000,
  "makeName": "xyz789",
  "modelNumber": 9223372036854776000,
  "modelName": "abc123",
  "variantNumber": 9223372036854776000,
  "variantName": "abc123",
  "versionNumber": 9223372036854776000,
  "versionName": "abc123",
  "colorNumber": 9223372036854776000,
  "colorName": "xyz789",
  "propulsionNumber": 9223372036854776000,
  "propulsionName": "xyz789",
  "kmPerLiter": Double,
  "co2Emission": Double,
  "registrationStatus": "abc123",
  "registrationStatusDate": 1654109791,
  "registrationNumber": "xyz789"
}

Types

Double

Description

The Double scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

Double

Types

DowJonesSecrets

Fields

Input Field	Description
`password` - `String!`
`username` - `String!`
`service` - `DowJonesService!`

Example

{
  "password": "xyz789",
  "username": "abc123",
  "service": "PRODUCTION"
}

Types

DowJonesService

Values

Enum Value	Description
`PRODUCTION`
`TEST`

Example

"PRODUCTION"

Types

ESkatAnnualIncome

Fields

Field Name	Description
`capitalIncome` - `BigDecimal!`
`deductions` - `BigDecimal!`
`other` - `BigDecimal!`
`personalIncome` - `ESkatPersonalIncome!`
`personalIncomeResult` - `BigDecimal!`

Example

{
  "capitalIncome": "28391719239482739937.1939459927192",
  "deductions": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192",
  "personalIncome": ESkatPersonalIncome,
  "personalIncomeResult": "28391719239482739937.1939459927192"
}

Types

ESkatAnnualTaxReturn

Fields

Field Name	Description
`year` - `Int!`
`income` - `ESkatAnnualIncome!`
`incomeResult` - `BigDecimal!`
`tax` - `ESkatTax!`
`taxResult` - `BigDecimal!`
`incomeFromShares` - `BigDecimal!`

Example

{
  "year": 123,
  "income": ESkatAnnualIncome,
  "incomeResult": "28391719239482739937.1939459927192",
  "tax": ESkatTax,
  "taxResult": "28391719239482739937.1939459927192",
  "incomeFromShares": "28391719239482739937.1939459927192"
}

Types

ESkatBankCodeIdentifier

Fields

Field Name	Description
`value` - `Int!`

Example

{"value": 123}

Types

ESkatCompanyCvrIdentifier

Fields

Field Name	Description
`cvr` - `Cvr!`

Example

{"cvr": "35890270"}

Types

ESkatCompanyInfo

Fields

Field Name	Description
`cvr` - `Cvr!`
`name` - `String!`

Example

{
  "cvr": "35890270",
  "name": "xyz789"
}

Types

ESkatDI

Fields

Field Name	Description
`salary` - `BigDecimal!`
`unemploymentBenefits` - `BigDecimal!`
`otherIncome` - `BigDecimal!`
`propertyTax` - `BigDecimal!`

Example

{
  "salary": "28391719239482739937.1939459927192",
  "unemploymentBenefits": "28391719239482739937.1939459927192",
  "otherIncome": "28391719239482739937.1939459927192",
  "propertyTax": "28391719239482739937.1939459927192"
}

Types

ESkatDebt

Fields

Field Name	Description
`debtType` - `EskatDebtType!`
`identifier` - `ESkatIdentifier!`
`reportDate` - `LocalDate!`
`startDate` - `LocalDate`
`ownerType` - `ESkatOwnerType`
`annualInterest` - `BigDecimal`
`balance` - `BigDecimal`

Example

{
  "debtType": "Mortgage",
  "identifier": ESkatCompanyCvrIdentifier,
  "reportDate": "2020-07-19",
  "startDate": "2020-07-19",
  "ownerType": ESkatOwnerType,
  "annualInterest": "28391719239482739937.1939459927192",
  "balance": "28391719239482739937.1939459927192"
}

Types

ESkatDerivedData

Fields

Field Name	Description
`summary` - `ESkatSummary!`	The summary of data fetched form the api
`pdf` - `Uri`	A signed url to the pdf embedded in the response
`raw` - `Uri!`	A signed url to the raw xml response

Example

{
  "summary": ESkatSummary,
  "pdf": "https://domain.com/resource",
  "raw": "https://domain.com/resource"
}

Types

ESkatEquityDetails

Fields

Field Name	Description
`total` - `BigDecimal!`
`cash` - `BigDecimal!`
`debt` - `BigDecimal!`
`property` - `BigDecimal!`
`stock` - `BigDecimal!`

Example

{
  "total": "28391719239482739937.1939459927192",
  "cash": "28391719239482739937.1939459927192",
  "debt": "28391719239482739937.1939459927192",
  "property": "28391719239482739937.1939459927192",
  "stock": "28391719239482739937.1939459927192"
}

Types

ESkatIdentifier

Types

Union Types
`ESkatCompanyCvrIdentifier`
`ESkatBankCodeIdentifier`

Example

ESkatCompanyCvrIdentifier

Types

ESkatIncome

Fields

Field Name	Description
`gross` - `BigDecimal!`
`net` - `BigDecimal!`

Example

{
  "gross": "28391719239482739937.1939459927192",
  "net": "28391719239482739937.1939459927192"
}

Types

ESkatIncomeByCompanyMonth

Fields

Field Name	Description
`month` - `YearMonth!`
`company` - `Cvr!`
`value` - `ESkatIncome!`

Example

{
  "month": "2007-12",
  "company": "35890270",
  "value": ESkatIncome
}

Types

ESkatIncomeByMonth

Fields

Field Name	Description
`month` - `YearMonth!`
`value` - `ESkatIncome!`

Example

{
  "month": "2007-12",
  "value": ESkatIncome
}

Types

ESkatIncomeResult

Fields

Field Name	Description
`companies` - `[ESkatCompanyInfo!]!`
`maxMonth` - `YearMonth!`
`byCompanyMonth` - `[ESkatIncomeByCompanyMonth!]!`
`byMonth` - `[ESkatIncomeByMonth!]!`
`total` - `ESkatIncome!`
`months` - `Long!`
`average` - `ESkatIncome!`

Example

{
  "companies": [ESkatCompanyInfo],
  "maxMonth": "2007-12",
  "byCompanyMonth": [ESkatIncomeByCompanyMonth],
  "byMonth": [ESkatIncomeByMonth],
  "total": ESkatIncome,
  "months": 9223372036854776000,
  "average": ESkatIncome
}

Types

ESkatOwnerType

Fields

Field Name	Description
`value` - `String!`

Example

{"value": "abc123"}

Types

ESkatPersonalIncome

Fields

Field Name	Description
`salary` - `BigDecimal!`
`insurancePayoutsAndGrants` - `BigDecimal!`
`pensionBenefits` - `BigDecimal!`
`foreignSalary` - `BigDecimal!`
`depositPension` - `BigDecimal!`
`privateHelp` - `BigDecimal!`
`deductionPersonalIncome` - `BigDecimal!`
`companyProfitLoss` - `BigDecimal!`
`labourMarketContribution` - `BigDecimal!`
`investorDeductionRetaxation` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "salary": "28391719239482739937.1939459927192",
  "insurancePayoutsAndGrants": "28391719239482739937.1939459927192",
  "pensionBenefits": "28391719239482739937.1939459927192",
  "foreignSalary": "28391719239482739937.1939459927192",
  "depositPension": "28391719239482739937.1939459927192",
  "privateHelp": "28391719239482739937.1939459927192",
  "deductionPersonalIncome": "28391719239482739937.1939459927192",
  "companyProfitLoss": "28391719239482739937.1939459927192",
  "labourMarketContribution": "28391719239482739937.1939459927192",
  "investorDeductionRetaxation": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

ESkatPropertyOwnership

Fields

Field Name	Description
`startDate` - `LocalDate`
`endDate` - `LocalDate`
`municipalityCode` - `String`
`bbrCode` - `String`
`address` - `String`
`ownership` - `BigDecimal`

Example

{
  "startDate": "2020-07-19",
  "endDate": "2020-07-19",
  "municipalityCode": "abc123",
  "bbrCode": "abc123",
  "address": "xyz789",
  "ownership": "28391719239482739937.1939459927192"
}

Types

ESkatStatus

Types

Union Types
`CreditlinkESkatStatusCompleted`
`CreditlinkESkatStatusRunning`
`CreditlinkESkatStatusFailed`

Example

CreditlinkESkatStatusCompleted

Types

ESkatSummary

Fields

Field Name	Description
`debt` - `[ESkatDebt!]!`
`income` - `ESkatIncomeResult!`
`annualTaxReturn` - `ESkatAnnualTaxReturn`
`disposableIncome` - `ESkatDI!`
`totals` - `ESkatTotals!`

Example

{
  "debt": [ESkatDebt],
  "income": ESkatIncomeResult,
  "annualTaxReturn": ESkatAnnualTaxReturn,
  "disposableIncome": ESkatDI,
  "totals": ESkatTotals
}

Types

ESkatTax

Fields

Field Name	Description
`bottomTax` - `BigDecimal!`
`topTax` - `BigDecimal!`
`municipalityTax` - `BigDecimal!`
`propertyTax` - `BigDecimal!`
`other` - `BigDecimal!`

Example

{
  "bottomTax": "28391719239482739937.1939459927192",
  "topTax": "28391719239482739937.1939459927192",
  "municipalityTax": "28391719239482739937.1939459927192",
  "propertyTax": "28391719239482739937.1939459927192",
  "other": "28391719239482739937.1939459927192"
}

Types

ESkatTotals

Fields

Field Name	Description
`income` - `BigDecimal!`
`debt` - `BigDecimal!`
`equity` - `BigDecimal!`
`incomePersonal` - `BigDecimal!`
`incomeCapital` - `BigDecimal!`
`equityDomestic` - `ESkatEquityDetails!`
`equityForeign` - `ESkatEquityDetails!`
`propertyOwnership` - `[ESkatPropertyOwnership!]!`

Example

{
  "income": "28391719239482739937.1939459927192",
  "debt": "28391719239482739937.1939459927192",
  "equity": "28391719239482739937.1939459927192",
  "incomePersonal": "28391719239482739937.1939459927192",
  "incomeCapital": "28391719239482739937.1939459927192",
  "equityDomestic": ESkatEquityDetails,
  "equityForeign": ESkatEquityDetails,
  "propertyOwnership": [ESkatPropertyOwnership]
}

Types

EconomicAPIError

Fields

Field Name	Description
`statusCode` - `Int!`
`rawBody` - `String`
`errors` - `[EconomicAPIErrorMessage!]`

Example

{
  "statusCode": 123,
  "rawBody": "abc123",
  "errors": [EconomicAPIErrorMessage]
}

Types

EconomicAPIErrorMessage

Fields

Field Name	Description
`message` - `String!`
`value` - `String`

Example

{
  "message": "abc123",
  "value": "xyz789"
}

Types

EconomicConfig

Fields

Field Name	Description
`cashBookHandle` - `Int`
`paymentCashBookHandle` - `Int`
`bankAccountNo` - `Long`
`minInvoiceNo` - `Int`
`maxInvoiceNo` - `Int`
`fallbackDebtorNo` - `Long`
`personCustomerGroupId` - `Long`
`companyCustomerGroupId` - `Long`
`supplierGroupId` - `Long`
`vatZoneId` - `Long`
`paymentTermsId` - `Long`
`usePaymentTermsIdForBooking` - `Boolean!`
`minCustomerNo` - `Long`
`maxCustomerNo` - `Long`
`accountingYearStart` - `Int`
`invoiceMailSignature` - `String`
`invoiceMailSenderName` - `String`

Example

{
  "cashBookHandle": 987,
  "paymentCashBookHandle": 987,
  "bankAccountNo": 9223372036854776000,
  "minInvoiceNo": 987,
  "maxInvoiceNo": 123,
  "fallbackDebtorNo": 9223372036854776000,
  "personCustomerGroupId": 9223372036854776000,
  "companyCustomerGroupId": 9223372036854776000,
  "supplierGroupId": 9223372036854776000,
  "vatZoneId": 9223372036854776000,
  "paymentTermsId": 9223372036854776000,
  "usePaymentTermsIdForBooking": true,
  "minCustomerNo": 9223372036854776000,
  "maxCustomerNo": 9223372036854776000,
  "accountingYearStart": 123,
  "invoiceMailSignature": "xyz789",
  "invoiceMailSenderName": "xyz789"
}

Types

EconomicConfigInput

Fields

Input Field	Description
`invoiceMailSenderName` - `String`
`invoiceMailSignature` - `String`
`accountingYearStart` - `Int`
`maxCustomerNo` - `Long`
`minCustomerNo` - `Long`
`usePaymentTermsIdForBooking` - `Boolean!`
`paymentTermsId` - `Long`
`vatZoneId` - `Long`
`supplierGroupId` - `Long`
`companyCustomerGroupId` - `Long`
`personCustomerGroupId` - `Long`
`fallbackDebtorNo` - `Long`
`maxInvoiceNo` - `Int`
`minInvoiceNo` - `Int`
`bankAccountNo` - `Long`
`paymentCashBookHandle` - `Int`
`cashBookHandle` - `Int`

Example

{
  "invoiceMailSenderName": "xyz789",
  "invoiceMailSignature": "xyz789",
  "accountingYearStart": 987,
  "maxCustomerNo": 9223372036854776000,
  "minCustomerNo": 9223372036854776000,
  "usePaymentTermsIdForBooking": true,
  "paymentTermsId": 9223372036854776000,
  "vatZoneId": 9223372036854776000,
  "supplierGroupId": 9223372036854776000,
  "companyCustomerGroupId": 9223372036854776000,
  "personCustomerGroupId": 9223372036854776000,
  "fallbackDebtorNo": 9223372036854776000,
  "maxInvoiceNo": 987,
  "minInvoiceNo": 123,
  "bankAccountNo": 9223372036854776000,
  "paymentCashBookHandle": 987,
  "cashBookHandle": 987
}

Types

EconomicDepartment

Fields

Field Name	Description
`departmentNumber` - `Long!`
`name` - `String`

Example

{
  "departmentNumber": 9223372036854776000,
  "name": "abc123"
}

Types

EconomicDepartmentMissingConfigurationError

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

EconomicDepartmentResult

Types

Union Types
`EconomicDepartment`
`EconomicDepartmentMissingConfigurationError`
`EconomicDepartmentUnknownError`

Example

EconomicDepartment

Types

EconomicDepartmentUnknownError

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

EconomicInvoiceMailInfo

Fields

Field Name	Description
`invoiceId` - `UUID!`
`invoice` - `LoanAndLeaseBookedInvoice!`
`mail` - `MailLogEntry`
`status` - `EconomicInvoiceMailInfoStatus!`	The status of the generation of the email. For the sending status, follow the 'mail' field or the 'computedStatus' field.
`computedStatus` - `EconomicInvoiceMailInfoStatus!`	Computes an aggregate status over the generation of the email and the sending of the email.
`computedStatusTimestamp` - `Instant!`	Computes the timestamp for the 'computedStatus' field.

Example

{
  "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "invoice": LoanAndLeaseBookedInvoice,
  "mail": MailLogEntry,
  "status": "PENDING",
  "computedStatus": "PENDING",
  "computedStatusTimestamp": 1654109791
}

Types

EconomicInvoiceMailInfoStatus

Values

Enum Value	Description
`PENDING`
`ENQUEUED`
`FAILED`

Example

"PENDING"

Types

Email

Description

The Email scalar type is a valid RFC822 address.

Example

"john@gmail.com"

Types

EphemeralReference

Description

An ephemeral reference to some resource, usually a blob. The underlying type is String.

Example

EphemeralReference

Types

EphemeralUrls

Fields

Field Name	Description
`uploadUrl` - `Uri!`	Signed URL for upload (PUT) with TTL of 15 minutes
`downloadUrl` - `Uri!`	Signed URL for download (GET) with TTL of 15 minutes
`reference` - `EphemeralReference!`	Reference used in other contexts for pointing to the uploaded file. An `EphemeralReference` in the context of uploads is scoped by the user id (sub) in the JWT, so the user requsting the upload must also be the one submitting it

Example

{
  "uploadUrl": "https://domain.com/resource",
  "downloadUrl": "https://domain.com/resource",
  "reference": EphemeralReference
}

Types

EskatConfig

Fields

Field Name	Description
`cvr` - `Cvr!`
`apiId` - `String!`
`leasingConsentCode` - `String`
`loanConsentCode` - `String`

Example

{
  "cvr": "35890270",
  "apiId": "abc123",
  "leasingConsentCode": "xyz789",
  "loanConsentCode": "abc123"
}

Types

EskatDebtType

Values

Enum Value	Description
`Mortgage`
`Other`
`StudentLoan`
`InsurancePension`
`Bank`

Example

"Mortgage"

Types

ExternalId

Description

The ExternalId scalar type lets the caller bind an id, which is possibly unique to an object.

Example

"0110293"

Types

FTPServerConfigInput

Fields

Input Field	Description
`ftpFolder` - `String!`
`port` - `Int!`
`host` - `String!`
`password` - `String!`
`username` - `String!`
`keyFile` - `Uri!`

Example

{
  "ftpFolder": "abc123",
  "port": 987,
  "host": "xyz789",
  "password": "xyz789",
  "username": "xyz789",
  "keyFile": "https://domain.com/resource"
}

Types

File

Fields

Field Name	Description
`id` - `UUID!`
`filename` - `String`
`resource` - `DisplayableResource!`

Example

{
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "filename": "abc123",
  "resource": DisplayableResource
}

Types

FileInput

Fields

Input Field	Description
`uri` - `Uri!`
`caption` - `String`
`contentType` - `MediaType`
`filename` - `String`

Example

{
  "uri": "https://domain.com/resource",
  "caption": "abc123",
  "contentType": MediaType,
  "filename": "xyz789"
}

Types

FinancialCrimeEntry

Fields

Field Name	Description
`entryId` - `String!`
`entryType` - `String!`
`name` - `String!`
`yearsOfBirth` - `[Year!]!`
`monthsOfBirth` - `[YearMonth!]!`
`datesOfBirth` - `[LocalDate!]!`
`countries` - `[String!]!`
`title` - `String`
`score` - `BigDecimal`

Example

{
  "entryId": "xyz789",
  "entryType": "xyz789",
  "name": "xyz789",
  "yearsOfBirth": ["2007"],
  "monthsOfBirth": ["2007-12"],
  "datesOfBirth": ["2020-07-19"],
  "countries": ["abc123"],
  "title": "abc123",
  "score": "28391719239482739937.1939459927192"
}

Types

FinancialCrimeResponse

Types

Union Types
`RegisterError`
`FinancialCrimeResult`

Example

RegisterError

Types

FinancialCrimeResult

Fields

Field Name	Description
`entries` - `[FinancialCrimeEntry!]!`
`timestamp` - `Instant!`

Example

{
  "entries": [FinancialCrimeEntry],
  "timestamp": 1654109791
}

Types

FinancialCrimeStatus

Types

Union Types
`CreditlinkFinancialCrimeStatusCompleted`
`CreditlinkFinancialCrimeStatusEnumCase`

Example

CreditlinkFinancialCrimeStatusCompleted

Types

GlobalRole

Description

A global role

Values

Enum Value	Description
`ADMIN`

Example

"ADMIN"

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as \"4\") or integer (such as 4) input value will be accepted as an ID."

Example

Types

InputCreditlinkCase

Fields

Input Field	Description
`creditroCreateAndNotify` - `CreditlinkInputCreditroFlag`	Leaving this flag empty will disable creditro
`monthioCreateAndNotify` - `CreditlinkInputMonthioFlag`	Leaving this flag empty will disable monthio
`creditroFlag` - `CreditlinkCreditroFlag!`
`monthioFlag` - `CreditlinkMonthioFlag!`
`otherCreateCompanies` - `[CreateCreditlinkCompany!]!`
`otherCompanies` - `[InputCreditlinkCompany!]!`
`otherPersons` - `[CreateCreditlinkPerson!]!`
`psd2Provider` - `CreditlinkPSD2Provider`
`sendLink` - `Boolean!`
`secondaryDebtor` - `CreateCreditlinkPerson`
`primaryDebtor` - `CreateCreditlinkPerson`
`monthlyPayment` - `BigDecimal!`
`assetName` - `String!`
`dealerName` - `String!`
`externalId` - `ExternalId`

Example

{
  "creditroCreateAndNotify": CreditlinkInputCreditroFlag,
  "monthioCreateAndNotify": CreditlinkInputMonthioFlag,
  "creditroFlag": "DISABLED",
  "monthioFlag": "DISABLED",
  "otherCreateCompanies": [CreateCreditlinkCompany],
  "otherCompanies": [InputCreditlinkCompany],
  "otherPersons": [CreateCreditlinkPerson],
  "psd2Provider": "NORDIGEN",
  "sendLink": true,
  "secondaryDebtor": CreateCreditlinkPerson,
  "primaryDebtor": CreateCreditlinkPerson,
  "monthlyPayment": "28391719239482739937.1939459927192",
  "assetName": "xyz789",
  "dealerName": "xyz789",
  "externalId": "0110293"
}

Types

InputCreditlinkClientConfig

Fields

Input Field	Description
`privacyPolicyLink` - `String`
`loanIntroText` - `String`
`leasingIntroText` - `String`

Example

{
  "privacyPolicyLink": "abc123",
  "loanIntroText": "xyz789",
  "leasingIntroText": "abc123"
}

Types

InputCreditlinkCompany

Description

Deprecated. Use CreateCreditlinkCompany or UpdateCreditlinkCompany instead

Fields

Input Field	Description
`financialCrimeEnabled` - `Boolean!`
`badDebtEnabled` - `Boolean!`
`phone` - `Phone`
`email` - `Email`
`cvr` - `Cvr!`
`name` - `String!`

Example

{
  "financialCrimeEnabled": true,
  "badDebtEnabled": true,
  "phone": "29400888",
  "email": "john@gmail.com",
  "cvr": "35890270",
  "name": "abc123"
}

Types

InputCreditlinkNotificationConfig

Fields

Input Field	Description
`smsTemplate` - `String!`
`mailTemplateHtml` - `String!`
`mailTemplatePlaintext` - `String!`
`smsSenderName` - `String!`
`mailSenderMail` - `Email!`

Example

{
  "smsTemplate": "xyz789",
  "mailTemplateHtml": "abc123",
  "mailTemplatePlaintext": "xyz789",
  "smsSenderName": "xyz789",
  "mailSenderMail": "john@gmail.com"
}

Types

InputDisposableIncomeConfig

Fields

Input Field	Description
`indicativeAmountPerChild` - `BigDecimal!`
`indicativeAmountCouple` - `BigDecimal!`
`indicativeAmountSingle` - `BigDecimal!`

Example

{
  "indicativeAmountPerChild": "28391719239482739937.1939459927192",
  "indicativeAmountCouple": "28391719239482739937.1939459927192",
  "indicativeAmountSingle": "28391719239482739937.1939459927192"
}

Types

InputEskatConfig

Fields

Input Field	Description
`loanConsentCode` - `String`
`leasingConsentCode` - `String`
`apiId` - `String!`
`cvr` - `Cvr!`

Example

{
  "loanConsentCode": "abc123",
  "leasingConsentCode": "abc123",
  "apiId": "xyz789",
  "cvr": "35890270"
}

Types

InputEskatPkcs

Fields

Input Field	Description
`password` - `String!`
`alias` - `String!`
`uri` - `Uri!`

Example

{
  "password": "abc123",
  "alias": "xyz789",
  "uri": "https://domain.com/resource"
}

Types

InputNordigenOAuthConfig

Fields

Input Field	Description
`tokenUrl` - `Uri!`
`clientSecret` - `String!`
`clientId` - `String!`
`clientAudience` - `String!`
`audience` - `String!`

Example

{
  "tokenUrl": "https://domain.com/resource",
  "clientSecret": "xyz789",
  "clientId": "xyz789",
  "clientAudience": "xyz789",
  "audience": "abc123"
}

Types

Instant

Description

An instantaneous point on the time-line, the milliseconds since epoch. Represented as a number.

Example

1654109791

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

KnownCountryCode

Fields

Field Name	Description
`code` - `KnownCountryCodeType!`

Example

{"code": "DK"}

Types

KnownCountryCodeType

Values

Enum Value	Description
`DK`

Example

"DK"

Types

Lamport

Description

The Lamport scalar type is a lamport timestamp (version number).

Example

Types

LoanAndLeaseAddContractCommentInput

Fields

Input Field	Description
`comment` - `String!`
`contractId` - `UUID!`

Example

{
  "comment": "xyz789",
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseAddContractCommentResult

Fields

Field Name	Description
`contractId` - `UUID!`
`comments` - `[LoanAndLeaseContractComment!]!`

Example

{
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "comments": [LoanAndLeaseContractComment]
}

Types

LoanAndLeaseAddRepresentative

Fields

Input Field	Description
`name` - `String!`	The name of the representative
`entityId` - `UUID!`	The entity to add the representative to

Example

{
  "name": "abc123",
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseAddRepresentativeError

Values

Enum Value	Description
`ENTITY_NOT_FOUND`

Example

"ENTITY_NOT_FOUND"

Types

LoanAndLeaseAddRepresentativeErrorWrapper

Fields

Field Name	Description
`error` - `LoanAndLeaseAddRepresentativeError!`

Example

{"error": "ENTITY_NOT_FOUND"}

Types

LoanAndLeaseAddRepresentativeOutcome

Types

Union Types
`LoanAndLeaseAddRepresentativeSuccess`
`LoanAndLeaseAddRepresentativeErrorWrapper`

Example

LoanAndLeaseAddRepresentativeSuccess

Types

LoanAndLeaseAddRepresentativeSuccess

Fields

Field Name	Description
`representativeIds` - `[UUID!]!`

Example

{
  "representativeIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Types

LoanAndLeaseAdministratedRepresentative

Fields

Field Name	Description
`representative` - `LoanAndLeaseRepresentative!`
`disabled` - `Boolean!`

Example

{
  "representative": LoanAndLeaseRepresentative,
  "disabled": true
}

Types

LoanAndLeaseAnnuityConstant

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`constantAmount` - `BigDecimal!`
`bookingDate` - `LocalDate`

Example

{
  "costId": "abc123",
  "cost": LoanAndLeasePortfolioCosts,
  "constantAmount": "28391719239482739937.1939459927192",
  "bookingDate": "2020-07-19"
}

Types

LoanAndLeaseAnnuityConstantInput

Fields

Input Field	Description
`bookingDate` - `LocalDate`
`constantAmount` - `BigDecimal!`
`costId` - `String!`

Example

{
  "bookingDate": "2020-07-19",
  "constantAmount": "28391719239482739937.1939459927192",
  "costId": "abc123"
}

Types

LoanAndLeaseAssetOptions

Fields

Field Name	Description
`vin` - `String`
`makeModel` - `String`
`regNo` - `String`
`firstRegDate` - `LocalDate`

Example

{
  "vin": "xyz789",
  "makeModel": "abc123",
  "regNo": "xyz789",
  "firstRegDate": "2020-07-19"
}

Types

LoanAndLeaseAssetOptionsInput

Fields

Input Field	Description
`mileage` - `Int`
`comment` - `String`
`color` - `String`
`hasRegTax` - `Boolean!`
`hasVat` - `Boolean!`
`assetNo` - `Int`
`firstRegDate` - `LocalDate`
`regNo` - `String`
`makeModel` - `String`
`vin` - `String`

Example

{
  "mileage": 123,
  "comment": "xyz789",
  "color": "abc123",
  "hasRegTax": true,
  "hasVat": true,
  "assetNo": 123,
  "firstRegDate": "2020-07-19",
  "regNo": "abc123",
  "makeModel": "abc123",
  "vin": "xyz789"
}

Types

LoanAndLeaseBaseRate

Description

Requires the caller to have the 'reader' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`baseRateId` - `String!`
`date` - `LocalDate!`
`baseRate` - `BigDecimal`
`id` - `ID!`

Example

{
  "baseRateId": "xyz789",
  "date": "2020-07-19",
  "baseRate": "28391719239482739937.1939459927192",
  "id": "4"
}

Types

LoanAndLeaseBaseRateInput

Fields

Input Field	Description
`baseRate` - `BigDecimal`
`date` - `LocalDate!`
`baseRateId` - `String!`

Example

{
  "baseRate": "28391719239482739937.1939459927192",
  "date": "2020-07-19",
  "baseRateId": "abc123"
}

Types

LoanAndLeaseBookedInvoice

Description

Requires the caller to have the 'reader' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`header` - `LoanAndLeaseBookedInvoiceHeader!`
`lines` - `[LoanAndLeaseBookedInvoiceLine!]!`
`contract` - `LoanAndLeaseContract`
`mails` - `[EconomicInvoiceMailInfo!]!`
`id` - `ID!`

Example

{
  "header": LoanAndLeaseBookedInvoiceHeader,
  "lines": [LoanAndLeaseBookedInvoiceLine],
  "contract": LoanAndLeaseContract,
  "mails": [EconomicInvoiceMailInfo],
  "id": 4
}

Types

LoanAndLeaseBookedInvoiceHeader

Fields

Field Name	Description
`invoiceId` - `UUID!`
`invoiceNo` - `Long!`
`customerNumber` - `Long`
`date` - `LocalDate`
`recipientName` - `String`
`recipientAddress` - `String`
`recipientPostalCode` - `String`
`recipientCity` - `String`
`grossAmount` - `BigDecimal`
`vatAmount` - `BigDecimal`
`notesHeading` - `String`
`notesTextLine1` - `String`
`notesTextLine2` - `String`

Example

{
  "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "invoiceNo": 9223372036854776000,
  "customerNumber": 9223372036854776000,
  "date": "2020-07-19",
  "recipientName": "xyz789",
  "recipientAddress": "xyz789",
  "recipientPostalCode": "abc123",
  "recipientCity": "xyz789",
  "grossAmount": "28391719239482739937.1939459927192",
  "vatAmount": "28391719239482739937.1939459927192",
  "notesHeading": "abc123",
  "notesTextLine1": "abc123",
  "notesTextLine2": "abc123"
}

Types

LoanAndLeaseBookedInvoiceLine

Fields

Field Name	Description
`invoiceId` - `UUID!`
`description` - `String`
`totalNetAmount` - `BigDecimal`
`vatAmount` - `BigDecimal`

Example

{
  "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "description": "xyz789",
  "totalNetAmount": "28391719239482739937.1939459927192",
  "vatAmount": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseBookingByDate

Fields

Field Name	Description
`date` - `LocalDate!`
`transactions` - `[LoanAndLeaseCost!]!`
`invoices` - `[LoanAndLeaseInvoice!]!`

Example

{
  "date": "2020-07-19",
  "transactions": [LoanAndLeaseCost],
  "invoices": [LoanAndLeaseInvoice]
}

Types

LoanAndLeaseBookingByDateDetailed

Fields

Field Name	Description
`date` - `LocalDate!`
`transactionLines` - `[PreviewTransactionLineWithCostId!]!`
`invoices` - `[LoanAndLeaseInvoiceDetailed!]!`

Example

{
  "date": "2020-07-19",
  "transactionLines": [PreviewTransactionLineWithCostId],
  "invoices": [LoanAndLeaseInvoiceDetailed]
}

Types

LoanAndLeaseBookingError

Types

Union Types
`LoanAndLeaseStructuredBookingError`
`LoanAndLeaseSimpleBookingError`

Example

LoanAndLeaseStructuredBookingError

Types

LoanAndLeaseBookingParams

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`date` - `LocalDate!`
`entry` - `Lamport!`
`entityGroup` - `Lamport!`
`costs` - `Lamport`
`changeResidualValue` - `Lamport`
`changeAnnuityEnd` - `Lamport`
`changeInterestRate` - `Lamport`
`bookingParams` - `Lamport`
`serialNo` - `Int`
`baseRate` - `Lamport`
`prtRate` - `Lamport`
`portfolio` - `Lamport`
`portfolioCosts` - `Lamport`

Example

{
  "contract": LoanAndLeaseContract,
  "date": "2020-07-19",
  "entry": 42,
  "entityGroup": 42,
  "costs": 42,
  "changeResidualValue": 42,
  "changeAnnuityEnd": 42,
  "changeInterestRate": 42,
  "bookingParams": 42,
  "serialNo": 987,
  "baseRate": 42,
  "prtRate": 42,
  "portfolio": 42,
  "portfolioCosts": 42
}

Types

LoanAndLeaseBookingParamsInput

Fields

Input Field	Description
`portfolioCosts` - `Lamport`
`portfolio` - `Lamport`
`prtRate` - `Lamport`
`baseRate` - `Lamport`
`serialNo` - `Int`
`bookingParams` - `Lamport`
`changeInterestRate` - `Lamport`
`changeAnnuityEnd` - `Lamport`
`changeResidualValue` - `Lamport`
`costs` - `Lamport`
`entityGroup` - `Lamport!`
`entry` - `Lamport!`
`date` - `LocalDate!`
`contractId` - `UUID!`

Example

{
  "portfolioCosts": 42,
  "portfolio": 42,
  "prtRate": 42,
  "baseRate": 42,
  "serialNo": 987,
  "bookingParams": 42,
  "changeInterestRate": 42,
  "changeAnnuityEnd": 42,
  "changeResidualValue": 42,
  "costs": 42,
  "entityGroup": 42,
  "entry": 42,
  "date": "2020-07-19",
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseBookingParamsNotNewestError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`expected` - `LoanAndLeaseBookingParams!`

Example

{
  "contract": LoanAndLeaseContract,
  "expected": LoanAndLeaseBookingParams
}

Types

LoanAndLeaseBookingStatusFilter

Values

Enum Value	Description
`COMPLETED`
`PENDING`
`FAILED`

Example

"COMPLETED"

Types

LoanAndLeaseCollectionMethod

Values

Enum Value	Description
`BETALINGSSERVICE`
`MANUAL`
`EAN`

Example

"BETALINGSSERVICE"

Types

LoanAndLeaseCollectionPeriod

Fields

Field Name	Description
`now` - `Instant!`
`period` - `YearMonth!`
`minBankDay` - `LocalDate!`
`maxBankDay` - `LocalDate!`
`deadline` - `Instant!`

Example

{
  "now": 1654109791,
  "period": "2007-12",
  "minBankDay": "2020-07-19",
  "maxBankDay": "2020-07-19",
  "deadline": 1654109791
}

Types

LoanAndLeaseCompany

Description

Requires the caller to have the 'reader' permission to the 'loanandlease/entity' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`entityId` - `UUID!`
`name` - `String!`
`address` - `String`
`postalCode` - `String`
`countryCode` - `CountryCode`
`email` - `Email`
`invoiceEmail` - `Email`
`phone` - `Phone`
`mobile` - `Phone`
`vatIdentification` - `CompanyIdentifier`
`identifiers` - `[CompanyIdentifier!]!`
`economicId` - `String`
`economicCreditorId` - `Int`
`ean` - `String`
`city` - `String`
`report` - `LoanAndLeaseEntityReport`
`retention` - `LoanAndLeaseEntityRetention`
`roles` - `[MutableEntityRole!]!`
`id` - `ID!`

Example

{
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "name": "abc123",
  "address": "abc123",
  "postalCode": "xyz789",
  "countryCode": KnownCountryCode,
  "email": "john@gmail.com",
  "invoiceEmail": "john@gmail.com",
  "phone": "29400888",
  "mobile": "29400888",
  "vatIdentification": CountrySpecificValue,
  "identifiers": [CountrySpecificValue],
  "economicId": "xyz789",
  "economicCreditorId": 987,
  "ean": "xyz789",
  "city": "abc123",
  "report": LoanAndLeaseEntityReport,
  "retention": LoanAndLeaseEntityRetention,
  "roles": ["DEALER"],
  "id": "4"
}

Types

LoanAndLeaseCompanyInput

Fields

Input Field	Description
`ean` - `String`
`invoiceEmail` - `Email`
`city` - `String`
`identifiers` - `[CompanyIdentifierInput!]!`
`vatIdentification` - `CompanyIdentifierInput`
`mobile` - `Phone`
`phone` - `Phone`
`email` - `Email`
`countryCode` - `CountryCodeInput`
`postalCode` - `String`
`address` - `String`
`name` - `String!`

Example

{
  "ean": "xyz789",
  "invoiceEmail": "john@gmail.com",
  "city": "abc123",
  "identifiers": [CompanyIdentifierInput],
  "vatIdentification": CompanyIdentifierInput,
  "mobile": "29400888",
  "phone": "29400888",
  "email": "john@gmail.com",
  "countryCode": CountryCodeInput,
  "postalCode": "abc123",
  "address": "abc123",
  "name": "abc123"
}

Types

LoanAndLeaseCompanyUpdate

Fields

Input Field	Description
`company` - `LoanAndLeaseCompanyInput!`
`setCreditorId` - `SetCreditorId`
`setDebtorId` - `SetDebtorId`
`entityId` - `UUID!`

Example

{
  "company": LoanAndLeaseCompanyInput,
  "setCreditorId": SetCreditorId,
  "setDebtorId": SetDebtorId,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseComputedRetentionType

Values

Enum Value	Description
`DEFAULT_RETENTION`	sets retention date to 30 days from now

Example

"DEFAULT_RETENTION"

Types

LoanAndLeaseContract

Description

Requires the caller to have the 'reader' permission to the 'loanandlease/contract' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`contractId` - `UUID!`
`dimensionNo` - `Int`
`contractType` - `ContractType!`
`department` - `EconomicDepartmentResult`
`portfolio` - `LoanAndLeasePortfolio!`
`annuityStart` - `LocalDate!`	Start date for contract
`annuityEnd` - `LocalDate`	End date (exclusive) for contract, describing the ordinary expiration of the contract, i.e. the date for which annuity has reached residualValue
`adjustEnd` - `LocalDate`	End date (exclusive) for contract, for stopping the contract before the ordinary expiration of the contract
`periodUnit` - `LoanAndLeasePeriodUnit!`
`baseRate` - `BigDecimal!`
`internalMarginRate` - `BigDecimal!`
`externalMarginRate` - `BigDecimal!`
`fixedRate` - `Boolean!`
`residualValue` - `BigDecimal!`
`contractStatus` - `LoanAndLeaseContractStatus!`
`contractStart` - `LocalDate`	Used to describe when the contract starts if it is different from annuityStart. Otherwise falls back to annuity start.
`entities` - `LoanAndLeaseContractEntities!`
`costs` - `[LoanAndLeaseContractCosts!]!`
`changeResidualValue` - `[LoanAndLeaseContractChangeResidualValue!]!`
`changeAnnuityEnd` - `[LoanAndLeaseContractChangeAnnuityEnd!]!`	End date (exclusive) for contract, describing the ordinary expiration of the contract, i.e. the date for which annuity has reached residualValue
`changeInterestRate` - `[LoanAndLeaseContractChangeInterestRate!]!`
`changeEntities` - `[LoanAndLeaseContractChangeEntities!]!`
`mileageOptions` - `LoanAndLeaseLimitedMileage`
`assetOptions` - `LoanAndLeaseAssetOptions!`
`asset` - `Asset!`
`periodAlignment` - `LoanAndLeasePeriodAlignment!`
`invoiceText` - `String`
`sharedInsurancePolicy` - `Boolean!`
`expirationStatus` - `LoanAndLeaseExpirationStatus`
`regTax` - `LoanAndLeaseRegTax!`
`secondHandVat` - `Boolean!`
`approverInitials` - `String`
`firstPeriodInvoice` - `LocalDate`
`firstBooking` - `LocalDate`
`collectionMethod` - `LoanAndLeaseCollectionMethod!`
`mailNotification` - `Boolean!`
`report` - `LoanAndLeaseContractReport`
`retention` - `LoanAndLeaseContractRetention`
`annuityFinalEnd` - `LocalDate`	End date (inclusive) for contract, taking all annuityEnd changes and adjustEnd into account
`computedEndDate` - `LocalDate`	End date (inclusive), corresponding to regTaxEndDate if it is defined, otherwise annuityFinalEnd
`computedStartDate` - `LocalDate`	Start date, corresponding to regTaxStartDate if it is defined, otherwise annuityStart
`regTaxEndDate` - `LocalDate`	End date (inclusive) for the registration tax, currently only defined if the vehicle is registrered with Proportionate Registration Tax.
`regTaxStartDate` - `LocalDate`	Start date for the registration tax, currently only defined if the vehicle is registrered with Proportionate Registration Tax.
`comments` - `[LoanAndLeaseContractComment!]!`
`files` - `[ContractFile!]!`
`bookedInvoices` - `[LoanAndLeaseBookedInvoice!]!`
`mirrorEntries` - `MirrorEntryCasehubResult`
`pmtRoundingType` - `PmtRoundingType`
`annuityType` - `AnnuityType`
`bookingState` - `PortfolioV2BookingState!`
`disabledAssets` - `[String!]!`
`id` - `ID!`

Example

{
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "dimensionNo": 987,
  "contractType": ContractTypeEconomic,
  "department": EconomicDepartment,
  "portfolio": LoanAndLeasePortfolio,
  "annuityStart": "2020-07-19",
  "annuityEnd": "2020-07-19",
  "adjustEnd": "2020-07-19",
  "periodUnit": "MONTH",
  "baseRate": "28391719239482739937.1939459927192",
  "internalMarginRate": "28391719239482739937.1939459927192",
  "externalMarginRate": "28391719239482739937.1939459927192",
  "fixedRate": true,
  "residualValue": "28391719239482739937.1939459927192",
  "contractStatus": "DRAFT",
  "contractStart": "2020-07-19",
  "entities": LoanAndLeaseContractEntities,
  "costs": [LoanAndLeaseContractCostPayment],
  "changeResidualValue": [
    LoanAndLeaseContractChangeResidualValue
  ],
  "changeAnnuityEnd": [
    LoanAndLeaseContractChangeAnnuityEnd
  ],
  "changeInterestRate": [
    LoanAndLeaseContractChangeInterestRate
  ],
  "changeEntities": [LoanAndLeaseContractChangeEntities],
  "mileageOptions": LoanAndLeaseLimitedMileage,
  "assetOptions": LoanAndLeaseAssetOptions,
  "asset": Asset,
  "periodAlignment": "ALIGNED",
  "invoiceText": "xyz789",
  "sharedInsurancePolicy": true,
  "expirationStatus": "PENDING_CUSTOMER",
  "regTax": LoanAndLeaseRegTaxNone,
  "secondHandVat": true,
  "approverInitials": "xyz789",
  "firstPeriodInvoice": "2020-07-19",
  "firstBooking": "2020-07-19",
  "collectionMethod": "BETALINGSSERVICE",
  "mailNotification": true,
  "report": LoanAndLeaseContractReport,
  "retention": LoanAndLeaseContractRetention,
  "annuityFinalEnd": "2020-07-19",
  "computedEndDate": "2020-07-19",
  "computedStartDate": "2020-07-19",
  "regTaxEndDate": "2020-07-19",
  "regTaxStartDate": "2020-07-19",
  "comments": [LoanAndLeaseContractComment],
  "files": [ContractFile],
  "bookedInvoices": [LoanAndLeaseBookedInvoice],
  "mirrorEntries": MirrorEntryCasehubResult,
  "pmtRoundingType": "NO_ROUNDING",
  "annuityType": "BEGIN",
  "bookingState": PortfolioV2BookingState,
  "disabledAssets": ["xyz789"],
  "id": 4
}

Types

LoanAndLeaseContractAnnuityEndInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractChangeAnnuityEndDataInput!`
`contractId` - `UUID!`

Example

{
  "data": LoanAndLeaseContractChangeAnnuityEndDataInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractChangeAnnuityEnd

Fields

Field Name	Description
`date` - `LocalDate!`
`annuityEnd` - `LocalDate`

Example

{
  "date": "2020-07-19",
  "annuityEnd": "2020-07-19"
}

Types

LoanAndLeaseContractChangeAnnuityEndDataInput

Fields

Input Field	Description
`annuityEnd` - `LocalDate`
`date` - `LocalDate!`

Example

{
  "annuityEnd": "2020-07-19",
  "date": "2020-07-19"
}

Types

LoanAndLeaseContractChangeEntities

Fields

Field Name	Description
`date` - `LocalDate`
`data` - `LoanAndLeaseContractEntities`

Example

{
  "date": "2020-07-19",
  "data": LoanAndLeaseContractEntities
}

Types

LoanAndLeaseContractChangeEntitiesDataInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractEntitiesInput`
`date` - `LocalDate`

Example

{
  "data": LoanAndLeaseContractEntitiesInput,
  "date": "2020-07-19"
}

Types

LoanAndLeaseContractChangeEntitiesInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractChangeEntitiesDataInput!`
`contractId` - `UUID!`

Example

{
  "data": LoanAndLeaseContractChangeEntitiesDataInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractChangeInterestRate

Fields

Field Name	Description
`date` - `LocalDate!`
`interestRateNominal` - `LoanAndLeaseInterestRateNominal`

Example

{
  "date": "2020-07-19",
  "interestRateNominal": LoanAndLeaseInterestRateNominal
}

Types

LoanAndLeaseContractChangeInterestRateDataInput

Fields

Input Field	Description
`interestRateNominal` - `LoanAndLeaseInterestRateNominalInput`
`date` - `LocalDate!`

Example

{
  "interestRateNominal": LoanAndLeaseInterestRateNominalInput,
  "date": "2020-07-19"
}

Types

LoanAndLeaseContractChangeResidualValue

Fields

Field Name	Description
`date` - `LocalDate!`
`residualValue` - `BigDecimal`

Example

{
  "date": "2020-07-19",
  "residualValue": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseContractChangeResidualValueDataInput

Fields

Input Field	Description
`residualValue` - `BigDecimal`
`date` - `LocalDate!`

Example

{
  "residualValue": "28391719239482739937.1939459927192",
  "date": "2020-07-19"
}

Types

LoanAndLeaseContractComment

Fields

Field Name	Description
`comment` - `String!`
`created` - `Instant!`
`createdBy` - `String!`
`author` - `User`

Example

{
  "comment": "abc123",
  "created": 1654109791,
  "createdBy": "xyz789",
  "author": User
}

Types

LoanAndLeaseContractCostAnnuityPeriodic

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`periodicCost` - `LoanAndLeasePeriodicCost!`
`startDate` - `LocalDate`
`endDate` - `LocalDate`
`adjustOnEndChange` - `Boolean`
`bookingDate` - `LocalDate`

Example

{
  "costId": "abc123",
  "cost": LoanAndLeasePortfolioCosts,
  "periodicCost": LoanAndLeasePeriodicCostPeriod,
  "startDate": "2020-07-19",
  "endDate": "2020-07-19",
  "adjustOnEndChange": true,
  "bookingDate": "2020-07-19"
}

Types

LoanAndLeaseContractCostAnnuityPeriodicInput

Fields

Input Field	Description
`bookingDate` - `LocalDate`
`adjustOnEndChange` - `Boolean!`
`endDate` - `LocalDate`
`startDate` - `LocalDate`
`periodicCostPeriod` - `LoanAndLeasePeriodicCostPeriodInput`	Is mutually exclusive with periodicCostPrt
`perodicCostPrt` - `LoanAndLeasePeriodicCostPrtInput`	Is mutually exclusive with periodicCostPeriod
`costId` - `String!`

Example

{
  "bookingDate": "2020-07-19",
  "adjustOnEndChange": true,
  "endDate": "2020-07-19",
  "startDate": "2020-07-19",
  "periodicCostPeriod": LoanAndLeasePeriodicCostPeriodInput,
  "perodicCostPrt": LoanAndLeasePeriodicCostPrtInput,
  "costId": "xyz789"
}

Types

LoanAndLeaseContractCostDelete

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`bookingDate` - `LocalDate`

Example

{
  "costId": "abc123",
  "cost": LoanAndLeasePortfolioCosts,
  "bookingDate": "2020-07-19"
}

Types

LoanAndLeaseContractCostDeleteInput

Fields

Input Field	Description
`bookingDate` - `LocalDate`
`costId` - `String!`

Example

{
  "bookingDate": "2020-07-19",
  "costId": "xyz789"
}

Types

LoanAndLeaseContractCostDirectConstant

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`constantAmount` - `BigDecimal!`
`bookingDate` - `LocalDate`

Example

{
  "costId": "abc123",
  "cost": LoanAndLeasePortfolioCosts,
  "constantAmount": "28391719239482739937.1939459927192",
  "bookingDate": "2020-07-19"
}

Types

LoanAndLeaseContractCostDirectConstantInput

Fields

Input Field	Description
`bookingDate` - `LocalDate`
`constantAmount` - `BigDecimal!`
`costId` - `String!`

Example

{
  "bookingDate": "2020-07-19",
  "constantAmount": "28391719239482739937.1939459927192",
  "costId": "abc123"
}

Types

LoanAndLeaseContractCostDirectPeriodic

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`periodicCost` - `LoanAndLeasePeriodicCost!`
`bookingDate` - `LocalDate`
`endDate` - `LocalDate`

Example

{
  "costId": "xyz789",
  "cost": LoanAndLeasePortfolioCosts,
  "periodicCost": LoanAndLeasePeriodicCostPeriod,
  "bookingDate": "2020-07-19",
  "endDate": "2020-07-19"
}

Types

LoanAndLeaseContractCostDirectPeriodicInput

Fields

Input Field	Description
`endDate` - `LocalDate`
`bookingDate` - `LocalDate`
`periodicCostPeriod` - `LoanAndLeasePeriodicCostPeriodInput`	Is mutually exclusive with periodicCostPrt
`perodicCostPrt` - `LoanAndLeasePeriodicCostPrtInput`	Is mutually exclusive with periodicCostPeriod
`costId` - `String!`

Example

{
  "endDate": "2020-07-19",
  "bookingDate": "2020-07-19",
  "periodicCostPeriod": LoanAndLeasePeriodicCostPeriodInput,
  "perodicCostPrt": LoanAndLeasePeriodicCostPrtInput,
  "costId": "xyz789"
}

Types

LoanAndLeaseContractCostPayment

Fields

Field Name	Description
`costId` - `String!`
`cost` - `LoanAndLeasePortfolioCosts`
`amount` - `BigDecimal!`
`bookingDate` - `LocalDate`

Example

{
  "costId": "xyz789",
  "cost": LoanAndLeasePortfolioCosts,
  "amount": "28391719239482739937.1939459927192",
  "bookingDate": "2020-07-19"
}

Types

LoanAndLeaseContractCostPaymentInput

Fields

Input Field	Description
`bookingDate` - `LocalDate`
`amount` - `BigDecimal!`
`costId` - `String!`

Example

{
  "bookingDate": "2020-07-19",
  "amount": "28391719239482739937.1939459927192",
  "costId": "abc123"
}

Types

LoanAndLeaseContractCosts

Description

Costs that contain both cost id and cost data: CostId is a user-provided string-based ID. The same CostId can exist in multiple portfolios. If a Portfolio is not completely configured, a CostId might be missing in it. This is a valid state for the system - the system will just issue a warning when previewing booking, saying that the user should complete the configuration.

Types

Union Types
`LoanAndLeaseContractCostPayment`
`LoanAndLeaseContractCostDirectPeriodic`
`LoanAndLeaseContractCostDirectConstant`
`LoanAndLeaseContractCostDelete`
`LoanAndLeaseContractCostAnnuityPeriodic`
`LoanAndLeaseAnnuityConstant`

Example

LoanAndLeaseContractCostPayment

Types

LoanAndLeaseContractCostsDataInput

Fields

Input Field	Description
`payments` - `[LoanAndLeaseContractCostPaymentInput!]!`
`directPeriodics` - `[LoanAndLeaseContractCostDirectPeriodicInput!]!`
`directConstants` - `[LoanAndLeaseContractCostDirectConstantInput!]!`
`deletes` - `[LoanAndLeaseContractCostDeleteInput!]!`
`annuityPeriodics` - `[LoanAndLeaseContractCostAnnuityPeriodicInput!]!`
`annuityConstants` - `[LoanAndLeaseAnnuityConstantInput!]!`

Example

{
  "payments": [LoanAndLeaseContractCostPaymentInput],
  "directPeriodics": [
    LoanAndLeaseContractCostDirectPeriodicInput
  ],
  "directConstants": [
    LoanAndLeaseContractCostDirectConstantInput
  ],
  "deletes": [LoanAndLeaseContractCostDeleteInput],
  "annuityPeriodics": [
    LoanAndLeaseContractCostAnnuityPeriodicInput
  ],
  "annuityConstants": [LoanAndLeaseAnnuityConstantInput]
}

Types

LoanAndLeaseContractCostsInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractCostsDataInput!`
`contractId` - `UUID!`

Example

{
  "data": LoanAndLeaseContractCostsDataInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractCountsFiltered

Fields

Field Name	Description
`withOtherWarningType` - `LoanAndLeaseContractCountsFilteredWithOtherWarningType!`
`withOtherContractStatus` - `LoanAndLeaseContractCountsFilteredWithOtherContractStatus!`
`withOtherRegTax` - `LoanAndLeaseContractCountsFilteredWithOtherRegTax!`
`withOtherExpirationStatus` - `LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus!`
`portfolioCounts` - `ContractPortfolioCounts!`

Example

{
  "withOtherWarningType": LoanAndLeaseContractCountsFilteredWithOtherWarningType,
  "withOtherContractStatus": LoanAndLeaseContractCountsFilteredWithOtherContractStatus,
  "withOtherRegTax": LoanAndLeaseContractCountsFilteredWithOtherRegTax,
  "withOtherExpirationStatus": LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus,
  "portfolioCounts": ContractPortfolioCounts
}

Types

LoanAndLeaseContractCountsFilteredWithOtherContractStatus

Fields

Field Name	Description
`all` - `Long!`
`draft` - `Long!`
`starting` - `Long!`
`active` - `Long!`
`ending` - `Long!`
`completed` - `Long!`
`inventory` - `Long!`

Example

{
  "all": 9223372036854776000,
  "draft": 9223372036854776000,
  "starting": 9223372036854776000,
  "active": 9223372036854776000,
  "ending": 9223372036854776000,
  "completed": 9223372036854776000,
  "inventory": 9223372036854776000
}

Types

LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus

Fields

Field Name	Description
`all` - `Long!`
`pendingCustomer` - `Long!`
`extension` - `Long!`
`termination` - `Long!`
`newContract` - `Long!`

Example

{
  "all": 9223372036854776000,
  "pendingCustomer": 9223372036854776000,
  "extension": 9223372036854776000,
  "termination": 9223372036854776000,
  "newContract": 9223372036854776000
}

Types

LoanAndLeaseContractCountsFilteredWithOtherRegTax

Fields

Field Name	Description
`all` - `Long!`
`proportionate` - `Long!`
`full` - `Long!`
`none` - `Long!`

Example

{
  "all": 9223372036854776000,
  "proportionate": 9223372036854776000,
  "full": 9223372036854776000,
  "none": 9223372036854776000
}

Types

LoanAndLeaseContractCountsFilteredWithOtherWarningType

Fields

Field Name	Description
`all` - `Long!`
`anyWarning` - `Long!`
`supplierPayableWarning` - `Long!`
`assetWarning` - `Long!`
`startDateWarning` - `Long!`
`endDateWarning` - `Long!`
`anyAccountWarning` - `Long!`
`expirationWarning` - `Long!`
`annuityExpirationWarning` - `Long!`

Example

{
  "all": 9223372036854776000,
  "anyWarning": 9223372036854776000,
  "supplierPayableWarning": 9223372036854776000,
  "assetWarning": 9223372036854776000,
  "startDateWarning": 9223372036854776000,
  "endDateWarning": 9223372036854776000,
  "anyAccountWarning": 9223372036854776000,
  "expirationWarning": 9223372036854776000,
  "annuityExpirationWarning": 9223372036854776000
}

Types

LoanAndLeaseContractCreateInEconomicErrorType

Values

Enum Value	Description
`ALREADY_EXISTS`	If any input contracts already exist in economic
`MISSING_CONFIGURATION`	Missing economic configuration
`ENTITY_NOT_FOUND`	One of the contracts did not exist, the whole update is rolled back

Example

"ALREADY_EXISTS"

Types

LoanAndLeaseContractCreateInEconomicItemInput

Fields

Input Field	Description
`economicId` - `Long`
`contractId` - `UUID!`

Example

{
  "economicId": 9223372036854776000,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractCreateInput

Fields

Input Field	Description
`mailNotification` - `Boolean!`
`changeEntities` - `[LoanAndLeaseContractChangeEntitiesDataInput!]!`
`changeInterestRate` - `[LoanAndLeaseContractChangeInterestRateDataInput!]!`
`changeAnnuityEnd` - `[LoanAndLeaseContractChangeAnnuityEndDataInput!]!`
`changeResidualValue` - `[LoanAndLeaseContractChangeResidualValueDataInput!]!`
`costs` - `LoanAndLeaseContractCostsDataInput!`
`entities` - `LoanAndLeaseContractEntitiesInput!`
`contract` - `LoanAndLeaseContractInput!`

Example

{
  "mailNotification": true,
  "changeEntities": [
    LoanAndLeaseContractChangeEntitiesDataInput
  ],
  "changeInterestRate": [
    LoanAndLeaseContractChangeInterestRateDataInput
  ],
  "changeAnnuityEnd": [
    LoanAndLeaseContractChangeAnnuityEndDataInput
  ],
  "changeResidualValue": [
    LoanAndLeaseContractChangeResidualValueDataInput
  ],
  "costs": LoanAndLeaseContractCostsDataInput,
  "entities": LoanAndLeaseContractEntitiesInput,
  "contract": LoanAndLeaseContractInput
}

Types

LoanAndLeaseContractEntitiensDebtorInput

Fields

Input Field	Description
`pbsNoOverride` - `String`
`debtorId` - `UUID!`

Example

{
  "pbsNoOverride": "abc123",
  "debtorId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractEntities

Fields

Field Name	Description
`debtor` - `LoanAndLeaseEntity!`
`debtorPbsNoOverride` - `String`
`coDebtor` - `LoanAndLeaseEntity`
`repurchaser` - `[LoanAndLeaseEntity!]!`
`guarantor` - `[LoanAndLeaseEntity!]!`
`dealer` - `LoanAndLeaseEntity`
`supplier` - `LoanAndLeaseEntity`
`assetUser` - `LoanAndLeaseEntity`

Example

{
  "debtor": LoanAndLeasePerson,
  "debtorPbsNoOverride": "abc123",
  "coDebtor": LoanAndLeasePerson,
  "repurchaser": [LoanAndLeasePerson],
  "guarantor": [LoanAndLeasePerson],
  "dealer": LoanAndLeasePerson,
  "supplier": LoanAndLeasePerson,
  "assetUser": LoanAndLeasePerson
}

Types

LoanAndLeaseContractEntitiesInput

Description

Only one of 'debtorId' and 'debtor' may be provided.

Fields

Input Field	Description
`assetUserId` - `UUID`
`supplierId` - `UUID`
`dealerId` - `UUID`
`guarantorIds` - `[UUID!]!`
`repurchaserIds` - `[UUID!]!`
`coDebtorId` - `UUID`
`debtor` - `LoanAndLeaseContractEntitiensDebtorInput`
`debtorId` - `UUID`

Example

{
  "assetUserId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "supplierId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "dealerId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "guarantorIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "repurchaserIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "coDebtorId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "debtor": LoanAndLeaseContractEntitiensDebtorInput,
  "debtorId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractEntity

Values

Enum Value	Description
`DEBTOR`
`CO_DEBTOR`
`REPURCHASER`
`GURAUNTOR`
`DEALER`
`ASSET_USER`

Example

"DEBTOR"

Types

LoanAndLeaseContractInput

Fields

Input Field	Description
`disabledAssets` - `[String!]!`
`annuityType` - `AnnuityType`
`pmtRoundingType` - `PmtRoundingType`
`contractStart` - `LocalDate`	Used to describe when the contract starts if it is different from annuityStart. Otherwise falls back to annuity start.
`firstBooking` - `LocalDate`
`collectionMethod` - `LoanAndLeaseCollectionMethod`
`approverInitials` - `String`
`firstPeriodInvoice` - `LocalDate`
`secondHandVat` - `Boolean!`
`regTax` - `LoanAndLeaseRegTaxInput`	Leaving this empty means proportionate registration tax
`expirationStatus` - `LoanAndLeaseExpirationStatus`
`sharedInsurancePolicy` - `Boolean!`
`invoiceText` - `String`
`assetOptions` - `LoanAndLeaseAssetOptionsInput`	Use the 'asset' parameter instead, this is only for backwards compat and may have uninteded consequences. It will remove in the future.
`asset` - `UUID`
`mileageOptions` - `LoanAndLeaseLimitedMileageOptionsInput`	Leaving this empty means unlimited mileage
`contractStatus` - `LoanAndLeaseContractStatus!`
`residualValue` - `BigDecimal!`
`fixedRate` - `Boolean!`
`externalMarginRate` - `BigDecimal!`
`internalMarginRate` - `BigDecimal!`
`baseRate` - `BigDecimal!`
`periodAlignment` - `LoanAndLeasePeriodAlignment!`
`periodUnit` - `LoanAndLeasePeriodUnit!`
`adjustEnd` - `LocalDate`
`annuityEnd` - `LocalDate`	May only be null on v2 portfolios that have the indefinite flag set
`annuityStart` - `LocalDate!`
`portfolioId` - `String!`
`contractType` - `LoanAndLeaseContractTypeInput`	Mutually exclusive with 'dimensionNo', use this instead
`dimensionNo` - `Int`	Use 'contratType' input instead, this will eventually be deprecated

Example

{
  "disabledAssets": ["xyz789"],
  "annuityType": "BEGIN",
  "pmtRoundingType": "NO_ROUNDING",
  "contractStart": "2020-07-19",
  "firstBooking": "2020-07-19",
  "collectionMethod": "BETALINGSSERVICE",
  "approverInitials": "abc123",
  "firstPeriodInvoice": "2020-07-19",
  "secondHandVat": true,
  "regTax": LoanAndLeaseRegTaxInput,
  "expirationStatus": "PENDING_CUSTOMER",
  "sharedInsurancePolicy": true,
  "invoiceText": "abc123",
  "assetOptions": LoanAndLeaseAssetOptionsInput,
  "asset": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "mileageOptions": LoanAndLeaseLimitedMileageOptionsInput,
  "contractStatus": "DRAFT",
  "residualValue": "28391719239482739937.1939459927192",
  "fixedRate": true,
  "externalMarginRate": "28391719239482739937.1939459927192",
  "internalMarginRate": "28391719239482739937.1939459927192",
  "baseRate": "28391719239482739937.1939459927192",
  "periodAlignment": "ALIGNED",
  "periodUnit": "MONTH",
  "adjustEnd": "2020-07-19",
  "annuityEnd": "2020-07-19",
  "annuityStart": "2020-07-19",
  "portfolioId": "xyz789",
  "contractType": LoanAndLeaseContractTypeInput,
  "dimensionNo": 123
}

Types

LoanAndLeaseContractInterestRateInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractChangeInterestRateDataInput!`
`contractId` - `UUID!`

Example

{
  "data": LoanAndLeaseContractChangeInterestRateDataInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractMissingDimensionNoError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`

Example

{"contract": LoanAndLeaseContract}

Types

LoanAndLeaseContractNotActiveError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`

Example

{"contract": LoanAndLeaseContract}

Types

LoanAndLeaseContractReport

Fields

Field Name	Description
`supplierPayable` - `BigDecimal`
`asset` - `BigDecimal`
`asset2` - `BigDecimal`
`asset3` - `BigDecimal`
`deposit` - `BigDecimal`
`remainder` - `BigDecimal!`
`debtorRemainders` - `[LoanAndLeaseContractReportDebtorRemainder!]!`
`supplierPayableWarning` - `Boolean!`
`assetWarning` - `Boolean!`
`startDateWarning` - `Boolean!`
`endDateWarning` - `Boolean!`
`anyAccountWarning` - `Boolean!`
`expirationWarning` - `Boolean!`
`annuityExpirationWarning` - `Boolean!`

Example

{
  "supplierPayable": "28391719239482739937.1939459927192",
  "asset": "28391719239482739937.1939459927192",
  "asset2": "28391719239482739937.1939459927192",
  "asset3": "28391719239482739937.1939459927192",
  "deposit": "28391719239482739937.1939459927192",
  "remainder": "28391719239482739937.1939459927192",
  "debtorRemainders": [
    LoanAndLeaseContractReportDebtorRemainder
  ],
  "supplierPayableWarning": true,
  "assetWarning": true,
  "startDateWarning": true,
  "endDateWarning": true,
  "anyAccountWarning": true,
  "expirationWarning": true,
  "annuityExpirationWarning": true
}

Types

LoanAndLeaseContractReportDebtorRemainder

Fields

Field Name	Description
`remainder` - `BigDecimal!`
`entity` - `LoanAndLeaseEntity!`

Example

{
  "remainder": "28391719239482739937.1939459927192",
  "entity": LoanAndLeasePerson
}

Types

LoanAndLeaseContractResidualValueInput

Fields

Input Field	Description
`data` - `LoanAndLeaseContractChangeResidualValueDataInput!`
`contractId` - `UUID!`

Example

{
  "data": LoanAndLeaseContractChangeResidualValueDataInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractRetention

Fields

Field Name	Description
`hidden` - `Boolean!`
`retainUntil` - `Instant`
`hasConflicts` - `Boolean!`

Example

{"hidden": true, "retainUntil": 1654109791, "hasConflicts": true}

Types

LoanAndLeaseContractRetentionInput

Fields

Input Field	Description
`retention` - `LoanAndLeaseRetentionInput!`
`contractId` - `UUID!`

Example

{
  "retention": LoanAndLeaseRetentionInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractStatus

Values

Enum Value	Description
`DRAFT`
`STARTING`
`ACTIVE`
`ENDING`
`COMPLETED`
`INVENTORY`

Example

"DRAFT"

Types

LoanAndLeaseContractTypeEconomicInput

Fields

Input Field	Description
`dimensionNo` - `Int`

Example

{"dimensionNo": 123}

Types

LoanAndLeaseContractTypeGenericInput

Fields

Input Field	Description
`contractNumber` - `String`

Example

{"contractNumber": "abc123"}

Types

LoanAndLeaseContractTypeInput

Fields

Input Field	Description
`economic` - `LoanAndLeaseContractTypeEconomicInput`	Only one of 'generic' and 'economic' may be provided
`generic` - `LoanAndLeaseContractTypeGenericInput`	Only one of 'generic' and 'economic' may be provided

Example

{
  "economic": LoanAndLeaseContractTypeEconomicInput,
  "generic": LoanAndLeaseContractTypeGenericInput
}

Types

LoanAndLeaseContractUpdateError

Fields

Field Name	Description
`type` - `LoanAndLeaseContractUpdateErrorType!`

Example

{"type": "DUPLICATE_IDS"}

Types

LoanAndLeaseContractUpdateErrorType

Values

Enum Value	Description
`DUPLICATE_IDS`
`NOT_FOUND`

Example

"DUPLICATE_IDS"

Types

LoanAndLeaseContractUpdateInput

Fields

Input Field	Description
`mailNotification` - `Boolean`
`contract` - `LoanAndLeaseContractInput!`
`contractId` - `UUID!`

Example

{
  "mailNotification": true,
  "contract": LoanAndLeaseContractInput,
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseContractUpdateOutcome

Types

Union Types
`LoanAndLeaseContractUpdateError`
`LoanAndLeaseContractUpdateSuccess`

Example

LoanAndLeaseContractUpdateError

Types

LoanAndLeaseContractUpdateSuccess

Fields

Field Name	Description
`data` - `[LoanAndLeaseContract!]!`

Example

{"data": [LoanAndLeaseContract]}

Types

LoanAndLeaseCost

Fields

Field Name	Description
`costId` - `LoanAndLeaseCostId!`
`amount` - `BigDecimal!`
`text` - `String`

Example

{
  "costId": LoanAndLeaseIntrinsicCostId,
  "amount": "28391719239482739937.1939459927192",
  "text": "abc123"
}

Types

LoanAndLeaseCostId

Types

Union Types
`LoanAndLeaseIntrinsicCostId`
`LoanAndLeaseUserDefinedCostId`

Example

LoanAndLeaseIntrinsicCostId

Types

LoanAndLeaseCostMissingConfigError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`portfolioId` - `String!`
`costId` - `LoanAndLeaseCostId!`

Example

{
  "contract": LoanAndLeaseContract,
  "portfolioId": "xyz789",
  "costId": LoanAndLeaseIntrinsicCostId
}

Types

LoanAndLeaseCostMissingProductNoError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`portfolioId` - `String!`
`costId` - `LoanAndLeaseCostId!`

Example

{
  "contract": LoanAndLeaseContract,
  "portfolioId": "xyz789",
  "costId": LoanAndLeaseIntrinsicCostId
}

Types

LoanAndLeaseCreateCompanyInput

Fields

Input Field	Description
`creditorId` - `Int`
`createCreditorInEconomic` - `LoanAndLeaseCreateCreditorInEconomicInput`
`debtorId` - `Long`
`createInEconomic` - `LoanAndLeaseCreateInEconomicInput`
`company` - `LoanAndLeaseCompanyInput!`

Example

{
  "creditorId": 987,
  "createCreditorInEconomic": LoanAndLeaseCreateCreditorInEconomicInput,
  "debtorId": 9223372036854776000,
  "createInEconomic": LoanAndLeaseCreateInEconomicInput,
  "company": LoanAndLeaseCompanyInput
}

Types

LoanAndLeaseCreateContractInEconomicError

Fields

Field Name	Description
`type` - `LoanAndLeaseContractCreateInEconomicErrorType!`

Example

{"type": "ALREADY_EXISTS"}

Types

LoanAndLeaseCreateContractInEconomicOutcome

Types

Union Types
`LoanAndLeaseCreateContractInEconomicError`
`LoanAndLeaseCreateContractInEconomicResult`

Example

LoanAndLeaseCreateContractInEconomicError

Types

LoanAndLeaseCreateContractInEconomicResult

Fields

Field Name	Description
`outcome` - `[LoanAndLeaseContract!]!`

Example

{"outcome": [LoanAndLeaseContract]}

Types

LoanAndLeaseCreateCreditorInEconomicInput

Fields

Input Field	Description
`economicCreditorId` - `Int`

Example

{"economicCreditorId": 987}

Types

LoanAndLeaseCreateEntityInEconomicError

Fields

Field Name	Description
`type` - `LoanAndLeaseEntityCreateInEconomicErrorType!`

Example

{"type": "ALREADY_EXISTS"}

Types

LoanAndLeaseCreateEntityInEconomicOutcome

Types

Union Types
`LoanAndLeaseCreateEntityInEconomicError`
`LoanAndLeaseCreateEntityInEconomicResult`

Example

LoanAndLeaseCreateEntityInEconomicError

Types

LoanAndLeaseCreateEntityInEconomicResult

Fields

Field Name	Description
`outcome` - `[LoanAndLeaseEntity!]!`

Example

{"outcome": [LoanAndLeasePerson]}

Types

LoanAndLeaseCreateInEconomicInput

Fields

Input Field	Description
`economicId` - `Long`

Example

{"economicId": 9223372036854776000}

Types

LoanAndLeaseCreatePersonInput

Fields

Input Field	Description
`creditorId` - `Int`
`createCreditorInEconomic` - `LoanAndLeaseCreateCreditorInEconomicInput`
`debtorId` - `Long`
`createInEconomic` - `LoanAndLeaseCreateInEconomicInput`
`person` - `LoanAndLeasePersonInput!`

Example

{
  "creditorId": 123,
  "createCreditorInEconomic": LoanAndLeaseCreateCreditorInEconomicInput,
  "debtorId": 9223372036854776000,
  "createInEconomic": LoanAndLeaseCreateInEconomicInput,
  "person": LoanAndLeasePersonInput
}

Types

LoanAndLeaseCreatePortfolioInput

Fields

Input Field	Description
`costs` - `[LoanAndLeasePortfolioCostInput!]!`
`portfolio` - `LoanAndLeasePortfolioInput!`

Example

{
  "costs": [LoanAndLeasePortfolioCostInput],
  "portfolio": LoanAndLeasePortfolioInput
}

Types

LoanAndLeaseCreationError

Fields

Field Name	Description
`type` - `LoanAndLeaseCreationErrorType!`

Example

{"type": "ALREADY_EXISTS"}

Types

LoanAndLeaseCreationErrorType

Values

Enum Value	Description
`ALREADY_EXISTS`	If the input entities have identifiers that collide with existing entities
`MISSING_CONFIGURATION`	Missing economic configuration
`DUPLICATE_INPUT_ENTITY_IDENTIFIERS`	Duplicate identifiers found in the input

Example

"ALREADY_EXISTS"

Types

LoanAndLeaseCreationOutcome

Types

Union Types
`LoanAndLeaseCreationError`
`LoanAndLeaseCreationResult`

Example

LoanAndLeaseCreationError

Types

LoanAndLeaseCreationResult

Fields

Field Name	Description
`outcome` - `[LoanAndLeaseEntity!]!`

Example

{"outcome": [LoanAndLeasePerson]}

Types

LoanAndLeaseCreditorAccount

Description

At-least one of creditorNo and contraAccountNo is always set

Fields

Field Name	Description
`creditorNo` - `Long`
`contraAccountNo` - `Long`

Example

{"creditorNo": 9223372036854776000, "contraAccountNo": 9223372036854776000}

Types

LoanAndLeaseCreditorInvoice

Fields

Field Name	Description
`account` - `LoanAndLeaseCreditorAccount!`
`invoiceNumber` - `String`
`vatCode` - `String`
`dueDate` - `LocalDate`

Example

{
  "account": LoanAndLeaseCreditorAccount,
  "invoiceNumber": "xyz789",
  "vatCode": "xyz789",
  "dueDate": "2020-07-19"
}

Types

LoanAndLeaseCreditorPayment

Fields

Field Name	Description
`account` - `LoanAndLeaseCreditorAccount!`
`invoiceNumber` - `String`

Example

{
  "account": LoanAndLeaseCreditorAccount,
  "invoiceNumber": "abc123"
}

Types

LoanAndLeaseDebtorAccount

Description

At-least one of debtorNo and contraAccountNo is always set

Fields

Field Name	Description
`debtorNo` - `Long`
`contraAccountNo` - `Long`

Example

{"debtorNo": 9223372036854776000, "contraAccountNo": 9223372036854776000}

Types

LoanAndLeaseDebtorInvoice

Fields

Field Name	Description
`account` - `LoanAndLeaseDebtorAccount!`
`invoiceNumber` - `Int`
`vatCode` - `String`
`dueDate` - `LocalDate`

Example

{
  "account": LoanAndLeaseDebtorAccount,
  "invoiceNumber": 123,
  "vatCode": "abc123",
  "dueDate": "2020-07-19"
}

Types

LoanAndLeaseDebtorPayment

Fields

Field Name	Description
`account` - `LoanAndLeaseDebtorAccount!`
`invoiceNumber` - `Int`

Example

{
  "account": LoanAndLeaseDebtorAccount,
  "invoiceNumber": 123
}

Types

LoanAndLeaseDeliveryStateResult

Fields

Field Name	Description
`state` - `[LoanAndLeasePBSDeliveryState!]!`
`detachedPaymentStatuses` - `[LoanAndLeasePBSDetachedPayment!]!`

Example

{
  "state": [LoanAndLeasePBSDeliveryState],
  "detachedPaymentStatuses": [
    LoanAndLeasePBSDetachedPayment
  ]
}

Types

LoanAndLeaseDimensionNos

Fields

Field Name	Description
`dimensionNo1` - `Int`
`dimensionNo2` - `Int`
`dimensionNo3` - `Int`

Example

{"dimensionNo1": 987, "dimensionNo2": 123, "dimensionNo3": 987}

Types

LoanAndLeaseEntity

Types

Union Types
`LoanAndLeasePerson`
`LoanAndLeaseCompany`

Example

LoanAndLeasePerson

Types

LoanAndLeaseEntityCreateCreditorInEconomicItemInput

Fields

Input Field	Description
`economicCreditorId` - `Long`
`entityId` - `UUID!`

Example

{
  "economicCreditorId": 9223372036854776000,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseEntityCreateInEconomicErrorType

Values

Enum Value	Description
`ALREADY_EXISTS`	If any input entities already exist in economic
`MISSING_CONFIGURATION`	Missing economic configuration
`ENTITY_NOT_FOUND`	One of the entities did not exist, the whole update is rolled back

Example

"ALREADY_EXISTS"

Types

LoanAndLeaseEntityCreateInEconomicItemInput

Fields

Input Field	Description
`economicId` - `Long`
`entityId` - `UUID!`

Example

{
  "economicId": 9223372036854776000,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseEntityMissingDebtorNoError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`entityId` - `UUID!`
`entity` - `LoanAndLeaseEntity!`

Example

{
  "contract": LoanAndLeaseContract,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "entity": LoanAndLeasePerson
}

Types

LoanAndLeaseEntityReport

Fields

Field Name	Description
`total` - `BigDecimal!`
`remainder` - `BigDecimal!`
`diff` - `BigDecimal!`

Example

{
  "total": "28391719239482739937.1939459927192",
  "remainder": "28391719239482739937.1939459927192",
  "diff": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseEntityRetention

Fields

Field Name	Description
`conflicts` - `[LoanAndLeaseEntityRetentionRelatedToContractConflict!]!`
`hidden` - `Boolean!`
`retainUntil` - `Instant`
`hasConflicts` - `Boolean!`

Example

{
  "conflicts": [
    LoanAndLeaseEntityRetentionRelatedToContractConflict
  ],
  "hidden": true,
  "retainUntil": 1654109791,
  "hasConflicts": true
}

Types

LoanAndLeaseEntityRetentionInput

Fields

Input Field	Description
`retention` - `LoanAndLeaseRetentionInput!`
`entityId` - `UUID!`

Example

{
  "retention": LoanAndLeaseRetentionInput,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseEntityRetentionRelatedToContractConflict

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`
`contractEntity` - `LoanAndLeaseContractEntity!`

Example

{
  "contract": LoanAndLeaseContract,
  "contractEntity": "DEBTOR"
}

Types

LoanAndLeaseEntityUpdateErrorType

Values

Enum Value	Description
`ALREADY_EXISTS`	If any of the input entities have new identifiers that collide with existing entities
`MISSING_CONFIGURATION`	Missing economic configuration
`DUPLICATE_INPUT_ENTITY_IDENTIFIERS`	Duplicate identifiers found in the input
`ENTITY_NOT_FOUND`	One of the entities did not exist, the whole update is rolled back

Example

"ALREADY_EXISTS"

Types

LoanAndLeaseExpirationStatus

Values

Enum Value	Description
`PENDING_CUSTOMER`
`EXTENSION`
`TERMINATION`
`NEW_CONTRACT`

Example

"PENDING_CUSTOMER"

Types

LoanAndLeaseFinanceMemo

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "abc123"
}

Types

LoanAndLeaseGenerationError

Types

Union Types
`LoanAndLeaseGenerationErrorGenericEmissionError`
`LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsError`
`LoanAndLeaseGenerationErrorUnknownError`
`LoanAndLeaseGenerationErrorDebtorError`

Example

LoanAndLeaseGenerationErrorGenericEmissionError

Types

LoanAndLeaseGenerationErrorDebtorError

Fields

Field Name	Description
`entityId` - `UUID!`
`entity` - `LoanAndLeaseEntity!`
`error` - `LoanAndLeaseGenerationErrorDebtorErrorType!`
`invoiceIds` - `[UUID!]!`

Example

{
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "entity": LoanAndLeasePerson,
  "error": LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error,
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Types

LoanAndLeaseGenerationErrorDebtorErrorType

Types

Union Types
`LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error`
`LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn052Error`
`LoanAndLeaseGenerationErrorDebtorMoreThan20M602Error`
`LoanAndLeaseGenerationErrorDebtorSizeError`

Example

LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error

Types

LoanAndLeaseGenerationErrorDebtorMoreThan20M602Error

Fields

Field Name	Description
`found` - `Int!`

Example

{"found": 123}

Types

LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn052Error

Fields

Field Name	Description
`found` - `Int!`

Example

{"found": 987}

Types

LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error

Fields

Field Name	Description
`found` - `Int!`

Example

{"found": 987}

Types

LoanAndLeaseGenerationErrorDebtorSizeError

Fields

Field Name	Description
`field` - `LoanAndLeaseGenerationErrorDebtorSizeErrorFieldType!`
`emissionError` - `LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError!`

Example

{
  "field": "NAME_ADDRESS_1",
  "emissionError": LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError
}

Types

LoanAndLeaseGenerationErrorDebtorSizeErrorFieldType

Values

Enum Value	Description
`NAME_ADDRESS_1`
`NAME_ADDRESS_2`
`NAME_ADDRESS_3`
`NAME_ADDRESS_4`
`NAME_ADDRESS_5`
`POSTAL_CODE`
`COUNTRY_CODE`
`RECORD_052_LINE`

Example

"NAME_ADDRESS_1"

Types

LoanAndLeaseGenerationErrorEmissionCustomDataType

Fields

Field Name	Description
`type` - `String!`

Example

{"type": "xyz789"}

Types

LoanAndLeaseGenerationErrorEmissionDataType

Types

Union Types
`LoanAndLeaseGenerationErrorEmissionCustomDataType`
`LoanAndLeaseGenerationErrorEmissionPrimitiveDataType`

Example

LoanAndLeaseGenerationErrorEmissionCustomDataType

Types

LoanAndLeaseGenerationErrorEmissionError

Types

Union Types
`LoanAndLeaseGenerationErrorEmissionNumericStringError`
`LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError`

Example

LoanAndLeaseGenerationErrorEmissionNumericStringError

Types

LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError

Fields

Field Name	Description
`maxSize` - `Int!`
`actualSize` - `Int!`
`data` - `String!`
`dataType` - `LoanAndLeaseGenerationErrorEmissionDataType!`

Example

{
  "maxSize": 123,
  "actualSize": 123,
  "data": "abc123",
  "dataType": LoanAndLeaseGenerationErrorEmissionCustomDataType
}

Types

LoanAndLeaseGenerationErrorEmissionNumericStringError

Fields

Field Name	Description
`data` - `String!`

Example

{"data": "xyz789"}

Types

LoanAndLeaseGenerationErrorEmissionPrimitiveDataType

Fields

Field Name	Description
`type` - `LoanAndLeaseGenerationErrorEmissionPrimitiveDataTypeType!`

Example

{"type": "STRING"}

Types

LoanAndLeaseGenerationErrorEmissionPrimitiveDataTypeType

Values

Enum Value	Description
`STRING`
`INT`
`LONG`

Example

"STRING"

Types

LoanAndLeaseGenerationErrorGenericEmissionError

Fields

Field Name	Description
`emissionError` - `LoanAndLeaseGenerationErrorEmissionError!`

Example

{
  "emissionError": LoanAndLeaseGenerationErrorEmissionNumericStringError
}

Types

LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsError

Fields

Field Name	Description
`found` - `Int!`

Example

{"found": 123}

Types

LoanAndLeaseGenerationErrorUnknownError

Fields

Field Name	Description
`entityIds` - `UUID`
`entities` - `LoanAndLeaseEntity`
`invoiceIds` - `[UUID!]!`

Example

{
  "entityIds": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "entities": LoanAndLeasePerson,
  "invoiceIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Types

LoanAndLeaseInterestRateNominal

Fields

Field Name	Description
`baseRate` - `BigDecimal!`
`internalMarginRate` - `BigDecimal!`
`externalMarginRate` - `BigDecimal!`
`fixedRate` - `Boolean!`

Example

{
  "baseRate": "28391719239482739937.1939459927192",
  "internalMarginRate": "28391719239482739937.1939459927192",
  "externalMarginRate": "28391719239482739937.1939459927192",
  "fixedRate": true
}

Types

LoanAndLeaseInterestRateNominalInput

Fields

Input Field	Description
`fixedRate` - `Boolean!`
`externalMarginRate` - `BigDecimal!`
`internalMarginRate` - `BigDecimal!`
`baseRate` - `BigDecimal!`

Example

{
  "fixedRate": true,
  "externalMarginRate": "28391719239482739937.1939459927192",
  "internalMarginRate": "28391719239482739937.1939459927192",
  "baseRate": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseIntrinsicCostId

Fields

Field Name	Description
`type` - `LoanAndLeaseIntrinsicCostIdType!`

Example

{"type": "BASE_RATE"}

Types

LoanAndLeaseIntrinsicCostIdType

Values

Enum Value	Description
`BASE_RATE`
`INTERNAL_MARGIN_RATE`
`EXTERNAL_MARGIN_RATE`
`ASSET`
`ASSET2`
`ASSET3`
`DEPOSIT`
`INTERMEDIATE_VAT`
`INTERMEDIATE_NO_VAT`
`ADJUSTMENT_VAT`
`ADJUSTMENT_NO_VAT`
`PAYMENT`
`ACCRUED_INCOME`

Example

"BASE_RATE"

Types

LoanAndLeaseInvalidContractStateError

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`

Example

{"contract": LoanAndLeaseContract}

Types

LoanAndLeaseInvoice

Fields

Field Name	Description
`invoiceType` - `LoanAndLeaseInvoiceType!`
`costs` - `[LoanAndLeaseCost!]!`
`debtor` - `LoanAndLeaseEntity!`

Example

{
  "invoiceType": "START",
  "costs": [LoanAndLeaseCost],
  "debtor": LoanAndLeasePerson
}

Types

LoanAndLeaseInvoiceAggregates

Fields

Field Name	Description
`completed` - `Long!`
`pending` - `Long!`
`failed` - `Long!`

Example

{
  "completed": 9223372036854776000,
  "pending": 9223372036854776000,
  "failed": 9223372036854776000
}

Types

LoanAndLeaseInvoiceBookingErrorType

Types

Union Types
`LoanAndLeaseInvoiceBookingErrorTypeNoCustomerTemplateFound`
`LoanAndLeaseInvoiceBookingErrorTypeCouldNotVerifyThatTheBookedInvoiceWasOurs`
`LoanAndLeaseInvoiceBookingErrorTypeNoAvailableInvoiceNumber`
`LoanAndLeaseInvoiceBookingErrorTypeRestApiError`

Example

LoanAndLeaseInvoiceBookingErrorTypeNoCustomerTemplateFound

Types

LoanAndLeaseInvoiceBookingErrorTypeCouldNotVerifyThatTheBookedInvoiceWasOurs

Fields

Field Name	Description
`invoiceNumber` - `Long!`

Example

{"invoiceNumber": 9223372036854776000}

Types

LoanAndLeaseInvoiceBookingErrorTypeNoAvailableInvoiceNumber

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseInvoiceBookingErrorTypeNoCustomerTemplateFound

Fields

Field Name	Description
`customerNumber` - `Int!`

Example

{"customerNumber": 123}

Types

LoanAndLeaseInvoiceBookingErrorTypeRestApiError

Fields

Field Name	Description
`error` - `EconomicAPIError!`

Example

{"error": EconomicAPIError}

Types

LoanAndLeaseInvoiceBookingStatus

Types

Union Types
`LoanAndLeaseInvoiceBookingStatusPending`
`LoanAndLeaseInvoiceBookingStatusDiscarded`
`LoanAndLeaseInvoiceBookingStatusFailed`
`LoanAndLeaseInvoiceBookingStatusStarted`
`LoanAndLeaseInvoiceBookingStatusCompleted`

Example

LoanAndLeaseInvoiceBookingStatusPending

Types

LoanAndLeaseInvoiceBookingStatusCompleted

Fields

Field Name	Description
`invoiceNo` - `Long!`

Example

{"invoiceNo": 9223372036854776000}

Types

LoanAndLeaseInvoiceBookingStatusDiscarded

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseInvoiceBookingStatusFailed

Fields

Field Name	Description
`placeholder` - `Boolean!`
`errorType` - `LoanAndLeaseInvoiceBookingErrorType`

Example

{
  "placeholder": true,
  "errorType": LoanAndLeaseInvoiceBookingErrorTypeNoCustomerTemplateFound
}

Types

LoanAndLeaseInvoiceBookingStatusPending

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseInvoiceBookingStatusStarted

Fields

Field Name	Description
`draftNo` - `Long!`
`expectedInvoiceNo` - `Long!`

Example

{"draftNo": 9223372036854776000, "expectedInvoiceNo": 9223372036854776000}

Types

LoanAndLeaseInvoiceDetailed

Fields

Field Name	Description
`invoiceType` - `LoanAndLeaseInvoiceType!`
`debtor` - `LoanAndLeaseEntity!`
`invoiceHead` - `LoanAndLeasePreviewInvoiceHead!`
`invoiceLines` - `[LoanAndLeasePreviewInvoiceLineWithCostId!]!`

Example

{
  "invoiceType": "START",
  "debtor": LoanAndLeasePerson,
  "invoiceHead": LoanAndLeasePreviewInvoiceHead,
  "invoiceLines": [
    LoanAndLeasePreviewInvoiceLineWithCostId
  ]
}

Types

LoanAndLeaseInvoiceGroup

Fields

Field Name	Description
`invoiceId` - `UUID!`
`status` - `LoanAndLeaseInvoiceBookingStatus!`
`invoice` - `LoanAndLeasePreviewInvoice!`
`bookedInvoice` - `LoanAndLeaseBookedInvoice!`

Example

{
  "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "status": LoanAndLeaseInvoiceBookingStatusPending,
  "invoice": LoanAndLeasePreviewInvoice,
  "bookedInvoice": LoanAndLeaseBookedInvoice
}

Types

LoanAndLeaseInvoiceOverrideMailOptions

Fields

Input Field	Description
`mailContent` - `String`

Example

{"mailContent": "xyz789"}

Types

LoanAndLeaseInvoiceSelectionInput

Fields

Input Field	Description
`mailOptions` - `LoanAndLeaseInvoiceOverrideMailOptions`
`invoiceType` - `LoanAndLeaseInvoiceType!`
`debtorId` - `UUID!`
`date` - `LocalDate!`

Example

{
  "mailOptions": LoanAndLeaseInvoiceOverrideMailOptions,
  "invoiceType": "START",
  "debtorId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "date": "2020-07-19"
}

Types

LoanAndLeaseInvoiceType

Description

Legacy naming; START invoices ARE NOT collected. PERIOD invoices ARE collected using the contract's collection method.

Values

Enum Value	Description
`START`
`PERIOD`

Example

"START"

Types

LoanAndLeaseLimitedMileage

Fields

Field Name	Description
`annualMax` - `Int!`
`excessRate` - `BigDecimal!`

Example

{
  "annualMax": 987,
  "excessRate": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseLimitedMileageOptionsInput

Fields

Input Field	Description
`excessRate` - `BigDecimal!`
`annualMax` - `Int!`

Example

{
  "excessRate": "28391719239482739937.1939459927192",
  "annualMax": 987
}

Types

LoanAndLeaseMirrorLastRefreshed

Fields

Field Name	Description
`mostRecentStatus` - `LoanAndLeaseMirrorStatus!`
`lastRefreshed` - `Instant!`
`lastSuccessfulRefresh` - `Instant`

Example

{
  "mostRecentStatus": "RUNNING",
  "lastRefreshed": 1654109791,
  "lastSuccessfulRefresh": 1654109791
}

Types

LoanAndLeaseMirrorStatus

Values

Enum Value	Description
`RUNNING`
`SUCCESS`
`FAILED`

Example

"RUNNING"

Types

LoanAndLeasePBSCollectionError

Fields

Field Name	Description
`error` - `LoanAndLeasePBSCollectionErrorType!`

Example

{"error": "MISSING_CONFIGURATION"}

Types

LoanAndLeasePBSCollectionErrorType

Values

Enum Value	Description
`MISSING_CONFIGURATION`
`NOTHING_TO_COLLECT`
`INVOICES_NOT_COLLECTABLE`	The requested invoices were not in the set of collectable invoices.
`INVOICES_NOT_FOUND`

Example

"MISSING_CONFIGURATION"

Types

LoanAndLeasePBSCollectionOutcome

Types

Union Types
`LoanAndLeasePBSCollectionStructuredResult`
`LoanAndLeasePBSCollectionError`

Example

LoanAndLeasePBSCollectionStructuredResult

Types

LoanAndLeasePBSCollectionStructuredResult

Fields

Field Name	Description
`errors` - `[LoanAndLeaseGenerationError!]!`

Example

{
  "errors": [
    LoanAndLeaseGenerationErrorGenericEmissionError
  ]
}

Types

LoanAndLeasePBSDelivery

Fields

Field Name	Description
`debtor` - `LoanAndLeaseEntity!`
`invoice` - `LoanAndLeaseBookedInvoice!`
`bankDate` - `LocalDate!`
`paymentStatuses` - `[LoanAndLeasePBSPayment!]!`

Example

{
  "debtor": LoanAndLeasePerson,
  "invoice": LoanAndLeaseBookedInvoice,
  "bankDate": "2020-07-19",
  "paymentStatuses": [LoanAndLeasePBSPayment]
}

Types

LoanAndLeasePBSDeliveryState

Fields

Field Name	Description
`deliveryId` - `Long!`
`requestData` - `DisplayableResource!`
`invoices` - `[LoanAndLeasePBSDelivery!]!`
`vResponse` - `LoanAndLeasePBSResponse`
`tResponse` - `LoanAndLeasePBSResponse`
`abResponse` - `LoanAndLeasePBSResponse`

Example

{
  "deliveryId": 9223372036854776000,
  "requestData": DisplayableResource,
  "invoices": [LoanAndLeasePBSDelivery],
  "vResponse": LoanAndLeasePBSResponse,
  "tResponse": LoanAndLeasePBSResponse,
  "abResponse": LoanAndLeasePBSResponse
}

Types

LoanAndLeasePBSDetachedPayment

Fields

Field Name	Description
`customerNo` - `String!`
`paymentStatuses` - `[LoanAndLeasePBSPayment!]!`

Example

{
  "customerNo": "xyz789",
  "paymentStatuses": [LoanAndLeasePBSPayment]
}

Types

LoanAndLeasePBSPayment

Fields

Field Name	Description
`status` - `LoanAndLeasePBSPaymentStatus!`
`paymentType` - `LoanAndLeasePBSPaymentType!`
`paymentDueDate` - `LocalDate!`
`paymentDate` - `LocalDate`
`paymentAmount` - `BigDecimal`
`expectedPaymentAmount` - `BigDecimal!`

Example

{
  "status": "COMPLETED",
  "paymentType": "PAYMENT_SLIP",
  "paymentDueDate": "2020-07-19",
  "paymentDate": "2020-07-19",
  "paymentAmount": "28391719239482739937.1939459927192",
  "expectedPaymentAmount": "28391719239482739937.1939459927192"
}

Types

LoanAndLeasePBSPaymentStatus

Values

Enum Value	Description
`COMPLETED`
`CANCELLED`
`REJECTED`
`CHARGEBACK`

Example

"COMPLETED"

Types

LoanAndLeasePBSPaymentType

Values

Enum Value	Description
`PAYMENT_SLIP`
`AUTOMATIC_PAYMENT`

Example

"PAYMENT_SLIP"

Types

LoanAndLeasePBSResponse

Fields

Field Name	Description
`success` - `Boolean!`
`data` - `DisplayableResource!`

Example

{"success": true, "data": DisplayableResource}

Types

LoanAndLeasePeriodAlignment

Values

Enum Value	Description
`ALIGNED`
`UNALIGNED`

Example

"ALIGNED"

Types

LoanAndLeasePeriodRounding

Values

Enum Value	Description
`EXACT`
`UNALIGNED_FULL`
`ALIGNED_FULL`

Example

"EXACT"

Types

LoanAndLeasePeriodUnit

Values

Enum Value	Description
`MONTH`
`QUARTER`
`HALF_YEAR`
`YEAR`

Example

"MONTH"

Types

LoanAndLeasePeriodicCost

Types

Union Types
`LoanAndLeasePeriodicCostPeriod`
`LoanAndLeasePeriodicCostPrt`

Example

LoanAndLeasePeriodicCostPeriod

Types

LoanAndLeasePeriodicCostPeriod

Fields

Field Name	Description
`amount` - `BigDecimal!`
`unit` - `LoanAndLeasePeriodUnit!`
`rounding` - `LoanAndLeasePeriodRounding!`

Example

{
  "amount": "28391719239482739937.1939459927192",
  "unit": "MONTH",
  "rounding": "EXACT"
}

Types

LoanAndLeasePeriodicCostPeriodInput

Fields

Input Field	Description
`rounding` - `LoanAndLeasePeriodRounding!`
`unit` - `LoanAndLeasePeriodUnit!`
`amount` - `BigDecimal!`

Example

{
  "rounding": "EXACT",
  "unit": "MONTH",
  "amount": "28391719239482739937.1939459927192"
}

Types

LoanAndLeasePeriodicCostPrt

Fields

Field Name	Description
`amount` - `BigDecimal!`
`prtType` - `LoanAndLeasePrtType!`

Example

{
  "amount": "28391719239482739937.1939459927192",
  "prtType": "NORMAL"
}

Types

LoanAndLeasePeriodicCostPrtInput

Fields

Input Field	Description
`prtType` - `LoanAndLeasePrtType!`
`amount` - `BigDecimal!`

Example

{
  "prtType": "NORMAL",
  "amount": "28391719239482739937.1939459927192"
}

Types

LoanAndLeasePerson

Description

Requires the caller to have the 'reader' permission to the 'loanandlease/entity' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`entityId` - `UUID!`
`name` - `String!`
`address` - `String`
`postalCode` - `String`
`countryCode` - `CountryCode`
`email` - `Email`
`invoiceEmail` - `Email`
`phone` - `Phone`
`mobile` - `Phone`
`identifiers` - `[PersonIdentifier!]!`
`economicId` - `String`
`economicCreditorId` - `Int`
`city` - `String`
`report` - `LoanAndLeaseEntityReport`
`retention` - `LoanAndLeaseEntityRetention`
`roles` - `[MutableEntityRole!]!`
`id` - `ID!`

Example

{
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "name": "abc123",
  "address": "abc123",
  "postalCode": "abc123",
  "countryCode": KnownCountryCode,
  "email": "john@gmail.com",
  "invoiceEmail": "john@gmail.com",
  "phone": "29400888",
  "mobile": "29400888",
  "identifiers": [CountrySpecificValue],
  "economicId": "abc123",
  "economicCreditorId": 987,
  "city": "xyz789",
  "report": LoanAndLeaseEntityReport,
  "retention": LoanAndLeaseEntityRetention,
  "roles": ["DEALER"],
  "id": 4
}

Types

LoanAndLeasePersonInput

Fields

Input Field	Description
`invoiceEmail` - `Email`
`city` - `String`
`identifiers` - `[PersonIdentifierInput!]!`
`mobile` - `Phone`
`phone` - `Phone`
`email` - `Email`
`countryCode` - `CountryCodeInput`
`postalCode` - `String`
`address` - `String`
`name` - `String!`

Example

{
  "invoiceEmail": "john@gmail.com",
  "city": "abc123",
  "identifiers": [PersonIdentifierInput],
  "mobile": "29400888",
  "phone": "29400888",
  "email": "john@gmail.com",
  "countryCode": CountryCodeInput,
  "postalCode": "abc123",
  "address": "xyz789",
  "name": "xyz789"
}

Types

LoanAndLeasePersonUpdate

Fields

Input Field	Description
`person` - `LoanAndLeasePersonInput!`
`setCreditorId` - `SetCreditorId`
`setDebtorId` - `SetDebtorId`
`entityId` - `UUID!`

Example

{
  "person": LoanAndLeasePersonInput,
  "setCreditorId": SetCreditorId,
  "setDebtorId": SetDebtorId,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeasePortfolio

Fields

Field Name	Description
`portfolioId` - `String!`
`name` - `String!`
`baseRateId` - `String`
`bookingStartDate` - `LocalDate`
`periodicInvoiceStartDate` - `LocalDate`
`minEconomicContractId` - `Long`
`maxEconomicContractId` - `Long`
`annuityType` - `AnnuityType!`
`costs` - `[LoanAndLeasePortfolioCosts!]!`
`retention` - `LoanAndLeasePortfolioRetention`
`invoicePrefix` - `String`
`v2Config` - `PortfolioV2Configuration`
`portfolioV2` - `PortfolioV2`

Example

{
  "portfolioId": "xyz789",
  "name": "xyz789",
  "baseRateId": "xyz789",
  "bookingStartDate": "2020-07-19",
  "periodicInvoiceStartDate": "2020-07-19",
  "minEconomicContractId": 9223372036854776000,
  "maxEconomicContractId": 9223372036854776000,
  "annuityType": "BEGIN",
  "costs": [LoanAndLeasePortfolioCosts],
  "retention": LoanAndLeasePortfolioRetention,
  "invoicePrefix": "xyz789",
  "v2Config": PortfolioV2Configuration,
  "portfolioV2": PortfolioV2
}

Types

LoanAndLeasePortfolioCostInput

Fields

Input Field	Description
`isAccruedIncome` - `Boolean!`
`principalAccount` - `LoanAndLeasePrincipalAccount`
`showMethod` - `LoanAndLeaseShowMethod`
`incomeCostId` - `String`
`expenseCostId` - `String`
`entryText` - `String!`
`productNo` - `String`
`account` - `Long!`
`userDefined` - `String`	Exactly one of `intrinsic` and `userDefined` must be provided
`intrinsic` - `LoanAndLeaseIntrinsicCostIdType`	Exactly one of `intrinsic` and `userDefined` must be provided

Example

{
  "isAccruedIncome": true,
  "principalAccount": "ASSET",
  "showMethod": "DIRECT",
  "incomeCostId": "abc123",
  "expenseCostId": "xyz789",
  "entryText": "abc123",
  "productNo": "abc123",
  "account": 9223372036854776000,
  "userDefined": "abc123",
  "intrinsic": "BASE_RATE"
}

Types

LoanAndLeasePortfolioCosts

Fields

Field Name	Description
`costId` - `LoanAndLeaseCostId!`
`account` - `Long!`
`productNo` - `String`
`entryText` - `String!`
`expenseCostId` - `String`
`incomeCostId` - `String`
`showMethod` - `LoanAndLeaseShowMethod`
`principalAccount` - `LoanAndLeasePrincipalAccount`
`isAccruedIncome` - `Boolean!`

Example

{
  "costId": LoanAndLeaseIntrinsicCostId,
  "account": 9223372036854776000,
  "productNo": "xyz789",
  "entryText": "abc123",
  "expenseCostId": "xyz789",
  "incomeCostId": "xyz789",
  "showMethod": "DIRECT",
  "principalAccount": "ASSET",
  "isAccruedIncome": true
}

Types

LoanAndLeasePortfolioCreationError

Fields

Field Name	Description
`error` - `LoanAndLeasePortfolioCreationErrorType!`

Example

{"error": "ALREADY_EXISTS"}

Types

LoanAndLeasePortfolioCreationErrorType

Values

Enum Value	Description
`ALREADY_EXISTS`

Example

"ALREADY_EXISTS"

Types

LoanAndLeasePortfolioCreationOutcome

Types

Union Types
`LoanAndLeasePortfolios`
`LoanAndLeasePortfolioCreationError`

Example

LoanAndLeasePortfolios

Types

LoanAndLeasePortfolioDeletionRelatedToContractConflict

Fields

Field Name	Description
`contract` - `LoanAndLeaseContract!`

Example

{"contract": LoanAndLeaseContract}

Types

LoanAndLeasePortfolioInput

Fields

Input Field	Description
`v2Config` - `PortfolioV2Config`
`invoicePrefix` - `String`	Prefix for the invoice number
`annuityType` - `AnnuityType!`
`maxEconomicContractId` - `Long`
`minEconomicContractId` - `Long`
`periodicInvoiceStartDate` - `LocalDate`
`bookingStartDate` - `LocalDate`
`baseRateId` - `String`
`name` - `String!`
`portfolioId` - `String!`

Example

{
  "v2Config": PortfolioV2Config,
  "invoicePrefix": "xyz789",
  "annuityType": "BEGIN",
  "maxEconomicContractId": 9223372036854776000,
  "minEconomicContractId": 9223372036854776000,
  "periodicInvoiceStartDate": "2020-07-19",
  "bookingStartDate": "2020-07-19",
  "baseRateId": "xyz789",
  "name": "xyz789",
  "portfolioId": "xyz789"
}

Types

LoanAndLeasePortfolioRetention

Fields

Field Name	Description
`hidden` - `Boolean!`
`retainUntil` - `Instant`
`hasConflicts` - `Boolean!`

Example

{"hidden": true, "retainUntil": 1654109791, "hasConflicts": true}

Types

LoanAndLeasePortfolioRetentionInput

Fields

Input Field	Description
`retention` - `LoanAndLeaseRetentionInput!`
`portfolioId` - `String!`

Example

{
  "retention": LoanAndLeaseRetentionInput,
  "portfolioId": "abc123"
}

Types

LoanAndLeasePortfolioUpdateError

Fields

Field Name	Description
`error` - `LoanAndLeasePortfolioUpdateErrorType!`

Example

{"error": "NOT_FOUND"}

Types

LoanAndLeasePortfolioUpdateErrorType

Values

Enum Value	Description
`NOT_FOUND`
`DUPLICATE_IDS`

Example

"NOT_FOUND"

Types

LoanAndLeasePortfolioUpdateOutcome

Types

Union Types
`LoanAndLeasePortfolios`
`LoanAndLeasePortfolioUpdateError`

Example

LoanAndLeasePortfolios

Types

LoanAndLeasePortfolios

Fields

Field Name	Description
`portfolios` - `[LoanAndLeasePortfolio!]!`

Example

{"portfolios": [LoanAndLeasePortfolio]}

Types

LoanAndLeasePreviewBooking

Fields

Field Name	Description
`bookingParams` - `LoanAndLeaseBookingParams!`
`booking` - `[LoanAndLeaseBookingByDate!]!`
`pending` - `[LoanAndLeaseBookingByDate!]!`
`failed` - `[LoanAndLeaseBookingByDate!]!`
`noBooking` - `[LoanAndLeaseBookingByDate!]!`
`previous` - `[LoanAndLeaseBookingByDate!]!`
`future` - `[LoanAndLeaseBookingByDate!]!`
`annuityStart` - `[LoanAndLeaseBookingByDate!]!`
`annuityPeriodic` - `[LoanAndLeaseBookingByDate!]!`
`directStart` - `[LoanAndLeaseBookingByDate!]!`
`directPeriodic` - `[LoanAndLeaseBookingByDate!]!`

Example

{
  "bookingParams": LoanAndLeaseBookingParams,
  "booking": [LoanAndLeaseBookingByDate],
  "pending": [LoanAndLeaseBookingByDate],
  "failed": [LoanAndLeaseBookingByDate],
  "noBooking": [LoanAndLeaseBookingByDate],
  "previous": [LoanAndLeaseBookingByDate],
  "future": [LoanAndLeaseBookingByDate],
  "annuityStart": [LoanAndLeaseBookingByDate],
  "annuityPeriodic": [LoanAndLeaseBookingByDate],
  "directStart": [LoanAndLeaseBookingByDate],
  "directPeriodic": [LoanAndLeaseBookingByDate]
}

Types

LoanAndLeasePreviewBookingDetailed

Fields

Field Name	Description
`bookingParams` - `LoanAndLeaseBookingParams!`
`booking` - `[LoanAndLeaseBookingByDateDetailed!]!`
`pending` - `[LoanAndLeaseBookingByDateDetailed!]!`
`failed` - `[LoanAndLeaseBookingByDateDetailed!]!`
`previous` - `[LoanAndLeaseBookingByDateDetailed!]!`
`future` - `[LoanAndLeaseBookingByDateDetailed!]!`
`annuityStart` - `[LoanAndLeaseBookingByDateDetailed!]!`
`annuityPeriodic` - `[LoanAndLeaseBookingByDateDetailed!]!`
`directStart` - `[LoanAndLeaseBookingByDateDetailed!]!`
`directPeriodic` - `[LoanAndLeaseBookingByDateDetailed!]!`
`noBooking` - `[LoanAndLeaseBookingByDateDetailed!]!`

Example

{
  "bookingParams": LoanAndLeaseBookingParams,
  "booking": [LoanAndLeaseBookingByDateDetailed],
  "pending": [LoanAndLeaseBookingByDateDetailed],
  "failed": [LoanAndLeaseBookingByDateDetailed],
  "previous": [LoanAndLeaseBookingByDateDetailed],
  "future": [LoanAndLeaseBookingByDateDetailed],
  "annuityStart": [LoanAndLeaseBookingByDateDetailed],
  "annuityPeriodic": [LoanAndLeaseBookingByDateDetailed],
  "directStart": [LoanAndLeaseBookingByDateDetailed],
  "directPeriodic": [LoanAndLeaseBookingByDateDetailed],
  "noBooking": [LoanAndLeaseBookingByDateDetailed]
}

Types

LoanAndLeasePreviewBookingDetailedOutcome

Types

Union Types
`LoanAndLeasePreviewError`
`LoanAndLeasePreviewBookingDetailedResult`

Example

LoanAndLeasePreviewError

Types

LoanAndLeasePreviewBookingDetailedResult

Fields

Field Name	Description
`errors` - `[LoanAndLeaseStructuredBookingErrorType!]!`
`previews` - `[LoanAndLeasePreviewBookingDetailed!]!`

Example

{
  "errors": [LoanAndLeaseBookingParamsNotNewestError],
  "previews": [LoanAndLeasePreviewBookingDetailed]
}

Types

LoanAndLeasePreviewBookingOutcome

Types

Union Types
`LoanAndLeasePreviewError`
`LoanAndLeasePreviewBookingResult`

Example

LoanAndLeasePreviewError

Types

LoanAndLeasePreviewBookingResult

Fields

Field Name	Description
`errors` - `[LoanAndLeaseStructuredBookingErrorType!]!`
`previews` - `[LoanAndLeasePreviewBooking!]!`

Example

{
  "errors": [LoanAndLeaseBookingParamsNotNewestError],
  "previews": [LoanAndLeasePreviewBooking]
}

Types

LoanAndLeasePreviewCollectionError

Fields

Field Name	Description
`error` - `LoanAndLeasePreviewCollectionErrorType!`

Example

{"error": "MISSING_CONFIGURATION"}

Types

LoanAndLeasePreviewCollectionErrorType

Values

Enum Value	Description
`MISSING_CONFIGURATION`
`INVOICES_NOT_COLLECTABLE`
`NOT_FOUND`

Example

"MISSING_CONFIGURATION"

Types

LoanAndLeasePreviewCollectionOutcome

Types

Union Types
`LoanAndLeasePreviewCollectionError`
`LoanAndLeasePreviewCollectionStructuredErrors`
`LoanAndLeasePreviewCollectionResult`

Example

LoanAndLeasePreviewCollectionError

Types

LoanAndLeasePreviewCollectionResult

Fields

Field Name	Description
`data` - `Uri!`

Example

{"data": "https://domain.com/resource"}

Types

LoanAndLeasePreviewCollectionStructuredErrors

Fields

Field Name	Description
`errors` - `[LoanAndLeaseGenerationError!]!`

Example

{
  "errors": [
    LoanAndLeaseGenerationErrorGenericEmissionError
  ]
}

Types

LoanAndLeasePreviewError

Fields

Field Name	Description
`error` - `LoanAndLeasePreviewErrorType!`

Example

{"error": "DUPLICATE_IDS"}

Types

LoanAndLeasePreviewErrorType

Values

Enum Value	Description
`DUPLICATE_IDS`

Example

"DUPLICATE_IDS"

Types

LoanAndLeasePreviewInvoice

Fields

Field Name	Description
`head` - `LoanAndLeasePreviewInvoiceHead!`
`lines` - `[LoanAndLeasePreviewInvoiceLine!]!`

Example

{
  "head": LoanAndLeasePreviewInvoiceHead,
  "lines": [LoanAndLeasePreviewInvoiceLine]
}

Types

LoanAndLeasePreviewInvoiceHead

Fields

Field Name	Description
`customerNumber` - `Long!`
`date` - `LocalDate!`
`dueDate` - `LocalDate`
`notesHeading` - `String`
`notesTextLine1` - `String`
`notesTextLine2` - `String`

Example

{
  "customerNumber": 9223372036854776000,
  "date": "2020-07-19",
  "dueDate": "2020-07-19",
  "notesHeading": "xyz789",
  "notesTextLine1": "xyz789",
  "notesTextLine2": "abc123"
}

Types

LoanAndLeasePreviewInvoiceLine

Fields

Field Name	Description
`dimensionNo` - `Int`
`dimensionNos` - `LoanAndLeaseDimensionNos!`
`text` - `String!`
`productNo` - `String!`
`amount` - `BigDecimal!`

Example

{
  "dimensionNo": 987,
  "dimensionNos": LoanAndLeaseDimensionNos,
  "text": "abc123",
  "productNo": "abc123",
  "amount": "28391719239482739937.1939459927192"
}

Types

LoanAndLeasePreviewInvoiceLineWithCostId

Fields

Field Name	Description
`line` - `LoanAndLeasePreviewInvoiceLine!`
`cost` - `LoanAndLeasePortfolioCosts`

Example

{
  "line": LoanAndLeasePreviewInvoiceLine,
  "cost": LoanAndLeasePortfolioCosts
}

Types

LoanAndLeasePreviewTransaction

Fields

Field Name	Description
`date` - `LocalDate!`
`lines` - `[LoanAndLeasePreviewTransactionLine!]!`

Example

{
  "date": "2020-07-19",
  "lines": [LoanAndLeasePreviewTransactionLine]
}

Types

LoanAndLeasePreviewTransactionLine

Fields

Field Name	Description
`lineType` - `LoanAndLeaseTransactionLineType!`
`text` - `String!`
`amount` - `BigDecimal!`
`dimensionNo` - `Int`
`dimensionNos` - `LoanAndLeaseDimensionNos!`

Example

{
  "lineType": LoanAndLeaseCreditorPayment,
  "text": "abc123",
  "amount": "28391719239482739937.1939459927192",
  "dimensionNo": 123,
  "dimensionNos": LoanAndLeaseDimensionNos
}

Types

LoanAndLeasePrincipalAccount

Values

Enum Value	Description
`ASSET`
`ASSET2`
`ASSET3`
`DEPOSIT`

Example

"ASSET"

Types

LoanAndLeasePrtRate

Description

Requires the caller to have the 'reader' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`date` - `LocalDate!`
`prtRate` - `BigDecimal`
`id` - `ID!`

Example

{
  "date": "2020-07-19",
  "prtRate": "28391719239482739937.1939459927192",
  "id": "4"
}

Types

LoanAndLeasePrtRateInput

Fields

Input Field	Description
`prtRate` - `BigDecimal`
`date` - `LocalDate!`

Example

{
  "prtRate": "28391719239482739937.1939459927192",
  "date": "2020-07-19"
}

Types

LoanAndLeasePrtType

Values

Enum Value	Description
`NORMAL`
`L4_RECALC`
`REGULATION`

Example

"NORMAL"

Types

LoanAndLeaseRegTax

Types

Union Types
`LoanAndLeaseRegTaxNone`
`LoanAndLeaseRegTaxFull`
`LoanAndLeaseRegTaxProportionate`

Example

LoanAndLeaseRegTaxNone

Types

LoanAndLeaseRegTaxFull

Fields

Field Name	Description
`fullTax` - `BigDecimal`
`recalc` - `LoanAndLeaseRegTaxPrtRecalc`

Example

{
  "fullTax": "28391719239482739937.1939459927192",
  "recalc": LoanAndLeaseRegTaxPrtRecalc
}

Types

LoanAndLeaseRegTaxFullInput

Fields

Input Field	Description
`recalc` - `LoanAndLeaseRegTaxPrtRecalcInput`
`fullTax` - `BigDecimal`

Example

{
  "recalc": LoanAndLeaseRegTaxPrtRecalcInput,
  "fullTax": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseRegTaxInput

Fields

Input Field	Description
`proportionate` - `LoanAndLeaseRegTaxProportionateInput`
`full` - `LoanAndLeaseRegTaxFullInput`
`none` - `Boolean!`

Example

{
  "proportionate": LoanAndLeaseRegTaxProportionateInput,
  "full": LoanAndLeaseRegTaxFullInput,
  "none": true
}

Types

LoanAndLeaseRegTaxNone

Fields

Field Name	Description
`none` - `Boolean!`

Example

{"none": true}

Types

LoanAndLeaseRegTaxProportionate

Fields

Field Name	Description
`startDate` - `LocalDate`
`extraMonth` - `Boolean!`
`fullTax` - `BigDecimal`
`recalc` - `LoanAndLeaseRegTaxPrtRecalc`

Example

{
  "startDate": "2020-07-19",
  "extraMonth": true,
  "fullTax": "28391719239482739937.1939459927192",
  "recalc": LoanAndLeaseRegTaxPrtRecalc
}

Types

LoanAndLeaseRegTaxProportionateInput

Fields

Input Field	Description
`recalc` - `LoanAndLeaseRegTaxPrtRecalcInput`
`fullTax` - `BigDecimal`
`extraMonth` - `Boolean!`
`startDate` - `LocalDate`

Example

{
  "recalc": LoanAndLeaseRegTaxPrtRecalcInput,
  "fullTax": "28391719239482739937.1939459927192",
  "extraMonth": true,
  "startDate": "2020-07-19"
}

Types

LoanAndLeaseRegTaxPrtRecalc

Fields

Field Name	Description
`offsetMonths` - `Long!`
`fullTax` - `BigDecimal!`

Example

{
  "offsetMonths": 9223372036854776000,
  "fullTax": "28391719239482739937.1939459927192"
}

Types

LoanAndLeaseRegTaxPrtRecalcInput

Fields

Input Field	Description
`fullTax` - `BigDecimal!`
`offsetMonths` - `Long!`

Example

{
  "fullTax": "28391719239482739937.1939459927192",
  "offsetMonths": 9223372036854776000
}

Types

LoanAndLeaseRemoveRepresentativeError

Values

Enum Value	Description
`REPRESENTATIVE_NOT_FOUND`

Example

"REPRESENTATIVE_NOT_FOUND"

Types

LoanAndLeaseRepresentative

Fields

Field Name	Description
`representativeId` - `UUID!`
`entityId` - `UUID!`
`entity` - `LoanAndLeaseEntity!`
`name` - `String!`
`users` - `[User!]!`

Example

{
  "representativeId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "entity": LoanAndLeasePerson,
  "name": "xyz789",
  "users": [User]
}

Types

LoanAndLeaseRepresentativeUser

Fields

Input Field	Description
`userId` - `UserId!`
`representativeId` - `UUID!`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "representativeId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

LoanAndLeaseRetention

Fields

Field Name	Description
`hidden` - `Boolean!`
`retainUntil` - `Instant`
`hasConflicts` - `Boolean!`

Possible Types

LoanAndLeaseRetention Types
`LoanAndLeaseEntityRetention`
`LoanAndLeasePortfolioRetention`
`AssetRetention`
`LoanAndLeaseContractRetention`

Example

{"hidden": true, "retainUntil": 1654109791, "hasConflicts": true}

Types

LoanAndLeaseRetentionInput

Description

only one of 'retentionDate' or 'retentionType' can be specified

Fields

Input Field	Description
`hidden` - `Boolean!`
`retentionType` - `LoanAndLeaseComputedRetentionType`
`retentionDate` - `Instant`

Example

{
  "hidden": true,
  "retentionType": "DEFAULT_RETENTION",
  "retentionDate": 1654109791
}

Types

LoanAndLeaseShowMethod

Values

Enum Value	Description
`DIRECT`
`INTERMEDIATE_ACCOUNT`

Example

"DIRECT"

Types

LoanAndLeaseSimpleBookingError

Fields

Field Name	Description
`type` - `LoanAndLeaseSimpleBookingErrorType!`

Example

{"type": "DUPLICATE_IDS"}

Types

LoanAndLeaseSimpleBookingErrorType

Values

Enum Value	Description
`DUPLICATE_IDS`
`NOT_FOUND`

Example

"DUPLICATE_IDS"

Types

LoanAndLeaseSortEntityBy

Values

Enum Value	Description
`CREATED`
`NAME`
`ECONOMIC_CUSTOMER_ID`
`REMAINDER`

Example

"CREATED"

Types

LoanAndLeaseStructuredBookingError

Fields

Field Name	Description
`errors` - `[LoanAndLeaseStructuredBookingErrorType!]!`

Example

{"errors": [LoanAndLeaseBookingParamsNotNewestError]}

Types

LoanAndLeaseStructuredBookingErrorType

Types

Union Types
`LoanAndLeaseBookingParamsNotNewestError`
`LoanAndLeaseContractMissingDimensionNoError`
`LoanAndLeaseCostMissingConfigError`
`LoanAndLeaseCostMissingProductNoError`
`LoanAndLeaseEntityMissingDebtorNoError`
`LoanAndLeaseContractNotActiveError`
`LoanAndLeaseInvalidContractStateError`

Example

LoanAndLeaseBookingParamsNotNewestError

Types

LoanAndLeaseTransactionAggregates

Fields

Field Name	Description
`completed` - `Long!`
`pending` - `Long!`
`failed` - `Long!`

Example

{
  "completed": 9223372036854776000,
  "pending": 9223372036854776000,
  "failed": 9223372036854776000
}

Types

LoanAndLeaseTransactionEntry

Fields

Field Name	Description
`transactionId` - `UUID!`
`transaction` - `LoanAndLeasePreviewTransaction!`

Example

{
  "transactionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "transaction": LoanAndLeasePreviewTransaction
}

Types

LoanAndLeaseTransactionGroup

Fields

Field Name	Description
`transactionBatchId` - `UUID!`
`status` - `LoanAndLeaseTransactionGroupBookingStatus!`
`transactions` - `[LoanAndLeaseTransactionEntry!]!`

Example

{
  "transactionBatchId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "status": LoanAndLeaseTransactionGroupBookingStatusDiscarded,
  "transactions": [LoanAndLeaseTransactionEntry]
}

Types

LoanAndLeaseTransactionGroupBookingErrorType

Types

Union Types
`LoanAndLeaseTransactionGroupBookingErrorTypeCouldNotRefindTransactions`
`LoanAndLeaseTransactionGroupBookingErrorTypeApiError`

Example

LoanAndLeaseTransactionGroupBookingErrorTypeCouldNotRefindTransactions

Types

LoanAndLeaseTransactionGroupBookingErrorTypeApiError

Fields

Field Name	Description
`error` - `EconomicAPIError!`

Example

{"error": EconomicAPIError}

Types

LoanAndLeaseTransactionGroupBookingErrorTypeCouldNotRefindTransactions

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseTransactionGroupBookingStatus

Types

Union Types
`LoanAndLeaseTransactionGroupBookingStatusDiscarded`
`LoanAndLeaseTransactionGroupBookingStatusFailed`
`LoanAndLeaseTransactionGroupBookingStatusPending`
`LoanAndLeaseTransactionGroupBookingStatusCompleted`

Example

LoanAndLeaseTransactionGroupBookingStatusDiscarded

Types

LoanAndLeaseTransactionGroupBookingStatusCompleted

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseTransactionGroupBookingStatusDiscarded

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseTransactionGroupBookingStatusFailed

Fields

Field Name	Description
`errorType` - `LoanAndLeaseTransactionGroupBookingErrorType`

Example

{
  "errorType": LoanAndLeaseTransactionGroupBookingErrorTypeCouldNotRefindTransactions
}

Types

LoanAndLeaseTransactionGroupBookingStatusPending

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

LoanAndLeaseTransactionLineType

Types

Union Types
`LoanAndLeaseCreditorPayment`
`LoanAndLeaseCreditorInvoice`
`LoanAndLeaseFinanceMemo`
`LoanAndLeaseDebtorPayment`
`LoanAndLeaseDebtorInvoice`

Example

LoanAndLeaseCreditorPayment

Types

LoanAndLeaseUpdateError

Fields

Field Name	Description
`type` - `LoanAndLeaseEntityUpdateErrorType!`

Example

{"type": "ALREADY_EXISTS"}

Types

LoanAndLeaseUpdateOutcome

Types

Union Types
`LoanAndLeaseUpdateError`
`LoanAndLeaseUpdateResult`

Example

LoanAndLeaseUpdateError

Types

LoanAndLeaseUpdatePortfolioCostInput

Fields

Input Field	Description
`cost` - `LoanAndLeasePortfolioCostInput!`
`portfolioId` - `String!`

Example

{
  "cost": LoanAndLeasePortfolioCostInput,
  "portfolioId": "abc123"
}

Types

LoanAndLeaseUpdateResult

Fields

Field Name	Description
`outcome` - `[LoanAndLeaseEntity!]!`

Example

{"outcome": [LoanAndLeasePerson]}

Types

LoanAndLeaseUserDefinedCostId

Fields

Field Name	Description
`name` - `String!`

Example

{"name": "abc123"}

Types

LoandAndLeaseRegTaxType

Values

Enum Value	Description
`PROPORTIONATE`
`FULL`
`NONE`

Example

"PROPORTIONATE"

Types

LoandAndLeaseWarningType

Values

Enum Value	Description
`ANY`
`SUPPLIER_PAYABLE`
`ASSET`
`START_DATE`
`END_DATE`
`ANY_ACCOUNT`
`EXPIRATION`
`ANNUITY_EXPIRATION`

Example

"ANY"

Types

LocalDate

Description

A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03. Represented as as String.

Example

"2020-07-19"

Types

Long

Description

The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example

9223372036854776000

Types

MailLogEntry

Fields

Field Name	Description
`id` - `UUID!`
`sender` - `Email!`
`senderName` - `String`
`subject` - `String!`
`recipients` - `[Email!]!`
`cc` - `[Email!]!`
`text` - `DisplayableResource`
`html` - `DisplayableResource!`
`status` - `MailSendStatus`
`statusTimestamp` - `Instant`

Example

{
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "sender": "john@gmail.com",
  "senderName": "xyz789",
  "subject": "abc123",
  "recipients": ["john@gmail.com"],
  "cc": ["john@gmail.com"],
  "text": DisplayableResource,
  "html": DisplayableResource,
  "status": MailSendStatusFailed,
  "statusTimestamp": 1654109791
}

Types

MailSendStatus

Types

Union Types
`MailSendStatusFailed`
`MailSendStatusEnqueued`

Example

MailSendStatusFailed

Types

MailSendStatusEnqueued

Fields

Field Name	Description
`messageId` - `String!`

Example

{"messageId": "abc123"}

Types

MailSendStatusFailed

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

MediaType

Description

The MediaType scalar type is a valid media type (MIME type) like 'application/json'.

Example

MediaType

Types

MirrorEntryCasehubInvoice

Fields

Field Name	Description
`lines` - `[MirrorTransactionLine!]!`
`invoice` - `LoanAndLeaseBookedInvoice!`

Example

{
  "lines": [MirrorTransactionLine],
  "invoice": LoanAndLeaseBookedInvoice
}

Types

MirrorEntryCasehubResult

Fields

Field Name	Description
`invoices` - `[MirrorEntryCasehubInvoice!]!`
`transactions` - `[MirrorEntryCasehubTransaction!]!`
`unclassified` - `[MirrorTransactionLine!]!`

Example

{
  "invoices": [MirrorEntryCasehubInvoice],
  "transactions": [MirrorEntryCasehubTransaction],
  "unclassified": [MirrorTransactionLine]
}

Types

MirrorEntryCasehubTransaction

Fields

Field Name	Description
`lines` - `[MirrorTransactionLine!]!`

Example

{"lines": [MirrorTransactionLine]}

Types

MirrorTransactionLine

Fields

Field Name	Description
`lineType` - `MirrorTransactionLineType!`
`text` - `String!`
`amount` - `BigDecimal!`
`dimensionNo` - `Int`
`date` - `LocalDate!`	Booking date
`entryNumber` - `Long!`
`voucherNumber` - `Long`

Example

{
  "lineType": MirrorTransactionLineType,
  "text": "xyz789",
  "amount": "28391719239482739937.1939459927192",
  "dimensionNo": 987,
  "date": "2020-07-19",
  "entryNumber": 9223372036854776000,
  "voucherNumber": 9223372036854776000
}

Types

MirrorTransactionLineType

Fields

Field Name	Description
`account` - `Long!`

Possible Types

MirrorTransactionLineType Types
`MirrorTransactionLineTypeReminder`
`MirrorTransactionLineTypeCreditorInvoice`
`MirrorTransactionLineTypeTransferredOpeningEntry`
`MirrorTransactionLineTypeDebtorInvoice`
`MirrorTransactionLineTypeCreditorPayment`
`MirrorTransactionLineTypeSystemEntry`
`MirrorTransactionLineTypeJournalEntry`
`MirrorTransactionLineTypeDebtorPayment`
`MirrorTransactionLineTypeOpeningEntry`

Example

{"account": 9223372036854776000}

Types

MirrorTransactionLineTypeCreditorInvoice

Fields

Field Name	Description
`account` - `Long!`
`invoiceNumber` - `String`
`vatCode` - `String`
`dueDate` - `LocalDate`

Example

{
  "account": 9223372036854776000,
  "invoiceNumber": "xyz789",
  "vatCode": "abc123",
  "dueDate": "2020-07-19"
}

Types

MirrorTransactionLineTypeCreditorPayment

Fields

Field Name	Description
`account` - `Long!`
`invoiceNumber` - `String`

Example

{
  "account": 9223372036854776000,
  "invoiceNumber": "abc123"
}

Types

MirrorTransactionLineTypeDebtorInvoice

Fields

Field Name	Description
`account` - `Long!`
`invoiceNumber` - `Int`
`vatCode` - `String`
`dueDate` - `LocalDate`
`remainder` - `BigDecimal`

Example

{
  "account": 9223372036854776000,
  "invoiceNumber": 123,
  "vatCode": "abc123",
  "dueDate": "2020-07-19",
  "remainder": "28391719239482739937.1939459927192"
}

Types

MirrorTransactionLineTypeDebtorPayment

Fields

Field Name	Description
`account` - `Long!`
`invoiceNumber` - `Int`

Example

{"account": 9223372036854776000, "invoiceNumber": 123}

Types

MirrorTransactionLineTypeJournalEntry

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "xyz789"
}

Types

MirrorTransactionLineTypeOpeningEntry

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "xyz789"
}

Types

MirrorTransactionLineTypeReminder

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "abc123"
}

Types

MirrorTransactionLineTypeSystemEntry

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "abc123"
}

Types

MirrorTransactionLineTypeTransferredOpeningEntry

Fields

Field Name	Description
`account` - `Long!`
`vatCode` - `String`

Example

{
  "account": 9223372036854776000,
  "vatCode": "xyz789"
}

Types

MovedBookingInput

Fields

Input Field	Description
`userDefined` - `String`	Exactly one of `intrinsic` and `userDefined` must be provided
`intrinsic` - `LoanAndLeaseIntrinsicCostIdType`	Exactly one of `intrinsic` and `userDefined` must be provided
`invoiceType` - `LoanAndLeaseInvoiceType`
`newBookingDate` - `LocalDate`
`originalBookingDate` - `LocalDate!`
`contractId` - `UUID!`

Example

{
  "userDefined": "abc123",
  "intrinsic": "BASE_RATE",
  "invoiceType": "START",
  "newBookingDate": "2020-07-19",
  "originalBookingDate": "2020-07-19",
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

MutableEntityRole

Description

A role that can be mutated

Values

Enum Value	Description
`DEALER`	Translates to the 'dealer' role

Example

"DEALER"

Types

MutableRole

Description

A role that can be mutated

Values

Enum Value	Description
`ADMIN`	Translates to the 'admin' role
`APPROVER`	Translates to the 'approver' role

Example

"ADMIN"

Types

NewUserInput

Fields

Input Field	Description
`name` - `String!`
`password` - `String!`
`email` - `Email!`

Example

{
  "name": "xyz789",
  "password": "xyz789",
  "email": "john@gmail.com"
}

Types

Node

Fields

Field Name	Description
`id` - `ID!`

Possible Types

Node Types
`PortfolioV2ContractWithCosts`
`LoanAndLeasePerson`
`Asset`
`LoanAndLeaseContract`
`LoanAndLeaseBaseRate`
`LoanAndLeaseCompany`
`LoanAndLeaseBookedInvoice`
`OrganizationUser`
`LoanAndLeasePrtRate`

Example

{"id": "4"}

Types

NordigenAccount

Fields

Field Name	Description
`values` - `NordigenAggregatedValues!`
`requisitionId` - `UUID!`
`institutionId` - `String!`
`accountId` - `String!`
`accountTitle` - `String!`
`income` - `NordigenAggregatedBySign!`
`expense` - `NordigenAggregatedBySign!`
`transactions` - `[NordigenTransaction!]!`

Example

{
  "values": NordigenAggregatedValues,
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "institutionId": "abc123",
  "accountId": "xyz789",
  "accountTitle": "abc123",
  "income": NordigenAggregatedBySign,
  "expense": NordigenAggregatedBySign,
  "transactions": [NordigenTransaction]
}

Types

NordigenAggregatedByCategory

Fields

Field Name	Description
`values` - `NordigenAggregatedValues!`
`level0` - `Int`
`level1` - `Int`
`level2` - `Int`
`diCategory` - `NordigenDICategory`

Example

{
  "values": NordigenAggregatedValues,
  "level0": 123,
  "level1": 987,
  "level2": 987,
  "diCategory": "HOME_UTILITIES"
}

Types

NordigenAggregatedBySign

Fields

Field Name	Description
`values` - `NordigenAggregatedValues!`
`categories` - `[NordigenAggregatedByCategory!]!`

Example

{
  "values": NordigenAggregatedValues,
  "categories": [NordigenAggregatedByCategory]
}

Types

NordigenAggregatedData

Fields

Field Name	Description
`userId` - `UserId!`
`values` - `NordigenAggregatedValues!`
`maxMonth` - `YearMonth!`
`months` - `Int!`
`accounts` - `[NordigenAccount!]!`

Example

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "values": NordigenAggregatedValues,
  "maxMonth": "2007-12",
  "months": 123,
  "accounts": [NordigenAccount]
}

Types

NordigenAggregatedValues

Fields

Field Name	Description
`total` - `BigDecimal!`
`months` - `[BigDecimal!]!`

Example

{
  "total": "28391719239482739937.1939459927192",
  "months": [
    "28391719239482739937.1939459927192"
  ]
}

Types

NordigenCategory

Fields

Field Name	Description
`categoryId` - `Int!`
`title` - `String!`

Example

{"categoryId": 987, "title": "xyz789"}

Types

NordigenCompletedStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`
`reportId` - `UUID!`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "reportId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

NordigenCreatedStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

NordigenDICategory

Values

Enum Value	Description
`HOME_UTILITIES`
`HOME_RENT_AND_MORTGAGE`
`VEHICLE_OTHER`
`VEHICLE_FUEL`
`MISC_INSURANCES`
`MISC_OTHER_LOANS`
`MISC_CHILD_CARE`
`MISC_SUBSCRIPTIONS`
`MISC_OTHER`

Example

"HOME_UTILITIES"

Types

NordigenFailedAccountsDataStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`
`status` - `NordigenRequisitionStatus`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "status": "CREATED"
}

Types

NordigenFailedInsightsDataStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`
`reportId` - `UUID!`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "reportId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

NordigenFlowStatus

Types

Union Types
`NordigenCompletedStatus`
`NordigenFailedInsightsDataStatus`
`NordigenRunningInsightsDataStatus`
`NordigenFailedAccountsDataStatus`
`NordigenRunningAccountsDataStatus`
`NordigenCreatedStatus`

Example

NordigenCompletedStatus

Types

NordigenInstitution

Fields

Field Name	Description
`institutionId` - `NordigenInstitutionId!`
`name` - `String!`
`logo` - `Uri!`

Example

{
  "institutionId": NordigenInstitutionId,
  "name": "xyz789",
  "logo": "https://domain.com/resource"
}

Types

NordigenInstitutionId

Description

The underlying type of this id is always string

Example

NordigenInstitutionId

Types

NordigenRequisition

Fields

Field Name	Description
`requisitionId` - `UUID!`
`institutionId` - `String!`
`created` - `Instant!`
`nordigenStatus` - `NordigenFlowStatus`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "institutionId": "abc123",
  "created": 1654109791,
  "nordigenStatus": NordigenCompletedStatus
}

Types

NordigenRequisitionStatus

Values

Enum Value	Description
`CREATED`
`GIVING_CONSENT`
`UNDERGOING_AUTHENTICATION`
`REJECTED`
`SELECTING_ACCOUNTS`
`GRANTING_ACCESS`
`LINKED`
`SUSPENDED`
`EXPIRED`

Example

"CREATED"

Types

NordigenRunningAccountsDataStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

NordigenRunningInsightsDataStatus

Fields

Field Name	Description
`requisitionId` - `UUID!`
`reportId` - `UUID!`

Example

{
  "requisitionId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "reportId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

NordigenSecrets

Fields

Input Field	Description
`insightsClientSecret` - `String!`
`insightsClientId` - `String!`
`accountsSecretKey` - `String!`
`accountsSecretId` - `String!`

Example

{
  "insightsClientSecret": "xyz789",
  "insightsClientId": "abc123",
  "accountsSecretKey": "xyz789",
  "accountsSecretId": "xyz789"
}

Types

NordigenTransaction

Fields

Field Name	Description
`bookingDate` - `LocalDate!`
`text` - `String!`
`amount` - `BigDecimal!`
`level0` - `Int`
`level1` - `Int`
`level2` - `Int`
`diCategory` - `NordigenDICategory`

Example

{
  "bookingDate": "2020-07-19",
  "text": "xyz789",
  "amount": "28391719239482739937.1939459927192",
  "level0": 123,
  "level1": 123,
  "level2": 987,
  "diCategory": "HOME_UTILITIES"
}

Types

NumberPaging

Fields

Input Field	Description
`offset` - `Long!`
`size` - `Long!`

Example

{"offset": 9223372036854776000, "size": 9223372036854776000}

Types

Org

Description

The Org scalar type is a valid danish organisation number.

Example

"acme"

Types

OrgConfig

Fields

Field Name	Description
`assetNoRequired` - `Boolean!`

Example

{"assetNoRequired": true}

Types

OrgConfigInput

Fields

Input Field	Description
`assetNoRequired` - `Boolean!`

Example

{"assetNoRequired": true}

Types

Organization

Description

An organization

Fields

Field Name	Description
`users` - `[User!]!`	A list of all users that are associated with the org. This field will be deprecated. the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the ambient organization)
`organizationUsers` - `[OrganizationUser!]!`	A list of all users that have a relationship with the organization. Prefer this field over 'users'.
`me` - `OrganizationUser!`	Accesses information regarding the calling user's relation to the org.
`name` - `Org!`	the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the ambient organization)
`computedRoles` - `[ComputedRole!]!`	The computed roles are usually what you want to consider when doing pre-request sanity checks the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the ambient organization)
Arguments `in` - `[ComputedRole!]`
`mutableRoles` - `[MutableRole!]!`	the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'org' resource (derived from the ambient organization)
Arguments `in` - `[MutableRole!]`

Example

{
  "users": [User],
  "organizationUsers": [OrganizationUser],
  "me": OrganizationUser,
  "name": "acme",
  "computedRoles": ["ANYONE"],
  "mutableRoles": ["ADMIN"]
}

Types

OrganizationUser

Description

An datatype representing the relationship between an organization and a user

Fields

Field Name	Description
`organization` - `Organization!`
`user` - `User!`
`computedRoles` - `[ComputedRole!]!`	One of the following: the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the organization) the user in the type must be the caller
`mutableRoles` - `[MutableRole!]!`	One of the following: the subject 'user' (derived from the current caller's auth) must have the 'admin' relation to the 'org' resource (derived from the organization) the user in the type must be the caller
`id` - `ID!`

Example

{
  "organization": Organization,
  "user": User,
  "computedRoles": ["ANYONE"],
  "mutableRoles": ["ADMIN"],
  "id": 4
}

Types

OwnershipPercentage

Values

Enum Value	Description
`OWNERSHIP_0_05`
`OWNERSHIP_0_1`
`OWNERSHIP_0_15`
`OWNERSHIP_0_2`
`OWNERSHIP_0_25`
`OWNERSHIP_0_3333`
`OWNERSHIP_0_5`
`OWNERSHIP_0_6667`
`OWNERSHIP_0_9`
`OWNERSHIP_1_0`

Example

"OWNERSHIP_0_05"

Types

PBSConfig

Fields

Field Name	Description
`pbsNumber` - `Int!`
`cvr` - `Cvr!`
`deliveryIdOffset` - `Long!`
`debtorGroupNo` - `String!`
`companyInfo` - `String!`

Example

{
  "pbsNumber": 987,
  "cvr": "35890270",
  "deliveryIdOffset": 9223372036854776000,
  "debtorGroupNo": "abc123",
  "companyInfo": "xyz789"
}

Types

PBSConfigInput

Fields

Input Field	Description
`companyInfo` - `String!`
`debtorGroupNo` - `String!`
`deliveryIdOffset` - `Long!`
`cvr` - `Cvr!`
`pbsNumber` - `Int!`

Example

{
  "companyInfo": "xyz789",
  "debtorGroupNo": "xyz789",
  "deliveryIdOffset": 9223372036854776000,
  "cvr": "35890270",
  "pbsNumber": 123
}

Types

PepEntry

Fields

Field Name	Description
`firstName` - `String!`
`lastName` - `String!`
`category` - `String!`
`subCategory` - `String`
`dateOfBirth` - `LocalDate`

Example

{
  "firstName": "xyz789",
  "lastName": "abc123",
  "category": "xyz789",
  "subCategory": "xyz789",
  "dateOfBirth": "2020-07-19"
}

Types

PepGroup

Fields

Field Name	Description
`creation` - `Instant!`
`pepDate` - `LocalDate!`
`entries` - `[PepEntry!]!`

Example

{
  "creation": 1654109791,
  "pepDate": "2020-07-19",
  "entries": [PepEntry]
}

Types

PersonIdentifier

Types

Union Types
`CountrySpecificValue`
`DanishPersonIdentifier`

Example

CountrySpecificValue

Types

PersonIdentifierInput

Description

Either a danish person identifier or a country specific value must be specified. Specifying both is not allowed and will result in an error.

Fields

Input Field	Description
`countrySpecificValue` - `CountrySpecificValueInput`
`danishPersonIdentifier` - `Cpr`

Example

{
  "countrySpecificValue": CountrySpecificValueInput,
  "danishPersonIdentifier": "0810972032"
}

Types

Phone

Description

The Phone scalar type accepts any valid phone number. see https://github.com/google/libphonenumber for more information.

Example

"29400888"

Types

PmtRoundingType

Values

Enum Value	Description
`NO_ROUNDING`
`ROUND_0`
`CEIL_0`
`FLOOR_0`
`ROUND_10`
`CEIL_10`
`FLOOR_10`

Example

"NO_ROUNDING"

Types

PortfolioEconomicConfig

Fields

Field Name	Description
`portfolioId` - `String!`
`contractDimensionFamily` - `Int!`
`constantDimensionFamilies` - `[ConstantDimensionFamily!]!`

Example

{
  "portfolioId": "xyz789",
  "contractDimensionFamily": 987,
  "constantDimensionFamilies": [ConstantDimensionFamily]
}

Types

PortfolioEconomicConfigInput

Fields

Input Field	Description
`constantDimensionFamilies` - `[ConstantDimensionFamilyInput!]!`
`contractDimensionFamily` - `Int!`
`portfolioId` - `String!`

Example

{
  "constantDimensionFamilies": [
    ConstantDimensionFamilyInput
  ],
  "contractDimensionFamily": 987,
  "portfolioId": "xyz789"
}

Types

PortfolioV2

Fields

Field Name	Description
`costs` - `[PortfolioV2Cost!]!`
`assets` - `[PortfolioV2Asset!]!`
`accounts` - `[PortfolioV2Account!]!`
`products` - `[PortfolioV2Product!]!`

Example

{
  "costs": [PortfolioV2Cost],
  "assets": [PortfolioV2Asset],
  "accounts": [PortfolioV2Account],
  "products": [PortfolioV2Product]
}

Types

PortfolioV2Account

Fields

Field Name	Description
`accountId` - `String!`
`text` - `String!`
`accountNumber` - `Int!`

Example

{
  "accountId": "xyz789",
  "text": "abc123",
  "accountNumber": 123
}

Types

PortfolioV2AccountInput

Fields

Input Field	Description
`accountNumber` - `Int!`
`text` - `String!`
`accountId` - `String!`

Example

{
  "accountNumber": 987,
  "text": "abc123",
  "accountId": "xyz789"
}

Types

PortfolioV2AccountToAccountArc

Fields

Field Name	Description
`sourceAccountId` - `String!`
`sinkAccountId` - `String!`

Example

{
  "sourceAccountId": "abc123",
  "sinkAccountId": "abc123"
}

Types

PortfolioV2AccountToAccountArcInput

Fields

Input Field	Description
`sinkAccountId` - `String!`
`sourceAccountId` - `String!`

Example

{
  "sinkAccountId": "abc123",
  "sourceAccountId": "abc123"
}

Types

PortfolioV2ActivationTime

Types

Union Types
`PortfolioV2ActivationTimeAt`
`PortfolioV2ActivationTimeTermination`
`PortfolioV2ActivationTimeStart`

Example

PortfolioV2ActivationTimeAt

Types

PortfolioV2ActivationTimeAt

Fields

Field Name	Description
`at` - `LocalDate!`

Example

{"at": "2020-07-19"}

Types

PortfolioV2ActivationTimeAtInput

Fields

Input Field	Description
`at` - `LocalDate!`

Example

{"at": "2020-07-19"}

Types

PortfolioV2ActivationTimeInput

Description

Only one of the fields must be provided

Fields

Input Field	Description
`at` - `PortfolioV2ActivationTimeAtInput`
`termination` - `PortfolioV2ActivationTimeTerminationInput`
`start` - `PortfolioV2ActivationTimeStartInput`

Example

{
  "at": PortfolioV2ActivationTimeAtInput,
  "termination": PortfolioV2ActivationTimeTerminationInput,
  "start": PortfolioV2ActivationTimeStartInput
}

Types

PortfolioV2ActivationTimeStart

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

PortfolioV2ActivationTimeStartInput

Fields

Input Field	Description
`placeholder` - `Boolean`

Example

{"placeholder": true}

Types

PortfolioV2ActivationTimeTermination

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

PortfolioV2ActivationTimeTerminationInput

Fields

Input Field	Description
`placeholder` - `Boolean`

Example

{"placeholder": true}

Types

PortfolioV2Arc

Types

Union Types
`PortfolioV2DebtorToProductArc`
`PortfolioV2ProductToDebtorArc`
`PortfolioV2AccountToAccountArc`

Example

PortfolioV2DebtorToProductArc

Types

PortfolioV2ArcInput

Description

Only one of the fields must be provided

Fields

Input Field	Description
`debtorToProduct` - `PortfolioV2DebtorToProductArcInput`
`productToDebtor` - `PortfolioV2ProductToDebtorArcInput`
`accountToAccount` - `PortfolioV2AccountToAccountArcInput`

Example

{
  "debtorToProduct": PortfolioV2DebtorToProductArcInput,
  "productToDebtor": PortfolioV2ProductToDebtorArcInput,
  "accountToAccount": PortfolioV2AccountToAccountArcInput
}

Types

PortfolioV2Asset

Fields

Field Name	Description
`assetId` - `String!`
`text` - `String!`
`depreciationMode` - `PortfolioV2DepreciationMode!`
`interest` - `PortfolioV2BookingRule`
`payment` - `PortfolioV2BookingRule!`
`pmtRounding` - `Boolean!`

Example

{
  "assetId": "abc123",
  "text": "xyz789",
  "depreciationMode": "ZERO",
  "interest": PortfolioV2BookingRule,
  "payment": PortfolioV2BookingRule,
  "pmtRounding": true
}

Types

PortfolioV2AssetBookableProcess

Fields

Field Name	Description
`bookingRule` - `PortfolioV2BookingRule!`
`values` - `[PortfolioV2RangedValue!]!`

Example

{
  "bookingRule": PortfolioV2BookingRule,
  "values": [PortfolioV2RangedValue]
}

Types

PortfolioV2AssetInput

Fields

Input Field	Description
`pmtRounding` - `Boolean!`
`payment` - `PortfolioV2BookingRuleInput!`
`interest` - `PortfolioV2BookingRuleInput`
`depreciationMode` - `PortfolioV2DepreciationMode!`
`text` - `String!`
`assetId` - `String!`

Example

{
  "pmtRounding": true,
  "payment": PortfolioV2BookingRuleInput,
  "interest": PortfolioV2BookingRuleInput,
  "depreciationMode": "ZERO",
  "text": "abc123",
  "assetId": "abc123"
}

Types

PortfolioV2AssetProcess

Fields

Field Name	Description
`asset` - `PortfolioV2Asset!`
`pmts` - `PortfolioV2AssetBookableProcess!`
`interests` - `PortfolioV2AssetBookableProcess`
`values` - `[PortfolioV2RangedValue!]!`

Example

{
  "asset": PortfolioV2Asset,
  "pmts": PortfolioV2AssetBookableProcess,
  "interests": PortfolioV2AssetBookableProcess,
  "values": [PortfolioV2RangedValue]
}

Types

PortfolioV2BookingRule

Fields

Field Name	Description
`atBookingDate` - `[PortfolioV2Arc!]!`
`atTermination` - `[PortfolioV2Arc!]!`

Example

{
  "atBookingDate": [PortfolioV2DebtorToProductArc],
  "atTermination": [PortfolioV2DebtorToProductArc]
}

Types

PortfolioV2BookingRuleInput

Fields

Input Field	Description
`atTermination` - `[PortfolioV2ArcInput!]!`
`atBookingDate` - `[PortfolioV2ArcInput!]!`

Example

{
  "atTermination": [PortfolioV2ArcInput],
  "atBookingDate": [PortfolioV2ArcInput]
}

Types

PortfolioV2BookingState

Fields

Field Name	Description
`historical` - `[PortfolioV2HistoricalBooking!]!`
`ideal` - `[Bookable!]!`
`formattedIdeal` - `[PortfolioV2FormattedBooking!]!`
`difference` - `[Bookable!]!`
`formattedDifference` - `[PortfolioV2FormattedBooking!]!`
`noBooking` - `[Bookable!]!`
`formattedNoBooking` - `[PortfolioV2FormattedBooking!]!`
`assets` - `[PortfolioV2AssetProcess!]!`
`partitionByBookingDate` - `PortfolioV2PartitionedBookingState!`	A view of the booking state with bookings partitioned by to-book and future in respect to on the booking date
Arguments `bookingDate` - `LocalDate!`

Example

{
  "historical": [PortfolioV2HistoricalBooking],
  "ideal": [Bookable],
  "formattedIdeal": [PortfolioV2FormattedBooking],
  "difference": [Bookable],
  "formattedDifference": [PortfolioV2FormattedBooking],
  "noBooking": [Bookable],
  "formattedNoBooking": [PortfolioV2FormattedBooking],
  "assets": [PortfolioV2AssetProcess],
  "partitionByBookingDate": PortfolioV2PartitionedBookingState
}

Types

PortfolioV2BookingStateResult

Fields

Field Name	Description
`contractId` - `UUID!`
`bookingState` - `PortfolioV2BookingState!`

Example

{
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "bookingState": PortfolioV2BookingState
}

Types

PortfolioV2Config

Fields

Input Field	Description
`pmtRoundingType` - `PmtRoundingType!`
`invoicePrefix` - `String`	Prefix for the invoice number (DEPRECAED, use the portfolio's field instead)
`indefinite` - `Boolean!`	Weather or not the contract is allowed to have no end date (annuity)

Example

{
  "pmtRoundingType": "NO_ROUNDING",
  "invoicePrefix": "abc123",
  "indefinite": true
}

Types

PortfolioV2Configuration

Fields

Field Name	Description
`indefinite` - `Boolean!`
`invoicePrefix` - `String!`	Deprecated
`pmtRoundingType` - `PmtRoundingType!`

Example

{
  "indefinite": true,
  "invoicePrefix": "abc123",
  "pmtRoundingType": "NO_ROUNDING"
}

Types

PortfolioV2ContractCostInput

Fields

Input Field	Description
`costs` - `[PortfolioV2CostInstanceInput!]!`
`contractId` - `UUID!`

Example

{
  "costs": [PortfolioV2CostInstanceInput],
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

PortfolioV2ContractWithCosts

Description

Requires the caller to have the 'reader' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.

Fields

Field Name	Description
`contractId` - `UUID!`
`costs` - `[PortfolioV2CostInstance!]!`
`id` - `ID!`

Example

{
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "costs": [PortfolioV2CostInstance],
  "id": "4"
}

Types

PortfolioV2Cost

Fields

Field Name	Description
`costId` - `String!`
`text` - `String!`
`bookingRule` - `PortfolioV2BookingRule!`
`assets` - `[PortfolioV2CostAsset!]!`
`entityOverridable` - `Boolean!`

Example

{
  "costId": "abc123",
  "text": "abc123",
  "bookingRule": PortfolioV2BookingRule,
  "assets": [PortfolioV2CostAsset],
  "entityOverridable": true
}

Types

PortfolioV2CostAsset

Fields

Field Name	Description
`assetId` - `String!`
`sign` - `Sign!`

Example

{"assetId": "abc123", "sign": "POSITIVE"}

Types

PortfolioV2CostAssetInput

Fields

Input Field	Description
`sign` - `Sign!`
`assetId` - `String!`

Example

{"sign": "POSITIVE", "assetId": "abc123"}

Types

PortfolioV2CostInput

Fields

Input Field	Description
`entityOverridable` - `Boolean!`
`assets` - `[PortfolioV2CostAssetInput!]!`
`bookingRule` - `PortfolioV2BookingRuleInput!`
`text` - `String!`
`costId` - `String!`

Example

{
  "entityOverridable": true,
  "assets": [PortfolioV2CostAssetInput],
  "bookingRule": PortfolioV2BookingRuleInput,
  "text": "xyz789",
  "costId": "xyz789"
}

Types

PortfolioV2CostInstance

Fields

Field Name	Description
`id` - `UUID!`
`costId` - `String!`
`amount` - `BigDecimal!`
`activation` - `PortfolioV2ActivationTime!`
`periodicity` - `PortfolioV2Periodicity!`
`entityId` - `UUID`

Example

{
  "id": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "costId": "xyz789",
  "amount": "28391719239482739937.1939459927192",
  "activation": PortfolioV2ActivationTimeAt,
  "periodicity": PortfolioV2PeriodicityPeriodic,
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

PortfolioV2CostInstanceInput

Fields

Input Field	Description
`entityId` - `UUID`
`periodicity` - `PortfolioV2PeriodicityInput!`
`activation` - `PortfolioV2ActivationTimeInput!`
`amount` - `BigDecimal!`
`costId` - `String!`

Example

{
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "periodicity": PortfolioV2PeriodicityInput,
  "activation": PortfolioV2ActivationTimeInput,
  "amount": "28391719239482739937.1939459927192",
  "costId": "xyz789"
}

Types

PortfolioV2DebtorToProductArc

Fields

Field Name	Description
`sinkProductId` - `String!`

Example

{"sinkProductId": "xyz789"}

Types

PortfolioV2DebtorToProductArcInput

Fields

Input Field	Description
`sinkProductId` - `String!`

Example

{"sinkProductId": "abc123"}

Types

PortfolioV2DepreciationMode

Values

Enum Value	Description
`ZERO`
`FUTURE_VALUE`
`PRESENT_VALUE`

Example

"ZERO"

Types

PortfolioV2FormattedBooking

Fields

Field Name	Description
`date` - `LocalDate!`
`transaction` - `PortfolioV2FormattedTransaction`
`invoice` - `[PortfolioV2FormattedInvoice!]!`

Example

{
  "date": "2020-07-19",
  "transaction": PortfolioV2FormattedTransaction,
  "invoice": [PortfolioV2FormattedInvoice]
}

Types

PortfolioV2FormattedInvoice

Fields

Field Name	Description
`invoice` - `LoanAndLeasePreviewInvoice!`
`lines` - `[PortfolioV2FormattedInvoiceLine!]!`
`structuralInvoiceId` - `StructuralInvoiceId!`

Example

{
  "invoice": LoanAndLeasePreviewInvoice,
  "lines": [PortfolioV2FormattedInvoiceLine],
  "structuralInvoiceId": StructuralInvoiceId
}

Types

PortfolioV2FormattedInvoiceLine

Fields

Field Name	Description
`line` - `LoanAndLeasePreviewInvoiceLine!`
`bookable` - `Bookable!`
`product` - `PortfolioV2Product!`

Example

{
  "line": LoanAndLeasePreviewInvoiceLine,
  "bookable": Bookable,
  "product": PortfolioV2Product
}

Types

PortfolioV2FormattedTransaction

Fields

Field Name	Description
`transaction` - `LoanAndLeasePreviewTransaction!`
`lines` - `[PortfolioV2FormattedTransactionLine!]!`

Example

{
  "transaction": LoanAndLeasePreviewTransaction,
  "lines": [PortfolioV2FormattedTransactionLine]
}

Types

PortfolioV2FormattedTransactionLine

Fields

Field Name	Description
`line` - `LoanAndLeasePreviewTransactionLine!`
`bookable` - `Bookable!`
`account` - `PortfolioV2Account!`

Example

{
  "line": LoanAndLeasePreviewTransactionLine,
  "bookable": Bookable,
  "account": PortfolioV2Account
}

Types

PortfolioV2HistoricalBooking

Fields

Field Name	Description
`date` - `LocalDate!`
`nodes` - `[PortfolioV2HistoricalBookingNode!]!`

Example

{
  "date": "2020-07-19",
  "nodes": [PortfolioV2HistoricalBookingNode]
}

Types

PortfolioV2HistoricalBookingNode

Fields

Field Name	Description
`bookingType` - `BookingType!`
`nodes` - `[Bookable!]!`

Example

{
  "bookingType": BookingTypeTransaction,
  "nodes": [Bookable]
}

Types

PortfolioV2Input

Fields

Input Field	Description
`products` - `[PortfolioV2ProductInput!]!`
`accounts` - `[PortfolioV2AccountInput!]!`
`assets` - `[PortfolioV2AssetInput!]!`
`costs` - `[PortfolioV2CostInput!]!`

Example

{
  "products": [PortfolioV2ProductInput],
  "accounts": [PortfolioV2AccountInput],
  "assets": [PortfolioV2AssetInput],
  "costs": [PortfolioV2CostInput]
}

Types

PortfolioV2PartitionedBookingState

Fields

Field Name	Description
`booking` - `[Bookable!]!`
`formattedBooking` - `[PortfolioV2FormattedBooking!]!`
`future` - `[Bookable!]!`
`formattedFuture` - `[PortfolioV2FormattedBooking!]!`

Example

{
  "booking": [Bookable],
  "formattedBooking": [PortfolioV2FormattedBooking],
  "future": [Bookable],
  "formattedFuture": [PortfolioV2FormattedBooking]
}

Types

PortfolioV2Periodicity

Types

Union Types
`PortfolioV2PeriodicityPeriodic`
`PortfolioV2PeriodicityOnce`

Example

PortfolioV2PeriodicityPeriodic

Types

PortfolioV2PeriodicityInput

Description

Only one of the fields must be provided

Fields

Input Field	Description
`periodic` - `PortfolioV2PeriodicityPeriodicInput`
`once` - `PortfolioV2PeriodicityOnceInput`

Example

{
  "periodic": PortfolioV2PeriodicityPeriodicInput,
  "once": PortfolioV2PeriodicityOnceInput
}

Types

PortfolioV2PeriodicityOnce

Fields

Field Name	Description
`placeholder` - `Boolean!`

Example

{"placeholder": true}

Types

PortfolioV2PeriodicityOnceInput

Fields

Input Field	Description
`placeholder` - `Boolean`

Example

{"placeholder": true}

Types

PortfolioV2PeriodicityPeriodic

Fields

Field Name	Description
`until` - `LocalDate`

Example

{"until": "2020-07-19"}

Types

PortfolioV2PeriodicityPeriodicInput

Fields

Input Field	Description
`until` - `LocalDate`

Example

{"until": "2020-07-19"}

Types

PortfolioV2Product

Fields

Field Name	Description
`productId` - `String!`
`text` - `String!`
`productNumber` - `String!`
`collectable` - `Boolean!`

Example

{
  "productId": "xyz789",
  "text": "xyz789",
  "productNumber": "xyz789",
  "collectable": true
}

Types

PortfolioV2ProductInput

Fields

Input Field	Description
`collectable` - `Boolean!`
`productNumber` - `String!`
`text` - `String!`
`productId` - `String!`

Example

{
  "collectable": true,
  "productNumber": "abc123",
  "text": "xyz789",
  "productId": "abc123"
}

Types

PortfolioV2ProductToDebtorArc

Fields

Field Name	Description
`sourceProductId` - `String!`

Example

{"sourceProductId": "xyz789"}

Types

PortfolioV2ProductToDebtorArcInput

Fields

Input Field	Description
`sourceProductId` - `String!`

Example

{"sourceProductId": "xyz789"}

Types

PortfolioV2RangedValue

Fields

Field Name	Description
`start` - `LocalDate!`
`end` - `LocalDate!`
`value` - `BigDecimal!`

Example

{
  "start": "2020-07-19",
  "end": "2020-07-19",
  "value": "28391719239482739937.1939459927192"
}

Types

PortfolioV2UpsertErrorPortfolioNotFound

Fields

Field Name	Description
`portfolioId` - `String!`

Example

{"portfolioId": "abc123"}

Types

PortfolioV2UpsertOutcome

Types

Union Types
`PortfolioV2UpsertErrorPortfolioNotFound`
`PortfolioV2UpsertSuccess`

Example

PortfolioV2UpsertErrorPortfolioNotFound

Types

PortfolioV2UpsertSuccess

Fields

Field Name	Description
`portfolio` - `PortfolioV2!`

Example

{"portfolio": PortfolioV2}

Types

PreviewTransactionLineWithCostId

Fields

Field Name	Description
`line` - `LoanAndLeasePreviewTransactionLine!`
`cost` - `LoanAndLeasePortfolioCosts`

Example

{
  "line": LoanAndLeasePreviewTransactionLine,
  "cost": LoanAndLeasePortfolioCosts
}

Types

RefetchDmrAssetResult

Fields

Field Name	Description
`asset` - `Asset!`
`status` - `Boolean`

Example

{"asset": Asset, "status": true}

Types

RegisterError

Fields

Field Name	Description
`message` - `String!`
`timestamp` - `Instant!`

Example

{
  "message": "abc123",
  "timestamp": 1654109791
}

Types

RemoveContractFilesError

Types

Union Types
`RemoveContractFilesSuccess`
`RemoveContractFilesFilesNotFoundError`

Example

RemoveContractFilesSuccess

Types

RemoveContractFilesFilesNotFoundError

Fields

Field Name	Description
`fileIds` - `[UUID!]!`

Example

{
  "fileIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Types

RemoveContractFilesSuccess

Fields

Field Name	Description
`contracts` - `[LoanAndLeaseContract!]!`

Example

{"contracts": [LoanAndLeaseContract]}

Types

ReportingConfig

Fields

Field Name	Description
`expirationWarningDays` - `Int`

Example

{"expirationWarningDays": 123}

Types

ReportingConfigInput

Fields

Input Field	Description
`expirationWarningDays` - `Int`

Example

{"expirationWarningDays": 123}

Types

RkiSecrets

Fields

Input Field	Description
`password` - `String!`
`username` - `String!`
`service` - `RkiService!`

Example

{
  "password": "abc123",
  "username": "abc123",
  "service": "PRODUCTION"
}

Types

RkiService

Values

Enum Value	Description
`PRODUCTION`
`TEST`

Example

"PRODUCTION"

Types

SanctionedEntity

Fields

Field Name	Description
`refNo` - `String!`
`legalBasis` - `String!`
`programme` - `String!`
`names` - `[SanctionedEntityName!]!`
`birthdates` - `[SanctionedEntityBirthdate!]!`
`citizenships` - `[SanctionedEntityCitizenship!]!`
`remark` - `String`

Example

{
  "refNo": "xyz789",
  "legalBasis": "abc123",
  "programme": "abc123",
  "names": [SanctionedEntityName],
  "birthdates": [SanctionedEntityBirthdateRange],
  "citizenships": [SanctionedEntityCitizenship],
  "remark": "xyz789"
}

Types

SanctionedEntityBirthdate

Types

Union Types
`SanctionedEntityBirthdateRange`
`SanctionedEntityExactBirthdate`

Example

SanctionedEntityBirthdateRange

Types

SanctionedEntityBirthdateRange

Fields

Field Name	Description
`from` - `LocalDate!`
`to` - `LocalDate!`

Example

{
  "from": "2020-07-19",
  "to": "2020-07-19"
}

Types

SanctionedEntityCitizenship

Fields

Field Name	Description
`citizenship` - `String!`

Example

{"citizenship": "xyz789"}

Types

SanctionedEntityExactBirthdate

Fields

Field Name	Description
`birthdate` - `LocalDate!`

Example

{"birthdate": "2020-07-19"}

Types

SanctionedEntityName

Fields

Field Name	Description
`fullName` - `String!`

Example

{"fullName": "xyz789"}

Types

SetAssetError

Types

Union Types
`AssetUpdateAssetNoMustBeDefined`
`AssetUpdateAssetNoAlreadyExists`
`AssetUpdateVinAlreadyExists`
`AssetUpdateDuplicateVin`
`AssetUpdateDuplicateAssetNo`
`AssetUpdateIdDoesNotExist`

Example

AssetUpdateAssetNoMustBeDefined

Types

SetAssetResult

Types

Union Types
`AssetUpdateError`
`AssetUpdateSuccess`

Example

AssetUpdateError

Types

SetCreditorId

Fields

Input Field	Description
`creditorId` - `Int`

Example

{"creditorId": 987}

Types

SetDebtorId

Fields

Input Field	Description
`debtorId` - `Long`

Example

{"debtorId": 9223372036854776000}

Types

Sign

Values

Enum Value	Description
`POSITIVE`
`NEGATIVE`

Example

"POSITIVE"

Types

SortAssetBy

Values

Enum Value	Description
`CREATED`
`VIN`
`MAKE_MODEL`
`REG_NO`
`FIRST_REG_DATE`
`ASSET_NO`

Example

"CREATED"

Types

SortContractBy

Values

Enum Value	Description
`CREATED`
`ECONOMIC_NUMBER`
`DEBTOR_NAME`
`MAKE_MODEL`
`VIN`
`REGISTRATION_NUMBER`
`PORTFOLIO_ID`
`STATUS`
`START_DATE`
`END_DATE`
`SUPPLIER_PAYABLE`
`ASSET`
`ASSET2`
`DEPOSIT`
`REMAINDER`
`SUPPLIER_PAYABLE_WARNING`
`ASSET_WARNING`
`COMPUTED_END_DATE`
`COMPUTED_START_DATE`
`REG_TAX_END_DATE`
`REG_TAX_START_DATE`

Example

"CREATED"

Types

SortDirection

Values

Enum Value	Description
`ASC`
`DESC`

Example

"ASC"

Types

String

Description

The String is a UTF-8 character sequence usually representing human-readable text.

Example

"xyz789"

Types

StructuralInvoiceId

Fields

Field Name	Description
`date` - `LocalDate!`
`entityId` - `UUID!`
`invoiceType` - `LoanAndLeaseInvoiceType!`

Example

{
  "date": "2020-07-19",
  "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "invoiceType": "START"
}

Types

Timestamped

Fields

Field Name	Description
`timestamp` - `Instant!`

Possible Types

Timestamped Types
`RegisterError`
`BadDebtResult`
`FinancialCrimeResult`

Example

{"timestamp": 1654109791}

Types

UUID

Description

The UUID scalar type represents a UUID v4 as specified by RFC 4122.

Example

"a79dd2da-a9b2-4394-9c11-36c375346bc7"

Types

UnifiedDmrEntry

Fields

Field Name	Description
`vin` - `String`
`makeModel` - `String`
`vehicleType` - `String`
`vehicleModified` - `LocalDate`
`regNo` - `String`
`firstRegDate` - `LocalDate`
`usage` - `String`
`registrationModified` - `LocalDate`
`leasingPeriodStart` - `LocalDate`
`leasingPeriodEnd` - `LocalDate`
`status` - `String`
`dataSource` - `UnifiedDmrEntryDataSource!`

Example

{
  "vin": "abc123",
  "makeModel": "abc123",
  "vehicleType": "xyz789",
  "vehicleModified": "2020-07-19",
  "regNo": "xyz789",
  "firstRegDate": "2020-07-19",
  "usage": "xyz789",
  "registrationModified": "2020-07-19",
  "leasingPeriodStart": "2020-07-19",
  "leasingPeriodEnd": "2020-07-19",
  "status": "abc123",
  "dataSource": DmrAdhocRequest
}

Types

UnifiedDmrEntryDataSource

Types

Union Types
`DmrAdhocRequest`
`WeeklyDmrImportMetadata`

Example

DmrAdhocRequest

Types

UnknownCountryCode

Fields

Field Name	Description
`code` - `String!`

Example

{"code": "xyz789"}

Types

UpdateCost

Fields

Input Field	Description
`cost` - `PortfolioV2CostInstanceInput!`
`costId` - `UUID!`

Example

{
  "cost": PortfolioV2CostInstanceInput,
  "costId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

UpdateCosts

Fields

Input Field	Description
`create` - `[PortfolioV2CostInstanceInput!]!`
`update` - `[UpdateCost!]!`
`delete` - `[UUID!]!`
`contractId` - `UUID!`

Example

{
  "create": [PortfolioV2CostInstanceInput],
  "update": [UpdateCost],
  "delete": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7"
}

Types

UpdateCreditlinkCompany

Fields

Input Field	Description
`externalId` - `ExternalId`
`userId` - `UserId`
`financialCrimeEnabled` - `Boolean!`
`badDebtEnabled` - `Boolean!`
`phone` - `Phone`
`email` - `Email`
`cvr` - `Cvr!`
`name` - `String!`

Example

{
  "externalId": "0110293",
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "financialCrimeEnabled": true,
  "badDebtEnabled": true,
  "phone": "29400888",
  "email": "john@gmail.com",
  "cvr": "35890270",
  "name": "xyz789"
}

Types

UpdateCreditlinkPerson

Fields

Input Field	Description
`externalId` - `ExternalId`
`userId` - `UserId`
`proofOfIdentityEnabled` - `Boolean`
`psd2Enabled` - `Boolean!`
`taxInfoEnabled` - `Boolean!`
`financialCrimeEnabled` - `Boolean!`
`badDebtEnabled` - `Boolean!`
`phone` - `Phone`
`email` - `Email`
`cpr` - `Cpr`
`name` - `String!`

Example

{
  "externalId": "0110293",
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "proofOfIdentityEnabled": true,
  "psd2Enabled": true,
  "taxInfoEnabled": true,
  "financialCrimeEnabled": true,
  "badDebtEnabled": true,
  "phone": "29400888",
  "email": "john@gmail.com",
  "cpr": "0810972032",
  "name": "xyz789"
}

Types

Uri

Description

The Uri scalar type is a valid RFC3986 address.

Example

"https://domain.com/resource"

Types

User

Fields

Field Name	Description
`id` - `UserId!`
`name` - `String`
`email` - `Email`
`globalRoles` - `[GlobalRole!]!`	Your id must be the same as the userId in the object.
Arguments `in` - `[GlobalRole!]`
`organizations` - `[Organization!]!`	Prefer using the organizationUsers field, this will be deprecated. Your id must be the same as the userId in the object.
`organizationUsers` - `[OrganizationUser!]!`	Your id must be the same as the userId in the object.

Example

{
  "id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "name": "abc123",
  "email": "john@gmail.com",
  "globalRoles": ["ADMIN"],
  "organizations": [Organization],
  "organizationUsers": [OrganizationUser]
}

Types

UserId

Description

The UserId scalar type provides information abount who an action involves. A UserId must be in one of two forms:

'oauth2/SUB' where SUB is a BASE64 encoded UTF-8 subject string (as in JWT sub)
'opaque/UUID' where UUID is an opaque UUID assigned to a token based user

Example

"oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"

Types

WeeklyDmrImportMetadata

Fields

Field Name	Description
`importDate` - `Instant!`

Example

{"importDate": 1654109791}

Types

Year

Description

A year in the ISO-8601 calendar system, such as 2007.

Example

"2007"

Types

YearMonth

Description

A year-month in the ISO-8601 calendar system, such as 2007-12.

Example

"2007-12"

Types

collectionTimeStatus

Values

Enum Value	Description
`TOO_EARLY`
`NORMAL`
`EXTENDED`
`TOO_LATE`

Example

"TOO_EARLY"

Subscriptions

`assetSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [Asset!]!

Arguments

Name	Description
`sortDirection` - `SortDirection`	Default = `DESC`
`sortBy` - `SortAssetBy`	Default = `CREATED`
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`offset` - `Long!`
`size` - `Long!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription assetSearch(
  $sortDirection: SortDirection,
  $sortBy: SortAssetBy,
  $reverseSearch: String,
  $search: String,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  assetSearch(
    sortDirection: $sortDirection,
    sortBy: $sortBy,
    reverseSearch: $reverseSearch,
    search: $search,
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    assetId
    vin
    makeModel
    regNo
    firstRegDate
    assetNo
    hasVat
    hasRegTax
    color
    comment
    mileage
    retention {
      contractRelations {
        ...LoanAndLeaseContractFragment
      }
      hidden
      retainUntil
      hasConflicts
    }
    dmr {
      ident
      typeNumber
      typeName
      usageNumber
      usageName
      leasingValidFrom
      leasingValidTo
      status
      statusDate
      firstRegistrationDate
      vin
      makeNumber
      makeName
      modelNumber
      modelName
      variantNumber
      variantName
      versionNumber
      versionName
      colorNumber
      colorName
      propulsionNumber
      propulsionName
      kmPerLiter
      co2Emission
      registrationStatus
      registrationStatusDate
      registrationNumber
    }
    dmrAdhoc {
      newest {
        ...DmrAdhocRequestFragment
      }
      newestSuccessful {
        ...DmrAdhocRequestFragment
      }
    }
    mostRecentDmr {
      vin
      makeModel
      vehicleType
      vehicleModified
      regNo
      firstRegDate
      usage
      registrationModified
      leasingPeriodStart
      leasingPeriodEnd
      status
      dataSource {
        ... on DmrAdhocRequest {
          ...DmrAdhocRequestFragment
        }
        ... on WeeklyDmrImportMetadata {
          ...WeeklyDmrImportMetadataFragment
        }
      }
    }
    id
  }
}

Variables

{
  "sortDirection": "DESC",
  "sortBy": "CREATED",
  "reverseSearch": null,
  "search": "abc123",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "assetSearch": [
      {
        "assetId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "vin": "abc123",
        "makeModel": "abc123",
        "regNo": "xyz789",
        "firstRegDate": "2020-07-19",
        "assetNo": 987,
        "hasVat": true,
        "hasRegTax": true,
        "color": "xyz789",
        "comment": "xyz789",
        "mileage": 123,
        "retention": AssetRetention,
        "dmr": [DmrEntry],
        "dmrAdhoc": DmrAdhocResults,
        "mostRecentDmr": UnifiedDmrEntry,
        "id": 4
      }
    ]
  }
}

Subscriptions

`assets`

Description

If any requested assets do not exist, they will be omitted from the result the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [Asset!]!

Arguments

Name	Description
`assetIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription assets(
  $assetIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  assets(
    assetIds: $assetIds,
    org: $org,
    org: $org
  ) {
    assetId
    vin
    makeModel
    regNo
    firstRegDate
    assetNo
    hasVat
    hasRegTax
    color
    comment
    mileage
    retention {
      contractRelations {
        ...LoanAndLeaseContractFragment
      }
      hidden
      retainUntil
      hasConflicts
    }
    dmr {
      ident
      typeNumber
      typeName
      usageNumber
      usageName
      leasingValidFrom
      leasingValidTo
      status
      statusDate
      firstRegistrationDate
      vin
      makeNumber
      makeName
      modelNumber
      modelName
      variantNumber
      variantName
      versionNumber
      versionName
      colorNumber
      colorName
      propulsionNumber
      propulsionName
      kmPerLiter
      co2Emission
      registrationStatus
      registrationStatusDate
      registrationNumber
    }
    dmrAdhoc {
      newest {
        ...DmrAdhocRequestFragment
      }
      newestSuccessful {
        ...DmrAdhocRequestFragment
      }
    }
    mostRecentDmr {
      vin
      makeModel
      vehicleType
      vehicleModified
      regNo
      firstRegDate
      usage
      registrationModified
      leasingPeriodStart
      leasingPeriodEnd
      status
      dataSource {
        ... on DmrAdhocRequest {
          ...DmrAdhocRequestFragment
        }
        ... on WeeklyDmrImportMetadata {
          ...WeeklyDmrImportMetadataFragment
        }
      }
    }
    id
  }
}

Variables

{
  "assetIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "assets": [
      {
        "assetId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "vin": "abc123",
        "makeModel": "xyz789",
        "regNo": "xyz789",
        "firstRegDate": "2020-07-19",
        "assetNo": 987,
        "hasVat": true,
        "hasRegTax": true,
        "color": "abc123",
        "comment": "abc123",
        "mileage": 123,
        "retention": AssetRetention,
        "dmr": [DmrEntry],
        "dmrAdhoc": DmrAdhocResults,
        "mostRecentDmr": UnifiedDmrEntry,
        "id": 4
      }
    ]
  }
}

Subscriptions

`bookingStates`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioV2BookingStateResult!]!

Arguments

Name	Description
`contractIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription bookingStates(
  $contractIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  bookingStates(
    contractIds: $contractIds,
    org: $org,
    org: $org
  ) {
    contractId
    bookingState {
      historical {
        ...PortfolioV2HistoricalBookingFragment
      }
      ideal {
        ...BookableFragment
      }
      formattedIdeal {
        ...PortfolioV2FormattedBookingFragment
      }
      difference {
        ...BookableFragment
      }
      formattedDifference {
        ...PortfolioV2FormattedBookingFragment
      }
      noBooking {
        ...BookableFragment
      }
      formattedNoBooking {
        ...PortfolioV2FormattedBookingFragment
      }
      assets {
        ...PortfolioV2AssetProcessFragment
      }
      partitionByBookingDate {
        ...PortfolioV2PartitionedBookingStateFragment
      }
    }
  }
}

Variables

{
  "contractIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "bookingStates": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "bookingState": PortfolioV2BookingState
      }
    ]
  }
}

Subscriptions

`collectables`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Collectables!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription collectables(
  $org: Org!,
  $org: Org!
) {
  collectables(
    org: $org,
    org: $org
  ) {
    certificate {
      token {
        ...CollectionTokenFragment
      }
      hash
    }
    collectables {
      invoiceId
      status {
        ... on LoanAndLeaseInvoiceBookingStatusPending {
          ...LoanAndLeaseInvoiceBookingStatusPendingFragment
        }
        ... on LoanAndLeaseInvoiceBookingStatusDiscarded {
          ...LoanAndLeaseInvoiceBookingStatusDiscardedFragment
        }
        ... on LoanAndLeaseInvoiceBookingStatusFailed {
          ...LoanAndLeaseInvoiceBookingStatusFailedFragment
        }
        ... on LoanAndLeaseInvoiceBookingStatusStarted {
          ...LoanAndLeaseInvoiceBookingStatusStartedFragment
        }
        ... on LoanAndLeaseInvoiceBookingStatusCompleted {
          ...LoanAndLeaseInvoiceBookingStatusCompletedFragment
        }
      }
      invoice {
        ...LoanAndLeasePreviewInvoiceFragment
      }
      bookedInvoice {
        ...LoanAndLeaseBookedInvoiceFragment
      }
    }
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "collectables": {
      "certificate": CollectablesCertificate,
      "collectables": [LoanAndLeaseInvoiceGroup]
    }
  }
}

Subscriptions

`contractCosts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [PortfolioV2ContractWithCosts!]!

Arguments

Name	Description
`contractIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription contractCosts(
  $contractIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  contractCosts(
    contractIds: $contractIds,
    org: $org,
    org: $org
  ) {
    contractId
    costs {
      id
      costId
      amount
      activation {
        ... on PortfolioV2ActivationTimeAt {
          ...PortfolioV2ActivationTimeAtFragment
        }
        ... on PortfolioV2ActivationTimeTermination {
          ...PortfolioV2ActivationTimeTerminationFragment
        }
        ... on PortfolioV2ActivationTimeStart {
          ...PortfolioV2ActivationTimeStartFragment
        }
      }
      periodicity {
        ... on PortfolioV2PeriodicityPeriodic {
          ...PortfolioV2PeriodicityPeriodicFragment
        }
        ... on PortfolioV2PeriodicityOnce {
          ...PortfolioV2PeriodicityOnceFragment
        }
      }
      entityId
    }
    id
  }
}

Variables

{
  "contractIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "contractCosts": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "costs": [PortfolioV2CostInstance],
        "id": "4"
      }
    ]
  }
}

Subscriptions

`creditlinkCase`

Description

the subject 'user' (derived from the current caller's auth) must have the 'anyone' relation to the 'creditlink/case' resource (derived from the argument 'caseId')

Response

Returns a CreditlinkCaseEvent!

Arguments

Name	Description
`caseId` - `UUID!`
`org` - `Org!`	The organization which the action relates to.
`caseId` - `UUID!`

Example

Query

subscription creditlinkCase(
  $caseId: UUID!,
  $org: Org!,
  $caseId: UUID!
) {
  creditlinkCase(
    caseId: $caseId,
    org: $org,
    caseId: $caseId
  ) {
    ... on CreditlinkCaseSubscribedEvent {
      case {
        ...CreditlinkCaseFragment
      }
    }
    ... on CreditlinkCaseUpdatedEvent {
      case {
        ...CreditlinkCaseFragment
      }
    }
    ... on CreditlinkCaseDeletedEvent {
      org
      caseId
    }
  }
}

Variables

{
  "caseId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
  "org": "acme"
}

Response

{
  "data": {
    "creditlinkCase": CreditlinkCaseSubscribedEvent
  }
}

Subscriptions

`creditratingSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a CreditlinkCasesEvent!

Arguments

Name	Description
`filter` - `CreditlinkFilter`
`sortDirection` - `SortDirection`
`sort` - `CreditlinkSort!`
`paging` - `NumberPaging!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription creditratingSearch(
  $filter: CreditlinkFilter,
  $sortDirection: SortDirection,
  $sort: CreditlinkSort!,
  $paging: NumberPaging!,
  $org: Org!,
  $org: Org!
) {
  creditratingSearch(
    filter: $filter,
    sortDirection: $sortDirection,
    sort: $sort,
    paging: $paging,
    org: $org,
    org: $org
  ) {
    ... on CreditlinkCasesEventSubscribed {
      org
      bundles {
        ...CreditlinkCaseFragment
      }
    }
    ... on CreditlinkCasesEventUpdate {
      org
      new {
        ...CreditlinkCaseFragment
      }
      orderedIds
      removed
    }
  }
}

Variables

{
  "filter": "AWAITING_CUSTOMER",
  "sortDirection": "ASC",
  "sort": "EXTERNAL_ID",
  "paging": NumberPaging,
  "org": "acme"
}

Response

{
  "data": {
    "creditratingSearch": CreditlinkCasesEventSubscribed
  }
}

Subscriptions

`disposableIncomeConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a DisposableIncomeConfigEvent!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription disposableIncomeConfig(
  $org: Org!,
  $org: Org!
) {
  disposableIncomeConfig(
    org: $org,
    org: $org
  ) {
    ... on DisposableIncomeConfigSubscribedEvent {
      org
      currentConfig {
        ...DisposableIncomeConfigFragment
      }
    }
    ... on DisposableIncomeConfigUpdatedEvent {
      org
      newConfig {
        ...DisposableIncomeConfigFragment
      }
    }
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "disposableIncomeConfig": DisposableIncomeConfigSubscribedEvent
  }
}

Subscriptions

`economicConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an EconomicConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription economicConfig(
  $org: Org!,
  $org: Org!
) {
  economicConfig(
    org: $org,
    org: $org
  ) {
    cashBookHandle
    paymentCashBookHandle
    bankAccountNo
    minInvoiceNo
    maxInvoiceNo
    fallbackDebtorNo
    personCustomerGroupId
    companyCustomerGroupId
    supplierGroupId
    vatZoneId
    paymentTermsId
    usePaymentTermsIdForBooking
    minCustomerNo
    maxCustomerNo
    accountingYearStart
    invoiceMailSignature
    invoiceMailSenderName
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "economicConfig": {
      "cashBookHandle": 987,
      "paymentCashBookHandle": 987,
      "bankAccountNo": 9223372036854776000,
      "minInvoiceNo": 987,
      "maxInvoiceNo": 123,
      "fallbackDebtorNo": 9223372036854776000,
      "personCustomerGroupId": 9223372036854776000,
      "companyCustomerGroupId": 9223372036854776000,
      "supplierGroupId": 9223372036854776000,
      "vatZoneId": 9223372036854776000,
      "paymentTermsId": 9223372036854776000,
      "usePaymentTermsIdForBooking": true,
      "minCustomerNo": 9223372036854776000,
      "maxCustomerNo": 9223372036854776000,
      "accountingYearStart": 987,
      "invoiceMailSignature": "abc123",
      "invoiceMailSenderName": "xyz789"
    }
  }
}

Subscriptions

`hasEconomicConfigToken`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription hasEconomicConfigToken(
  $org: Org!,
  $org: Org!
) {
  hasEconomicConfigToken(
    org: $org,
    org: $org
  )
}

Variables

{"org": "acme"}

Response

{"data": {"hasEconomicConfigToken": true}}

Subscriptions

`hasFTPServerConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a Boolean!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription hasFTPServerConfig(
  $org: Org!,
  $org: Org!
) {
  hasFTPServerConfig(
    org: $org,
    org: $org
  )
}

Variables

{"org": "acme"}

Response

{"data": {"hasFTPServerConfig": true}}

Subscriptions

`loanAndLeaseBaseRate`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseBaseRate!]!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseBaseRate(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseBaseRate(
    org: $org,
    org: $org
  ) {
    baseRateId
    date
    baseRate
    id
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseBaseRate": [
      {
        "baseRateId": "abc123",
        "date": "2020-07-19",
        "baseRate": "28391719239482739937.1939459927192",
        "id": "4"
      }
    ]
  }
}

Subscriptions

`loanAndLeaseCollectableInvoices`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseBookedInvoice!]!

Arguments

Name	Description
`extended` - `Boolean!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseCollectableInvoices(
  $extended: Boolean!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseCollectableInvoices(
    extended: $extended,
    org: $org,
    org: $org
  ) {
    header {
      invoiceId
      invoiceNo
      customerNumber
      date
      recipientName
      recipientAddress
      recipientPostalCode
      recipientCity
      grossAmount
      vatAmount
      notesHeading
      notesTextLine1
      notesTextLine2
    }
    lines {
      invoiceId
      description
      totalNetAmount
      vatAmount
    }
    contract {
      contractId
      dimensionNo
      contractType {
        ... on ContractTypeEconomic {
          ...ContractTypeEconomicFragment
        }
        ... on ContractTypeGeneric {
          ...ContractTypeGenericFragment
        }
      }
      department {
        ... on EconomicDepartment {
          ...EconomicDepartmentFragment
        }
        ... on EconomicDepartmentMissingConfigurationError {
          ...EconomicDepartmentMissingConfigurationErrorFragment
        }
        ... on EconomicDepartmentUnknownError {
          ...EconomicDepartmentUnknownErrorFragment
        }
      }
      portfolio {
        ...LoanAndLeasePortfolioFragment
      }
      annuityStart
      annuityEnd
      adjustEnd
      periodUnit
      baseRate
      internalMarginRate
      externalMarginRate
      fixedRate
      residualValue
      contractStatus
      contractStart
      entities {
        ...LoanAndLeaseContractEntitiesFragment
      }
      costs {
        ... on LoanAndLeaseContractCostPayment {
          ...LoanAndLeaseContractCostPaymentFragment
        }
        ... on LoanAndLeaseContractCostDirectPeriodic {
          ...LoanAndLeaseContractCostDirectPeriodicFragment
        }
        ... on LoanAndLeaseContractCostDirectConstant {
          ...LoanAndLeaseContractCostDirectConstantFragment
        }
        ... on LoanAndLeaseContractCostDelete {
          ...LoanAndLeaseContractCostDeleteFragment
        }
        ... on LoanAndLeaseContractCostAnnuityPeriodic {
          ...LoanAndLeaseContractCostAnnuityPeriodicFragment
        }
        ... on LoanAndLeaseAnnuityConstant {
          ...LoanAndLeaseAnnuityConstantFragment
        }
      }
      changeResidualValue {
        ...LoanAndLeaseContractChangeResidualValueFragment
      }
      changeAnnuityEnd {
        ...LoanAndLeaseContractChangeAnnuityEndFragment
      }
      changeInterestRate {
        ...LoanAndLeaseContractChangeInterestRateFragment
      }
      changeEntities {
        ...LoanAndLeaseContractChangeEntitiesFragment
      }
      mileageOptions {
        ...LoanAndLeaseLimitedMileageFragment
      }
      assetOptions {
        ...LoanAndLeaseAssetOptionsFragment
      }
      asset {
        ...AssetFragment
      }
      periodAlignment
      invoiceText
      sharedInsurancePolicy
      expirationStatus
      regTax {
        ... on LoanAndLeaseRegTaxNone {
          ...LoanAndLeaseRegTaxNoneFragment
        }
        ... on LoanAndLeaseRegTaxFull {
          ...LoanAndLeaseRegTaxFullFragment
        }
        ... on LoanAndLeaseRegTaxProportionate {
          ...LoanAndLeaseRegTaxProportionateFragment
        }
      }
      secondHandVat
      approverInitials
      firstPeriodInvoice
      firstBooking
      collectionMethod
      mailNotification
      report {
        ...LoanAndLeaseContractReportFragment
      }
      retention {
        ...LoanAndLeaseContractRetentionFragment
      }
      annuityFinalEnd
      computedEndDate
      computedStartDate
      regTaxEndDate
      regTaxStartDate
      comments {
        ...LoanAndLeaseContractCommentFragment
      }
      files {
        ...ContractFileFragment
      }
      bookedInvoices {
        ...LoanAndLeaseBookedInvoiceFragment
      }
      mirrorEntries {
        ...MirrorEntryCasehubResultFragment
      }
      pmtRoundingType
      annuityType
      bookingState {
        ...PortfolioV2BookingStateFragment
      }
      disabledAssets
      id
    }
    mails {
      invoiceId
      invoice {
        ...LoanAndLeaseBookedInvoiceFragment
      }
      mail {
        ...MailLogEntryFragment
      }
      status
      computedStatus
      computedStatusTimestamp
    }
    id
  }
}

Variables

{"extended": true, "org": "acme"}

Response

{
  "data": {
    "loanAndLeaseCollectableInvoices": [
      {
        "header": LoanAndLeaseBookedInvoiceHeader,
        "lines": [LoanAndLeaseBookedInvoiceLine],
        "contract": LoanAndLeaseContract,
        "mails": [EconomicInvoiceMailInfo],
        "id": 4
      }
    ]
  }
}

Subscriptions

`loanAndLeaseContractCounts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractCountsFiltered!

Arguments

Name	Description
`portfolioIds` - `[String!]`
`expirationStatus` - `LoanAndLeaseExpirationStatus`	A filter that determines if the search should only return contracts with the specified expiration status
`regTaxType` - `LoandAndLeaseRegTaxType`	A filter that determines if the search should only return contracts with the specified reg tax type
`contractStatus` - `LoanAndLeaseContractStatus`	An optional contract status to filter by
`warningType` - `LoandAndLeaseWarningType`	A filter that determines if the search should only return contracts with the specified warning on them
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseContractCounts(
  $portfolioIds: [String!],
  $expirationStatus: LoanAndLeaseExpirationStatus,
  $regTaxType: LoandAndLeaseRegTaxType,
  $contractStatus: LoanAndLeaseContractStatus,
  $warningType: LoandAndLeaseWarningType,
  $reverseSearch: String,
  $search: String,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseContractCounts(
    portfolioIds: $portfolioIds,
    expirationStatus: $expirationStatus,
    regTaxType: $regTaxType,
    contractStatus: $contractStatus,
    warningType: $warningType,
    reverseSearch: $reverseSearch,
    search: $search,
    org: $org,
    org: $org
  ) {
    withOtherWarningType {
      all
      anyWarning
      supplierPayableWarning
      assetWarning
      startDateWarning
      endDateWarning
      anyAccountWarning
      expirationWarning
      annuityExpirationWarning
    }
    withOtherContractStatus {
      all
      draft
      starting
      active
      ending
      completed
      inventory
    }
    withOtherRegTax {
      all
      proportionate
      full
      none
    }
    withOtherExpirationStatus {
      all
      pendingCustomer
      extension
      termination
      newContract
    }
    portfolioCounts {
      all
      entries {
        ...ContractPortfolioCountFragment
      }
    }
  }
}

Variables

{
  "portfolioIds": ["xyz789"],
  "expirationStatus": "PENDING_CUSTOMER",
  "regTaxType": "PROPORTIONATE",
  "contractStatus": "DRAFT",
  "warningType": "ANY",
  "reverseSearch": null,
  "search": "xyz789",
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseContractCounts": {
      "withOtherWarningType": LoanAndLeaseContractCountsFilteredWithOtherWarningType,
      "withOtherContractStatus": LoanAndLeaseContractCountsFilteredWithOtherContractStatus,
      "withOtherRegTax": LoanAndLeaseContractCountsFilteredWithOtherRegTax,
      "withOtherExpirationStatus": LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus,
      "portfolioCounts": ContractPortfolioCounts
    }
  }
}

Subscriptions

`loanAndLeaseContractCountsFiltered`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseContractCountsFiltered!

Arguments

Name	Description
`portfolioIds` - `[String!]`
`expirationStatus` - `LoanAndLeaseExpirationStatus`	A filter that determines if the search should only return contracts with the specified expiration status
`regTaxType` - `LoandAndLeaseRegTaxType`	A filter that determines if the search should only return contracts with the specified reg tax type
`contractStatus` - `LoanAndLeaseContractStatus`	An optional contract status to filter by
`warningType` - `LoandAndLeaseWarningType`	A filter that determines if the search should only return contracts with the specified warning on them
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseContractCountsFiltered(
  $portfolioIds: [String!],
  $expirationStatus: LoanAndLeaseExpirationStatus,
  $regTaxType: LoandAndLeaseRegTaxType,
  $contractStatus: LoanAndLeaseContractStatus,
  $warningType: LoandAndLeaseWarningType,
  $reverseSearch: String,
  $search: String,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseContractCountsFiltered(
    portfolioIds: $portfolioIds,
    expirationStatus: $expirationStatus,
    regTaxType: $regTaxType,
    contractStatus: $contractStatus,
    warningType: $warningType,
    reverseSearch: $reverseSearch,
    search: $search,
    org: $org,
    org: $org
  ) {
    withOtherWarningType {
      all
      anyWarning
      supplierPayableWarning
      assetWarning
      startDateWarning
      endDateWarning
      anyAccountWarning
      expirationWarning
      annuityExpirationWarning
    }
    withOtherContractStatus {
      all
      draft
      starting
      active
      ending
      completed
      inventory
    }
    withOtherRegTax {
      all
      proportionate
      full
      none
    }
    withOtherExpirationStatus {
      all
      pendingCustomer
      extension
      termination
      newContract
    }
    portfolioCounts {
      all
      entries {
        ...ContractPortfolioCountFragment
      }
    }
  }
}

Variables

{
  "portfolioIds": ["xyz789"],
  "expirationStatus": "PENDING_CUSTOMER",
  "regTaxType": "PROPORTIONATE",
  "contractStatus": "DRAFT",
  "warningType": "ANY",
  "reverseSearch": null,
  "search": "abc123",
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseContractCountsFiltered": {
      "withOtherWarningType": LoanAndLeaseContractCountsFilteredWithOtherWarningType,
      "withOtherContractStatus": LoanAndLeaseContractCountsFilteredWithOtherContractStatus,
      "withOtherRegTax": LoanAndLeaseContractCountsFilteredWithOtherRegTax,
      "withOtherExpirationStatus": LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus,
      "portfolioCounts": ContractPortfolioCounts
    }
  }
}

Subscriptions

`loanAndLeaseContractSearch`

Description

The list of contracts will be null if the search string is invalid. For the technical details, consult a postgresql implementation of 'to_tsquery' The following permissions are required: One of the following:

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')
All of the following:
- entityIds must be a non-empty array
- the subject 'org' (derived from the argument 'org') must have the 'org' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')
- the subject 'user' (derived from the current caller's auth) must have the 'dealer_reader' relation to all of the 'loanandlease/entity' resources (derived from the argument 'entityIds')

Response

Returns [LoanAndLeaseContract!]

Arguments

Name	Description
`portfolioIds` - `[String!]`	Default = `null`
`expirationStatus` - `LoanAndLeaseExpirationStatus`	A filter that determines if the search should only return contracts with the specified expiration status
`regTaxType` - `LoandAndLeaseRegTaxType`	A filter that determines if the search should only return contracts with the specified reg tax type
`warningType` - `LoandAndLeaseWarningType`	A filter that determines if the search should only return contracts with the specified warning on them
`hasWarning` - `Boolean!`	A filter that determines if the search should only return contracts with warnings on them. Default = `false`
`contractStatus` - `LoanAndLeaseContractStatus`	An optional contract status to filter by
`sortDirection` - `SortDirection!`	Default = `DESC`
`sortBy` - `SortContractBy!`	Default = `CREATED`
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`
`org` - `Org!`	The organization which the action relates to.
`entityIds` - `[UUID!]`

Example

Query

subscription loanAndLeaseContractSearch(
  $portfolioIds: [String!],
  $expirationStatus: LoanAndLeaseExpirationStatus,
  $regTaxType: LoandAndLeaseRegTaxType,
  $warningType: LoandAndLeaseWarningType,
  $hasWarning: Boolean!,
  $contractStatus: LoanAndLeaseContractStatus,
  $sortDirection: SortDirection!,
  $sortBy: SortContractBy!,
  $reverseSearch: String,
  $search: String,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $entityIds: [UUID!],
  $org: Org!,
  $entityIds: [UUID!]
) {
  loanAndLeaseContractSearch(
    portfolioIds: $portfolioIds,
    expirationStatus: $expirationStatus,
    regTaxType: $regTaxType,
    warningType: $warningType,
    hasWarning: $hasWarning,
    contractStatus: $contractStatus,
    sortDirection: $sortDirection,
    sortBy: $sortBy,
    reverseSearch: $reverseSearch,
    search: $search,
    offset: $offset,
    size: $size,
    org: $org,
    entityIds: $entityIds,
    org: $org,
    entityIds: $entityIds
  ) {
    contractId
    dimensionNo
    contractType {
      ... on ContractTypeEconomic {
        ...ContractTypeEconomicFragment
      }
      ... on ContractTypeGeneric {
        ...ContractTypeGenericFragment
      }
    }
    department {
      ... on EconomicDepartment {
        ...EconomicDepartmentFragment
      }
      ... on EconomicDepartmentMissingConfigurationError {
        ...EconomicDepartmentMissingConfigurationErrorFragment
      }
      ... on EconomicDepartmentUnknownError {
        ...EconomicDepartmentUnknownErrorFragment
      }
    }
    portfolio {
      portfolioId
      name
      baseRateId
      bookingStartDate
      periodicInvoiceStartDate
      minEconomicContractId
      maxEconomicContractId
      annuityType
      costs {
        ...LoanAndLeasePortfolioCostsFragment
      }
      retention {
        ...LoanAndLeasePortfolioRetentionFragment
      }
      invoicePrefix
      v2Config {
        ...PortfolioV2ConfigurationFragment
      }
      portfolioV2 {
        ...PortfolioV2Fragment
      }
    }
    annuityStart
    annuityEnd
    adjustEnd
    periodUnit
    baseRate
    internalMarginRate
    externalMarginRate
    fixedRate
    residualValue
    contractStatus
    contractStart
    entities {
      debtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      debtorPbsNoOverride
      coDebtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      repurchaser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      guarantor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      dealer {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      supplier {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      assetUser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
    costs {
      ... on LoanAndLeaseContractCostPayment {
        ...LoanAndLeaseContractCostPaymentFragment
      }
      ... on LoanAndLeaseContractCostDirectPeriodic {
        ...LoanAndLeaseContractCostDirectPeriodicFragment
      }
      ... on LoanAndLeaseContractCostDirectConstant {
        ...LoanAndLeaseContractCostDirectConstantFragment
      }
      ... on LoanAndLeaseContractCostDelete {
        ...LoanAndLeaseContractCostDeleteFragment
      }
      ... on LoanAndLeaseContractCostAnnuityPeriodic {
        ...LoanAndLeaseContractCostAnnuityPeriodicFragment
      }
      ... on LoanAndLeaseAnnuityConstant {
        ...LoanAndLeaseAnnuityConstantFragment
      }
    }
    changeResidualValue {
      date
      residualValue
    }
    changeAnnuityEnd {
      date
      annuityEnd
    }
    changeInterestRate {
      date
      interestRateNominal {
        ...LoanAndLeaseInterestRateNominalFragment
      }
    }
    changeEntities {
      date
      data {
        ...LoanAndLeaseContractEntitiesFragment
      }
    }
    mileageOptions {
      annualMax
      excessRate
    }
    assetOptions {
      vin
      makeModel
      regNo
      firstRegDate
    }
    asset {
      assetId
      vin
      makeModel
      regNo
      firstRegDate
      assetNo
      hasVat
      hasRegTax
      color
      comment
      mileage
      retention {
        ...AssetRetentionFragment
      }
      dmr {
        ...DmrEntryFragment
      }
      dmrAdhoc {
        ...DmrAdhocResultsFragment
      }
      mostRecentDmr {
        ...UnifiedDmrEntryFragment
      }
      id
    }
    periodAlignment
    invoiceText
    sharedInsurancePolicy
    expirationStatus
    regTax {
      ... on LoanAndLeaseRegTaxNone {
        ...LoanAndLeaseRegTaxNoneFragment
      }
      ... on LoanAndLeaseRegTaxFull {
        ...LoanAndLeaseRegTaxFullFragment
      }
      ... on LoanAndLeaseRegTaxProportionate {
        ...LoanAndLeaseRegTaxProportionateFragment
      }
    }
    secondHandVat
    approverInitials
    firstPeriodInvoice
    firstBooking
    collectionMethod
    mailNotification
    report {
      supplierPayable
      asset
      asset2
      asset3
      deposit
      remainder
      debtorRemainders {
        ...LoanAndLeaseContractReportDebtorRemainderFragment
      }
      supplierPayableWarning
      assetWarning
      startDateWarning
      endDateWarning
      anyAccountWarning
      expirationWarning
      annuityExpirationWarning
    }
    retention {
      hidden
      retainUntil
      hasConflicts
    }
    annuityFinalEnd
    computedEndDate
    computedStartDate
    regTaxEndDate
    regTaxStartDate
    comments {
      comment
      created
      createdBy
      author {
        ...UserFragment
      }
    }
    files {
      file {
        ...FileFragment
      }
      category
      caption
      created
      author {
        ...UserFragment
      }
    }
    bookedInvoices {
      header {
        ...LoanAndLeaseBookedInvoiceHeaderFragment
      }
      lines {
        ...LoanAndLeaseBookedInvoiceLineFragment
      }
      contract {
        ...LoanAndLeaseContractFragment
      }
      mails {
        ...EconomicInvoiceMailInfoFragment
      }
      id
    }
    mirrorEntries {
      invoices {
        ...MirrorEntryCasehubInvoiceFragment
      }
      transactions {
        ...MirrorEntryCasehubTransactionFragment
      }
      unclassified {
        ...MirrorTransactionLineFragment
      }
    }
    pmtRoundingType
    annuityType
    bookingState {
      historical {
        ...PortfolioV2HistoricalBookingFragment
      }
      ideal {
        ...BookableFragment
      }
      formattedIdeal {
        ...PortfolioV2FormattedBookingFragment
      }
      difference {
        ...BookableFragment
      }
      formattedDifference {
        ...PortfolioV2FormattedBookingFragment
      }
      noBooking {
        ...BookableFragment
      }
      formattedNoBooking {
        ...PortfolioV2FormattedBookingFragment
      }
      assets {
        ...PortfolioV2AssetProcessFragment
      }
      partitionByBookingDate {
        ...PortfolioV2PartitionedBookingStateFragment
      }
    }
    disabledAssets
    id
  }
}

Variables

{
  "portfolioIds": null,
  "expirationStatus": "PENDING_CUSTOMER",
  "regTaxType": "PROPORTIONATE",
  "warningType": "ANY",
  "hasWarning": false,
  "contractStatus": "DRAFT",
  "sortDirection": "DESC",
  "sortBy": "CREATED",
  "reverseSearch": null,
  "search": "abc123",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme",
  "entityIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ]
}

Response

{
  "data": {
    "loanAndLeaseContractSearch": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "dimensionNo": 123,
        "contractType": ContractTypeEconomic,
        "department": EconomicDepartment,
        "portfolio": LoanAndLeasePortfolio,
        "annuityStart": "2020-07-19",
        "annuityEnd": "2020-07-19",
        "adjustEnd": "2020-07-19",
        "periodUnit": "MONTH",
        "baseRate": "28391719239482739937.1939459927192",
        "internalMarginRate": "28391719239482739937.1939459927192",
        "externalMarginRate": "28391719239482739937.1939459927192",
        "fixedRate": true,
        "residualValue": "28391719239482739937.1939459927192",
        "contractStatus": "DRAFT",
        "contractStart": "2020-07-19",
        "entities": LoanAndLeaseContractEntities,
        "costs": [LoanAndLeaseContractCostPayment],
        "changeResidualValue": [
          LoanAndLeaseContractChangeResidualValue
        ],
        "changeAnnuityEnd": [
          LoanAndLeaseContractChangeAnnuityEnd
        ],
        "changeInterestRate": [
          LoanAndLeaseContractChangeInterestRate
        ],
        "changeEntities": [
          LoanAndLeaseContractChangeEntities
        ],
        "mileageOptions": LoanAndLeaseLimitedMileage,
        "assetOptions": LoanAndLeaseAssetOptions,
        "asset": Asset,
        "periodAlignment": "ALIGNED",
        "invoiceText": "xyz789",
        "sharedInsurancePolicy": true,
        "expirationStatus": "PENDING_CUSTOMER",
        "regTax": LoanAndLeaseRegTaxNone,
        "secondHandVat": true,
        "approverInitials": "xyz789",
        "firstPeriodInvoice": "2020-07-19",
        "firstBooking": "2020-07-19",
        "collectionMethod": "BETALINGSSERVICE",
        "mailNotification": true,
        "report": LoanAndLeaseContractReport,
        "retention": LoanAndLeaseContractRetention,
        "annuityFinalEnd": "2020-07-19",
        "computedEndDate": "2020-07-19",
        "computedStartDate": "2020-07-19",
        "regTaxEndDate": "2020-07-19",
        "regTaxStartDate": "2020-07-19",
        "comments": [LoanAndLeaseContractComment],
        "files": [ContractFile],
        "bookedInvoices": [LoanAndLeaseBookedInvoice],
        "mirrorEntries": MirrorEntryCasehubResult,
        "pmtRoundingType": "NO_ROUNDING",
        "annuityType": "BEGIN",
        "bookingState": PortfolioV2BookingState,
        "disabledAssets": ["xyz789"],
        "id": "4"
      }
    ]
  }
}

Subscriptions

`loanAndLeaseContracts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseContract!]!

Arguments

Name	Description
`contractIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseContracts(
  $contractIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseContracts(
    contractIds: $contractIds,
    org: $org,
    org: $org
  ) {
    contractId
    dimensionNo
    contractType {
      ... on ContractTypeEconomic {
        ...ContractTypeEconomicFragment
      }
      ... on ContractTypeGeneric {
        ...ContractTypeGenericFragment
      }
    }
    department {
      ... on EconomicDepartment {
        ...EconomicDepartmentFragment
      }
      ... on EconomicDepartmentMissingConfigurationError {
        ...EconomicDepartmentMissingConfigurationErrorFragment
      }
      ... on EconomicDepartmentUnknownError {
        ...EconomicDepartmentUnknownErrorFragment
      }
    }
    portfolio {
      portfolioId
      name
      baseRateId
      bookingStartDate
      periodicInvoiceStartDate
      minEconomicContractId
      maxEconomicContractId
      annuityType
      costs {
        ...LoanAndLeasePortfolioCostsFragment
      }
      retention {
        ...LoanAndLeasePortfolioRetentionFragment
      }
      invoicePrefix
      v2Config {
        ...PortfolioV2ConfigurationFragment
      }
      portfolioV2 {
        ...PortfolioV2Fragment
      }
    }
    annuityStart
    annuityEnd
    adjustEnd
    periodUnit
    baseRate
    internalMarginRate
    externalMarginRate
    fixedRate
    residualValue
    contractStatus
    contractStart
    entities {
      debtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      debtorPbsNoOverride
      coDebtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      repurchaser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      guarantor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      dealer {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      supplier {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      assetUser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
    costs {
      ... on LoanAndLeaseContractCostPayment {
        ...LoanAndLeaseContractCostPaymentFragment
      }
      ... on LoanAndLeaseContractCostDirectPeriodic {
        ...LoanAndLeaseContractCostDirectPeriodicFragment
      }
      ... on LoanAndLeaseContractCostDirectConstant {
        ...LoanAndLeaseContractCostDirectConstantFragment
      }
      ... on LoanAndLeaseContractCostDelete {
        ...LoanAndLeaseContractCostDeleteFragment
      }
      ... on LoanAndLeaseContractCostAnnuityPeriodic {
        ...LoanAndLeaseContractCostAnnuityPeriodicFragment
      }
      ... on LoanAndLeaseAnnuityConstant {
        ...LoanAndLeaseAnnuityConstantFragment
      }
    }
    changeResidualValue {
      date
      residualValue
    }
    changeAnnuityEnd {
      date
      annuityEnd
    }
    changeInterestRate {
      date
      interestRateNominal {
        ...LoanAndLeaseInterestRateNominalFragment
      }
    }
    changeEntities {
      date
      data {
        ...LoanAndLeaseContractEntitiesFragment
      }
    }
    mileageOptions {
      annualMax
      excessRate
    }
    assetOptions {
      vin
      makeModel
      regNo
      firstRegDate
    }
    asset {
      assetId
      vin
      makeModel
      regNo
      firstRegDate
      assetNo
      hasVat
      hasRegTax
      color
      comment
      mileage
      retention {
        ...AssetRetentionFragment
      }
      dmr {
        ...DmrEntryFragment
      }
      dmrAdhoc {
        ...DmrAdhocResultsFragment
      }
      mostRecentDmr {
        ...UnifiedDmrEntryFragment
      }
      id
    }
    periodAlignment
    invoiceText
    sharedInsurancePolicy
    expirationStatus
    regTax {
      ... on LoanAndLeaseRegTaxNone {
        ...LoanAndLeaseRegTaxNoneFragment
      }
      ... on LoanAndLeaseRegTaxFull {
        ...LoanAndLeaseRegTaxFullFragment
      }
      ... on LoanAndLeaseRegTaxProportionate {
        ...LoanAndLeaseRegTaxProportionateFragment
      }
    }
    secondHandVat
    approverInitials
    firstPeriodInvoice
    firstBooking
    collectionMethod
    mailNotification
    report {
      supplierPayable
      asset
      asset2
      asset3
      deposit
      remainder
      debtorRemainders {
        ...LoanAndLeaseContractReportDebtorRemainderFragment
      }
      supplierPayableWarning
      assetWarning
      startDateWarning
      endDateWarning
      anyAccountWarning
      expirationWarning
      annuityExpirationWarning
    }
    retention {
      hidden
      retainUntil
      hasConflicts
    }
    annuityFinalEnd
    computedEndDate
    computedStartDate
    regTaxEndDate
    regTaxStartDate
    comments {
      comment
      created
      createdBy
      author {
        ...UserFragment
      }
    }
    files {
      file {
        ...FileFragment
      }
      category
      caption
      created
      author {
        ...UserFragment
      }
    }
    bookedInvoices {
      header {
        ...LoanAndLeaseBookedInvoiceHeaderFragment
      }
      lines {
        ...LoanAndLeaseBookedInvoiceLineFragment
      }
      contract {
        ...LoanAndLeaseContractFragment
      }
      mails {
        ...EconomicInvoiceMailInfoFragment
      }
      id
    }
    mirrorEntries {
      invoices {
        ...MirrorEntryCasehubInvoiceFragment
      }
      transactions {
        ...MirrorEntryCasehubTransactionFragment
      }
      unclassified {
        ...MirrorTransactionLineFragment
      }
    }
    pmtRoundingType
    annuityType
    bookingState {
      historical {
        ...PortfolioV2HistoricalBookingFragment
      }
      ideal {
        ...BookableFragment
      }
      formattedIdeal {
        ...PortfolioV2FormattedBookingFragment
      }
      difference {
        ...BookableFragment
      }
      formattedDifference {
        ...PortfolioV2FormattedBookingFragment
      }
      noBooking {
        ...BookableFragment
      }
      formattedNoBooking {
        ...PortfolioV2FormattedBookingFragment
      }
      assets {
        ...PortfolioV2AssetProcessFragment
      }
      partitionByBookingDate {
        ...PortfolioV2PartitionedBookingStateFragment
      }
    }
    disabledAssets
    id
  }
}

Variables

{
  "contractIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseContracts": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "dimensionNo": 987,
        "contractType": ContractTypeEconomic,
        "department": EconomicDepartment,
        "portfolio": LoanAndLeasePortfolio,
        "annuityStart": "2020-07-19",
        "annuityEnd": "2020-07-19",
        "adjustEnd": "2020-07-19",
        "periodUnit": "MONTH",
        "baseRate": "28391719239482739937.1939459927192",
        "internalMarginRate": "28391719239482739937.1939459927192",
        "externalMarginRate": "28391719239482739937.1939459927192",
        "fixedRate": true,
        "residualValue": "28391719239482739937.1939459927192",
        "contractStatus": "DRAFT",
        "contractStart": "2020-07-19",
        "entities": LoanAndLeaseContractEntities,
        "costs": [LoanAndLeaseContractCostPayment],
        "changeResidualValue": [
          LoanAndLeaseContractChangeResidualValue
        ],
        "changeAnnuityEnd": [
          LoanAndLeaseContractChangeAnnuityEnd
        ],
        "changeInterestRate": [
          LoanAndLeaseContractChangeInterestRate
        ],
        "changeEntities": [
          LoanAndLeaseContractChangeEntities
        ],
        "mileageOptions": LoanAndLeaseLimitedMileage,
        "assetOptions": LoanAndLeaseAssetOptions,
        "asset": Asset,
        "periodAlignment": "ALIGNED",
        "invoiceText": "xyz789",
        "sharedInsurancePolicy": true,
        "expirationStatus": "PENDING_CUSTOMER",
        "regTax": LoanAndLeaseRegTaxNone,
        "secondHandVat": true,
        "approverInitials": "xyz789",
        "firstPeriodInvoice": "2020-07-19",
        "firstBooking": "2020-07-19",
        "collectionMethod": "BETALINGSSERVICE",
        "mailNotification": true,
        "report": LoanAndLeaseContractReport,
        "retention": LoanAndLeaseContractRetention,
        "annuityFinalEnd": "2020-07-19",
        "computedEndDate": "2020-07-19",
        "computedStartDate": "2020-07-19",
        "regTaxEndDate": "2020-07-19",
        "regTaxStartDate": "2020-07-19",
        "comments": [LoanAndLeaseContractComment],
        "files": [ContractFile],
        "bookedInvoices": [LoanAndLeaseBookedInvoice],
        "mirrorEntries": MirrorEntryCasehubResult,
        "pmtRoundingType": "NO_ROUNDING",
        "annuityType": "BEGIN",
        "bookingState": PortfolioV2BookingState,
        "disabledAssets": ["abc123"],
        "id": "4"
      }
    ]
  }
}

Subscriptions

`loanAndLeaseContractsByEconomicIds`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseContract!]!

Arguments

Name	Description
`economicIds` - `[Long!]!`	Must be non-empty.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseContractsByEconomicIds(
  $economicIds: [Long!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseContractsByEconomicIds(
    economicIds: $economicIds,
    org: $org,
    org: $org
  ) {
    contractId
    dimensionNo
    contractType {
      ... on ContractTypeEconomic {
        ...ContractTypeEconomicFragment
      }
      ... on ContractTypeGeneric {
        ...ContractTypeGenericFragment
      }
    }
    department {
      ... on EconomicDepartment {
        ...EconomicDepartmentFragment
      }
      ... on EconomicDepartmentMissingConfigurationError {
        ...EconomicDepartmentMissingConfigurationErrorFragment
      }
      ... on EconomicDepartmentUnknownError {
        ...EconomicDepartmentUnknownErrorFragment
      }
    }
    portfolio {
      portfolioId
      name
      baseRateId
      bookingStartDate
      periodicInvoiceStartDate
      minEconomicContractId
      maxEconomicContractId
      annuityType
      costs {
        ...LoanAndLeasePortfolioCostsFragment
      }
      retention {
        ...LoanAndLeasePortfolioRetentionFragment
      }
      invoicePrefix
      v2Config {
        ...PortfolioV2ConfigurationFragment
      }
      portfolioV2 {
        ...PortfolioV2Fragment
      }
    }
    annuityStart
    annuityEnd
    adjustEnd
    periodUnit
    baseRate
    internalMarginRate
    externalMarginRate
    fixedRate
    residualValue
    contractStatus
    contractStart
    entities {
      debtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      debtorPbsNoOverride
      coDebtor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      repurchaser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      guarantor {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      dealer {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      supplier {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      assetUser {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
    }
    costs {
      ... on LoanAndLeaseContractCostPayment {
        ...LoanAndLeaseContractCostPaymentFragment
      }
      ... on LoanAndLeaseContractCostDirectPeriodic {
        ...LoanAndLeaseContractCostDirectPeriodicFragment
      }
      ... on LoanAndLeaseContractCostDirectConstant {
        ...LoanAndLeaseContractCostDirectConstantFragment
      }
      ... on LoanAndLeaseContractCostDelete {
        ...LoanAndLeaseContractCostDeleteFragment
      }
      ... on LoanAndLeaseContractCostAnnuityPeriodic {
        ...LoanAndLeaseContractCostAnnuityPeriodicFragment
      }
      ... on LoanAndLeaseAnnuityConstant {
        ...LoanAndLeaseAnnuityConstantFragment
      }
    }
    changeResidualValue {
      date
      residualValue
    }
    changeAnnuityEnd {
      date
      annuityEnd
    }
    changeInterestRate {
      date
      interestRateNominal {
        ...LoanAndLeaseInterestRateNominalFragment
      }
    }
    changeEntities {
      date
      data {
        ...LoanAndLeaseContractEntitiesFragment
      }
    }
    mileageOptions {
      annualMax
      excessRate
    }
    assetOptions {
      vin
      makeModel
      regNo
      firstRegDate
    }
    asset {
      assetId
      vin
      makeModel
      regNo
      firstRegDate
      assetNo
      hasVat
      hasRegTax
      color
      comment
      mileage
      retention {
        ...AssetRetentionFragment
      }
      dmr {
        ...DmrEntryFragment
      }
      dmrAdhoc {
        ...DmrAdhocResultsFragment
      }
      mostRecentDmr {
        ...UnifiedDmrEntryFragment
      }
      id
    }
    periodAlignment
    invoiceText
    sharedInsurancePolicy
    expirationStatus
    regTax {
      ... on LoanAndLeaseRegTaxNone {
        ...LoanAndLeaseRegTaxNoneFragment
      }
      ... on LoanAndLeaseRegTaxFull {
        ...LoanAndLeaseRegTaxFullFragment
      }
      ... on LoanAndLeaseRegTaxProportionate {
        ...LoanAndLeaseRegTaxProportionateFragment
      }
    }
    secondHandVat
    approverInitials
    firstPeriodInvoice
    firstBooking
    collectionMethod
    mailNotification
    report {
      supplierPayable
      asset
      asset2
      asset3
      deposit
      remainder
      debtorRemainders {
        ...LoanAndLeaseContractReportDebtorRemainderFragment
      }
      supplierPayableWarning
      assetWarning
      startDateWarning
      endDateWarning
      anyAccountWarning
      expirationWarning
      annuityExpirationWarning
    }
    retention {
      hidden
      retainUntil
      hasConflicts
    }
    annuityFinalEnd
    computedEndDate
    computedStartDate
    regTaxEndDate
    regTaxStartDate
    comments {
      comment
      created
      createdBy
      author {
        ...UserFragment
      }
    }
    files {
      file {
        ...FileFragment
      }
      category
      caption
      created
      author {
        ...UserFragment
      }
    }
    bookedInvoices {
      header {
        ...LoanAndLeaseBookedInvoiceHeaderFragment
      }
      lines {
        ...LoanAndLeaseBookedInvoiceLineFragment
      }
      contract {
        ...LoanAndLeaseContractFragment
      }
      mails {
        ...EconomicInvoiceMailInfoFragment
      }
      id
    }
    mirrorEntries {
      invoices {
        ...MirrorEntryCasehubInvoiceFragment
      }
      transactions {
        ...MirrorEntryCasehubTransactionFragment
      }
      unclassified {
        ...MirrorTransactionLineFragment
      }
    }
    pmtRoundingType
    annuityType
    bookingState {
      historical {
        ...PortfolioV2HistoricalBookingFragment
      }
      ideal {
        ...BookableFragment
      }
      formattedIdeal {
        ...PortfolioV2FormattedBookingFragment
      }
      difference {
        ...BookableFragment
      }
      formattedDifference {
        ...PortfolioV2FormattedBookingFragment
      }
      noBooking {
        ...BookableFragment
      }
      formattedNoBooking {
        ...PortfolioV2FormattedBookingFragment
      }
      assets {
        ...PortfolioV2AssetProcessFragment
      }
      partitionByBookingDate {
        ...PortfolioV2PartitionedBookingStateFragment
      }
    }
    disabledAssets
    id
  }
}

Variables

{
  "economicIds": [9223372036854776000],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseContractsByEconomicIds": [
      {
        "contractId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "dimensionNo": 123,
        "contractType": ContractTypeEconomic,
        "department": EconomicDepartment,
        "portfolio": LoanAndLeasePortfolio,
        "annuityStart": "2020-07-19",
        "annuityEnd": "2020-07-19",
        "adjustEnd": "2020-07-19",
        "periodUnit": "MONTH",
        "baseRate": "28391719239482739937.1939459927192",
        "internalMarginRate": "28391719239482739937.1939459927192",
        "externalMarginRate": "28391719239482739937.1939459927192",
        "fixedRate": true,
        "residualValue": "28391719239482739937.1939459927192",
        "contractStatus": "DRAFT",
        "contractStart": "2020-07-19",
        "entities": LoanAndLeaseContractEntities,
        "costs": [LoanAndLeaseContractCostPayment],
        "changeResidualValue": [
          LoanAndLeaseContractChangeResidualValue
        ],
        "changeAnnuityEnd": [
          LoanAndLeaseContractChangeAnnuityEnd
        ],
        "changeInterestRate": [
          LoanAndLeaseContractChangeInterestRate
        ],
        "changeEntities": [
          LoanAndLeaseContractChangeEntities
        ],
        "mileageOptions": LoanAndLeaseLimitedMileage,
        "assetOptions": LoanAndLeaseAssetOptions,
        "asset": Asset,
        "periodAlignment": "ALIGNED",
        "invoiceText": "abc123",
        "sharedInsurancePolicy": true,
        "expirationStatus": "PENDING_CUSTOMER",
        "regTax": LoanAndLeaseRegTaxNone,
        "secondHandVat": true,
        "approverInitials": "abc123",
        "firstPeriodInvoice": "2020-07-19",
        "firstBooking": "2020-07-19",
        "collectionMethod": "BETALINGSSERVICE",
        "mailNotification": true,
        "report": LoanAndLeaseContractReport,
        "retention": LoanAndLeaseContractRetention,
        "annuityFinalEnd": "2020-07-19",
        "computedEndDate": "2020-07-19",
        "computedStartDate": "2020-07-19",
        "regTaxEndDate": "2020-07-19",
        "regTaxStartDate": "2020-07-19",
        "comments": [LoanAndLeaseContractComment],
        "files": [ContractFile],
        "bookedInvoices": [LoanAndLeaseBookedInvoice],
        "mirrorEntries": MirrorEntryCasehubResult,
        "pmtRoundingType": "NO_ROUNDING",
        "annuityType": "BEGIN",
        "bookingState": PortfolioV2BookingState,
        "disabledAssets": ["abc123"],
        "id": "4"
      }
    ]
  }
}

Subscriptions

`loanAndLeaseEntities`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseEntity!]!

Arguments

Name	Description
`entityIds` - `[UUID!]!`	Must be non-empty.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseEntities(
  $entityIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntities(
    entityIds: $entityIds,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePerson {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishPersonIdentifier {
          ...DanishPersonIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
    ... on LoanAndLeaseCompany {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      vatIdentification {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      ean
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
  }
}

Variables

{
  "entityIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{"data": {"loanAndLeaseEntities": [LoanAndLeasePerson]}}

Subscriptions

`loanAndLeaseEntitiesByEconomicIds`

Description

The number of company and person identifiers must be larger than zero. the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseEntity!]!

Arguments

Name	Description
`economicIds` - `[String!]!`	Must be non-empty.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseEntitiesByEconomicIds(
  $economicIds: [String!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntitiesByEconomicIds(
    economicIds: $economicIds,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePerson {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishPersonIdentifier {
          ...DanishPersonIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
    ... on LoanAndLeaseCompany {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      vatIdentification {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      ean
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
  }
}

Variables

{
  "economicIds": ["abc123"],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseEntitiesByEconomicIds": [
      LoanAndLeasePerson
    ]
  }
}

Subscriptions

`loanAndLeaseEntitiesByIdentifiers`

Description

Response

Returns [LoanAndLeaseEntity!]!

Arguments

Name	Description
`companyIdentifiers` - `[CompanyIdentifierInput!]!`
`personIdentifiers` - `[PersonIdentifierInput!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseEntitiesByIdentifiers(
  $companyIdentifiers: [CompanyIdentifierInput!]!,
  $personIdentifiers: [PersonIdentifierInput!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntitiesByIdentifiers(
    companyIdentifiers: $companyIdentifiers,
    personIdentifiers: $personIdentifiers,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePerson {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishPersonIdentifier {
          ...DanishPersonIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
    ... on LoanAndLeaseCompany {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      vatIdentification {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      ean
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
  }
}

Variables

{
  "companyIdentifiers": [CompanyIdentifierInput],
  "personIdentifiers": [PersonIdentifierInput],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseEntitiesByIdentifiers": [
      LoanAndLeasePerson
    ]
  }
}

Subscriptions

`loanAndLeaseEntityRepresentatives`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseRepresentative!]!

Arguments

Name	Description
`entityIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseEntityRepresentatives(
  $entityIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntityRepresentatives(
    entityIds: $entityIds,
    org: $org,
    org: $org
  ) {
    representativeId
    entityId
    entity {
      ... on LoanAndLeasePerson {
        ...LoanAndLeasePersonFragment
      }
      ... on LoanAndLeaseCompany {
        ...LoanAndLeaseCompanyFragment
      }
    }
    name
    users {
      id
      name
      email
      globalRoles
      organizations {
        ...OrganizationFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
    }
  }
}

Variables

{
  "entityIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseEntityRepresentatives": [
      {
        "representativeId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "entity": LoanAndLeasePerson,
        "name": "abc123",
        "users": [User]
      }
    ]
  }
}

Subscriptions

`loanAndLeaseEntitySearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseEntity!]!

Arguments

Name	Description
`contractEntityTypes` - `[LoanAndLeaseContractEntity!]`	Filter by contract entity type
`sortDirection` - `SortDirection!`	Default = `DESC`
`sortBy` - `LoanAndLeaseSortEntityBy!`	Default = `CREATED`
`reverseSearch` - `String`	An optional suffix search string, searches in the reversed lexemes. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES). Default = `null`
`search` - `String`	An optional prefix search string. Should adhere to 'to_tsquery' in postgresql ( https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES)
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseEntitySearch(
  $contractEntityTypes: [LoanAndLeaseContractEntity!],
  $sortDirection: SortDirection!,
  $sortBy: LoanAndLeaseSortEntityBy!,
  $reverseSearch: String,
  $search: String,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseEntitySearch(
    contractEntityTypes: $contractEntityTypes,
    sortDirection: $sortDirection,
    sortBy: $sortBy,
    reverseSearch: $reverseSearch,
    search: $search,
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePerson {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishPersonIdentifier {
          ...DanishPersonIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
    ... on LoanAndLeaseCompany {
      entityId
      name
      address
      postalCode
      countryCode {
        ... on KnownCountryCode {
          ...KnownCountryCodeFragment
        }
        ... on UnknownCountryCode {
          ...UnknownCountryCodeFragment
        }
      }
      email
      invoiceEmail
      phone
      mobile
      vatIdentification {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      identifiers {
        ... on CountrySpecificValue {
          ...CountrySpecificValueFragment
        }
        ... on DanishCompanyIdentifier {
          ...DanishCompanyIdentifierFragment
        }
      }
      economicId
      economicCreditorId
      ean
      city
      report {
        ...LoanAndLeaseEntityReportFragment
      }
      retention {
        ...LoanAndLeaseEntityRetentionFragment
      }
      roles
      id
    }
  }
}

Variables

{
  "contractEntityTypes": ["DEBTOR"],
  "sortDirection": "DESC",
  "sortBy": "CREATED",
  "reverseSearch": null,
  "search": "abc123",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseEntitySearch": [LoanAndLeasePerson]
  }
}

Subscriptions

`loanAndLeaseInvoiceAggregates`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseInvoiceAggregates!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseInvoiceAggregates(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseInvoiceAggregates(
    org: $org,
    org: $org
  ) {
    completed
    pending
    failed
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseInvoiceAggregates": {
      "completed": 9223372036854776000,
      "pending": 9223372036854776000,
      "failed": 9223372036854776000
    }
  }
}

Subscriptions

`loanAndLeaseInvoiceMailSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [EconomicInvoiceMailInfo!]!

Arguments

Name	Description
`ids` - `[UUID!]`
`statusFilter` - `EconomicInvoiceMailInfoStatus`
`sortDirection` - `SortDirection!`	Default = `DESC`
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseInvoiceMailSearch(
  $ids: [UUID!],
  $statusFilter: EconomicInvoiceMailInfoStatus,
  $sortDirection: SortDirection!,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseInvoiceMailSearch(
    ids: $ids,
    statusFilter: $statusFilter,
    sortDirection: $sortDirection,
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    invoiceId
    invoice {
      header {
        ...LoanAndLeaseBookedInvoiceHeaderFragment
      }
      lines {
        ...LoanAndLeaseBookedInvoiceLineFragment
      }
      contract {
        ...LoanAndLeaseContractFragment
      }
      mails {
        ...EconomicInvoiceMailInfoFragment
      }
      id
    }
    mail {
      id
      sender
      senderName
      subject
      recipients
      cc
      text {
        ...DisplayableResourceFragment
      }
      html {
        ...DisplayableResourceFragment
      }
      status {
        ... on MailSendStatusFailed {
          ...MailSendStatusFailedFragment
        }
        ... on MailSendStatusEnqueued {
          ...MailSendStatusEnqueuedFragment
        }
      }
      statusTimestamp
    }
    status
    computedStatus
    computedStatusTimestamp
  }
}

Variables

{
  "ids": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "statusFilter": "PENDING",
  "sortDirection": "DESC",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseInvoiceMailSearch": [
      {
        "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "invoice": LoanAndLeaseBookedInvoice,
        "mail": MailLogEntry,
        "status": "PENDING",
        "computedStatus": "PENDING",
        "computedStatusTimestamp": 1654109791
      }
    ]
  }
}

Subscriptions

`loanAndLeaseInvoiceSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseInvoiceGroup!]!

Arguments

Name	Description
`bookingStatusFilter` - `LoanAndLeaseBookingStatusFilter`	Filter by booking status
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseInvoiceSearch(
  $bookingStatusFilter: LoanAndLeaseBookingStatusFilter,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseInvoiceSearch(
    bookingStatusFilter: $bookingStatusFilter,
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    invoiceId
    status {
      ... on LoanAndLeaseInvoiceBookingStatusPending {
        ...LoanAndLeaseInvoiceBookingStatusPendingFragment
      }
      ... on LoanAndLeaseInvoiceBookingStatusDiscarded {
        ...LoanAndLeaseInvoiceBookingStatusDiscardedFragment
      }
      ... on LoanAndLeaseInvoiceBookingStatusFailed {
        ...LoanAndLeaseInvoiceBookingStatusFailedFragment
      }
      ... on LoanAndLeaseInvoiceBookingStatusStarted {
        ...LoanAndLeaseInvoiceBookingStatusStartedFragment
      }
      ... on LoanAndLeaseInvoiceBookingStatusCompleted {
        ...LoanAndLeaseInvoiceBookingStatusCompletedFragment
      }
    }
    invoice {
      head {
        ...LoanAndLeasePreviewInvoiceHeadFragment
      }
      lines {
        ...LoanAndLeasePreviewInvoiceLineFragment
      }
    }
    bookedInvoice {
      header {
        ...LoanAndLeaseBookedInvoiceHeaderFragment
      }
      lines {
        ...LoanAndLeaseBookedInvoiceLineFragment
      }
      contract {
        ...LoanAndLeaseContractFragment
      }
      mails {
        ...EconomicInvoiceMailInfoFragment
      }
      id
    }
  }
}

Variables

{
  "bookingStatusFilter": "COMPLETED",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseInvoiceSearch": [
      {
        "invoiceId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "status": LoanAndLeaseInvoiceBookingStatusPending,
        "invoice": LoanAndLeasePreviewInvoice,
        "bookedInvoice": LoanAndLeaseBookedInvoice
      }
    ]
  }
}

Subscriptions

`loanAndLeaseMirrorLastRefreshed`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseMirrorLastRefreshed

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseMirrorLastRefreshed(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseMirrorLastRefreshed(
    org: $org,
    org: $org
  ) {
    mostRecentStatus
    lastRefreshed
    lastSuccessfulRefresh
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseMirrorLastRefreshed": {
      "mostRecentStatus": "RUNNING",
      "lastRefreshed": 1654109791,
      "lastSuccessfulRefresh": 1654109791
    }
  }
}

Subscriptions

`loanAndLeaseMyRepresentatives`

Description

the subject 'user' (derived from the current caller's auth) must have the 'dealer_reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseRepresentative!]!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseMyRepresentatives(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseMyRepresentatives(
    org: $org,
    org: $org
  ) {
    representativeId
    entityId
    entity {
      ... on LoanAndLeasePerson {
        ...LoanAndLeasePersonFragment
      }
      ... on LoanAndLeaseCompany {
        ...LoanAndLeaseCompanyFragment
      }
    }
    name
    users {
      id
      name
      email
      globalRoles
      organizations {
        ...OrganizationFragment
      }
      organizationUsers {
        ...OrganizationUserFragment
      }
    }
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseMyRepresentatives": [
      {
        "representativeId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "entityId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "entity": LoanAndLeasePerson,
        "name": "abc123",
        "users": [User]
      }
    ]
  }
}

Subscriptions

`loanAndLeasePBSDeliveryState`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseDeliveryStateResult!

Arguments

Name	Description
`when` - `YearMonth`	None defaults to current server time.
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePBSDeliveryState(
  $when: YearMonth,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePBSDeliveryState(
    when: $when,
    org: $org,
    org: $org
  ) {
    state {
      deliveryId
      requestData {
        ...DisplayableResourceFragment
      }
      invoices {
        ...LoanAndLeasePBSDeliveryFragment
      }
      vResponse {
        ...LoanAndLeasePBSResponseFragment
      }
      tResponse {
        ...LoanAndLeasePBSResponseFragment
      }
      abResponse {
        ...LoanAndLeasePBSResponseFragment
      }
    }
    detachedPaymentStatuses {
      customerNo
      paymentStatuses {
        ...LoanAndLeasePBSPaymentFragment
      }
    }
  }
}

Variables

{
  "when": "2007-12",
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePBSDeliveryState": {
      "state": [LoanAndLeasePBSDeliveryState],
      "detachedPaymentStatuses": [
        LoanAndLeasePBSDetachedPayment
      ]
    }
  }
}

Subscriptions

`loanAndLeasePortfolio`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeasePortfolio!]!

Arguments

Name	Description
`portfolioIds` - `[String!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePortfolio(
  $portfolioIds: [String!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePortfolio(
    portfolioIds: $portfolioIds,
    org: $org,
    org: $org
  ) {
    portfolioId
    name
    baseRateId
    bookingStartDate
    periodicInvoiceStartDate
    minEconomicContractId
    maxEconomicContractId
    annuityType
    costs {
      costId {
        ... on LoanAndLeaseIntrinsicCostId {
          ...LoanAndLeaseIntrinsicCostIdFragment
        }
        ... on LoanAndLeaseUserDefinedCostId {
          ...LoanAndLeaseUserDefinedCostIdFragment
        }
      }
      account
      productNo
      entryText
      expenseCostId
      incomeCostId
      showMethod
      principalAccount
      isAccruedIncome
    }
    retention {
      hidden
      retainUntil
      hasConflicts
    }
    invoicePrefix
    v2Config {
      indefinite
      invoicePrefix
      pmtRoundingType
    }
    portfolioV2 {
      costs {
        ...PortfolioV2CostFragment
      }
      assets {
        ...PortfolioV2AssetFragment
      }
      accounts {
        ...PortfolioV2AccountFragment
      }
      products {
        ...PortfolioV2ProductFragment
      }
    }
  }
}

Variables

{
  "portfolioIds": ["xyz789"],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePortfolio": [
      {
        "portfolioId": "abc123",
        "name": "abc123",
        "baseRateId": "xyz789",
        "bookingStartDate": "2020-07-19",
        "periodicInvoiceStartDate": "2020-07-19",
        "minEconomicContractId": 9223372036854776000,
        "maxEconomicContractId": 9223372036854776000,
        "annuityType": "BEGIN",
        "costs": [LoanAndLeasePortfolioCosts],
        "retention": LoanAndLeasePortfolioRetention,
        "invoicePrefix": "xyz789",
        "v2Config": PortfolioV2Configuration,
        "portfolioV2": PortfolioV2
      }
    ]
  }
}

Subscriptions

`loanAndLeasePortfolioDeletionConflicts`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeasePortfolioDeletionRelatedToContractConflict!]!

Arguments

Name	Description
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`portfolioIds` - `[String!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePortfolioDeletionConflicts(
  $offset: Long!,
  $size: Long!,
  $portfolioIds: [String!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePortfolioDeletionConflicts(
    offset: $offset,
    size: $size,
    portfolioIds: $portfolioIds,
    org: $org,
    org: $org
  ) {
    contract {
      contractId
      dimensionNo
      contractType {
        ... on ContractTypeEconomic {
          ...ContractTypeEconomicFragment
        }
        ... on ContractTypeGeneric {
          ...ContractTypeGenericFragment
        }
      }
      department {
        ... on EconomicDepartment {
          ...EconomicDepartmentFragment
        }
        ... on EconomicDepartmentMissingConfigurationError {
          ...EconomicDepartmentMissingConfigurationErrorFragment
        }
        ... on EconomicDepartmentUnknownError {
          ...EconomicDepartmentUnknownErrorFragment
        }
      }
      portfolio {
        ...LoanAndLeasePortfolioFragment
      }
      annuityStart
      annuityEnd
      adjustEnd
      periodUnit
      baseRate
      internalMarginRate
      externalMarginRate
      fixedRate
      residualValue
      contractStatus
      contractStart
      entities {
        ...LoanAndLeaseContractEntitiesFragment
      }
      costs {
        ... on LoanAndLeaseContractCostPayment {
          ...LoanAndLeaseContractCostPaymentFragment
        }
        ... on LoanAndLeaseContractCostDirectPeriodic {
          ...LoanAndLeaseContractCostDirectPeriodicFragment
        }
        ... on LoanAndLeaseContractCostDirectConstant {
          ...LoanAndLeaseContractCostDirectConstantFragment
        }
        ... on LoanAndLeaseContractCostDelete {
          ...LoanAndLeaseContractCostDeleteFragment
        }
        ... on LoanAndLeaseContractCostAnnuityPeriodic {
          ...LoanAndLeaseContractCostAnnuityPeriodicFragment
        }
        ... on LoanAndLeaseAnnuityConstant {
          ...LoanAndLeaseAnnuityConstantFragment
        }
      }
      changeResidualValue {
        ...LoanAndLeaseContractChangeResidualValueFragment
      }
      changeAnnuityEnd {
        ...LoanAndLeaseContractChangeAnnuityEndFragment
      }
      changeInterestRate {
        ...LoanAndLeaseContractChangeInterestRateFragment
      }
      changeEntities {
        ...LoanAndLeaseContractChangeEntitiesFragment
      }
      mileageOptions {
        ...LoanAndLeaseLimitedMileageFragment
      }
      assetOptions {
        ...LoanAndLeaseAssetOptionsFragment
      }
      asset {
        ...AssetFragment
      }
      periodAlignment
      invoiceText
      sharedInsurancePolicy
      expirationStatus
      regTax {
        ... on LoanAndLeaseRegTaxNone {
          ...LoanAndLeaseRegTaxNoneFragment
        }
        ... on LoanAndLeaseRegTaxFull {
          ...LoanAndLeaseRegTaxFullFragment
        }
        ... on LoanAndLeaseRegTaxProportionate {
          ...LoanAndLeaseRegTaxProportionateFragment
        }
      }
      secondHandVat
      approverInitials
      firstPeriodInvoice
      firstBooking
      collectionMethod
      mailNotification
      report {
        ...LoanAndLeaseContractReportFragment
      }
      retention {
        ...LoanAndLeaseContractRetentionFragment
      }
      annuityFinalEnd
      computedEndDate
      computedStartDate
      regTaxEndDate
      regTaxStartDate
      comments {
        ...LoanAndLeaseContractCommentFragment
      }
      files {
        ...ContractFileFragment
      }
      bookedInvoices {
        ...LoanAndLeaseBookedInvoiceFragment
      }
      mirrorEntries {
        ...MirrorEntryCasehubResultFragment
      }
      pmtRoundingType
      annuityType
      bookingState {
        ...PortfolioV2BookingStateFragment
      }
      disabledAssets
      id
    }
  }
}

Variables

{
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "portfolioIds": ["abc123"],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePortfolioDeletionConflicts": [
      {"contract": LoanAndLeaseContract}
    ]
  }
}

Subscriptions

`loanAndLeasePortfolioSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeasePortfolio!]!

Arguments

Name	Description
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePortfolioSearch(
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePortfolioSearch(
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    portfolioId
    name
    baseRateId
    bookingStartDate
    periodicInvoiceStartDate
    minEconomicContractId
    maxEconomicContractId
    annuityType
    costs {
      costId {
        ... on LoanAndLeaseIntrinsicCostId {
          ...LoanAndLeaseIntrinsicCostIdFragment
        }
        ... on LoanAndLeaseUserDefinedCostId {
          ...LoanAndLeaseUserDefinedCostIdFragment
        }
      }
      account
      productNo
      entryText
      expenseCostId
      incomeCostId
      showMethod
      principalAccount
      isAccruedIncome
    }
    retention {
      hidden
      retainUntil
      hasConflicts
    }
    invoicePrefix
    v2Config {
      indefinite
      invoicePrefix
      pmtRoundingType
    }
    portfolioV2 {
      costs {
        ...PortfolioV2CostFragment
      }
      assets {
        ...PortfolioV2AssetFragment
      }
      accounts {
        ...PortfolioV2AccountFragment
      }
      products {
        ...PortfolioV2ProductFragment
      }
    }
  }
}

Variables

{
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePortfolioSearch": [
      {
        "portfolioId": "abc123",
        "name": "abc123",
        "baseRateId": "abc123",
        "bookingStartDate": "2020-07-19",
        "periodicInvoiceStartDate": "2020-07-19",
        "minEconomicContractId": 9223372036854776000,
        "maxEconomicContractId": 9223372036854776000,
        "annuityType": "BEGIN",
        "costs": [LoanAndLeasePortfolioCosts],
        "retention": LoanAndLeasePortfolioRetention,
        "invoicePrefix": "abc123",
        "v2Config": PortfolioV2Configuration,
        "portfolioV2": PortfolioV2
      }
    ]
  }
}

Subscriptions

`loanAndLeasePreviewAllBooking`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePreviewBookingResult!

Arguments

Name	Description
`portfolioIds` - `[String!]!`	Default = `[]`
`date` - `LocalDate!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePreviewAllBooking(
  $portfolioIds: [String!]!,
  $date: LocalDate!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePreviewAllBooking(
    portfolioIds: $portfolioIds,
    date: $date,
    org: $org,
    org: $org
  ) {
    errors {
      ... on LoanAndLeaseBookingParamsNotNewestError {
        ...LoanAndLeaseBookingParamsNotNewestErrorFragment
      }
      ... on LoanAndLeaseContractMissingDimensionNoError {
        ...LoanAndLeaseContractMissingDimensionNoErrorFragment
      }
      ... on LoanAndLeaseCostMissingConfigError {
        ...LoanAndLeaseCostMissingConfigErrorFragment
      }
      ... on LoanAndLeaseCostMissingProductNoError {
        ...LoanAndLeaseCostMissingProductNoErrorFragment
      }
      ... on LoanAndLeaseEntityMissingDebtorNoError {
        ...LoanAndLeaseEntityMissingDebtorNoErrorFragment
      }
      ... on LoanAndLeaseContractNotActiveError {
        ...LoanAndLeaseContractNotActiveErrorFragment
      }
      ... on LoanAndLeaseInvalidContractStateError {
        ...LoanAndLeaseInvalidContractStateErrorFragment
      }
    }
    previews {
      bookingParams {
        ...LoanAndLeaseBookingParamsFragment
      }
      booking {
        ...LoanAndLeaseBookingByDateFragment
      }
      pending {
        ...LoanAndLeaseBookingByDateFragment
      }
      failed {
        ...LoanAndLeaseBookingByDateFragment
      }
      noBooking {
        ...LoanAndLeaseBookingByDateFragment
      }
      previous {
        ...LoanAndLeaseBookingByDateFragment
      }
      future {
        ...LoanAndLeaseBookingByDateFragment
      }
      annuityStart {
        ...LoanAndLeaseBookingByDateFragment
      }
      annuityPeriodic {
        ...LoanAndLeaseBookingByDateFragment
      }
      directStart {
        ...LoanAndLeaseBookingByDateFragment
      }
      directPeriodic {
        ...LoanAndLeaseBookingByDateFragment
      }
    }
  }
}

Variables

{
  "portfolioIds": [""],
  "date": "2020-07-19",
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePreviewAllBooking": {
      "errors": [LoanAndLeaseBookingParamsNotNewestError],
      "previews": [LoanAndLeasePreviewBooking]
    }
  }
}

Subscriptions

`loanAndLeasePreviewBooking`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePreviewBookingOutcome!

Arguments

Name	Description
`date` - `LocalDate!`
`contractIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePreviewBooking(
  $date: LocalDate!,
  $contractIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePreviewBooking(
    date: $date,
    contractIds: $contractIds,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePreviewError {
      error
    }
    ... on LoanAndLeasePreviewBookingResult {
      errors {
        ... on LoanAndLeaseBookingParamsNotNewestError {
          ...LoanAndLeaseBookingParamsNotNewestErrorFragment
        }
        ... on LoanAndLeaseContractMissingDimensionNoError {
          ...LoanAndLeaseContractMissingDimensionNoErrorFragment
        }
        ... on LoanAndLeaseCostMissingConfigError {
          ...LoanAndLeaseCostMissingConfigErrorFragment
        }
        ... on LoanAndLeaseCostMissingProductNoError {
          ...LoanAndLeaseCostMissingProductNoErrorFragment
        }
        ... on LoanAndLeaseEntityMissingDebtorNoError {
          ...LoanAndLeaseEntityMissingDebtorNoErrorFragment
        }
        ... on LoanAndLeaseContractNotActiveError {
          ...LoanAndLeaseContractNotActiveErrorFragment
        }
        ... on LoanAndLeaseInvalidContractStateError {
          ...LoanAndLeaseInvalidContractStateErrorFragment
        }
      }
      previews {
        ...LoanAndLeasePreviewBookingFragment
      }
    }
  }
}

Variables

{
  "date": "2020-07-19",
  "contractIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePreviewBooking": LoanAndLeasePreviewError
  }
}

Subscriptions

`loanAndLeasePreviewBookingDetailed`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeasePreviewBookingDetailedOutcome!

Arguments

Name	Description
`date` - `LocalDate!`
`contractIds` - `[UUID!]!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePreviewBookingDetailed(
  $date: LocalDate!,
  $contractIds: [UUID!]!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePreviewBookingDetailed(
    date: $date,
    contractIds: $contractIds,
    org: $org,
    org: $org
  ) {
    ... on LoanAndLeasePreviewError {
      error
    }
    ... on LoanAndLeasePreviewBookingDetailedResult {
      errors {
        ... on LoanAndLeaseBookingParamsNotNewestError {
          ...LoanAndLeaseBookingParamsNotNewestErrorFragment
        }
        ... on LoanAndLeaseContractMissingDimensionNoError {
          ...LoanAndLeaseContractMissingDimensionNoErrorFragment
        }
        ... on LoanAndLeaseCostMissingConfigError {
          ...LoanAndLeaseCostMissingConfigErrorFragment
        }
        ... on LoanAndLeaseCostMissingProductNoError {
          ...LoanAndLeaseCostMissingProductNoErrorFragment
        }
        ... on LoanAndLeaseEntityMissingDebtorNoError {
          ...LoanAndLeaseEntityMissingDebtorNoErrorFragment
        }
        ... on LoanAndLeaseContractNotActiveError {
          ...LoanAndLeaseContractNotActiveErrorFragment
        }
        ... on LoanAndLeaseInvalidContractStateError {
          ...LoanAndLeaseInvalidContractStateErrorFragment
        }
      }
      previews {
        ...LoanAndLeasePreviewBookingDetailedFragment
      }
    }
  }
}

Variables

{
  "date": "2020-07-19",
  "contractIds": [
    "a79dd2da-a9b2-4394-9c11-36c375346bc7"
  ],
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeasePreviewBookingDetailed": LoanAndLeasePreviewError
  }
}

Subscriptions

`loanAndLeasePrtRate`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeasePrtRate!]!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeasePrtRate(
  $org: Org!,
  $org: Org!
) {
  loanAndLeasePrtRate(
    org: $org,
    org: $org
  ) {
    date
    prtRate
    id
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeasePrtRate": [
      {
        "date": "2020-07-19",
        "prtRate": "28391719239482739937.1939459927192",
        "id": "4"
      }
    ]
  }
}

Subscriptions

`loanAndLeaseTransactionAggregates`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns a LoanAndLeaseTransactionAggregates!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseTransactionAggregates(
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseTransactionAggregates(
    org: $org,
    org: $org
  ) {
    completed
    pending
    failed
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "loanAndLeaseTransactionAggregates": {
      "completed": 9223372036854776000,
      "pending": 9223372036854776000,
      "failed": 9223372036854776000
    }
  }
}

Subscriptions

`loanAndLeaseTransactionSearch`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseTransactionGroup!]!

Arguments

Name	Description
`bookingStatusFilter` - `LoanAndLeaseBookingStatusFilter`	Filter by booking status
`offset` - `Long!`	What offset to start the search at
`size` - `Long!`	The page size
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseTransactionSearch(
  $bookingStatusFilter: LoanAndLeaseBookingStatusFilter,
  $offset: Long!,
  $size: Long!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseTransactionSearch(
    bookingStatusFilter: $bookingStatusFilter,
    offset: $offset,
    size: $size,
    org: $org,
    org: $org
  ) {
    transactionBatchId
    status {
      ... on LoanAndLeaseTransactionGroupBookingStatusDiscarded {
        ...LoanAndLeaseTransactionGroupBookingStatusDiscardedFragment
      }
      ... on LoanAndLeaseTransactionGroupBookingStatusFailed {
        ...LoanAndLeaseTransactionGroupBookingStatusFailedFragment
      }
      ... on LoanAndLeaseTransactionGroupBookingStatusPending {
        ...LoanAndLeaseTransactionGroupBookingStatusPendingFragment
      }
      ... on LoanAndLeaseTransactionGroupBookingStatusCompleted {
        ...LoanAndLeaseTransactionGroupBookingStatusCompletedFragment
      }
    }
    transactions {
      transactionId
      transaction {
        ...LoanAndLeasePreviewTransactionFragment
      }
    }
  }
}

Variables

{
  "bookingStatusFilter": "COMPLETED",
  "offset": 9223372036854776000,
  "size": 9223372036854776000,
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseTransactionSearch": [
      {
        "transactionBatchId": "a79dd2da-a9b2-4394-9c11-36c375346bc7",
        "status": LoanAndLeaseTransactionGroupBookingStatusDiscarded,
        "transactions": [LoanAndLeaseTransactionEntry]
      }
    ]
  }
}

Subscriptions

`loanAndLeaseUserRepresentatives`

Description

the subject 'user' (derived from the current caller's auth) must have the 'reader' relation to the 'org' resource (derived from the argument 'org')

Response

Returns [LoanAndLeaseAdministratedRepresentative!]!

Arguments

Name	Description
`userId` - `UserId!`
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription loanAndLeaseUserRepresentatives(
  $userId: UserId!,
  $org: Org!,
  $org: Org!
) {
  loanAndLeaseUserRepresentatives(
    userId: $userId,
    org: $org,
    org: $org
  ) {
    representative {
      representativeId
      entityId
      entity {
        ... on LoanAndLeasePerson {
          ...LoanAndLeasePersonFragment
        }
        ... on LoanAndLeaseCompany {
          ...LoanAndLeaseCompanyFragment
        }
      }
      name
      users {
        ...UserFragment
      }
    }
    disabled
  }
}

Variables

{
  "userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
  "org": "acme"
}

Response

{
  "data": {
    "loanAndLeaseUserRepresentatives": [
      {
        "representative": LoanAndLeaseRepresentative,
        "disabled": true
      }
    ]
  }
}

Subscriptions

`orgConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'manager' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an OrgConfig!

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription orgConfig(
  $org: Org!,
  $org: Org!
) {
  orgConfig(
    org: $org,
    org: $org
  ) {
    assetNoRequired
  }
}

Variables

{"org": "acme"}

Response

{"data": {"orgConfig": {"assetNoRequired": true}}}

Subscriptions

`pbsConfig`

Description

the subject 'user' (derived from the current caller's auth) must have the 'config' relation to the 'org' resource (derived from the argument 'org')

Response

Returns an PBSConfig

Arguments

Name	Description
`org` - `Org!`	The organization which the action relates to.
`org` - `Org!`	The organization which the action relates to.

Example

Query

subscription pbsConfig(
  $org: Org!,
  $org: Org!
) {
  pbsConfig(
    org: $org,
    org: $org
  ) {
    pbsNumber
    cvr
    deliveryIdOffset
    debtorGroupNo
    companyInfo
  }
}

Variables

{"org": "acme"}

Response

{
  "data": {
    "pbsConfig": {
      "pbsNumber": 987,
      "cvr": "35890270",
      "deliveryIdOffset": 9223372036854776000,
      "debtorGroupNo": "xyz789",
      "companyInfo": "xyz789"
    }
  }
}

Documentation by Anvil SpectaQL