Get offers

cURL

curl -X GET \
 /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": {},
            "cancellationPeriod": {}
          }
        ],
        "status": "active",
        "activatedAt": "2021-01-01T00:00:00+00:00",
        "poNumber": "PO-00000001",
        "contractDetails": {
          "contractStart": "2023-11-07T05:31:56Z",
          "contractEnd": "2023-11-07T05:31:56Z"
        },
        "trialEndsOn": "2021-01-01T00:00:00+00:00",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "nextBillingDate": "2023-11-07T05:31:56Z",
        "lastBillingAt": "2023-11-07T05:31:56Z",
        "partner": {
          "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
          "name": "John Doe",
          "number": "123456",
          "email": "[email protected]"
        }
      },
      "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>",
      "status": "open",
      "description": "<string>",
      "sections": [
        "<string>"
      ],
      "locale": "<string>",
      "recipients": [
        {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "role": "read",
          "createdAt": "2023-11-07T05:31:56Z",
          "signingStatus": "not_started",
          "signingLog": [
            "<string>"
          ],
          "signedDocument": "https://example.com/",
          "link": "https://example.com/offers/1/recipient-1"
        }
      ],
      "auditLogDocument": "https://example.com/",
      "signedDocument": "https://example.com/",
      "signedAt": "2023-11-07T05:31:56Z",
      "autoActivateSubscription": true,
      "crmDealId": "<string>",
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00",
      "contactPerson": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "avatar": "<string>"
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

GET

offers

cURL

curl -X GET \
 /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": {},
            "cancellationPeriod": {}
          }
        ],
        "status": "active",
        "activatedAt": "2021-01-01T00:00:00+00:00",
        "poNumber": "PO-00000001",
        "contractDetails": {
          "contractStart": "2023-11-07T05:31:56Z",
          "contractEnd": "2023-11-07T05:31:56Z"
        },
        "trialEndsOn": "2021-01-01T00:00:00+00:00",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "nextBillingDate": "2023-11-07T05:31:56Z",
        "lastBillingAt": "2023-11-07T05:31:56Z",
        "partner": {
          "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
          "name": "John Doe",
          "number": "123456",
          "email": "[email protected]"
        }
      },
      "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>",
      "status": "open",
      "description": "<string>",
      "sections": [
        "<string>"
      ],
      "locale": "<string>",
      "recipients": [
        {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "role": "read",
          "createdAt": "2023-11-07T05:31:56Z",
          "signingStatus": "not_started",
          "signingLog": [
            "<string>"
          ],
          "signedDocument": "https://example.com/",
          "link": "https://example.com/offers/1/recipient-1"
        }
      ],
      "auditLogDocument": "https://example.com/",
      "signedDocument": "https://example.com/",
      "signedAt": "2023-11-07T05:31:56Z",
      "autoActivateSubscription": true,
      "crmDealId": "<string>",
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00",
      "contactPerson": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "avatar": "<string>"
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Query Parameters

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

Response

Offer collection

data

object[]

Show child attributes

data.id

string

data.subscription

object

Show child attributes

data.subscription.id

string

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

data.subscription.externalId

string | null

data.subscription.number

string

The number of the subscription.

Example:

"S-00000001"

data.subscription.name

string | null

The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.

Example:

"Fitness M"

data.subscription.billingGroup

object

The billing group defines the billing cycle of the subscription.

data.subscription.periods

object[]

Show child attributes

data.subscription.periods.id

string

data.subscription.periods.contractPeriodCount

integer

data.subscription.periods.contractPeriod

object

data.subscription.periods.cancellationPeriod

object

data.subscription.status

any

The status of the subscription.

Possible values:

draft: The subscription is in draft mode and not active yet.
active: The subscription is active and will be billed.
paused: The subscription is paused and will not be billed.
cancelled: The subscription is cancelled and will not be billed anymore.
terminated: The subscription is terminated and will not be billed anymore.
offer: The subscription is an offer and waiting for acceptance.

Example:

"active"

data.subscription.activatedAt

string<date-time> | null

The date the subscription was activated.

Example:

"2021-01-01T00:00:00+00:00"

data.subscription.poNumber

string | null

The po number of the subscription.

Example:

"PO-00000001"

data.subscription.contractDetails

object

The contract details of the subscription.

Show child attributes

data.subscription.contractDetails.contractStart

string<date-time>

The start of the contract.

data.subscription.contractDetails.contractEnd

string<date-time> | null

The end of the contract.

data.subscription.trialEndsOn

string<date-time> | null

The date the trial period ends.

Example:

"2021-01-01T00:00:00+00:00"

data.subscription.customFields

object

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Show child attributes

data.subscription.customFields.{key}

string

Example:

{ "field1": "value1", "field2": "value2" }

data.subscription.createdAt

string<date-time>

The date and time when the resource was created.

Example:

"2021-01-01T00:00:00+00:00"

data.subscription.updatedAt

string<date-time>

The date and time when the resource was last updated.

Example:

"2021-01-01T00:00:00+00:00"

data.subscription.nextBillingDate

string<date-time> | null

The next billing date of the subscription.

data.subscription.lastBillingAt

string<date-time> | null

The last billing date of the subscription.

data.subscription.partner

object

The partner of the customer.

Show child attributes

data.subscription.partner.id

string

The ID of the partner

Example:

"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b"

data.subscription.partner.name

string

The name of the partner

Example:

"John Doe"

data.subscription.partner.number

string

The customer number of the partner

Example:

"123456"

data.subscription.partner.email

string | null

The email address of the partner

Example:

"[email protected]"

data.customer

object

Show child attributes

data.customer.id

string

Example:

"00000000-0000-0000-0000-000000000000"

data.customer.customerNumber

string

Required string length: 2 - 255

Example:

"CUSTOMER-000"

data.customer.timeZone

string

default:Europe/Berlin

Example:

"Europe/Berlin"

data.customer.firstName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"John"

data.customer.lastName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"Doe"

data.customer.currencyCode

string

Can be empty. In this case the default currency of the tenant is used.

Example:

"EUR"

data.customer.companyName

string | null

Required string length: 2 - 255

Example:

"Acme Inc."

data.customer.datevId

string | null

The ID of the customer in DATEV

Required string length: 2 - 255

Example:

"123456789"

data.customer.status

enum<string>

default:STATUS_ACTIVE

Available options:

STATUS_ACTIVE,

STATUS_ARCHIVED,

STATUS_SUSPENDED

Example:

"STATUS_ACTIVE"

data.number

string

data.name

string | null

data.status

enum<string>

Available options:

open,

signed,

signing,

archived

data.description

string | null

data.sections

string[]

data.locale

string

data.recipients

object[]

Show child attributes

data.recipients.id

string

data.recipients.email

string

data.recipients.firstName

string

data.recipients.lastName

string

data.recipients.role

enum<string>

Available options:

read,

sign

data.recipients.createdAt

string<date-time>

data.recipients.signingStatus

enum<string>

default:not_started

Available options:

pending,

started,

signed,

not_started,

archived

Example:

"not_started"

data.recipients.signingLog

string[]

data.recipients.signedDocument

string<iri-reference> | null

Example:

"https://example.com/"

data.recipients.link

string

Link to the offer for the recipient

Example:

"https://example.com/offers/1/recipient-1"

data.auditLogDocument

string<iri-reference> | null

Example:

"https://example.com/"

data.signedDocument

string<iri-reference> | null

Example:

"https://example.com/"

data.signedAt

string<date-time> | null

data.autoActivateSubscription

boolean

default:true

Example:

true

data.crmDealId

string | null

data.createdAt

string<date-time>

The date and time when the resource was created.

Example:

"2021-01-01T00:00:00+00:00"

data.updatedAt

string<date-time>

The date and time when the resource was last updated.

Example:

"2021-01-01T00:00:00+00:00"

data.contactPerson

object

The contact person of the offer

Show child attributes

data.contactPerson.id

string

data.contactPerson.firstName

string

data.contactPerson.lastName

string

data.contactPerson.email

string

data.contactPerson.avatar

string | null

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Authorizations

Query Parameters

Response