Angebote auflisten
curl --request GET \
--url https://coreapi.io/offers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"subscription": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"externalId": "<string>",
"number": "S-00000001",
"name": "Fitness M",
"billingGroup": {},
"periods": [
{
"id": "<string>",
"contractPeriodCount": 123,
"contractPeriod": "1M",
"cancellationPeriod": "1M"
}
],
"status": "active",
"activatedAt": "2021-01-01T00:00:00+00:00",
"poNumber": "PO-00000001",
"contractDetails": {
"contractStart": "2021-01-01T00:00:00+00:00",
"contractEnd": "2021-01-01T00:00:00+00:00"
},
"trialEndsOn": "2021-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"statistics": {
"unpaidGrossAmount": {
"amount": 1000,
"precision": 2,
"currency": "EUR",
"i18n": "10,00 €",
"inputValue": "10.00"
},
"totalContractValue": {
"amount": 1000,
"precision": 2,
"currency": "EUR",
"i18n": "10,00 €",
"inputValue": "10.00"
}
},
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"nextBillingDate": "2021-01-01T00:00:00+00:00",
"lastBillingAt": "2021-01-01T00:00:00+00:00",
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"number": "<string>",
"name": "<string>",
"sections": [
"<string>"
],
"customVariables": {},
"locale": "<string>",
"recipients": [
{
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"createdAt": "2021-01-01T00:00:00+00:00",
"signingStatus": "not_started",
"signingLog": [
"<string>"
],
"signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"link": "https://example.com/o/1/recipient-1"
}
],
"purchaseOrderDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"auditLogDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"signedAt": "2021-01-01T00:00:00+00:00",
"autoActivateSubscription": true,
"crmDealId": "<string>",
"acceptanceMode": "click",
"dealType": "new_business",
"validUntil": "2021-01-01T00:00:00+00:00",
"cachedContractValueCents": "<string>",
"cachedContractValueCurrency": "<string>",
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"capturedInvoiceDetails": {},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>",
"phone": "<string>",
"linkedin": "<string>",
"position": "<string>",
"website": "<string>"
},
"signed": true,
"issuedAt": "2021-01-01T00:00:00+00:00",
"publishedVersionHash": "<string>",
"currentVersionHash": "<string>"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Angebote
Angebote auflisten
Gibt die Angebote der Organisation als Liste mit Paginierung zurück.
GET
/
offers
Angebote auflisten
curl --request GET \
--url https://coreapi.io/offers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"subscription": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"externalId": "<string>",
"number": "S-00000001",
"name": "Fitness M",
"billingGroup": {},
"periods": [
{
"id": "<string>",
"contractPeriodCount": 123,
"contractPeriod": "1M",
"cancellationPeriod": "1M"
}
],
"status": "active",
"activatedAt": "2021-01-01T00:00:00+00:00",
"poNumber": "PO-00000001",
"contractDetails": {
"contractStart": "2021-01-01T00:00:00+00:00",
"contractEnd": "2021-01-01T00:00:00+00:00"
},
"trialEndsOn": "2021-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"statistics": {
"unpaidGrossAmount": {
"amount": 1000,
"precision": 2,
"currency": "EUR",
"i18n": "10,00 €",
"inputValue": "10.00"
},
"totalContractValue": {
"amount": 1000,
"precision": 2,
"currency": "EUR",
"i18n": "10,00 €",
"inputValue": "10.00"
}
},
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"nextBillingDate": "2021-01-01T00:00:00+00:00",
"lastBillingAt": "2021-01-01T00:00:00+00:00",
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "partner@example.com"
}
},
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"number": "<string>",
"name": "<string>",
"sections": [
"<string>"
],
"customVariables": {},
"locale": "<string>",
"recipients": [
{
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"createdAt": "2021-01-01T00:00:00+00:00",
"signingStatus": "not_started",
"signingLog": [
"<string>"
],
"signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"link": "https://example.com/o/1/recipient-1"
}
],
"purchaseOrderDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"auditLogDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"signedDocument": "ad8c7c0e-3b1a-4f5c-8b7a-5d5b6a4b2f1e",
"signedAt": "2021-01-01T00:00:00+00:00",
"autoActivateSubscription": true,
"crmDealId": "<string>",
"acceptanceMode": "click",
"dealType": "new_business",
"validUntil": "2021-01-01T00:00:00+00:00",
"cachedContractValueCents": "<string>",
"cachedContractValueCurrency": "<string>",
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"capturedInvoiceDetails": {},
"contactPerson": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"avatar": "<string>",
"phone": "<string>",
"linkedin": "<string>",
"position": "<string>",
"website": "<string>"
},
"signed": true,
"issuedAt": "2021-01-01T00:00:00+00:00",
"publishedVersionHash": "<string>",
"currentVersionHash": "<string>"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Autorisierungen
API-Token der Organisation. Sende es als Authorization: Bearer api_... Das Token ist fest an genau eine Organisation gebunden.
Abfrageparameter
The collection page number
The number of items per page
Erforderlicher Bereich:
0 <= x <= 100Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc Verfügbare Optionen:
asc, desc War diese Seite hilfreich?
⌘I