CaseHub API Reference
API Endpoints
https://api.casehub.dk/graphqlHeaders
Authorization: Bearer <YOUR_TOKEN_HERE>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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"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
}
}
}
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
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkCaseForDebtor": {
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"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
}
}
}
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
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": "xyz789",
"privacyPolicyLink": "abc123"
}
}
}
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
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkCreditroGetCaseData": {
"status": CreditlinkCreditroCaseStatusSuccess
}
}
}
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
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"
}
}
}
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
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
]
}
}
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
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkMonthioGetCaseData": {
"status": CreditlinkMonthioCaseStatusSuccess
}
}
}
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
Example
Query
query creditlinkMonthioGetConfig(
$org: Org!,
$org: Org!
) {
creditlinkMonthioGetConfig(
org: $org,
org: $org
) {
enabled
smartCheckConfigurationId
}
}
Variables
{"org": "acme"}
Response
{
"data": {
"creditlinkMonthioGetConfig": {
"enabled": true,
"smartCheckConfigurationId": 987
}
}
}
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
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": "xyz789",
"mailTemplatePlaintext": "abc123",
"mailTemplateHtml": "abc123",
"smsTemplate": "xyz789"
}
}
}
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!
Example
Query
query creditlinkReport(
$caseId: UUID!,
$org: Org!,
$org: Org!
) {
creditlinkReport(
caseId: $caseId,
org: $org,
org: $org
) {
resource
contentType
thumbnail
}
}
Variables
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkReport": {
"resource": "https://domain.com/resource",
"contentType": "abc123",
"thumbnail": "https://domain.com/resource"
}
}
}
cvrCompanyData
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
[CvrData!]!
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": "abc123",
"postalCode": "abc123",
"city": "xyz789",
"district": "xyz789",
"companyCreationDate": "2020-07-19",
"companyType": "abc123",
"bindingAgreement": "xyz789",
"management": [CvrParticipant],
"boardMembers": [CvrParticipant],
"owners": [CvrParticipant],
"participants": [CvrParticipant]
}
]
}
}
cvrFreeTextSearch
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
[CvrSearchResult!]!
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"
}
]
}
}
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!
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
}
}
}
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
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": "abc123",
"leasingConsentCode": "abc123",
"loanConsentCode": "xyz789"
}
}
}
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!
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"
}
}
}
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!
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": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
Response
{"data": {"eskatToken": "xyz789"}}
loanAndLeaseCollectionPeriod
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
LoanAndLeaseCollectionPeriod!
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
}
}
}
loanAndLeaseContractSearchExport
Description
The following permissions are required: One of the following:
- the subject 'user' (derived from the current caller's auth) must have the 'manager' 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 |
|---|---|
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(
$expirationStatus: LoanAndLeaseExpirationStatus,
$regTaxType: LoandAndLeaseRegTaxType,
$warningType: LoandAndLeaseWarningType,
$hasWarning: Boolean!,
$contractStatus: LoanAndLeaseContractStatus,
$reverseSearch: String,
$search: String,
$org: Org!,
$entityIds: [UUID!],
$org: Org!,
$entityIds: [UUID!]
) {
loanAndLeaseContractSearchExport(
expirationStatus: $expirationStatus,
regTaxType: $regTaxType,
warningType: $warningType,
hasWarning: $hasWarning,
contractStatus: $contractStatus,
reverseSearch: $reverseSearch,
search: $search,
org: $org,
entityIds: $entityIds,
org: $org,
entityIds: $entityIds
)
}
Variables
{
"expirationStatus": "PENDING_CUSTOMER",
"regTaxType": "PROPORTIONATE",
"warningType": "ANY",
"hasWarning": false,
"contractStatus": "DRAFT",
"reverseSearch": null,
"search": "abc123",
"org": "acme",
"entityIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
Response
{
"data": {
"loanAndLeaseContractSearchExport": "https://domain.com/resource"
}
}
loanAndLeasePreviewCollection
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
LoanAndLeasePreviewCollectionOutcome!
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"extended": true,
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePreviewCollection": LoanAndLeasePreviewCollectionError
}
}
node
nodes
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!]!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"nordigenAggregatedData": [
{
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"values": NordigenAggregatedValues,
"maxMonth": "2007-12",
"months": 123,
"accounts": [NordigenAccount]
}
]
}
}
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!]!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"nordigenCategories": [
{"categoryId": 987, "title": "abc123"}
]
}
}
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!]!
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"
}
]
}
}
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!
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": ["CONTRACT_READER"],
"mutableRoles": ["APPROVER"]
}
}
}
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
Example
Query
query reportingConfig(
$org: Org!,
$org: Org!
) {
reportingConfig(
org: $org,
org: $org
) {
expirationWarningDays
}
}
Variables
{"org": "acme"}
Response
{"data": {"reportingConfig": {"expirationWarningDays": 123}}}
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]
}
}
}
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": "abc123",
"email": "john@gmail.com",
"globalRoles": ["ADMIN"],
"organizations": [Organization],
"organizationUsers": [OrganizationUser]
}
]
}
}
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!
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": "xyz789"
}
}
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"addEntityRoles": true}}
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": ["APPROVER"],
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"org": "acme"
}
Response
{
"data": {
"addRoles": {
"id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"name": "xyz789",
"email": "john@gmail.com",
"globalRoles": ["ADMIN"],
"organizations": [Organization],
"organizationUsers": [OrganizationUser]
}
}
}
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
}
}
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
}
}
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
}
}
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
}
}
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 AssetCreationVinAlreadyExists {
...AssetCreationVinAlreadyExistsFragment
}
}
}
... on AssetCreationSuccess {
assets {
...AssetFragment
}
}
}
}
Variables
{
"assets": [AssetInput],
"org": "acme"
}
Response
{"data": {"createAssets": AssetCreationFailure}}
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
}
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
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
}
}
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
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
}
}
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
}
}
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
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
}
}
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]
}
}
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkAppendProofOfIdentity": true}}
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!
Example
Query
mutation creditlinkApproverCloseCase(
$caseId: UUID!,
$org: Org!,
$org: Org!
) {
creditlinkApproverCloseCase(
caseId: $caseId,
org: $org,
org: $org
)
}
Variables
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkApproverCloseCase": "OPEN"}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkApproverDisposableIncome": 42}}
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!
Example
Query
mutation creditlinkApproverReopenCase(
$caseId: UUID!,
$org: Org!,
$org: Org!
) {
creditlinkApproverReopenCase(
caseId: $caseId,
org: $org,
org: $org
)
}
Variables
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkApproverReopenCase": "OPEN"}}
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}}
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!
Example
Query
mutation creditlinkComment(
$comment: String!,
$caseId: UUID!,
$org: Org!,
$org: Org!
) {
creditlinkComment(
comment: $comment,
caseId: $caseId,
org: $org,
org: $org
)
}
Variables
{
"comment": "xyz789",
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkComment": 42}}
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!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkComplianceAnswer": true}}
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": "abc123",
"customerServiceId": "xyz789",
"clientManagerEmail": "john@gmail.com"
}
}
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkDebtorCloseCase": "OPEN"}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkDebtorDisposableIncome": true}}
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!
Example
Query
mutation creditlinkDeleteCase(
$caseId: UUID!,
$org: Org!,
$org: Org!
) {
creditlinkDeleteCase(
caseId: $caseId,
org: $org,
org: $org
)
}
Variables
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkDeleteCase": true}}
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
}
}
}
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}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkProofOfIdentityStatus": true}}
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!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkRetentionDate": true}}
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!
Example
Query
mutation creditlinkRevokeConsent(
$caseId: UUID!,
$org: Org!,
$caseId: UUID!
) {
creditlinkRevokeConsent(
caseId: $caseId,
org: $org,
caseId: $caseId
)
}
Variables
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkRevokeConsent": true}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkSendEmail": true}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"creditlinkSendSms": true}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkSetUsers": {
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"externalId": "0110293",
"dealerName": "xyz789",
"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
}
}
}
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!
Example
Query
mutation creditlinkZenixUrl(
$org: Org!,
$org: Org!
) {
creditlinkZenixUrl(
org: $org,
org: $org
)
}
Variables
{"org": "acme"}
Response
{
"data": {
"creditlinkZenixUrl": "https://domain.com/resource"
}
}
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
}
}
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!
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": "xyz789",
"org": "acme"
}
Response
{"data": {"cvrSecrets": true}}
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}}
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}}
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}}
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}}
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
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"comments": [LoanAndLeaseContractComment]
}
]
}
}
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
}
}
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
}
}
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}}
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
}
}
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!
Example
Query
mutation loanAndLeaseDiscardInvoices(
$invoiceIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseDiscardInvoices(
invoiceIds: $invoiceIds,
org: $org,
org: $org
)
}
Variables
{
"invoiceIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseDiscardInvoices": true}}
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!
Example
Query
mutation loanAndLeaseDiscardTransactionGroups(
$transactionGroupIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseDiscardTransactionGroups(
transactionGroupIds: $transactionGroupIds,
org: $org,
org: $org
)
}
Variables
{
"transactionGroupIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseDiscardTransactionGroups": true}}
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
}
}
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}}
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
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
}
}
}
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!
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"extended": true,
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePbsCollect": LoanAndLeasePBSCollectionStructuredResult
}
}
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}}
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!
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseRemoveContractFiles": RemoveContractFilesSuccess
}
}
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}}
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
Example
Query
mutation loanAndLeaseRemoveRepresentatives(
$representatives: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseRemoveRepresentatives(
representatives: $representatives,
org: $org,
org: $org
)
}
Variables
{
"representatives": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseRemoveRepresentatives": "REPRESENTATIVE_NOT_FOUND"}}
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!
Example
Query
mutation loanAndLeaseRetryInvoices(
$invoiceIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseRetryInvoices(
invoiceIds: $invoiceIds,
org: $org,
org: $org
)
}
Variables
{
"invoiceIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseRetryInvoices": true}}
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!
Example
Query
mutation loanAndLeaseRetryTransactions(
$transactionIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseRetryTransactions(
transactionIds: $transactionIds,
org: $org,
org: $org
)
}
Variables
{
"transactionIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseRetryTransactions": true}}
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!
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}}
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!]!
Example
Query
mutation loanAndLeaseSendInvoiceMail(
$invoiceIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseSendInvoiceMail(
invoiceIds: $invoiceIds,
org: $org,
org: $org
)
}
Variables
{
"invoiceIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseSendInvoiceMail": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
}
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
}
]
}
}
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
}
]
}
}
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
}
}
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
}
}
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}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"nordigenLink": "https://domain.com/resource"
}
}
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}}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{"data": {"removeEntityRoles": true}}
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": ["APPROVER"],
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"org": "acme"
}
Response
{
"data": {
"removeRoles": {
"id": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"name": "xyz789",
"email": "john@gmail.com",
"globalRoles": ["ADMIN"],
"organizations": [Organization],
"organizationUsers": [OrganizationUser]
}
}
}
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": 987}}}
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
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]
}
}
}
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}}
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}}
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 AssetUpdateVinAlreadyExists {
...AssetUpdateVinAlreadyExistsFragment
}
... on AssetUpdateIdDoesNotExist {
...AssetUpdateIdDoesNotExistFragment
}
}
}
... on AssetUpdateSuccess {
assets {
...AssetFragment
}
}
}
}
Variables
{
"assets": [AssetUpdateInput],
"org": "acme"
}
Response
{"data": {"setAssets": AssetUpdateError}}
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
}
}
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
}
}
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
AddContractFilesContractNotFoundError
Fields
| Field Name | Description |
|---|---|
contracts -
[LoanAndLeaseContract!]!
|
Example
{"contracts": [LoanAndLeaseContract]}
AddContractFilesOutcome
Types
| Union Types |
|---|
Example
AddContractFilesSuccess
AddContractFilesSuccess
Fields
| Field Name | Description |
|---|---|
contracts -
[LoanAndLeaseContract!]!
|
Example
{"contracts": [LoanAndLeaseContract]}
AppPortalAccess
Asset
Description
Requires the caller to have the 'manager' permission to the 'org' resource, to query any field on this type unless otherwise specified on a field.
Example
{
"assetId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"vin": "xyz789",
"makeModel": "abc123",
"regNo": "abc123",
"firstRegDate": "2020-07-19",
"retention": AssetRetention,
"id": "4"
}
AssetCreationError
Types
| Union Types |
|---|
Example
AssetCreationVinAlreadyExists
AssetCreationFailure
Fields
| Field Name | Description |
|---|---|
errors -
[AssetCreationError!]!
|
Example
{"errors": [AssetCreationVinAlreadyExists]}
AssetCreationSuccess
Fields
| Field Name | Description |
|---|---|
assets -
[Asset!]!
|
Example
{"assets": [Asset]}
AssetCreationVinAlreadyExists
AssetInput
AssetRetention
Fields
| Field Name | Description |
|---|---|
contractRelations -
[LoanAndLeaseContract!]!
|
|
hidden -
Boolean!
|
|
retainUntil -
Instant
|
|
hasConflicts -
Boolean!
|
Example
{
"contractRelations": [LoanAndLeaseContract],
"hidden": true,
"retainUntil": 1654109791,
"hasConflicts": true
}
AssetRetentionInput
Fields
| Input Field | Description |
|---|---|
retentionInput -
LoanAndLeaseRetentionInput!
|
|
id -
UUID!
|
Example
{
"retentionInput": LoanAndLeaseRetentionInput,
"id": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
AssetUpdateError
Fields
| Field Name | Description |
|---|---|
errors -
[SetAssetError!]!
|
Example
{"errors": [AssetUpdateVinAlreadyExists]}
AssetUpdateIdDoesNotExist
Fields
| Field Name | Description |
|---|---|
id -
UUID!
|
Example
{
"id": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
AssetUpdateInput
Fields
| Input Field | Description |
|---|---|
input -
AssetInput!
|
|
id -
UUID!
|
Example
{
"input": AssetInput,
"id": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
AssetUpdateSuccess
Fields
| Field Name | Description |
|---|---|
assets -
[Asset!]!
|
Example
{"assets": [Asset]}
AssetUpdateVinAlreadyExists
BadDebtEntry
Example
{
"entryId": "abc123",
"creditor": "abc123",
"dateOfTransmission": "2020-07-19",
"dateOfRemoval": "2020-07-19",
"foundation": "xyz789",
"amount": "28391719239482739937.1939459927192"
}
BadDebtResponse
Types
| Union Types |
|---|
Example
RegisterError
BadDebtResult
Fields
| Field Name | Description |
|---|---|
name -
String
|
|
entries -
[BadDebtEntry!]!
|
|
timestamp -
Instant!
|
Example
{
"name": "xyz789",
"entries": [BadDebtEntry],
"timestamp": 1654109791
}
BadDebtStatus
Example
CreditlinkBadDebtStatusFailed
BigDecimal
Description
The BigDecimal scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
"28391719239482739937.1939459927192"
BigInt
Description
The BigInt scalar type represents non-fractional signed whole numeric values. BigInt can represent values of arbitrary size.
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CompanyIdentifier
Types
| Union Types |
|---|
Example
CountrySpecificValue
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"
}
ComplianceAnswer
Fields
| Field Name | Description |
|---|---|
recentLoans -
Boolean!
|
Example
{"recentLoans": true}
ComputedRole
Description
A role that is immutable and derived from the mutable roles
Values
| Enum Value | Description |
|---|---|
|
|
Translates to the 'contract_reader' role |
|
|
Translates to the 'manager' role |
|
|
Translates to the 'anyone' role |
|
|
Translates to the 'config' role |
Example
"CONTRACT_READER"
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
}
ContractFileCategory
Values
| Enum Value | Description |
|---|---|
|
|
Example
"OTHER"
ContractFileInput
Fields
| Input Field | Description |
|---|---|
category -
ContractFileCategory!
|
|
file -
FileInput!
|
|
contractId -
UUID!
|
Example
{
"category": "OTHER",
"file": FileInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
CountryCode
Types
| Union Types |
|---|
Example
KnownCountryCode
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": "abc123"
}
CountrySpecificValue
CountrySpecificValueInput
Cpr
Description
The Cpr scalar type is a valid danish Cpr.
Example
"0810972032"
CreateAssetResult
Types
| Union Types |
|---|
Example
AssetCreationFailure
CreateCreditlinkCompany
Example
{
"externalId": "0110293",
"financialCrimeEnabled": true,
"badDebtEnabled": true,
"phone": "29400888",
"email": "john@gmail.com",
"cvr": "35890270",
"name": "abc123"
}
CreateCreditlinkPerson
Example
{
"externalId": "0110293",
"creditroContact": true,
"proofOfIdentityEnabled": true,
"psd2Enabled": true,
"taxInfoEnabled": true,
"financialCrimeEnabled": true,
"badDebtEnabled": true,
"phone": "29400888",
"email": "john@gmail.com",
"cpr": "0810972032",
"name": "xyz789"
}
CreditlinkBadDebtStatusCompleted
Fields
| Field Name | Description |
|---|---|
data -
BadDebtResult!
|
Lazily fetches the underlying data |
Example
{"data": BadDebtResult}
CreditlinkBadDebtStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"PENDING"
CreditlinkBadDebtStatusEnumCase
Fields
| Field Name | Description |
|---|---|
enumCase -
CreditlinkBadDebtStatusEnum!
|
Example
{"enumCase": "PENDING"}
CreditlinkBadDebtStatusFailed
Fields
| Field Name | Description |
|---|---|
error -
RegisterError!
|
Lazily fetches the underlying error |
Example
{"error": RegisterError}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"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
}
CreditlinkCaseCreated
Fields
| Field Name | Description |
|---|---|
caseId -
UUID!
|
|
case -
CreditlinkCase!
|
Example
{
"caseId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"case": CreditlinkCase
}
CreditlinkCaseCreationError
Fields
| Field Name | Description |
|---|---|
errorType -
CreditlinkCaseCreationErrorType!
|
Example
{"errorType": "EXTERNAL_ID_ALREADY_EXISTS"}
CreditlinkCaseCreationErrorType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EXTERNAL_ID_ALREADY_EXISTS"
CreditlinkCaseCreationResult
Types
| Union Types |
|---|
Example
CreditlinkCaseCreationError
CreditlinkCaseDeletedEvent
CreditlinkCaseEvent
Example
CreditlinkCaseSubscribedEvent
CreditlinkCaseStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
CreditlinkCaseSubscribedEvent
Fields
| Field Name | Description |
|---|---|
case -
CreditlinkCase
|
Example
{"case": CreditlinkCase}
CreditlinkCaseUpdatedEvent
Fields
| Field Name | Description |
|---|---|
case -
CreditlinkCase!
|
Example
{"case": CreditlinkCase}
CreditlinkCasesEvent
Types
| Union Types |
|---|
Example
CreditlinkCasesEventSubscribed
CreditlinkCasesEventSubscribed
Fields
| Field Name | Description |
|---|---|
org -
Org!
|
|
bundles -
[CreditlinkCase!]!
|
Example
{
"org": "acme",
"bundles": [CreditlinkCase]
}
CreditlinkCasesEventUpdate
Fields
| Field Name | Description |
|---|---|
org -
Org!
|
|
new -
[CreditlinkCase!]!
|
|
orderedIds -
[UUID!]!
|
|
removed -
[UUID!]!
|
Example
{
"org": "acme",
"new": [CreditlinkCase],
"orderedIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"removed": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
CreditlinkClientConfig
CreditlinkComment
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"
}
CreditlinkCreditroCaseData
Fields
| Field Name | Description |
|---|---|
status -
CreditlinkCreditroCaseStatus!
|
Example
{"status": CreditlinkCreditroCaseStatusSuccess}
CreditlinkCreditroCaseStatus
Example
CreditlinkCreditroCaseStatusSuccess
CreditlinkCreditroCaseStatusFailure
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkCreditroCaseStatusPending
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkCreditroCaseStatusPreRequest
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkCreditroCaseStatusSuccess
Fields
| Field Name | Description |
|---|---|
creditroId -
String!
|
Example
{"creditroId": "xyz789"}
CreditlinkCreditroConfigIn
CreditlinkCreditroConfigOut
CreditlinkCreditroFlag
Description
This is a deprecated flag, use the other flag instead
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DISABLED"
CreditlinkCreditroSecrets
Fields
| Input Field | Description |
|---|---|
apiToken -
String!
|
Example
{"apiToken": "xyz789"}
CreditlinkCvrStatusCompleted
Fields
| Field Name | Description |
|---|---|
cvrData -
CvrData
|
|
annualReports -
[CvrAnnualReport!]!
|
Example
{
"cvrData": CvrData,
"annualReports": [CvrAnnualReport]
}
CreditlinkCvrStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PENDING"
CreditlinkCvrStatusEnumCase
Fields
| Field Name | Description |
|---|---|
enumCase -
CreditlinkCvrStatusEnum!
|
Example
{"enumCase": "PENDING"}
CreditlinkDisposableIncome
Fields
| Field Name | Description |
|---|---|
income -
CreditlinkDisposableIncomeIncome!
|
|
home -
CreditlinkDisposableIncomeHome!
|
|
vehicle -
CreditlinkDisposableIncomeVehicle!
|
|
misc -
CreditlinkDisposableIncomeMisc!
|
Example
{
"income": CreditlinkDisposableIncomeIncome,
"home": CreditlinkDisposableIncomeHome,
"vehicle": CreditlinkDisposableIncomeVehicle,
"misc": CreditlinkDisposableIncomeMisc
}
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"
}
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"
}
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"
}
CreditlinkDisposableIncomeRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIMARY_DEBTOR"
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"
}
CreditlinkESkatStatusCompleted
Fields
| Field Name | Description |
|---|---|
userId -
UserId!
|
|
lamport -
Lamport!
|
|
derivedData -
ESkatDerivedData!
|
Example
{
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"lamport": 42,
"derivedData": ESkatDerivedData
}
CreditlinkESkatStatusFailed
Fields
| Field Name | Description |
|---|---|
userId -
UserId!
|
Example
{
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
}
CreditlinkESkatStatusRunning
Fields
| Field Name | Description |
|---|---|
userId -
UserId!
|
Example
{
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d"
}
CreditlinkEntity
Types
| Union Types |
|---|
Example
CreditlinkPerson
CreditlinkFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWAITING_CUSTOMER"
CreditlinkFinancialCrimeStatusCompleted
Fields
| Field Name | Description |
|---|---|
data -
FinancialCrimeResult!
|
Lazily fetches the underlying data |
Example
{"data": FinancialCrimeResult}
CreditlinkFinancialCrimeStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PENDING"
CreditlinkFinancialCrimeStatusEnumCase
Fields
| Field Name | Description |
|---|---|
enumCase -
CreditlinkFinancialCrimeStatusEnum!
|
Example
{"enumCase": "PENDING"}
CreditlinkInputCreditroFlag
Fields
| Input Field | Description |
|---|---|
dummy -
Boolean!
|
This field facilitates forwards compatibility |
Example
{"dummy": true}
CreditlinkInputDisposableIncome
Fields
| Input Field | Description |
|---|---|
misc -
CreditlinkInputDisposableIncomeMisc!
|
|
vehicle -
CreditlinkInputDisposableIncomeVehicle!
|
|
home -
CreditlinkInputDisposableIncomeHome!
|
|
income -
CreditlinkInputDisposableIncomeIncome!
|
Example
{
"misc": CreditlinkInputDisposableIncomeMisc,
"vehicle": CreditlinkInputDisposableIncomeVehicle,
"home": CreditlinkInputDisposableIncomeHome,
"income": CreditlinkInputDisposableIncomeIncome
}
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"
}
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"
}
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"
}
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"
}
CreditlinkInputMonthioFlag
CreditlinkInputUserDisposableIncome
Fields
| Input Field | Description |
|---|---|
expensePct -
BigDecimal!
|
|
children -
Int!
|
|
adults -
Int!
|
|
disposableIncome -
CreditlinkInputDisposableIncome!
|
Example
{
"expensePct": "28391719239482739937.1939459927192",
"children": 123,
"adults": 123,
"disposableIncome": CreditlinkInputDisposableIncome
}
CreditlinkMonthioCaseData
Fields
| Field Name | Description |
|---|---|
status -
CreditlinkMonthioCaseStatus!
|
Example
{"status": CreditlinkMonthioCaseStatusSuccess}
CreditlinkMonthioCaseStatus
Example
CreditlinkMonthioCaseStatusSuccess
CreditlinkMonthioCaseStatusFailure
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkMonthioCaseStatusPending
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkMonthioCaseStatusPreRequest
Fields
| Field Name | Description |
|---|---|
dummy -
Boolean!
|
Example
{"dummy": true}
CreditlinkMonthioCaseStatusSuccess
CreditlinkMonthioConfigIn
CreditlinkMonthioConfigOut
CreditlinkMonthioFlag
Description
This is a deprecated flag, use the other flag instead
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DISABLED"
CreditlinkMonthioSecrets
CreditlinkNotificationConfig
Example
{
"mailSenderMail": "john@gmail.com",
"smsSenderName": "xyz789",
"mailTemplatePlaintext": "xyz789",
"mailTemplateHtml": "xyz789",
"smsTemplate": "xyz789"
}
CreditlinkPSD2Provider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NORDIGEN"
CreditlinkPSD2Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FAILED"
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"
}
CreditlinkPersonAddressError
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Example
{"message": "xyz789"}
CreditlinkPersonAddressResponse
Types
| Union Types |
|---|
Example
CreditlinkPersonAddressError
CreditlinkPersonAddressSuccess
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"
}
CreditlinkProofOfIdentityStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPROVED"
CreditlinkSort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_ID"
CreditlinkUserDisposableIncome
Fields
| Field Name | Description |
|---|---|
disposableIncome -
CreditlinkDisposableIncome!
|
|
adults -
Int!
|
|
children -
Int!
|
|
expensePct -
BigDecimal!
|
Example
{
"disposableIncome": CreditlinkDisposableIncome,
"adults": 987,
"children": 987,
"expensePct": "28391719239482739937.1939459927192"
}
Cvr
Description
The Cvr scalar type is a valid danish Cvr.
Example
"35890270"
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
|
Example
{
"cvr": "35890270",
"startDate": "2020-07-19",
"endDate": "2020-07-19",
"grossIncome": {},
"ordinaryBusinessIncome": {},
"netIncome": {},
"equity": {},
"proposedDividend": {},
"assets": {},
"pdf": DisplayableResource
}
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": "abc123",
"cvr": "35890270",
"address": "xyz789",
"postalCode": "abc123",
"city": "abc123",
"district": "abc123",
"companyCreationDate": "2020-07-19",
"companyType": "abc123",
"bindingAgreement": "xyz789",
"management": [CvrParticipant],
"boardMembers": [CvrParticipant],
"owners": [CvrParticipant],
"participants": [CvrParticipant]
}
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": "xyz789",
"postalCode": "xyz789",
"participantFunction": "abc123",
"city": "abc123",
"district": "abc123",
"ownershipPercentage": "OWNERSHIP_0_05"
}
CvrParticipantType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PERSON"
CvrSearchResult
CvrStatus
Types
| Union Types |
|---|
Example
CreditlinkCvrStatusCompleted
DanishCompanyIdentifier
Fields
| Field Name | Description |
|---|---|
cvr -
Cvr!
|
Example
{"cvr": "35890270"}
DanishPersonIdentifier
Fields
| Field Name | Description |
|---|---|
cpr -
Cpr!
|
Example
{"cpr": "0810972032"}
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": "abc123",
"thumbnail": "https://domain.com/resource"
}
DisposableIncomeConfig
Fields
| Field Name | Description |
|---|---|
indicativeAmountSingle -
BigDecimal!
|
|
indicativeAmountCouple -
BigDecimal!
|
|
indicativeAmountPerChild -
BigDecimal!
|
Example
{
"indicativeAmountSingle": "28391719239482739937.1939459927192",
"indicativeAmountCouple": "28391719239482739937.1939459927192",
"indicativeAmountPerChild": "28391719239482739937.1939459927192"
}
DisposableIncomeConfigEvent
Types
| Union Types |
|---|
Example
DisposableIncomeConfigSubscribedEvent
DisposableIncomeConfigSubscribedEvent
Fields
| Field Name | Description |
|---|---|
org -
Org!
|
|
currentConfig -
DisposableIncomeConfig
|
Example
{
"org": "acme",
"currentConfig": DisposableIncomeConfig
}
DisposableIncomeConfigUpdatedEvent
Fields
| Field Name | Description |
|---|---|
org -
Org!
|
|
newConfig -
DisposableIncomeConfig!
|
Example
{
"org": "acme",
"newConfig": DisposableIncomeConfig
}
DowJonesSecrets
Fields
| Input Field | Description |
|---|---|
password -
String!
|
|
username -
String!
|
|
service -
DowJonesService!
|
Example
{
"password": "xyz789",
"username": "xyz789",
"service": "PRODUCTION"
}
DowJonesService
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRODUCTION"
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"
}
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"
}
ESkatBankCodeIdentifier
Fields
| Field Name | Description |
|---|---|
value -
Int!
|
Example
{"value": 123}
ESkatCompanyCvrIdentifier
Fields
| Field Name | Description |
|---|---|
cvr -
Cvr!
|
Example
{"cvr": "35890270"}
ESkatCompanyInfo
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"
}
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"
}
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"
}
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"
}
ESkatIdentifier
Types
| Union Types |
|---|
Example
ESkatCompanyCvrIdentifier
ESkatIncome
Fields
| Field Name | Description |
|---|---|
gross -
BigDecimal!
|
|
net -
BigDecimal!
|
Example
{
"gross": "28391719239482739937.1939459927192",
"net": "28391719239482739937.1939459927192"
}
ESkatIncomeByCompanyMonth
Fields
| Field Name | Description |
|---|---|
month -
YearMonth!
|
|
company -
Cvr!
|
|
value -
ESkatIncome!
|
Example
{
"month": "2007-12",
"company": "35890270",
"value": ESkatIncome
}
ESkatIncomeByMonth
Fields
| Field Name | Description |
|---|---|
month -
YearMonth!
|
|
value -
ESkatIncome!
|
Example
{
"month": "2007-12",
"value": ESkatIncome
}
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
}
ESkatOwnerType
Fields
| Field Name | Description |
|---|---|
value -
String!
|
Example
{"value": "xyz789"}
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"
}
ESkatPropertyOwnership
Example
{
"startDate": "2020-07-19",
"endDate": "2020-07-19",
"municipalityCode": "xyz789",
"bbrCode": "xyz789",
"address": "abc123",
"ownership": "28391719239482739937.1939459927192"
}
ESkatStatus
Example
CreditlinkESkatStatusCompleted
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
}
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"
}
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]
}
Description
The Email scalar type is a valid RFC822 address.
Example
"john@gmail.com"
EphemeralReference
Description
An ephemeral reference to some resource, usually a blob. The underlying type is String.
Example
EphemeralReference
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
}
EskatConfig
EskatDebtType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Mortgage"
ExternalId
Description
The ExternalId scalar type lets the caller bind an id, which is possibly unique to an object.
Example
"0110293"
File
Fields
| Field Name | Description |
|---|---|
id -
UUID!
|
|
filename -
String
|
|
resource -
DisplayableResource!
|
Example
{
"id": "e35f72e9-9969-4577-96a0-4011fae907c4",
"filename": "xyz789",
"resource": DisplayableResource
}
FileInput
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": "abc123",
"entryType": "abc123",
"name": "abc123",
"yearsOfBirth": ["2007"],
"monthsOfBirth": ["2007-12"],
"datesOfBirth": ["2020-07-19"],
"countries": ["abc123"],
"title": "abc123",
"score": "28391719239482739937.1939459927192"
}
FinancialCrimeResponse
Types
| Union Types |
|---|
Example
RegisterError
FinancialCrimeResult
Fields
| Field Name | Description |
|---|---|
entries -
[FinancialCrimeEntry!]!
|
|
timestamp -
Instant!
|
Example
{
"entries": [FinancialCrimeEntry],
"timestamp": 1654109791
}
FinancialCrimeStatus
Example
CreditlinkFinancialCrimeStatusCompleted
GlobalRole
Description
A global role
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ADMIN"
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
"4"
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": "abc123",
"dealerName": "xyz789",
"externalId": "0110293"
}
InputCreditlinkClientConfig
InputCreditlinkCompany
Description
Deprecated. Use CreateCreditlinkCompany or UpdateCreditlinkCompany instead
Example
{
"financialCrimeEnabled": true,
"badDebtEnabled": true,
"phone": "29400888",
"email": "john@gmail.com",
"cvr": "35890270",
"name": "abc123"
}
InputCreditlinkNotificationConfig
Example
{
"smsTemplate": "xyz789",
"mailTemplateHtml": "abc123",
"mailTemplatePlaintext": "abc123",
"smsSenderName": "abc123",
"mailSenderMail": "john@gmail.com"
}
InputDisposableIncomeConfig
Fields
| Input Field | Description |
|---|---|
indicativeAmountPerChild -
BigDecimal!
|
|
indicativeAmountCouple -
BigDecimal!
|
|
indicativeAmountSingle -
BigDecimal!
|
Example
{
"indicativeAmountPerChild": "28391719239482739937.1939459927192",
"indicativeAmountCouple": "28391719239482739937.1939459927192",
"indicativeAmountSingle": "28391719239482739937.1939459927192"
}
InputEskatConfig
InputEskatPkcs
InputNordigenOAuthConfig
Instant
Description
An instantaneous point on the time-line, the milliseconds since epoch. Represented as a number.
Example
1654109791
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
987
KnownCountryCode
Fields
| Field Name | Description |
|---|---|
code -
KnownCountryCodeType!
|
Example
{"code": "DK"}
KnownCountryCodeType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DK"
Lamport
Description
The Lamport scalar type is a lamport timestamp (version number).
Example
42
LoanAndLeaseAddContractCommentInput
LoanAndLeaseAddContractCommentResult
Fields
| Field Name | Description |
|---|---|
contractId -
UUID!
|
|
comments -
[LoanAndLeaseContractComment!]!
|
Example
{
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"comments": [LoanAndLeaseContractComment]
}
LoanAndLeaseAddRepresentative
LoanAndLeaseAddRepresentativeError
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ENTITY_NOT_FOUND"
LoanAndLeaseAddRepresentativeErrorWrapper
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeaseAddRepresentativeError!
|
Example
{"error": "ENTITY_NOT_FOUND"}
LoanAndLeaseAddRepresentativeOutcome
Example
LoanAndLeaseAddRepresentativeSuccess
LoanAndLeaseAddRepresentativeSuccess
Fields
| Field Name | Description |
|---|---|
representativeIds -
[UUID!]!
|
Example
{
"representativeIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
LoanAndLeaseAdministratedRepresentative
Fields
| Field Name | Description |
|---|---|
representative -
LoanAndLeaseRepresentative!
|
|
disabled -
Boolean!
|
Example
{
"representative": LoanAndLeaseRepresentative,
"disabled": true
}
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"
}
LoanAndLeaseAnnuityConstantInput
Fields
| Input Field | Description |
|---|---|
bookingDate -
LocalDate
|
|
constantAmount -
BigDecimal!
|
|
costId -
String!
|
Example
{
"bookingDate": "2020-07-19",
"constantAmount": "28391719239482739937.1939459927192",
"costId": "abc123"
}
LoanAndLeaseAssetOptions
LoanAndLeaseAssetOptionsInput
LoanAndLeaseBaseRate
Description
Requires the caller to have the 'manager' 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"
}
LoanAndLeaseBaseRateInput
Fields
| Input Field | Description |
|---|---|
baseRate -
BigDecimal
|
|
date -
LocalDate!
|
|
baseRateId -
String!
|
Example
{
"baseRate": "28391719239482739937.1939459927192",
"date": "2020-07-19",
"baseRateId": "abc123"
}
LoanAndLeaseBookedInvoice
Description
Requires the caller to have the 'manager' 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!]!
|
|
id -
ID!
|
Example
{
"header": LoanAndLeaseBookedInvoiceHeader,
"lines": [LoanAndLeaseBookedInvoiceLine],
"id": 4
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"invoiceNo": 9223372036854776000,
"customerNumber": 9223372036854776000,
"date": "2020-07-19",
"recipientName": "abc123",
"recipientAddress": "xyz789",
"recipientPostalCode": "abc123",
"recipientCity": "xyz789",
"grossAmount": "28391719239482739937.1939459927192",
"vatAmount": "28391719239482739937.1939459927192",
"notesHeading": "abc123",
"notesTextLine1": "xyz789",
"notesTextLine2": "xyz789"
}
LoanAndLeaseBookedInvoiceLine
Fields
| Field Name | Description |
|---|---|
invoiceId -
UUID!
|
|
description -
String
|
|
totalNetAmount -
BigDecimal
|
|
vatAmount -
BigDecimal
|
Example
{
"invoiceId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"description": "abc123",
"totalNetAmount": "28391719239482739937.1939459927192",
"vatAmount": "28391719239482739937.1939459927192"
}
LoanAndLeaseBookingByDate
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
transactions -
[LoanAndLeaseCost!]!
|
|
invoices -
[LoanAndLeaseInvoice!]!
|
Example
{
"date": "2020-07-19",
"transactions": [LoanAndLeaseCost],
"invoices": [LoanAndLeaseInvoice]
}
LoanAndLeaseBookingByDateDetailed
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
transactionLines -
[PreviewTransactionLineWithCostId!]!
|
|
invoices -
[LoanAndLeaseInvoiceDetailed!]!
|
Example
{
"date": "2020-07-19",
"transactionLines": [PreviewTransactionLineWithCostId],
"invoices": [LoanAndLeaseInvoiceDetailed]
}
LoanAndLeaseBookingError
Types
| Union Types |
|---|
Example
LoanAndLeaseStructuredBookingError
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
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseBookingParamsNotNewestError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
|
expected -
LoanAndLeaseBookingParams!
|
Example
{
"contract": LoanAndLeaseContract,
"expected": LoanAndLeaseBookingParams
}
LoanAndLeaseBookingStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
LoanAndLeaseCollectionMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BETALINGSSERVICE"
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
}
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
|
|
city -
String
|
|
report -
LoanAndLeaseEntityReport
|
|
retention -
LoanAndLeaseEntityRetention
|
|
roles -
[MutableEntityRole!]!
|
|
id -
ID!
|
Example
{
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"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": "abc123",
"economicCreditorId": 987,
"city": "abc123",
"report": LoanAndLeaseEntityReport,
"retention": LoanAndLeaseEntityRetention,
"roles": ["DEALER"],
"id": 4
}
LoanAndLeaseCompanyInput
Fields
| Input Field | Description |
|---|---|
invoiceEmail -
Email
|
|
city -
String
|
|
identifiers -
[CompanyIdentifierInput!]!
|
|
vatIdentification -
CompanyIdentifierInput
|
|
mobile -
Phone
|
|
phone -
Phone
|
|
email -
Email
|
|
countryCode -
CountryCodeInput
|
|
postalCode -
String
|
|
address -
String
|
|
name -
String!
|
Example
{
"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": "xyz789"
}
LoanAndLeaseCompanyUpdate
Fields
| Input Field | Description |
|---|---|
company -
LoanAndLeaseCompanyInput!
|
|
entityId -
UUID!
|
Example
{
"company": LoanAndLeaseCompanyInput,
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseComputedRetentionType
Values
| Enum Value | Description |
|---|---|
|
|
sets retention date to 30 days from now |
Example
"DEFAULT_RETENTION"
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
|
|
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!
|
|
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
|
|
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!]!
|
|
id -
ID!
|
Example
{
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"dimensionNo": 987,
"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",
"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": "xyz789",
"firstPeriodInvoice": "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],
"id": "4"
}
LoanAndLeaseContractAnnuityEndInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractChangeAnnuityEndDataInput!
|
|
contractId -
UUID!
|
Example
{
"data": LoanAndLeaseContractChangeAnnuityEndDataInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractChangeAnnuityEnd
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
annuityEnd -
LocalDate
|
Example
{
"date": "2020-07-19",
"annuityEnd": "2020-07-19"
}
LoanAndLeaseContractChangeAnnuityEndDataInput
Fields
| Input Field | Description |
|---|---|
annuityEnd -
LocalDate
|
|
date -
LocalDate!
|
Example
{
"annuityEnd": "2020-07-19",
"date": "2020-07-19"
}
LoanAndLeaseContractChangeEntities
Fields
| Field Name | Description |
|---|---|
date -
LocalDate
|
|
data -
LoanAndLeaseContractEntities
|
Example
{
"date": "2020-07-19",
"data": LoanAndLeaseContractEntities
}
LoanAndLeaseContractChangeEntitiesDataInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractEntitiesInput
|
|
date -
LocalDate
|
Example
{
"data": LoanAndLeaseContractEntitiesInput,
"date": "2020-07-19"
}
LoanAndLeaseContractChangeEntitiesInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractChangeEntitiesDataInput!
|
|
contractId -
UUID!
|
Example
{
"data": LoanAndLeaseContractChangeEntitiesDataInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractChangeInterestRate
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
interestRateNominal -
LoanAndLeaseInterestRateNominal
|
Example
{
"date": "2020-07-19",
"interestRateNominal": LoanAndLeaseInterestRateNominal
}
LoanAndLeaseContractChangeInterestRateDataInput
Fields
| Input Field | Description |
|---|---|
interestRateNominal -
LoanAndLeaseInterestRateNominalInput
|
|
date -
LocalDate!
|
Example
{
"interestRateNominal": LoanAndLeaseInterestRateNominalInput,
"date": "2020-07-19"
}
LoanAndLeaseContractChangeResidualValue
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
residualValue -
BigDecimal
|
Example
{
"date": "2020-07-19",
"residualValue": "28391719239482739937.1939459927192"
}
LoanAndLeaseContractChangeResidualValueDataInput
Fields
| Input Field | Description |
|---|---|
residualValue -
BigDecimal
|
|
date -
LocalDate!
|
Example
{
"residualValue": "28391719239482739937.1939459927192",
"date": "2020-07-19"
}
LoanAndLeaseContractComment
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"
}
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"
}
LoanAndLeaseContractCostDelete
Fields
| Field Name | Description |
|---|---|
costId -
String!
|
|
cost -
LoanAndLeasePortfolioCosts
|
|
bookingDate -
LocalDate
|
Example
{
"costId": "xyz789",
"cost": LoanAndLeasePortfolioCosts,
"bookingDate": "2020-07-19"
}
LoanAndLeaseContractCostDeleteInput
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"
}
LoanAndLeaseContractCostDirectConstantInput
Fields
| Input Field | Description |
|---|---|
bookingDate -
LocalDate
|
|
constantAmount -
BigDecimal!
|
|
costId -
String!
|
Example
{
"bookingDate": "2020-07-19",
"constantAmount": "28391719239482739937.1939459927192",
"costId": "abc123"
}
LoanAndLeaseContractCostDirectPeriodic
Fields
| Field Name | Description |
|---|---|
costId -
String!
|
|
cost -
LoanAndLeasePortfolioCosts
|
|
periodicCost -
LoanAndLeasePeriodicCost!
|
|
bookingDate -
LocalDate
|
|
endDate -
LocalDate
|
Example
{
"costId": "abc123",
"cost": LoanAndLeasePortfolioCosts,
"periodicCost": LoanAndLeasePeriodicCostPeriod,
"bookingDate": "2020-07-19",
"endDate": "2020-07-19"
}
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": "abc123"
}
LoanAndLeaseContractCostPayment
Fields
| Field Name | Description |
|---|---|
costId -
String!
|
|
cost -
LoanAndLeasePortfolioCosts
|
|
amount -
BigDecimal!
|
|
bookingDate -
LocalDate
|
Example
{
"costId": "abc123",
"cost": LoanAndLeasePortfolioCosts,
"amount": "28391719239482739937.1939459927192",
"bookingDate": "2020-07-19"
}
LoanAndLeaseContractCostPaymentInput
Fields
| Input Field | Description |
|---|---|
bookingDate -
LocalDate
|
|
amount -
BigDecimal!
|
|
costId -
String!
|
Example
{
"bookingDate": "2020-07-19",
"amount": "28391719239482739937.1939459927192",
"costId": "xyz789"
}
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.
Example
LoanAndLeaseContractCostPayment
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]
}
LoanAndLeaseContractCostsInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractCostsDataInput!
|
|
contractId -
UUID!
|
Example
{
"data": LoanAndLeaseContractCostsDataInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractCountsFiltered
Fields
| Field Name | Description |
|---|---|
withOtherWarningType -
LoanAndLeaseContractCountsFilteredWithOtherWarningType!
|
|
withOtherContractStatus -
LoanAndLeaseContractCountsFilteredWithOtherContractStatus!
|
|
withOtherRegTax -
LoanAndLeaseContractCountsFilteredWithOtherRegTax!
|
|
withOtherExpirationStatus -
LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus!
|
Example
{
"withOtherWarningType": LoanAndLeaseContractCountsFilteredWithOtherWarningType,
"withOtherContractStatus": LoanAndLeaseContractCountsFilteredWithOtherContractStatus,
"withOtherRegTax": LoanAndLeaseContractCountsFilteredWithOtherRegTax,
"withOtherExpirationStatus": LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus
}
LoanAndLeaseContractCountsFilteredWithOtherContractStatus
Example
{
"all": 9223372036854776000,
"draft": 9223372036854776000,
"starting": 9223372036854776000,
"active": 9223372036854776000,
"ending": 9223372036854776000,
"completed": 9223372036854776000,
"inventory": 9223372036854776000
}
LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus
Example
{
"all": 9223372036854776000,
"pendingCustomer": 9223372036854776000,
"extension": 9223372036854776000,
"termination": 9223372036854776000,
"newContract": 9223372036854776000
}
LoanAndLeaseContractCountsFilteredWithOtherRegTax
LoanAndLeaseContractCountsFilteredWithOtherWarningType
Example
{
"all": 9223372036854776000,
"anyWarning": 9223372036854776000,
"supplierPayableWarning": 9223372036854776000,
"assetWarning": 9223372036854776000,
"startDateWarning": 9223372036854776000,
"endDateWarning": 9223372036854776000,
"anyAccountWarning": 9223372036854776000,
"expirationWarning": 9223372036854776000
}
LoanAndLeaseContractCreateInEconomicErrorType
Values
| Enum Value | Description |
|---|---|
|
|
If any input contracts already exist in economic |
|
|
Missing economic configuration |
|
|
One of the contracts did not exist, the whole update is rolled back |
Example
"ALREADY_EXISTS"
LoanAndLeaseContractCreateInEconomicItemInput
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
}
LoanAndLeaseContractEntitiensDebtorInput
LoanAndLeaseContractEntities
Fields
| Field Name | Description |
|---|---|
debtor -
LoanAndLeaseEntity!
|
|
debtorPbsNoOverride -
String
|
|
coDebtor -
LoanAndLeaseEntity
|
|
repurchaser -
[LoanAndLeaseEntity!]!
|
|
guarantor -
[LoanAndLeaseEntity!]!
|
|
dealer -
LoanAndLeaseEntity
|
|
supplier -
LoanAndLeaseEntity
|
Example
{
"debtor": LoanAndLeasePerson,
"debtorPbsNoOverride": "xyz789",
"coDebtor": LoanAndLeasePerson,
"repurchaser": [LoanAndLeasePerson],
"guarantor": [LoanAndLeasePerson],
"dealer": LoanAndLeasePerson,
"supplier": LoanAndLeasePerson
}
LoanAndLeaseContractEntitiesInput
Description
Only one of 'debtorId' and 'debtor' may be provided.
Example
{
"supplierId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"dealerId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"guarantorIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"repurchaserIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"coDebtorId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"debtor": LoanAndLeaseContractEntitiensDebtorInput,
"debtorId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractEntity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DEBTOR"
LoanAndLeaseContractInput
Fields
| Input Field | Description |
|---|---|
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!
|
|
annuityStart -
LocalDate!
|
|
portfolioId -
String!
|
|
dimensionNo -
Int
|
Example
{
"collectionMethod": "BETALINGSSERVICE",
"approverInitials": "xyz789",
"firstPeriodInvoice": "2020-07-19",
"secondHandVat": true,
"regTax": LoanAndLeaseRegTaxInput,
"expirationStatus": "PENDING_CUSTOMER",
"sharedInsurancePolicy": true,
"invoiceText": "abc123",
"assetOptions": LoanAndLeaseAssetOptionsInput,
"asset": "e35f72e9-9969-4577-96a0-4011fae907c4",
"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": "abc123",
"dimensionNo": 987
}
LoanAndLeaseContractInterestRateInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractChangeInterestRateDataInput!
|
|
contractId -
UUID!
|
Example
{
"data": LoanAndLeaseContractChangeInterestRateDataInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractMissingDimensionNoError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
Example
{"contract": LoanAndLeaseContract}
LoanAndLeaseContractNotActiveError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
Example
{"contract": LoanAndLeaseContract}
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!
|
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
}
LoanAndLeaseContractReportDebtorRemainder
Fields
| Field Name | Description |
|---|---|
remainder -
BigDecimal!
|
|
entity -
LoanAndLeaseEntity!
|
Example
{
"remainder": "28391719239482739937.1939459927192",
"entity": LoanAndLeasePerson
}
LoanAndLeaseContractResidualValueInput
Fields
| Input Field | Description |
|---|---|
data -
LoanAndLeaseContractChangeResidualValueDataInput!
|
|
contractId -
UUID!
|
Example
{
"data": LoanAndLeaseContractChangeResidualValueDataInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractRetention
LoanAndLeaseContractRetentionInput
Fields
| Input Field | Description |
|---|---|
retention -
LoanAndLeaseRetentionInput!
|
|
contractId -
UUID!
|
Example
{
"retention": LoanAndLeaseRetentionInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
LoanAndLeaseContractUpdateError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseContractUpdateErrorType!
|
Example
{"type": "DUPLICATE_IDS"}
LoanAndLeaseContractUpdateErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DUPLICATE_IDS"
LoanAndLeaseContractUpdateInput
Fields
| Input Field | Description |
|---|---|
mailNotification -
Boolean
|
|
contract -
LoanAndLeaseContractInput!
|
|
contractId -
UUID!
|
Example
{
"mailNotification": true,
"contract": LoanAndLeaseContractInput,
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseContractUpdateOutcome
Types
| Union Types |
|---|
Example
LoanAndLeaseContractUpdateError
LoanAndLeaseContractUpdateSuccess
Fields
| Field Name | Description |
|---|---|
data -
[LoanAndLeaseContract!]!
|
Example
{"data": [LoanAndLeaseContract]}
LoanAndLeaseCost
Fields
| Field Name | Description |
|---|---|
costId -
LoanAndLeaseCostId!
|
|
amount -
BigDecimal!
|
|
text -
String
|
Example
{
"costId": LoanAndLeaseIntrinsicCostId,
"amount": "28391719239482739937.1939459927192",
"text": "xyz789"
}
LoanAndLeaseCostId
Types
| Union Types |
|---|
Example
LoanAndLeaseIntrinsicCostId
LoanAndLeaseCostMissingConfigError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
|
portfolioId -
String!
|
|
costId -
LoanAndLeaseCostId!
|
Example
{
"contract": LoanAndLeaseContract,
"portfolioId": "abc123",
"costId": LoanAndLeaseIntrinsicCostId
}
LoanAndLeaseCostMissingProductNoError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
|
portfolioId -
String!
|
|
costId -
LoanAndLeaseCostId!
|
Example
{
"contract": LoanAndLeaseContract,
"portfolioId": "xyz789",
"costId": LoanAndLeaseIntrinsicCostId
}
LoanAndLeaseCreateCompanyInput
Fields
| Input Field | Description |
|---|---|
createCreditorInEconomic -
LoanAndLeaseCreateCreditorInEconomicInput
|
|
createInEconomic -
LoanAndLeaseCreateInEconomicInput
|
|
company -
LoanAndLeaseCompanyInput!
|
Example
{
"createCreditorInEconomic": LoanAndLeaseCreateCreditorInEconomicInput,
"createInEconomic": LoanAndLeaseCreateInEconomicInput,
"company": LoanAndLeaseCompanyInput
}
LoanAndLeaseCreateContractInEconomicError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseContractCreateInEconomicErrorType!
|
Example
{"type": "ALREADY_EXISTS"}
LoanAndLeaseCreateContractInEconomicOutcome
Example
LoanAndLeaseCreateContractInEconomicError
LoanAndLeaseCreateContractInEconomicResult
Fields
| Field Name | Description |
|---|---|
outcome -
[LoanAndLeaseContract!]!
|
Example
{"outcome": [LoanAndLeaseContract]}
LoanAndLeaseCreateCreditorInEconomicInput
Fields
| Input Field | Description |
|---|---|
economicCreditorId -
Int
|
Example
{"economicCreditorId": 987}
LoanAndLeaseCreateEntityInEconomicError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseEntityCreateInEconomicErrorType!
|
Example
{"type": "ALREADY_EXISTS"}
LoanAndLeaseCreateEntityInEconomicOutcome
Example
LoanAndLeaseCreateEntityInEconomicError
LoanAndLeaseCreateEntityInEconomicResult
Fields
| Field Name | Description |
|---|---|
outcome -
[LoanAndLeaseEntity!]!
|
Example
{"outcome": [LoanAndLeasePerson]}
LoanAndLeaseCreateInEconomicInput
Fields
| Input Field | Description |
|---|---|
economicId -
Long
|
Example
{"economicId": 9223372036854776000}
LoanAndLeaseCreatePersonInput
Fields
| Input Field | Description |
|---|---|
createCreditorInEconomic -
LoanAndLeaseCreateCreditorInEconomicInput
|
|
createInEconomic -
LoanAndLeaseCreateInEconomicInput
|
|
person -
LoanAndLeasePersonInput!
|
Example
{
"createCreditorInEconomic": LoanAndLeaseCreateCreditorInEconomicInput,
"createInEconomic": LoanAndLeaseCreateInEconomicInput,
"person": LoanAndLeasePersonInput
}
LoanAndLeaseCreatePortfolioInput
Fields
| Input Field | Description |
|---|---|
costs -
[LoanAndLeasePortfolioCostInput!]!
|
|
portfolio -
LoanAndLeasePortfolioInput!
|
Example
{
"costs": [LoanAndLeasePortfolioCostInput],
"portfolio": LoanAndLeasePortfolioInput
}
LoanAndLeaseCreationError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseCreationErrorType!
|
Example
{"type": "ALREADY_EXISTS"}
LoanAndLeaseCreationErrorType
Values
| Enum Value | Description |
|---|---|
|
|
If the input entities have identifiers that collide with existing entities |
|
|
Missing economic configuration |
|
|
Duplicate identifiers found in the input |
Example
"ALREADY_EXISTS"
LoanAndLeaseCreationOutcome
Types
| Union Types |
|---|
Example
LoanAndLeaseCreationError
LoanAndLeaseCreationResult
Fields
| Field Name | Description |
|---|---|
outcome -
[LoanAndLeaseEntity!]!
|
Example
{"outcome": [LoanAndLeasePerson]}
LoanAndLeaseCreditorAccount
LoanAndLeaseCreditorInvoice
Fields
| Field Name | Description |
|---|---|
account -
LoanAndLeaseCreditorAccount!
|
|
invoiceNumber -
String
|
|
vatCode -
String
|
|
dueDate -
LocalDate
|
Example
{
"account": LoanAndLeaseCreditorAccount,
"invoiceNumber": "xyz789",
"vatCode": "abc123",
"dueDate": "2020-07-19"
}
LoanAndLeaseCreditorPayment
Fields
| Field Name | Description |
|---|---|
account -
LoanAndLeaseCreditorAccount!
|
|
invoiceNumber -
String
|
Example
{
"account": LoanAndLeaseCreditorAccount,
"invoiceNumber": "xyz789"
}
LoanAndLeaseDebtorAccount
LoanAndLeaseDebtorInvoice
Fields
| Field Name | Description |
|---|---|
account -
LoanAndLeaseDebtorAccount!
|
|
invoiceNumber -
Int
|
|
vatCode -
String
|
|
dueDate -
LocalDate
|
Example
{
"account": LoanAndLeaseDebtorAccount,
"invoiceNumber": 123,
"vatCode": "xyz789",
"dueDate": "2020-07-19"
}
LoanAndLeaseDebtorPayment
Fields
| Field Name | Description |
|---|---|
account -
LoanAndLeaseDebtorAccount!
|
|
invoiceNumber -
Int
|
Example
{
"account": LoanAndLeaseDebtorAccount,
"invoiceNumber": 987
}
LoanAndLeaseDeliveryStateResult
Fields
| Field Name | Description |
|---|---|
state -
[LoanAndLeasePBSDeliveryState!]!
|
|
detachedPaymentStatuses -
[LoanAndLeasePBSDetachedPayment!]!
|
Example
{
"state": [LoanAndLeasePBSDeliveryState],
"detachedPaymentStatuses": [
LoanAndLeasePBSDetachedPayment
]
}
LoanAndLeaseEntity
Types
| Union Types |
|---|
Example
LoanAndLeasePerson
LoanAndLeaseEntityCreateCreditorInEconomicItemInput
LoanAndLeaseEntityCreateInEconomicErrorType
Values
| Enum Value | Description |
|---|---|
|
|
If any input entities already exist in economic |
|
|
Missing economic configuration |
|
|
One of the entities did not exist, the whole update is rolled back |
Example
"ALREADY_EXISTS"
LoanAndLeaseEntityCreateInEconomicItemInput
LoanAndLeaseEntityMissingDebtorNoError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
|
entityId -
UUID!
|
|
entity -
LoanAndLeaseEntity!
|
Example
{
"contract": LoanAndLeaseContract,
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entity": LoanAndLeasePerson
}
LoanAndLeaseEntityReport
Fields
| Field Name | Description |
|---|---|
total -
BigDecimal!
|
|
remainder -
BigDecimal!
|
|
diff -
BigDecimal!
|
Example
{
"total": "28391719239482739937.1939459927192",
"remainder": "28391719239482739937.1939459927192",
"diff": "28391719239482739937.1939459927192"
}
LoanAndLeaseEntityRetention
Fields
| Field Name | Description |
|---|---|
conflicts -
[LoanAndLeaseEntityRetentionRelatedToContractConflict!]!
|
|
hidden -
Boolean!
|
|
retainUntil -
Instant
|
|
hasConflicts -
Boolean!
|
Example
{
"conflicts": [
LoanAndLeaseEntityRetentionRelatedToContractConflict
],
"hidden": true,
"retainUntil": 1654109791,
"hasConflicts": true
}
LoanAndLeaseEntityRetentionInput
Fields
| Input Field | Description |
|---|---|
retention -
LoanAndLeaseRetentionInput!
|
|
entityId -
UUID!
|
Example
{
"retention": LoanAndLeaseRetentionInput,
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeaseEntityRetentionRelatedToContractConflict
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
|
contractEntity -
LoanAndLeaseContractEntity!
|
Example
{
"contract": LoanAndLeaseContract,
"contractEntity": "DEBTOR"
}
LoanAndLeaseEntityUpdateErrorType
Values
| Enum Value | Description |
|---|---|
|
|
If any of the input entities have new identifiers that collide with existing entities |
|
|
Missing economic configuration |
|
|
Duplicate identifiers found in the input |
|
|
One of the entities did not exist, the whole update is rolled back |
Example
"ALREADY_EXISTS"
LoanAndLeaseExpirationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING_CUSTOMER"
LoanAndLeaseFinanceMemo
LoanAndLeaseGenerationError
Example
LoanAndLeaseGenerationErrorGenericEmissionError
LoanAndLeaseGenerationErrorDebtorError
Fields
| Field Name | Description |
|---|---|
entityId -
UUID!
|
|
entity -
LoanAndLeaseEntity!
|
|
error -
LoanAndLeaseGenerationErrorDebtorErrorType!
|
|
invoiceIds -
[UUID!]!
|
Example
{
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entity": LoanAndLeasePerson,
"error": LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error,
"invoiceIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
LoanAndLeaseGenerationErrorDebtorErrorType
Example
LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error
LoanAndLeaseGenerationErrorDebtorMoreThan20M602Error
Fields
| Field Name | Description |
|---|---|
found -
Int!
|
Example
{"found": 987}
LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn052Error
Fields
| Field Name | Description |
|---|---|
found -
Int!
|
Example
{"found": 123}
LoanAndLeaseGenerationErrorDebtorMoreThan5000LinesIn062Error
Fields
| Field Name | Description |
|---|---|
found -
Int!
|
Example
{"found": 987}
LoanAndLeaseGenerationErrorDebtorSizeError
Fields
| Field Name | Description |
|---|---|
field -
LoanAndLeaseGenerationErrorDebtorSizeErrorFieldType!
|
|
emissionError -
LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError!
|
Example
{
"field": "NAME_ADDRESS_1",
"emissionError": LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError
}
LoanAndLeaseGenerationErrorDebtorSizeErrorFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME_ADDRESS_1"
LoanAndLeaseGenerationErrorEmissionCustomDataType
Fields
| Field Name | Description |
|---|---|
type -
String!
|
Example
{"type": "xyz789"}
LoanAndLeaseGenerationErrorEmissionDataType
Example
LoanAndLeaseGenerationErrorEmissionCustomDataType
LoanAndLeaseGenerationErrorEmissionError
Example
LoanAndLeaseGenerationErrorEmissionNumericStringError
LoanAndLeaseGenerationErrorEmissionMaxSizeExceededError
Fields
| Field Name | Description |
|---|---|
maxSize -
Int!
|
|
actualSize -
Int!
|
|
data -
String!
|
|
dataType -
LoanAndLeaseGenerationErrorEmissionDataType!
|
Example
{
"maxSize": 123,
"actualSize": 987,
"data": "xyz789",
"dataType": LoanAndLeaseGenerationErrorEmissionCustomDataType
}
LoanAndLeaseGenerationErrorEmissionNumericStringError
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "xyz789"}
LoanAndLeaseGenerationErrorEmissionPrimitiveDataType
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseGenerationErrorEmissionPrimitiveDataTypeType!
|
Example
{"type": "STRING"}
LoanAndLeaseGenerationErrorEmissionPrimitiveDataTypeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"STRING"
LoanAndLeaseGenerationErrorGenericEmissionError
Fields
| Field Name | Description |
|---|---|
emissionError -
LoanAndLeaseGenerationErrorEmissionError!
|
Example
{
"emissionError": LoanAndLeaseGenerationErrorEmissionNumericStringError
}
LoanAndLeaseGenerationErrorGenericMoreThan9000SectionsError
Fields
| Field Name | Description |
|---|---|
found -
Int!
|
Example
{"found": 987}
LoanAndLeaseGenerationErrorUnknownError
Fields
| Field Name | Description |
|---|---|
entityIds -
UUID
|
|
entities -
LoanAndLeaseEntity
|
|
invoiceIds -
[UUID!]!
|
Example
{
"entityIds": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entities": LoanAndLeasePerson,
"invoiceIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
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
}
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"
}
LoanAndLeaseIntrinsicCostId
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseIntrinsicCostIdType!
|
Example
{"type": "BASE_RATE"}
LoanAndLeaseIntrinsicCostIdType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BASE_RATE"
LoanAndLeaseInvalidContractStateError
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
Example
{"contract": LoanAndLeaseContract}
LoanAndLeaseInvoice
Fields
| Field Name | Description |
|---|---|
invoiceType -
LoanAndLeaseInvoiceType!
|
|
costs -
[LoanAndLeaseCost!]!
|
|
debtor -
LoanAndLeaseEntity!
|
Example
{
"invoiceType": "START",
"costs": [LoanAndLeaseCost],
"debtor": LoanAndLeasePerson
}
LoanAndLeaseInvoiceAggregates
LoanAndLeaseInvoiceBookingStatus
Example
LoanAndLeaseInvoiceBookingStatusPending
LoanAndLeaseInvoiceBookingStatusCompleted
Fields
| Field Name | Description |
|---|---|
invoiceNo -
Long!
|
Example
{"invoiceNo": 9223372036854776000}
LoanAndLeaseInvoiceBookingStatusDiscarded
Fields
| Field Name | Description |
|---|---|
placeholder -
Boolean!
|
Example
{"placeholder": true}
LoanAndLeaseInvoiceBookingStatusFailed
Fields
| Field Name | Description |
|---|---|
placeholder -
Boolean!
|
Example
{"placeholder": true}
LoanAndLeaseInvoiceBookingStatusPending
Fields
| Field Name | Description |
|---|---|
placeholder -
Boolean!
|
Example
{"placeholder": true}
LoanAndLeaseInvoiceBookingStatusStarted
LoanAndLeaseInvoiceDetailed
Fields
| Field Name | Description |
|---|---|
invoiceType -
LoanAndLeaseInvoiceType!
|
|
debtor -
LoanAndLeaseEntity!
|
|
invoiceHead -
LoanAndLeasePreviewInvoiceHead!
|
|
invoiceLines -
[LoanAndLeasePreviewInvoiceLineWithCostId!]!
|
Example
{
"invoiceType": "START",
"debtor": LoanAndLeasePerson,
"invoiceHead": LoanAndLeasePreviewInvoiceHead,
"invoiceLines": [
LoanAndLeasePreviewInvoiceLineWithCostId
]
}
LoanAndLeaseInvoiceGroup
Fields
| Field Name | Description |
|---|---|
invoiceId -
UUID!
|
|
status -
LoanAndLeaseInvoiceBookingStatus!
|
|
invoice -
LoanAndLeasePreviewInvoice!
|
Example
{
"invoiceId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"status": LoanAndLeaseInvoiceBookingStatusPending,
"invoice": LoanAndLeasePreviewInvoice
}
LoanAndLeaseInvoiceSelectionInput
Fields
| Input Field | Description |
|---|---|
invoiceType -
LoanAndLeaseInvoiceType!
|
|
debtorId -
UUID!
|
|
date -
LocalDate!
|
Example
{
"invoiceType": "START",
"debtorId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"date": "2020-07-19"
}
LoanAndLeaseInvoiceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"START"
LoanAndLeaseLimitedMileage
Fields
| Field Name | Description |
|---|---|
annualMax -
Int!
|
|
excessRate -
BigDecimal!
|
Example
{
"annualMax": 987,
"excessRate": "28391719239482739937.1939459927192"
}
LoanAndLeaseLimitedMileageOptionsInput
Fields
| Input Field | Description |
|---|---|
excessRate -
BigDecimal!
|
|
annualMax -
Int!
|
Example
{
"excessRate": "28391719239482739937.1939459927192",
"annualMax": 987
}
LoanAndLeaseMirrorLastRefreshed
Fields
| Field Name | Description |
|---|---|
mostRecentStatus -
LoanAndLeaseMirrorStatus!
|
|
lastRefreshed -
Instant!
|
|
lastSuccessfulRefresh -
Instant
|
Example
{
"mostRecentStatus": "RUNNING",
"lastRefreshed": 1654109791,
"lastSuccessfulRefresh": 1654109791
}
LoanAndLeaseMirrorStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"RUNNING"
LoanAndLeasePBSCollectionError
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeasePBSCollectionErrorType!
|
Example
{"error": "MISSING_CONFIGURATION"}
LoanAndLeasePBSCollectionErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
The requested invoices were not in the set of collectable invoices. |
|
|
Example
"MISSING_CONFIGURATION"
LoanAndLeasePBSCollectionOutcome
Types
| Union Types |
|---|
Example
LoanAndLeasePBSCollectionStructuredResult
LoanAndLeasePBSCollectionStructuredResult
Fields
| Field Name | Description |
|---|---|
errors -
[LoanAndLeaseGenerationError!]!
|
Example
{
"errors": [
LoanAndLeaseGenerationErrorGenericEmissionError
]
}
LoanAndLeasePBSDelivery
Fields
| Field Name | Description |
|---|---|
debtor -
LoanAndLeaseEntity!
|
|
invoice -
LoanAndLeaseBookedInvoice!
|
|
bankDate -
LocalDate!
|
|
paymentStatuses -
[LoanAndLeasePBSPayment!]!
|
Example
{
"debtor": LoanAndLeasePerson,
"invoice": LoanAndLeaseBookedInvoice,
"bankDate": "2020-07-19",
"paymentStatuses": [LoanAndLeasePBSPayment]
}
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
}
LoanAndLeasePBSDetachedPayment
Fields
| Field Name | Description |
|---|---|
customerNo -
String!
|
|
paymentStatuses -
[LoanAndLeasePBSPayment!]!
|
Example
{
"customerNo": "abc123",
"paymentStatuses": [LoanAndLeasePBSPayment]
}
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"
}
LoanAndLeasePBSPaymentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
LoanAndLeasePBSPaymentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PAYMENT_SLIP"
LoanAndLeasePBSResponse
Fields
| Field Name | Description |
|---|---|
success -
Boolean!
|
|
data -
DisplayableResource!
|
Example
{"success": true, "data": DisplayableResource}
LoanAndLeasePeriodAlignment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALIGNED"
LoanAndLeasePeriodRounding
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EXACT"
LoanAndLeasePeriodUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MONTH"
LoanAndLeasePeriodicCost
Types
| Union Types |
|---|
Example
LoanAndLeasePeriodicCostPeriod
LoanAndLeasePeriodicCostPeriod
Fields
| Field Name | Description |
|---|---|
amount -
BigDecimal!
|
|
unit -
LoanAndLeasePeriodUnit!
|
|
rounding -
LoanAndLeasePeriodRounding!
|
Example
{
"amount": "28391719239482739937.1939459927192",
"unit": "MONTH",
"rounding": "EXACT"
}
LoanAndLeasePeriodicCostPeriodInput
Fields
| Input Field | Description |
|---|---|
rounding -
LoanAndLeasePeriodRounding!
|
|
unit -
LoanAndLeasePeriodUnit!
|
|
amount -
BigDecimal!
|
Example
{
"rounding": "EXACT",
"unit": "MONTH",
"amount": "28391719239482739937.1939459927192"
}
LoanAndLeasePeriodicCostPrt
Fields
| Field Name | Description |
|---|---|
amount -
BigDecimal!
|
|
prtType -
LoanAndLeasePrtType!
|
Example
{
"amount": "28391719239482739937.1939459927192",
"prtType": "NORMAL"
}
LoanAndLeasePeriodicCostPrtInput
Fields
| Input Field | Description |
|---|---|
prtType -
LoanAndLeasePrtType!
|
|
amount -
BigDecimal!
|
Example
{
"prtType": "NORMAL",
"amount": "28391719239482739937.1939459927192"
}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"name": "abc123",
"address": "abc123",
"postalCode": "abc123",
"countryCode": KnownCountryCode,
"email": "john@gmail.com",
"invoiceEmail": "john@gmail.com",
"phone": "29400888",
"mobile": "29400888",
"identifiers": [CountrySpecificValue],
"economicId": "xyz789",
"economicCreditorId": 987,
"city": "abc123",
"report": LoanAndLeaseEntityReport,
"retention": LoanAndLeaseEntityRetention,
"roles": ["DEALER"],
"id": 4
}
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": "xyz789",
"address": "abc123",
"name": "xyz789"
}
LoanAndLeasePersonUpdate
Fields
| Input Field | Description |
|---|---|
person -
LoanAndLeasePersonInput!
|
|
entityId -
UUID!
|
Example
{
"person": LoanAndLeasePersonInput,
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
LoanAndLeasePortfolio
Fields
| Field Name | Description |
|---|---|
portfolioId -
String!
|
|
name -
String!
|
|
baseRateId -
String
|
|
bookingStartDate -
LocalDate
|
|
periodicInvoiceStartDate -
LocalDate
|
|
minEconomicContractId -
Long
|
|
maxEconomicContractId -
Long
|
|
costs -
[LoanAndLeasePortfolioCosts!]!
|
|
retention -
LoanAndLeasePortfolioRetention
|
Example
{
"portfolioId": "abc123",
"name": "xyz789",
"baseRateId": "abc123",
"bookingStartDate": "2020-07-19",
"periodicInvoiceStartDate": "2020-07-19",
"minEconomicContractId": 9223372036854776000,
"maxEconomicContractId": 9223372036854776000,
"costs": [LoanAndLeasePortfolioCosts],
"retention": LoanAndLeasePortfolioRetention
}
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 -
LoanAndLeaseIntrinsicCostIdType
|
Exactly one of |
Example
{
"isAccruedIncome": true,
"principalAccount": "ASSET",
"showMethod": "DIRECT",
"incomeCostId": "abc123",
"expenseCostId": "xyz789",
"entryText": "xyz789",
"productNo": "xyz789",
"account": 9223372036854776000,
"userDefined": "abc123",
"intrinsic": "BASE_RATE"
}
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": "abc123",
"entryText": "xyz789",
"expenseCostId": "xyz789",
"incomeCostId": "abc123",
"showMethod": "DIRECT",
"principalAccount": "ASSET",
"isAccruedIncome": true
}
LoanAndLeasePortfolioCreationError
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeasePortfolioCreationErrorType!
|
Example
{"error": "ALREADY_EXISTS"}
LoanAndLeasePortfolioCreationErrorType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ALREADY_EXISTS"
LoanAndLeasePortfolioCreationOutcome
Types
| Union Types |
|---|
Example
LoanAndLeasePortfolios
LoanAndLeasePortfolioDeletionRelatedToContractConflict
Fields
| Field Name | Description |
|---|---|
contract -
LoanAndLeaseContract!
|
Example
{"contract": LoanAndLeaseContract}
LoanAndLeasePortfolioInput
Example
{
"maxEconomicContractId": 9223372036854776000,
"minEconomicContractId": 9223372036854776000,
"periodicInvoiceStartDate": "2020-07-19",
"bookingStartDate": "2020-07-19",
"baseRateId": "abc123",
"name": "xyz789",
"portfolioId": "abc123"
}
LoanAndLeasePortfolioRetention
LoanAndLeasePortfolioRetentionInput
Fields
| Input Field | Description |
|---|---|
retention -
LoanAndLeaseRetentionInput!
|
|
portfolioId -
String!
|
Example
{
"retention": LoanAndLeaseRetentionInput,
"portfolioId": "abc123"
}
LoanAndLeasePortfolioUpdateError
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeasePortfolioUpdateErrorType!
|
Example
{"error": "NOT_FOUND"}
LoanAndLeasePortfolioUpdateErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NOT_FOUND"
LoanAndLeasePortfolioUpdateOutcome
Types
| Union Types |
|---|
Example
LoanAndLeasePortfolios
LoanAndLeasePortfolios
Fields
| Field Name | Description |
|---|---|
portfolios -
[LoanAndLeasePortfolio!]!
|
Example
{"portfolios": [LoanAndLeasePortfolio]}
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]
}
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]
}
LoanAndLeasePreviewBookingDetailedOutcome
Types
| Union Types |
|---|
Example
LoanAndLeasePreviewError
LoanAndLeasePreviewBookingDetailedResult
Fields
| Field Name | Description |
|---|---|
errors -
[LoanAndLeaseStructuredBookingErrorType!]!
|
|
previews -
[LoanAndLeasePreviewBookingDetailed!]!
|
Example
{
"errors": [LoanAndLeaseBookingParamsNotNewestError],
"previews": [LoanAndLeasePreviewBookingDetailed]
}
LoanAndLeasePreviewBookingOutcome
Types
| Union Types |
|---|
Example
LoanAndLeasePreviewError
LoanAndLeasePreviewBookingResult
Fields
| Field Name | Description |
|---|---|
errors -
[LoanAndLeaseStructuredBookingErrorType!]!
|
|
previews -
[LoanAndLeasePreviewBooking!]!
|
Example
{
"errors": [LoanAndLeaseBookingParamsNotNewestError],
"previews": [LoanAndLeasePreviewBooking]
}
LoanAndLeasePreviewCollectionError
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeasePreviewCollectionErrorType!
|
Example
{"error": "MISSING_CONFIGURATION"}
LoanAndLeasePreviewCollectionErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MISSING_CONFIGURATION"
LoanAndLeasePreviewCollectionOutcome
Example
LoanAndLeasePreviewCollectionError
LoanAndLeasePreviewCollectionResult
Fields
| Field Name | Description |
|---|---|
data -
Uri!
|
Example
{"data": "https://domain.com/resource"}
LoanAndLeasePreviewCollectionStructuredErrors
Fields
| Field Name | Description |
|---|---|
errors -
[LoanAndLeaseGenerationError!]!
|
Example
{
"errors": [
LoanAndLeaseGenerationErrorGenericEmissionError
]
}
LoanAndLeasePreviewError
Fields
| Field Name | Description |
|---|---|
error -
LoanAndLeasePreviewErrorType!
|
Example
{"error": "DUPLICATE_IDS"}
LoanAndLeasePreviewErrorType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DUPLICATE_IDS"
LoanAndLeasePreviewInvoice
Fields
| Field Name | Description |
|---|---|
head -
LoanAndLeasePreviewInvoiceHead!
|
|
lines -
[LoanAndLeasePreviewInvoiceLine!]!
|
Example
{
"head": LoanAndLeasePreviewInvoiceHead,
"lines": [LoanAndLeasePreviewInvoiceLine]
}
LoanAndLeasePreviewInvoiceHead
Example
{
"customerNumber": 9223372036854776000,
"date": "2020-07-19",
"dueDate": "2020-07-19",
"notesHeading": "abc123",
"notesTextLine1": "xyz789",
"notesTextLine2": "abc123"
}
LoanAndLeasePreviewInvoiceLine
Fields
| Field Name | Description |
|---|---|
dimensionNo -
Int
|
|
text -
String!
|
|
productNo -
String!
|
|
amount -
BigDecimal!
|
Example
{
"dimensionNo": 987,
"text": "xyz789",
"productNo": "xyz789",
"amount": "28391719239482739937.1939459927192"
}
LoanAndLeasePreviewInvoiceLineWithCostId
Fields
| Field Name | Description |
|---|---|
line -
LoanAndLeasePreviewInvoiceLine!
|
|
cost -
LoanAndLeasePortfolioCosts
|
Example
{
"line": LoanAndLeasePreviewInvoiceLine,
"cost": LoanAndLeasePortfolioCosts
}
LoanAndLeasePreviewTransaction
Fields
| Field Name | Description |
|---|---|
date -
LocalDate!
|
|
lines -
[LoanAndLeasePreviewTransactionLine!]!
|
Example
{
"date": "2020-07-19",
"lines": [LoanAndLeasePreviewTransactionLine]
}
LoanAndLeasePreviewTransactionLine
Fields
| Field Name | Description |
|---|---|
lineType -
LoanAndLeaseTransactionLineType!
|
|
text -
String!
|
|
amount -
BigDecimal!
|
|
dimensionNo -
Int
|
Example
{
"lineType": LoanAndLeaseCreditorPayment,
"text": "xyz789",
"amount": "28391719239482739937.1939459927192",
"dimensionNo": 987
}
LoanAndLeasePrincipalAccount
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSET"
LoanAndLeasePrtRate
Description
Requires the caller to have the 'manager' 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
}
LoanAndLeasePrtRateInput
Fields
| Input Field | Description |
|---|---|
prtRate -
BigDecimal
|
|
date -
LocalDate!
|
Example
{
"prtRate": "28391719239482739937.1939459927192",
"date": "2020-07-19"
}
LoanAndLeasePrtType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NORMAL"
LoanAndLeaseRegTax
Types
| Union Types |
|---|
Example
LoanAndLeaseRegTaxNone
LoanAndLeaseRegTaxFull
Fields
| Field Name | Description |
|---|---|
fullTax -
BigDecimal
|
|
recalc -
LoanAndLeaseRegTaxPrtRecalc
|
Example
{
"fullTax": "28391719239482739937.1939459927192",
"recalc": LoanAndLeaseRegTaxPrtRecalc
}
LoanAndLeaseRegTaxFullInput
Fields
| Input Field | Description |
|---|---|
recalc -
LoanAndLeaseRegTaxPrtRecalcInput
|
|
fullTax -
BigDecimal
|
Example
{
"recalc": LoanAndLeaseRegTaxPrtRecalcInput,
"fullTax": "28391719239482739937.1939459927192"
}
LoanAndLeaseRegTaxInput
Fields
| Input Field | Description |
|---|---|
proportionate -
LoanAndLeaseRegTaxProportionateInput
|
|
full -
LoanAndLeaseRegTaxFullInput
|
|
none -
Boolean!
|
Example
{
"proportionate": LoanAndLeaseRegTaxProportionateInput,
"full": LoanAndLeaseRegTaxFullInput,
"none": true
}
LoanAndLeaseRegTaxNone
Fields
| Field Name | Description |
|---|---|
none -
Boolean!
|
Example
{"none": true}
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
}
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"
}
LoanAndLeaseRegTaxPrtRecalc
Fields
| Field Name | Description |
|---|---|
offsetMonths -
Long!
|
|
fullTax -
BigDecimal!
|
Example
{
"offsetMonths": 9223372036854776000,
"fullTax": "28391719239482739937.1939459927192"
}
LoanAndLeaseRegTaxPrtRecalcInput
Fields
| Input Field | Description |
|---|---|
fullTax -
BigDecimal!
|
|
offsetMonths -
Long!
|
Example
{
"fullTax": "28391719239482739937.1939459927192",
"offsetMonths": 9223372036854776000
}
LoanAndLeaseRemoveRepresentativeError
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REPRESENTATIVE_NOT_FOUND"
LoanAndLeaseRepresentative
Fields
| Field Name | Description |
|---|---|
representativeId -
UUID!
|
|
entityId -
UUID!
|
|
entity -
LoanAndLeaseEntity!
|
|
name -
String!
|
|
users -
[User!]!
|
Example
{
"representativeId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entity": LoanAndLeasePerson,
"name": "abc123",
"users": [User]
}
LoanAndLeaseRepresentativeUser
LoanAndLeaseRetention
Possible Types
| LoanAndLeaseRetention Types |
|---|
Example
{"hidden": true, "retainUntil": 1654109791, "hasConflicts": true}
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
}
LoanAndLeaseShowMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DIRECT"
LoanAndLeaseSimpleBookingError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseSimpleBookingErrorType!
|
Example
{"type": "DUPLICATE_IDS"}
LoanAndLeaseSimpleBookingErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DUPLICATE_IDS"
LoanAndLeaseSortEntityBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
LoanAndLeaseStructuredBookingError
Fields
| Field Name | Description |
|---|---|
errors -
[LoanAndLeaseStructuredBookingErrorType!]!
|
Example
{"errors": [LoanAndLeaseBookingParamsNotNewestError]}
LoanAndLeaseStructuredBookingErrorType
Example
LoanAndLeaseBookingParamsNotNewestError
LoanAndLeaseTransactionAggregates
LoanAndLeaseTransactionBookingStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
LoanAndLeaseTransactionEntry
Fields
| Field Name | Description |
|---|---|
transactionId -
UUID!
|
|
transaction -
LoanAndLeasePreviewTransaction!
|
Example
{
"transactionId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"transaction": LoanAndLeasePreviewTransaction
}
LoanAndLeaseTransactionGroup
Fields
| Field Name | Description |
|---|---|
transactionBatchId -
UUID!
|
|
status -
LoanAndLeaseTransactionBookingStatus!
|
|
transactions -
[LoanAndLeaseTransactionEntry!]!
|
Example
{
"transactionBatchId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"status": "COMPLETED",
"transactions": [LoanAndLeaseTransactionEntry]
}
LoanAndLeaseTransactionLineType
Example
LoanAndLeaseCreditorPayment
LoanAndLeaseUpdateError
Fields
| Field Name | Description |
|---|---|
type -
LoanAndLeaseEntityUpdateErrorType!
|
Example
{"type": "ALREADY_EXISTS"}
LoanAndLeaseUpdateOutcome
Types
| Union Types |
|---|
Example
LoanAndLeaseUpdateError
LoanAndLeaseUpdatePortfolioCostInput
Fields
| Input Field | Description |
|---|---|
cost -
LoanAndLeasePortfolioCostInput!
|
|
portfolioId -
String!
|
Example
{
"cost": LoanAndLeasePortfolioCostInput,
"portfolioId": "abc123"
}
LoanAndLeaseUpdateResult
Fields
| Field Name | Description |
|---|---|
outcome -
[LoanAndLeaseEntity!]!
|
Example
{"outcome": [LoanAndLeasePerson]}
LoanAndLeaseUserDefinedCostId
Fields
| Field Name | Description |
|---|---|
name -
String!
|
Example
{"name": "xyz789"}
LoandAndLeaseRegTaxType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROPORTIONATE"
LoandAndLeaseWarningType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANY"
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"
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
MediaType
Description
The MediaType scalar type is a valid media type (MIME type) like 'application/json'.
Example
MediaType
MutableEntityRole
Description
A role that can be mutated
Values
| Enum Value | Description |
|---|---|
|
|
Translates to the 'dealer' role |
Example
"DEALER"
MutableRole
Description
A role that can be mutated
Values
| Enum Value | Description |
|---|---|
|
|
Translates to the 'approver' role |
|
|
Translates to the 'admin' role |
Example
"APPROVER"
NewUserInput
Node
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Example
{"id": 4}
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"institutionId": "abc123",
"accountId": "xyz789",
"accountTitle": "abc123",
"income": NordigenAggregatedBySign,
"expense": NordigenAggregatedBySign,
"transactions": [NordigenTransaction]
}
NordigenAggregatedByCategory
Fields
| Field Name | Description |
|---|---|
values -
NordigenAggregatedValues!
|
|
level0 -
Int
|
|
level1 -
Int
|
|
level2 -
Int
|
|
diCategory -
NordigenDICategory
|
Example
{
"values": NordigenAggregatedValues,
"level0": 123,
"level1": 987,
"level2": 123,
"diCategory": "HOME_UTILITIES"
}
NordigenAggregatedBySign
Fields
| Field Name | Description |
|---|---|
values -
NordigenAggregatedValues!
|
|
categories -
[NordigenAggregatedByCategory!]!
|
Example
{
"values": NordigenAggregatedValues,
"categories": [NordigenAggregatedByCategory]
}
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": 987,
"accounts": [NordigenAccount]
}
NordigenAggregatedValues
Fields
| Field Name | Description |
|---|---|
total -
BigDecimal!
|
|
months -
[BigDecimal!]!
|
Example
{
"total": "28391719239482739937.1939459927192",
"months": [
"28391719239482739937.1939459927192"
]
}
NordigenCategory
NordigenCompletedStatus
NordigenCreatedStatus
Fields
| Field Name | Description |
|---|---|
requisitionId -
UUID!
|
Example
{
"requisitionId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
NordigenDICategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOME_UTILITIES"
NordigenFailedAccountsDataStatus
Fields
| Field Name | Description |
|---|---|
requisitionId -
UUID!
|
|
status -
NordigenRequisitionStatus
|
Example
{
"requisitionId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"status": "CREATED"
}
NordigenFailedInsightsDataStatus
NordigenFlowStatus
Example
NordigenCompletedStatus
NordigenInstitution
Fields
| Field Name | Description |
|---|---|
institutionId -
NordigenInstitutionId!
|
|
name -
String!
|
|
logo -
Uri!
|
Example
{
"institutionId": NordigenInstitutionId,
"name": "xyz789",
"logo": "https://domain.com/resource"
}
NordigenInstitutionId
Description
The underlying type of this id is always string
Example
NordigenInstitutionId
NordigenRequisition
Fields
| Field Name | Description |
|---|---|
requisitionId -
UUID!
|
|
institutionId -
String!
|
|
created -
Instant!
|
|
nordigenStatus -
NordigenFlowStatus
|
Example
{
"requisitionId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"institutionId": "abc123",
"created": 1654109791,
"nordigenStatus": NordigenCompletedStatus
}
NordigenRequisitionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
NordigenRunningAccountsDataStatus
Fields
| Field Name | Description |
|---|---|
requisitionId -
UUID!
|
Example
{
"requisitionId": "e35f72e9-9969-4577-96a0-4011fae907c4"
}
NordigenRunningInsightsDataStatus
NordigenSecrets
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": "abc123",
"amount": "28391719239482739937.1939459927192",
"level0": 987,
"level1": 987,
"level2": 987,
"diCategory": "HOME_UTILITIES"
}
NumberPaging
Org
Description
The Org scalar type is a valid danish organisation number.
Example
"acme"
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
|
|
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
|
|
Example
{
"users": [User],
"organizationUsers": [OrganizationUser],
"me": OrganizationUser,
"name": "acme",
"computedRoles": ["CONTRACT_READER"],
"mutableRoles": ["APPROVER"]
}
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:
|
mutableRoles -
[MutableRole!]!
|
One of the following:
|
id -
ID!
|
Example
{
"organization": Organization,
"user": User,
"computedRoles": ["CONTRACT_READER"],
"mutableRoles": ["APPROVER"],
"id": 4
}
OwnershipPercentage
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OWNERSHIP_0_05"
PepEntry
PepGroup
Fields
| Field Name | Description |
|---|---|
creation -
Instant!
|
|
pepDate -
LocalDate!
|
|
entries -
[PepEntry!]!
|
Example
{
"creation": 1654109791,
"pepDate": "2020-07-19",
"entries": [PepEntry]
}
PersonIdentifier
Types
| Union Types |
|---|
Example
CountrySpecificValue
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"
}
Phone
Description
The Phone scalar type accepts any valid phone number. see
https://github.com/google/libphonenumber for more information.
Example
"29400888"
PreviewTransactionLineWithCostId
Fields
| Field Name | Description |
|---|---|
line -
LoanAndLeasePreviewTransactionLine!
|
|
cost -
LoanAndLeasePortfolioCosts
|
Example
{
"line": LoanAndLeasePreviewTransactionLine,
"cost": LoanAndLeasePortfolioCosts
}
RegisterError
RemoveContractFilesError
Types
| Union Types |
|---|
Example
RemoveContractFilesSuccess
RemoveContractFilesFilesNotFoundError
Fields
| Field Name | Description |
|---|---|
fileIds -
[UUID!]!
|
Example
{
"fileIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
RemoveContractFilesSuccess
Fields
| Field Name | Description |
|---|---|
contracts -
[LoanAndLeaseContract!]!
|
Example
{"contracts": [LoanAndLeaseContract]}
ReportingConfig
Fields
| Field Name | Description |
|---|---|
expirationWarningDays -
Int
|
Example
{"expirationWarningDays": 987}
ReportingConfigInput
Fields
| Input Field | Description |
|---|---|
expirationWarningDays -
Int
|
Example
{"expirationWarningDays": 987}
RkiSecrets
Fields
| Input Field | Description |
|---|---|
password -
String!
|
|
username -
String!
|
|
service -
RkiService!
|
Example
{
"password": "abc123",
"username": "abc123",
"service": "PRODUCTION"
}
RkiService
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRODUCTION"
SanctionedEntity
Fields
| Field Name | Description |
|---|---|
refNo -
String!
|
|
legalBasis -
String!
|
|
programme -
String!
|
|
names -
[SanctionedEntityName!]!
|
|
birthdates -
[SanctionedEntityBirthdate!]!
|
|
citizenships -
[SanctionedEntityCitizenship!]!
|
|
remark -
String
|
Example
{
"refNo": "xyz789",
"legalBasis": "xyz789",
"programme": "xyz789",
"names": [SanctionedEntityName],
"birthdates": [SanctionedEntityBirthdateRange],
"citizenships": [SanctionedEntityCitizenship],
"remark": "xyz789"
}
SanctionedEntityBirthdate
Types
| Union Types |
|---|
Example
SanctionedEntityBirthdateRange
SanctionedEntityBirthdateRange
Fields
| Field Name | Description |
|---|---|
from -
LocalDate!
|
|
to -
LocalDate!
|
Example
{
"from": "2020-07-19",
"to": "2020-07-19"
}
SanctionedEntityCitizenship
Fields
| Field Name | Description |
|---|---|
citizenship -
String!
|
Example
{"citizenship": "xyz789"}
SanctionedEntityExactBirthdate
Fields
| Field Name | Description |
|---|---|
birthdate -
LocalDate!
|
Example
{"birthdate": "2020-07-19"}
SanctionedEntityName
Fields
| Field Name | Description |
|---|---|
fullName -
String!
|
Example
{"fullName": "xyz789"}
SetAssetError
Types
| Union Types |
|---|
Example
AssetUpdateVinAlreadyExists
SetAssetResult
Types
| Union Types |
|---|
Example
AssetUpdateError
SortAssetBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
SortContractBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
String
Description
The String is a UTF-8 character sequence usually representing human-readable text.
Example
"xyz789"
Timestamped
Fields
| Field Name | Description |
|---|---|
timestamp -
Instant!
|
Possible Types
| Timestamped Types |
|---|
Example
{"timestamp": 1654109791}
UUID
Description
The UUID scalar type represents a UUID v4 as specified by
RFC 4122.
Example
"e35f72e9-9969-4577-96a0-4011fae907c4"
UnknownCountryCode
Fields
| Field Name | Description |
|---|---|
code -
String!
|
Example
{"code": "xyz789"}
UpdateCreditlinkCompany
Example
{
"externalId": "0110293",
"userId": "oauthprovider|c5beb9b2-d77a-49f4-b584-29b965c9379d",
"financialCrimeEnabled": true,
"badDebtEnabled": true,
"phone": "29400888",
"email": "john@gmail.com",
"cvr": "35890270",
"name": "xyz789"
}
UpdateCreditlinkPerson
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": "abc123"
}
Uri
Description
The Uri scalar type is a valid RFC3986 address.
Example
"https://domain.com/resource"
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
|
|
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": "xyz789",
"email": "john@gmail.com",
"globalRoles": ["ADMIN"],
"organizations": [Organization],
"organizationUsers": [OrganizationUser]
}
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"
Year
Description
A year in the ISO-8601 calendar system, such as 2007.
Example
"2007"
YearMonth
Description
A year-month in the ISO-8601 calendar system, such as 2007-12.
Example
"2007-12"
Subscriptions
assetSearch
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
[Asset!]!
Arguments
| Name | Description |
|---|---|
sortDirection -
SortDirection
|
Default = DESC |
sortBy -
SortAssetBy
|
Default = CREATED |
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,
$search: String,
$offset: Long!,
$size: Long!,
$org: Org!,
$org: Org!
) {
assetSearch(
sortDirection: $sortDirection,
sortBy: $sortBy,
search: $search,
offset: $offset,
size: $size,
org: $org,
org: $org
) {
assetId
vin
makeModel
regNo
firstRegDate
retention {
contractRelations {
...LoanAndLeaseContractFragment
}
hidden
retainUntil
hasConflicts
}
id
}
}
Variables
{
"sortDirection": "DESC",
"sortBy": "CREATED",
"search": "xyz789",
"offset": 9223372036854776000,
"size": 9223372036854776000,
"org": "acme"
}
Response
{
"data": {
"assetSearch": [
{
"assetId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"vin": "abc123",
"makeModel": "abc123",
"regNo": "xyz789",
"firstRegDate": "2020-07-19",
"retention": AssetRetention,
"id": 4
}
]
}
}
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 'manager' relation to the 'org' resource (derived from the argument 'org')
Response
Returns
[Asset!]!
Example
Query
subscription assets(
$assetIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
assets(
assetIds: $assetIds,
org: $org,
org: $org
) {
assetId
vin
makeModel
regNo
firstRegDate
retention {
contractRelations {
...LoanAndLeaseContractFragment
}
hidden
retainUntil
hasConflicts
}
id
}
}
Variables
{
"assetIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"assets": [
{
"assetId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"vin": "xyz789",
"makeModel": "abc123",
"regNo": "abc123",
"firstRegDate": "2020-07-19",
"retention": AssetRetention,
"id": "4"
}
]
}
}
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!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"org": "acme"
}
Response
{
"data": {
"creditlinkCase": CreditlinkCaseSubscribedEvent
}
}
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
}
}
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!
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
}
}
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!]!
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"
}
]
}
}
loanAndLeaseCollectableInvoices
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
[LoanAndLeaseBookedInvoice!]!
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
}
id
}
}
Variables
{"extended": true, "org": "acme"}
Response
{
"data": {
"loanAndLeaseCollectableInvoices": [
{
"header": LoanAndLeaseBookedInvoiceHeader,
"lines": [LoanAndLeaseBookedInvoiceLine],
"id": "4"
}
]
}
}
loanAndLeaseContractCounts
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
LoanAndLeaseContractCountsFiltered!
Arguments
| Name | Description |
|---|---|
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(
$expirationStatus: LoanAndLeaseExpirationStatus,
$regTaxType: LoandAndLeaseRegTaxType,
$contractStatus: LoanAndLeaseContractStatus,
$warningType: LoandAndLeaseWarningType,
$reverseSearch: String,
$search: String,
$org: Org!,
$org: Org!
) {
loanAndLeaseContractCounts(
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
}
withOtherContractStatus {
all
draft
starting
active
ending
completed
inventory
}
withOtherRegTax {
all
proportionate
full
none
}
withOtherExpirationStatus {
all
pendingCustomer
extension
termination
newContract
}
}
}
Variables
{
"expirationStatus": "PENDING_CUSTOMER",
"regTaxType": "PROPORTIONATE",
"contractStatus": "DRAFT",
"warningType": "ANY",
"reverseSearch": null,
"search": "abc123",
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseContractCounts": {
"withOtherWarningType": LoanAndLeaseContractCountsFilteredWithOtherWarningType,
"withOtherContractStatus": LoanAndLeaseContractCountsFilteredWithOtherContractStatus,
"withOtherRegTax": LoanAndLeaseContractCountsFilteredWithOtherRegTax,
"withOtherExpirationStatus": LoanAndLeaseContractCountsFilteredWithOtherExpirationStatus
}
}
}
loanAndLeaseContractCountsFiltered
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
LoanAndLeaseContractCountsFiltered!
Arguments
| Name | Description |
|---|---|
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(
$expirationStatus: LoanAndLeaseExpirationStatus,
$regTaxType: LoandAndLeaseRegTaxType,
$contractStatus: LoanAndLeaseContractStatus,
$warningType: LoandAndLeaseWarningType,
$reverseSearch: String,
$search: String,
$org: Org!,
$org: Org!
) {
loanAndLeaseContractCountsFiltered(
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
}
withOtherContractStatus {
all
draft
starting
active
ending
completed
inventory
}
withOtherRegTax {
all
proportionate
full
none
}
withOtherExpirationStatus {
all
pendingCustomer
extension
termination
newContract
}
}
}
Variables
{
"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
}
}
}
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 'manager' 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 |
|---|---|
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(
$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(
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
portfolio {
portfolioId
name
baseRateId
bookingStartDate
periodicInvoiceStartDate
minEconomicContractId
maxEconomicContractId
costs {
...LoanAndLeasePortfolioCostsFragment
}
retention {
...LoanAndLeasePortfolioRetentionFragment
}
}
annuityStart
annuityEnd
adjustEnd
periodUnit
baseRate
internalMarginRate
externalMarginRate
fixedRate
residualValue
contractStatus
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
}
}
}
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
retention {
...AssetRetentionFragment
}
id
}
periodAlignment
invoiceText
sharedInsurancePolicy
expirationStatus
regTax {
... on LoanAndLeaseRegTaxNone {
...LoanAndLeaseRegTaxNoneFragment
}
... on LoanAndLeaseRegTaxFull {
...LoanAndLeaseRegTaxFullFragment
}
... on LoanAndLeaseRegTaxProportionate {
...LoanAndLeaseRegTaxProportionateFragment
}
}
secondHandVat
approverInitials
firstPeriodInvoice
collectionMethod
mailNotification
report {
supplierPayable
asset
asset2
asset3
deposit
remainder
debtorRemainders {
...LoanAndLeaseContractReportDebtorRemainderFragment
}
supplierPayableWarning
assetWarning
startDateWarning
endDateWarning
anyAccountWarning
expirationWarning
}
retention {
hidden
retainUntil
hasConflicts
}
annuityFinalEnd
computedEndDate
computedStartDate
regTaxEndDate
regTaxStartDate
comments {
comment
created
createdBy
author {
...UserFragment
}
}
files {
file {
...FileFragment
}
category
caption
created
author {
...UserFragment
}
}
id
}
}
Variables
{
"expirationStatus": "PENDING_CUSTOMER",
"regTaxType": "PROPORTIONATE",
"warningType": "ANY",
"hasWarning": false,
"contractStatus": "DRAFT",
"sortDirection": "DESC",
"sortBy": "CREATED",
"reverseSearch": null,
"search": "xyz789",
"offset": 9223372036854776000,
"size": 9223372036854776000,
"org": "acme",
"entityIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
]
}
Response
{
"data": {
"loanAndLeaseContractSearch": [
{
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"dimensionNo": 987,
"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",
"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": "xyz789",
"firstPeriodInvoice": "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],
"id": "4"
}
]
}
}
loanAndLeaseContracts
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
[LoanAndLeaseContract!]!
Example
Query
subscription loanAndLeaseContracts(
$contractIds: [UUID!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseContracts(
contractIds: $contractIds,
org: $org,
org: $org
) {
contractId
dimensionNo
portfolio {
portfolioId
name
baseRateId
bookingStartDate
periodicInvoiceStartDate
minEconomicContractId
maxEconomicContractId
costs {
...LoanAndLeasePortfolioCostsFragment
}
retention {
...LoanAndLeasePortfolioRetentionFragment
}
}
annuityStart
annuityEnd
adjustEnd
periodUnit
baseRate
internalMarginRate
externalMarginRate
fixedRate
residualValue
contractStatus
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
}
}
}
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
retention {
...AssetRetentionFragment
}
id
}
periodAlignment
invoiceText
sharedInsurancePolicy
expirationStatus
regTax {
... on LoanAndLeaseRegTaxNone {
...LoanAndLeaseRegTaxNoneFragment
}
... on LoanAndLeaseRegTaxFull {
...LoanAndLeaseRegTaxFullFragment
}
... on LoanAndLeaseRegTaxProportionate {
...LoanAndLeaseRegTaxProportionateFragment
}
}
secondHandVat
approverInitials
firstPeriodInvoice
collectionMethod
mailNotification
report {
supplierPayable
asset
asset2
asset3
deposit
remainder
debtorRemainders {
...LoanAndLeaseContractReportDebtorRemainderFragment
}
supplierPayableWarning
assetWarning
startDateWarning
endDateWarning
anyAccountWarning
expirationWarning
}
retention {
hidden
retainUntil
hasConflicts
}
annuityFinalEnd
computedEndDate
computedStartDate
regTaxEndDate
regTaxStartDate
comments {
comment
created
createdBy
author {
...UserFragment
}
}
files {
file {
...FileFragment
}
category
caption
created
author {
...UserFragment
}
}
id
}
}
Variables
{
"contractIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseContracts": [
{
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"dimensionNo": 987,
"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",
"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": "abc123",
"firstPeriodInvoice": "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],
"id": "4"
}
]
}
}
loanAndLeaseContractsByEconomicIds
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
[LoanAndLeaseContract!]!
Example
Query
subscription loanAndLeaseContractsByEconomicIds(
$economicIds: [Long!]!,
$org: Org!,
$org: Org!
) {
loanAndLeaseContractsByEconomicIds(
economicIds: $economicIds,
org: $org,
org: $org
) {
contractId
dimensionNo
portfolio {
portfolioId
name
baseRateId
bookingStartDate
periodicInvoiceStartDate
minEconomicContractId
maxEconomicContractId
costs {
...LoanAndLeasePortfolioCostsFragment
}
retention {
...LoanAndLeasePortfolioRetentionFragment
}
}
annuityStart
annuityEnd
adjustEnd
periodUnit
baseRate
internalMarginRate
externalMarginRate
fixedRate
residualValue
contractStatus
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
}
}
}
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
retention {
...AssetRetentionFragment
}
id
}
periodAlignment
invoiceText
sharedInsurancePolicy
expirationStatus
regTax {
... on LoanAndLeaseRegTaxNone {
...LoanAndLeaseRegTaxNoneFragment
}
... on LoanAndLeaseRegTaxFull {
...LoanAndLeaseRegTaxFullFragment
}
... on LoanAndLeaseRegTaxProportionate {
...LoanAndLeaseRegTaxProportionateFragment
}
}
secondHandVat
approverInitials
firstPeriodInvoice
collectionMethod
mailNotification
report {
supplierPayable
asset
asset2
asset3
deposit
remainder
debtorRemainders {
...LoanAndLeaseContractReportDebtorRemainderFragment
}
supplierPayableWarning
assetWarning
startDateWarning
endDateWarning
anyAccountWarning
expirationWarning
}
retention {
hidden
retainUntil
hasConflicts
}
annuityFinalEnd
computedEndDate
computedStartDate
regTaxEndDate
regTaxStartDate
comments {
comment
created
createdBy
author {
...UserFragment
}
}
files {
file {
...FileFragment
}
category
caption
created
author {
...UserFragment
}
}
id
}
}
Variables
{
"economicIds": [9223372036854776000],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseContractsByEconomicIds": [
{
"contractId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"dimensionNo": 987,
"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",
"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": "xyz789",
"firstPeriodInvoice": "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],
"id": 4
}
]
}
}
loanAndLeaseEntities
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
[LoanAndLeaseEntity!]!
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
city
report {
...LoanAndLeaseEntityReportFragment
}
retention {
...LoanAndLeaseEntityRetentionFragment
}
roles
id
}
}
}
Variables
{
"entityIds": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{"data": {"loanAndLeaseEntities": [LoanAndLeasePerson]}}
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 'manager' 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
city
report {
...LoanAndLeaseEntityReportFragment
}
retention {
...LoanAndLeaseEntityRetentionFragment
}
roles
id
}
}
}
Variables
{
"economicIds": ["abc123"],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseEntitiesByEconomicIds": [
LoanAndLeasePerson
]
}
}
loanAndLeaseEntitiesByIdentifiers
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 'manager' relation to the 'org' resource (derived from the argument 'org')
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
city
report {
...LoanAndLeaseEntityReportFragment
}
retention {
...LoanAndLeaseEntityRetentionFragment
}
roles
id
}
}
}
Variables
{
"companyIdentifiers": [CompanyIdentifierInput],
"personIdentifiers": [PersonIdentifierInput],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseEntitiesByIdentifiers": [
LoanAndLeasePerson
]
}
}
loanAndLeaseEntityRepresentatives
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
[LoanAndLeaseRepresentative!]!
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseEntityRepresentatives": [
{
"representativeId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entity": LoanAndLeasePerson,
"name": "xyz789",
"users": [User]
}
]
}
}
loanAndLeaseEntitySearch
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
[LoanAndLeaseEntity!]!
Arguments
| Name | Description |
|---|---|
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(
$sortDirection: SortDirection!,
$sortBy: LoanAndLeaseSortEntityBy!,
$reverseSearch: String,
$search: String,
$offset: Long!,
$size: Long!,
$org: Org!,
$org: Org!
) {
loanAndLeaseEntitySearch(
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
city
report {
...LoanAndLeaseEntityReportFragment
}
retention {
...LoanAndLeaseEntityRetentionFragment
}
roles
id
}
}
}
Variables
{
"sortDirection": "DESC",
"sortBy": "CREATED",
"reverseSearch": null,
"search": "xyz789",
"offset": 9223372036854776000,
"size": 9223372036854776000,
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseEntitySearch": [LoanAndLeasePerson]
}
}
loanAndLeaseInvoiceAggregates
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
LoanAndLeaseInvoiceAggregates!
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
}
}
}
loanAndLeaseInvoiceSearch
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
[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
}
}
}
}
Variables
{
"bookingStatusFilter": "COMPLETED",
"offset": 9223372036854776000,
"size": 9223372036854776000,
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseInvoiceSearch": [
{
"invoiceId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"status": LoanAndLeaseInvoiceBookingStatusPending,
"invoice": LoanAndLeasePreviewInvoice
}
]
}
}
loanAndLeaseMirrorLastRefreshed
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
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
}
}
}
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!]!
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": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entityId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"entity": LoanAndLeasePerson,
"name": "abc123",
"users": [User]
}
]
}
}
loanAndLeasePBSDeliveryState
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
LoanAndLeaseDeliveryStateResult!
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
]
}
}
}
loanAndLeasePortfolio
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
[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
costs {
costId {
... on LoanAndLeaseIntrinsicCostId {
...LoanAndLeaseIntrinsicCostIdFragment
}
... on LoanAndLeaseUserDefinedCostId {
...LoanAndLeaseUserDefinedCostIdFragment
}
}
account
productNo
entryText
expenseCostId
incomeCostId
showMethod
principalAccount
isAccruedIncome
}
retention {
hidden
retainUntil
hasConflicts
}
}
}
Variables
{
"portfolioIds": ["xyz789"],
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePortfolio": [
{
"portfolioId": "xyz789",
"name": "xyz789",
"baseRateId": "abc123",
"bookingStartDate": "2020-07-19",
"periodicInvoiceStartDate": "2020-07-19",
"minEconomicContractId": 9223372036854776000,
"maxEconomicContractId": 9223372036854776000,
"costs": [LoanAndLeasePortfolioCosts],
"retention": LoanAndLeasePortfolioRetention
}
]
}
}
loanAndLeasePortfolioDeletionConflicts
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
[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
portfolio {
...LoanAndLeasePortfolioFragment
}
annuityStart
annuityEnd
adjustEnd
periodUnit
baseRate
internalMarginRate
externalMarginRate
fixedRate
residualValue
contractStatus
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
collectionMethod
mailNotification
report {
...LoanAndLeaseContractReportFragment
}
retention {
...LoanAndLeaseContractRetentionFragment
}
annuityFinalEnd
computedEndDate
computedStartDate
regTaxEndDate
regTaxStartDate
comments {
...LoanAndLeaseContractCommentFragment
}
files {
...ContractFileFragment
}
id
}
}
}
Variables
{
"offset": 9223372036854776000,
"size": 9223372036854776000,
"portfolioIds": ["xyz789"],
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePortfolioDeletionConflicts": [
{"contract": LoanAndLeaseContract}
]
}
}
loanAndLeasePortfolioSearch
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
[LoanAndLeasePortfolio!]!
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
costs {
costId {
... on LoanAndLeaseIntrinsicCostId {
...LoanAndLeaseIntrinsicCostIdFragment
}
... on LoanAndLeaseUserDefinedCostId {
...LoanAndLeaseUserDefinedCostIdFragment
}
}
account
productNo
entryText
expenseCostId
incomeCostId
showMethod
principalAccount
isAccruedIncome
}
retention {
hidden
retainUntil
hasConflicts
}
}
}
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,
"costs": [LoanAndLeasePortfolioCosts],
"retention": LoanAndLeasePortfolioRetention
}
]
}
}
loanAndLeasePreviewAllBooking
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
LoanAndLeasePreviewBookingResult!
Arguments
| Name | Description |
|---|---|
date -
LocalDate!
|
|
org -
Org!
|
The organization which the action relates to. |
org -
Org!
|
The organization which the action relates to. |
Example
Query
subscription loanAndLeasePreviewAllBooking(
$date: LocalDate!,
$org: Org!,
$org: Org!
) {
loanAndLeasePreviewAllBooking(
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
{
"date": "2020-07-19",
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePreviewAllBooking": {
"errors": [LoanAndLeaseBookingParamsNotNewestError],
"previews": [LoanAndLeasePreviewBooking]
}
}
}
loanAndLeasePreviewBooking
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
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePreviewBooking": LoanAndLeasePreviewError
}
}
loanAndLeasePreviewBookingDetailed
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
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": [
"e35f72e9-9969-4577-96a0-4011fae907c4"
],
"org": "acme"
}
Response
{
"data": {
"loanAndLeasePreviewBookingDetailed": LoanAndLeasePreviewError
}
}
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!]!
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"
}
]
}
}
loanAndLeaseTransactionAggregates
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
LoanAndLeaseTransactionAggregates!
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
}
}
}
loanAndLeaseTransactionSearch
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
[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
transactions {
transactionId
transaction {
...LoanAndLeasePreviewTransactionFragment
}
}
}
}
Variables
{
"bookingStatusFilter": "COMPLETED",
"offset": 9223372036854776000,
"size": 9223372036854776000,
"org": "acme"
}
Response
{
"data": {
"loanAndLeaseTransactionSearch": [
{
"transactionBatchId": "e35f72e9-9969-4577-96a0-4011fae907c4",
"status": "COMPLETED",
"transactions": [LoanAndLeaseTransactionEntry]
}
]
}
}
loanAndLeaseUserRepresentatives
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
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
}
]
}
}