cURL
curl -X GET \
/dunning/documents/{id} \
--header "Authorization: Bearer <token>"import requests
url = "https://coreapi.io/dunning/documents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/dunning/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/dunning/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "ad8f6b9c-4b9c-4c9c-9c4b-9c4b9c4b9c4b",
"customer": {
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{}
],
"addresses": [
{}
],
"customerGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {},
"defaultInvoiceAddress": {},
"defaultEmailAddress": {},
"defaultInvoiceEmailAddress": {},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"recipient": "https://example.com/",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"documentDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"media": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"template": "https://example.com/",
"invoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{}
],
"addresses": [
{}
],
"customerGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {},
"defaultInvoiceAddress": {},
"defaultEmailAddress": {},
"defaultInvoiceEmailAddress": {},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"paymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": "<unknown>",
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard",
"id": "00000000-0000-0000-0000-000000000000"
},
"tax": {
"code": "19",
"rate": 19,
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%"
},
"type": "product",
"parent": "<unknown>",
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": "https://example.com/",
"subscriptionItem": "https://example.com/",
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "zugferd211",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<unknown>"
},
"level": 123,
"status": "<unknown>",
"reason": "<string>",
"dunningFeeCents": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dunningFee": {},
"number": "<string>"
}Dunning
Get dunning document
Get dunning document
Required permissions:dunning-document:readGET
/
dunning
/
documents
/
{id}
cURL
curl -X GET \
/dunning/documents/{id} \
--header "Authorization: Bearer <token>"import requests
url = "https://coreapi.io/dunning/documents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/dunning/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/dunning/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "ad8f6b9c-4b9c-4c9c-9c4b-9c4b9c4b9c4b",
"customer": {
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{}
],
"addresses": [
{}
],
"customerGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {},
"defaultInvoiceAddress": {},
"defaultEmailAddress": {},
"defaultInvoiceEmailAddress": {},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"recipient": "https://example.com/",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"documentDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"media": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"template": "https://example.com/",
"invoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"countryCode": "DE",
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"vatId": "DE123456789",
"isVatIdValid": true,
"datevId": "123456789",
"commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
"commercialRegisterNumber": "HRB 123456",
"status": "STATUS_ACTIVE",
"gender": "male",
"phone": "+49 123 456789",
"language": "de",
"totalTurnOverRank": 10,
"createdAt": "2020-01-01T00:00:00+00:00",
"emailAddresses": [
{}
],
"addresses": [
{}
],
"customerGroup": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"businessCustomer": true,
"defaultAddress": {},
"defaultInvoiceAddress": {},
"defaultEmailAddress": {},
"defaultInvoiceEmailAddress": {},
"defaultPaymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>"
},
"isPartner": true,
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"paymentMethod": {
"id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "Visa (4242)",
"data": [
"<string>"
],
"creationDate": "2024-01-15T10:30:00+00:00",
"expirationDate": "2026-12-31T23:59:59+00:00",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": "<unknown>",
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard",
"id": "00000000-0000-0000-0000-000000000000"
},
"tax": {
"code": "19",
"rate": 19,
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%"
},
"type": "product",
"parent": "<unknown>",
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": "https://example.com/",
"subscriptionItem": "https://example.com/",
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "zugferd211",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<unknown>"
},
"level": 123,
"status": "<unknown>",
"reason": "<string>",
"dunningFeeCents": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dunningFee": {},
"number": "<string>"
}Autorisierungen
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Pfadparameter
DunningDocument identifier
Antwort
DunningDocument resource
The id of the dunning document
Beispiel:
"ad8f6b9c-4b9c-4c9c-9c4b-9c4b9c4b9c4b"
The customer of the dunning document
Show child attributes
Show child attributes
The recipient of the dunning document
Beispiel:
"https://example.com/"
The title of the dunning document
The introduction of the dunning document
The closing of the dunning document
The document date of the dunning document
The due date until when the invoice should be paid
Show child attributes
Show child attributes
The document template used for this dunning document
Beispiel:
"https://example.com/"
The invoice for which this dunning document was created
Show child attributes
Show child attributes
The level of the current dunning document
The type of the current dunning document
Verfügbare Optionen:
reminder, dunning The status of the current dunning document
Possible values:
open: The dunning document is open and can be paid.cancelled: The dunning document was cancelled and can not be paid anymore.paid: The dunning document was paid and can not be paid anymore. The dunning process for this invoice is stopped.
The reason for the cancellation. This is used for internal purposes only.
The dunning fee in cents for this dunning document. This is only relevant for dunning documents of type "dunning".
War diese Seite hilfreich?
⌘I