Skip to main content

Offer

Information about an offer. This query is still a work in progress at this point and will include more details in the future. This query should be used to get the offer PDF link.

type Offer {
  applicationFormDownloadLink: FileDownloadResult!
  contractID: PolicyID!
  endDate: Date
  informationOnProductDownloadLink: FileDownloadResult
  offerFundsInformationDownloadLink: FileDownloadResult
  offerKeyInvestmentDocumentDownloadLink: FileDownloadResult
  offerKeyInvestorInformationDocumentDownloadLink: FileDownloadResult
  offerKeyInvestorInformationDocumentOneTimeDownloadLink: FileDownloadResult
  offerProductInformationSheetDownloadLink: FileDownloadResult
  persons: [OfferPerson!]!
  regularPremium: OfferRegularPremium
  sampleQuotationDownloadLink: FileDownloadResult
  startDate: Date
}

Fields​

Returns a download link for the application form (_Antragsformular_) for the offer. The link expires after 5 minutes after being generated.

Resolves to DocumentNotAvailableError while the offer carries no application form.

Offer.contractID ● PolicyID! non-null scalar​

The contractID of the offer and the future policyID.

Offer.endDate ● Date scalar​

The day cover ends, as the insurance system states it on the offer. null while the offer carries no end date, and for an offer that runs without a fixed end.

Returns a download link for the information on the product (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no product information.

Returns a download link for the funds information (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no funds information.

Returns a download link for the key investment document (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no key investment document.

Returns a download link for the key investor information document (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no key investor information document.

Returns a download link for the key investor information document (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no single-premium key investor information document.

Returns a download link for the product information sheet (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no product information sheet.

Offer.persons ● [OfferPerson!]! non-null object​

The people attached to the offer, one entry per role they hold.

This is how you match an offer to a customer you already know: customerID is the same identifier the customer query takes and that createOffer accepts as existingCustomer.byID.ID. For an offer a broker created outside your integration — one you first hear about through a webhook — it is the only way to tell whose offer it is.

Empty while the insurance system has not reported the offer's people yet; our sync fills them in shortly after the offer is created.

Offer.regularPremium ● OfferRegularPremium object​

The offer's recurring premium: one payment, and how often it is paid.

null when the offer carries no recurring premium, and when what it carries is incomplete — a premium stated without its cadence, or in a currency this API does not convert, is published as absent rather than in part.

Returns a download link for the sample quotation (PDF) for the offer. The link expires after 5 minutes after being generated.

null while the offer carries no sample quotation.

Offer.startDate ● Date scalar​

The day cover starts, as the insurance system states it on the offer. null while the offer carries no start date.

Implemented By​

OfferResult union