Get system debtor
This endpoint is for fetching the system debtor.
Request​
URL​
/system-debtors/<identificationNumber>
Method​
GET
Headers​
Content-Type: application/json
Authorization: Bearer eyy...
Response​
Status code 200.
Response Body
{
"identificationNumber": {
"type": "String",
"description": "This is either an organization number or a personal identity number."
},
"locale": {
"type": "String",
"description": "The locale of the debtor."
},
"name": {
"type": "String",
"description": "The name of the debtor."
},
"vatNumber": {
"type": "String",
"description": "The VAT number of the debtor."
},
"insuranceLimitLocale": {
"type": "Number",
"description": "The insurance limit of the debtor in system locale currency"
},
"allowFactoring": {
"type": "Boolean",
"description": "Whether the debtor is allowed to use factoring."
},
"balances": {
"total": {
"type": "Number",
"description": "The total balance of the debtor. Calculated from the sum of capital, reminder and interest on active invoices."
},
"totalLocale": {
"type": "Number",
"description": "The total balance of the debtor in system locale currency. Calculated from the sum of capital, reminder and interest on active invoices."
},
"capital": {
"type": "Number",
"description": "The capital balance of the debtor on active invoices."
},
"capitalLocale": {
"type": "Number",
"description": "The capital balance of the debtor in system locale currency on active invoices."
},
"capitalService": {
"type": "Number",
"description": "The capital service balance of the debtor on active invoices."
},
"capitalServiceLocale": {
"type": "Number",
"description": "The capital service balance of the debtor in system locale currency on active invoices."
},
"capitalFinanced": {
"type": "Number",
"description": "The capital financed balance of the debtor on active invoices."
},
"capitalFinancedLocale": {
"type": "Number",
"description": "The capital financed balance of the debtor in system locale currency on active invoices."
},
"capitalFinancedNoRecourse": {
"type": "Number",
"description": "The capital financed no recourse balance of the debtor on active invoices."
},
"capitalFinancedNoRecourseLocale": {
"type": "Number",
"description": "The capital financed no recourse balance of the debtor in system locale currency on active invoices."
},
"capitalFinancedWithRecourse": {
"type": "Number",
"description": "The capital financed with recourse balance of the debtor on active invoices."
},
"capitalFinancedWithRecourseLocale": {
"type": "Number",
"description": "The capital financed with recourse balance of the debtor in system locale currency on active invoices."
},
"capitalFinancedInsuranceLocale": {
"type": "Number",
"description": "The capital financed insuranced balance of the debtor in system locale currency on active invoices."
},
"reminder": {
"type": "Number",
"description": "The reminder balance of the debtor on active invoices."
},
"reminderLocale": {
"type": "Number",
"description": "The reminder balance of the debtor in system locale currency on active invoices."
},
"interest": {
"type": "Number",
"description": "The interest balance of the debtor. Calculated from the sum of interest on active invoices."
},
"interestLocale": {
"type": "Number",
"description": "The interest balance of the debtor in system locale currency on active invoices."
},
"expiredTotal": {
"type": "Number",
"description": "The expired total balance of the debtor. Calculated from the sum of capital, reminder and interest on expired invoices."
},
"expiredTotalLocale": {
"type": "Number",
"description": "The total balance of the debtor in system locale currency. Calculated from the sum of capital, reminder and interest on expired invoices."
},
"expiredCapital": {
"type": "Number",
"description": "The capital balance of the debtor. Calculated from the sum of capital on expired invoices."
},
"expiredCapitalLocale": {
"type": "Number",
"description": "The capital balance of the debtor in system locale currency. Calculated from the sum of capital on expired invoices."
},
"expiredCapitalService": {
"type": "Number",
"description": "The capital service balance of the debtor. Calculated from the sum of capital service on expired invoices."
},
"expiredCapitalServiceLocale": {
"type": "Number",
"description": "The capital service balance of the debtor in system locale currency. Calculated from the sum of capital service on expired invoices."
},
"expiredCapitalFinanced": {
"type": "Number",
"description": "The capital financed balance of the debtor. Calculated from the sum of capital financed on expired invoices."
},
"expiredCapitalFinancedLocale": {
"type": "Number",
"description": "The capital financed balance of the debtor in system locale currency. Calculated from the sum of capital financed on expired invoices."
},
"expiredCapitalFinancedNoRecourse": {
"type": "Number",
"description": "The capital financed no recourse balance of the debtor. Calculated from the sum of capital financed no recourse on expired invoices."
},
"expiredCapitalFinancedNoRecourseLocale": {
"type": "Number",
"description": "The capital financed no recourse balance of the debtor in system locale currency. Calculated from the sum of capital financed no recourse on expired invoices."
},
"expiredCapitalFinancedWithRecourse": {
"type": "Number",
"description": "The capital financed with recourse balance of the debtor. Calculated from the sum of capital financed with recourse on expired invoices."
},
"expiredCapitalFinancedWithRecourseLocale": {
"type": "Number",
"description": "The capital financed with recourse balance of the debtor in system locale currency. Calculated from the sum of capital financed with recourse on expired invoices."
},
"expiredReminder": {
"type": "Number",
"description": "The reminder balance of the debtor. Calculated from the sum of reminder on expired invoices."
},
"expiredReminderLocale": {
"type": "Number",
"description": "The reminder balance of the debtor in system locale currency. Calculated from the sum of reminder on expired invoices."
},
"expiredInterest": {
"type": "Number",
"description": "The interest balance of the debtor. Calculated from the sum of interest on expired invoices."
},
"expiredInterestLocale": {
"type": "Number",
"description": "The interest balance of the debtor in system locale currency. Calculated from the sum of interest on expired invoices."
}
},
"createdDate": {
"type": "String",
"description": "The date when the debtor was created."
},
"createdBy": {
"type": "String",
"description": "The user who created the debtor."
},
"updatedDate": {
"type": "String",
"description": "The date when the debtor was last updated."
},
"updatedBy": {
"type": "String",
"description": "The user who last updated the debtor."
},
"document": {
"id": {
"type": "String",
"description": "The ID of the document."
},
"fileName": {
"type": "String",
"description": "The name of the file."
},
"fileNameRaw": {
"type": "String",
"description": "The raw name of the file."
}
},
"segment": {
"type": "String",
"description": "The segment of the debtor."
},
"overrideInvoiceInsuranceValidation": {
"type": "Boolean",
"description": "Whether the invoice insurance validation is overridden."
},
"ignoreServiceProviderCreditCheck": {
"type": "Boolean",
"description": "Whether credit check data should be updated on the debtor."
},
"sniCode": {
"type": "String",
"description": "The SNI code of the debtor."
}
}