AUautarc
Offer

Get offer by id

The offer row only, plus the offer editor's net and gross totals. Line items (including packages) are GET /offer/{offerId}/items; offer-level discounts are GET /offer/{offerId}/discounts.

get/offer/{offerId}

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Path parameters

offerIdstring uuid required

ID of the offer to fetch

Response

A single offer

idstring uuid
project_idstring uuid
company_idstring uuid
customer_idstring uuid
human_idstring
parent_offer_idstring uuid nullable

Set on a supplementary offer (Nachtragsangebot) to the id of the main offer it supplements. Null on every other document.

supplement_numberinteger nullable

The supplement's number within its main offer (1 for N1, 2 for N2, …). Null unless parent_offer_id is set.

offer_datestring date-time
valid_untilstring date-time
status'inProgress' | 'done' | 'canceled' | 'accepted' | 'rejected'
status_changed_atstring date-time nullable
created_by_profile_idstring nullable
contact_person_idstring nullable
is_templateboolean nullable
template_namestring nullable
offer_lockedboolean
titlestring nullable
cover_letterstring nullable
concluding_remarksstring nullable
show_cover_letter_greetingboolean
show_individual_pricesboolean
show_total_pricesboolean
show_product_descriptionsboolean
is_lump_sumboolean

When true, the offer total is the typed lump sum rather than the sum of line items.

lump_sum_in_centinteger nullable

Lump-sum amount in cents. Net or gross depending on lump_sum_vat_mode.

lump_sum_vat_mode'net' | 'gross' nullable
lump_sum_tax_ratenumber nullable
absolute_discount_in_centinteger nullable
percentage_discountinteger nullable
kfw_single_residence_funding_percentinteger nullable
is_home_owners_associationboolean nullable
number_of_unitsinteger nullable
number_of_units_to_fundinteger nullable
is_applicant_ownerboolean nullable
basic_funding_rateinteger nullable
applicant_funding_rateinteger nullable
exact_installation_datestring date-time nullable
approximate_installation_datestring nullable
custom_colorstring nullable
show_company_signature_fieldboolean
show_customer_signature_fieldboolean
signature_mode'manual' | 'personalSignature'
company_logo_position'left' | 'right'
enable_product_pageboolean nullable
enable_next_steps_pageboolean nullable
enable_attachment_pageboolean nullable
cover_page_type'generated' | 'custom' | 'customCoverPage1' | 'customCoverPage2' | 'customCoverPage3' | 'customCoverPage4' | 'customCoverPage5' | 'customCoverPage6'
installation_date_type'none' | 'exact' | 'approximate'
show_cover_page_dynamic_infoboolean
bubble_idstring nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
netnumber

The offer's net total as the offer editor shows it, in the major currency unit (e.g. 1234.56 means 1,234.56 EUR) — not cents, and not a percentage of the line items. Computed by the same pricing engine as the app: it accounts for per-line VAT rates, quantity and document discounts, packages, optional items and lump sums, so do not recompute it from the line items. Returned by GET /offer and GET /offer/{offerId}; the PATCH /offer/{offerId} response does not include it.

grossnumber

The offer's gross total (net plus VAT) as the offer editor shows it, in the major currency unit — not cents, and not a percentage of the line items. Computed by the same pricing engine as net; for a lump-sum offer it is derived from the lump sum and its VAT mode. Returned by GET /offer and GET /offer/{offerId}; the PATCH /offer/{offerId} response does not include it.

Changes

No recorded changes to this operation across all 1 revision of this API.