Zum Hauptinhalt springen
GET
/
api
/
offers
/
{id}
Get an offer
curl --request GET \
  --url https://coreapi.io/api/offers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "number": "<string>",
  "recipients": [
    {
      "email": "jsmith@example.com",
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  ],
  "documents": {
    "signed": {
      "id": "<string>",
      "filename": "<string>",
      "url": "<string>"
    },
    "auditLog": {
      "id": "<string>",
      "filename": "<string>",
      "url": "<string>"
    },
    "purchaseOrder": {
      "id": "<string>",
      "filename": "<string>",
      "url": "<string>"
    }
  },
  "name": "<string>",
  "locale": "de",
  "validUntil": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "issuedAt": "2023-11-07T05:31:56Z",
  "signedAt": "2023-11-07T05:31:56Z",
  "contractValue": {
    "amount": 123,
    "currencyCode": "EUR",
    "precision": 123
  },
  "proposal": {},
  "sections": [
    {}
  ],
  "autoActivateSubscription": true,
  "customVariables": {},
  "links": {
    "self": "<string>",
    "approval": "<string>"
  },
  "customer": {
    "id": "<string>",
    "name": "<string>"
  },
  "subscription": {
    "id": "<string>",
    "number": "<string>"
  },
  "contactPerson": {
    "id": "<string>",
    "name": "<string>"
  },
  "salesChannel": {
    "id": "<string>",
    "name": "<string>",
    "brandName": "<string>"
  }
}

Autorisierungen

​
Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Pfadparameter

​
id
string<ulid>
erforderlich

Offer ID (ULID).

Antwort

The offer resource.

The canonical v2 representation of an offer.

​
id
string
erforderlich

Stable offer identifier (ULID).

​
number
string
erforderlich

Human-readable offer number, e.g. ANG-1042.

​
status
enum<string>
erforderlich
Verfügbare Optionen:
open,
signing,
awaiting_invoice_details,
signed,
archived
​
acceptanceMode
enum<string>
erforderlich
Verfügbare Optionen:
click,
esignature,
print
​
dealType
enum<string>
erforderlich
Verfügbare Optionen:
new_business,
expansion,
renewal,
one_off
​
recipients
object[]
erforderlich
​
documents
object
erforderlich

Grouped offer documents. Each slot is null until the document exists.

​
name
string | null

Optional internal title.

​
locale
string | null
Beispiel:

"de"

​
validUntil
string<date-time> | null
​
createdAt
string<date-time> | null
​
updatedAt
string<date-time> | null
​
issuedAt
string<date-time> | null

When the offer was first published.

​
signedAt
string<date-time> | null
​
contractValue
object

Total contract value. Null if not computable yet.

​
proposal
object

Computed pricing model. Null if the offer carries no priced proposal.

​
sections
object[]

Document blocks that make up the offer body.

​
autoActivateSubscription
boolean
​
customVariables
object

Custom template variables as name to value.

​
links
object

Related sub-resources (HATEOAS).

​
customer
object

Linked customer. Null if the offer is not linked yet.

​
subscription
object

Linked subscription. Set when the offer extends or renews an existing subscription, and also once an accepted offer has been converted into a subscription. Null when the offer is not linked to a subscription.

​
contactPerson
object

Primary contact person. Null if none is set.

​
salesChannel
object

Sales channel the offer belongs to.