Skip to main content

Interface: Tender

Defined in: type/Tender.ts:18

Comprehensive tender entity representing a potential order in the system.

  • Tenders are draft orders that contain all necessary information for order processing including customer details, items, pricing, addresses, payment methods, and shipping information. They can be modified, processed into orders, or deleted as needed.

Properties​

actionCode?​

optional actionCode?: string

Defined in: type/Tender.ts:100

Action code that is applied to this tender. Is only filled if a valid action code was applied during checkout

bonusItems?​

optional bonusItems?: TenderMainItem[]

Defined in: type/Tender.ts:78

The tender/order bonusItems

carriers?​

optional carriers?: TenderCarrier[]

Defined in: type/Tender.ts:88

List of selectable carriers

channelId?​

optional channelId?: number

Defined in: type/Tender.ts:33

Sales channel identifier where the tender originated. Identifies the specific sales channel (website, mobile app, etc.) used to create this tender.

company?​

optional company?: Company

Defined in: type/Tender.ts:129

Company associated with this tender. Returns the company involved in this tender process. Used for organizational context and access control within the tender management system.

companyId?​

optional companyId?: number

Defined in: type/Tender.ts:54

Company identifier for business-to-business tenders. Used in combination with contactId to establish the company context for the tender.

contact?​

optional contact?: Contact

Defined in: type/Tender.ts:123

Contact person associated with this tender. Returns the specific contact who is responsible for or involved in this tender process. Used for direct communication and relationship management.

contactId?​

optional contactId?: number

Defined in: type/Tender.ts:48

Contact person identifier associated with this tender. Used in combination with companyId to identify the specific contact person within a company who is responsible for this tender.

createdAt​

createdAt: string

Defined in: type/Tender.ts:36

Timestamp when the tender was initially created. Records the exact moment this tender was first established in the system.

createdBy?​

optional createdBy?: number

Defined in: type/Tender.ts:39

Identifier of the user who created this tender. Tracks the originator of the tender for audit and accountability purposes.

createdByAdminUserId?​

optional createdByAdminUserId?: number

Defined in: type/Tender.ts:143

Admin user ID who created this tender

createdByContactId?​

optional createdByContactId?: number

Defined in: type/Tender.ts:145

Contact user ID who created this tender

createdByCustomerId?​

optional createdByCustomerId?: number

Defined in: type/Tender.ts:147

Customer user ID who created this tender

createdFromRevisionNumber?​

optional createdFromRevisionNumber?: number

Defined in: type/Tender.ts:149

Source revision number when tender was created from existing revision

creditPoints?​

optional creditPoints?: number

Defined in: type/Tender.ts:98

Tender/order accumulated credit points

currency?​

optional currency?: string

Defined in: type/Tender.ts:108

The currency for this tender

currencyRatio?​

optional currencyRatio?: number

Defined in: type/Tender.ts:110

The currency ratio for this tender

customer?​

optional customer?: Customer

Defined in: type/Tender.ts:126

Customer associated with this tender. Returns the customer who initiated or is the subject of this tender. Used for customer relationship management and tender tracking.

customerId?​

optional customerId?: number

Defined in: type/Tender.ts:51

Customer identifier for individual customer tenders. Used for direct customer relationships where no company association is required.

debtorId?​

optional debtorId?: string

Defined in: type/Tender.ts:68

Invoice company debtor ID

deliveryAddress?​

optional deliveryAddress?: TenderAddress

Defined in: type/Tender.ts:72

The address the order should be shipped to

email​

email: string

Defined in: type/Tender.ts:66

User's email

externalId?​

optional externalId?: string

Defined in: type/Tender.ts:112

The order's ID in an external system

extra3?​

optional extra3?: string

Defined in: type/Tender.ts:114

Additional information field that can be stored with a tender/order

extra4?​

optional extra4?: string

Defined in: type/Tender.ts:116

Additional information field that can be stored with a tender/order

firstName?​

optional firstName?: string

Defined in: type/Tender.ts:60

User's first name

incentivesApplied?​

optional incentivesApplied?: boolean

Defined in: type/Tender.ts:96

Indicates whether incentives are already applied

invalid?​

optional invalid?: boolean

Defined in: type/Tender.ts:139

Invalid status flag indicating tender issues

invalidationReason?​

optional invalidationReason?: string

Defined in: type/Tender.ts:141

Reason for tender invalidation if applicable

invoiceAddress?​

optional invoiceAddress?: TenderAddress

Defined in: type/Tender.ts:70

The address the invoice for the order should be sent to

invoiceUserId?​

optional invoiceUserId?: number

Defined in: type/Tender.ts:56

The invoice userId for this tender

isEditable?​

optional isEditable?: boolean

Defined in: type/Tender.ts:118

Indicates whether tender can be edited

itemCount?​

optional itemCount?: number

Defined in: type/Tender.ts:74

Tender/order main item count

items?​

optional items?: TenderMainItem[]

Defined in: type/Tender.ts:76

The tender/order items

language?​

optional language?: string

Defined in: type/Tender.ts:106

The language for this tender

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Tender.ts:42

Timestamp of the most recent modification to the tender. Updates automatically whenever any aspect of the tender is changed.

lastModifiedBy?​

optional lastModifiedBy?: number

Defined in: type/Tender.ts:45

Identifier of the user who last modified this tender. Tracks the most recent editor for audit and accountability purposes.

lastName?​

optional lastName?: string

Defined in: type/Tender.ts:64

User's last name

middleName?​

optional middleName?: string

Defined in: type/Tender.ts:62

User's middle name

orderId?​

optional orderId?: number

Defined in: type/Tender.ts:24

Associated order identifier when tender was created from an existing order. Links the tender to its source order for reference and audit purposes.

ownerId?​

optional ownerId?: number

Defined in: type/Tender.ts:27

Identifier of the user who owns this tender. Represents the primary responsible party for the tender management and processing.

paymentData?​

optional paymentData?: TenderPayment

Defined in: type/Tender.ts:80

Payment data for this tender/order

payMethods?​

optional payMethods?: TenderPaymethod[]

Defined in: type/Tender.ts:90

List of selectable payment methods for this tender, including non allowed for the applied user

postageData?​

optional postageData?: TenderPostage

Defined in: type/Tender.ts:82

Postage data for this tender/order

public?​

optional public?: boolean

Defined in: type/Tender.ts:133

Public visibility flag for tender sharing and collaboration

publicVersionNumber?​

optional publicVersionNumber?: number

Defined in: type/Tender.ts:137

Public version number for external sharing

reference?​

optional reference?: string

Defined in: type/Tender.ts:102

User's reference for this tender

remarks?​

optional remarks?: string

Defined in: type/Tender.ts:104

User's remarks for this tender

revisionNumber?​

optional revisionNumber?: number

Defined in: type/Tender.ts:135

Current revision number for version tracking

revisions?​

optional revisions?: OrderRevisionResponse

Defined in: type/Tender.ts:131

List of tender revisions for version control and audit purposes

source?​

optional source?: string

Defined in: type/Tender.ts:92

Tender/order origin

status​

status: string

Defined in: type/Tender.ts:58

Tender/order status

taxLevels?​

optional taxLevels?: TenderTaxLevel[]

Defined in: type/Tender.ts:86

Amount of tax that applies to this tender/order per tax code

tenderId​

tenderId: string

Defined in: type/Tender.ts:21

Unique identifier for the tender. This is the primary key used to reference and manage the tender throughout its lifecycle.

total?​

optional total?: TenderTotal

Defined in: type/Tender.ts:84

Tender total

type​

type: OrderType

Defined in: type/Tender.ts:30

Classification of the tender type. Determines the processing workflow and business rules that apply to this tender.

validUntil?​

optional validUntil?: string

Defined in: type/Tender.ts:120

Valid until date (Display Only!)

valuePoints?​

optional valuePoints?: number

Defined in: type/Tender.ts:94

Total amount of valuePoints that apply to this tender/order