Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
accountNumber | Account number | Text | ||
accountType | Account type Type of account |
Enum |
Allowed values:
Customer
Reseller
Subsidiary
Prospect
Other
|
|
activeACV | ACV Annual contract value |
Amount | ||
attachUBLToInvoiceAccountSetting | Attach UBL to invoice Attach UBL to invoice when posting. Only works if invoive delivery method is Email. |
Checkbox | ||
balance | Balance Balance of the account including tax |
Amount | ||
activeCMRR | CMRR Contracted monthly recurring revenue |
Amount | ||
currency | Currency The default currency applied to new orders for the account. |
Text | ||
defaultCurrency | Currency The default currency applied to new orders for the account |
Reference |
Referenced entity
currency
|
|
currencyCode | Currency code | Text | ||
defaultInvoiceAddress | Default invoice address The default invoice address applied to new orders for the account |
Reference |
Referenced entity
address
|
|
defaultPaymentTerm | Default payment term The default payment term applied to new orders for this account. |
Reference |
Referenced entity
paymentterm
|
|
description | Description | Text | ||
disableInvoiceReminders | Disable Invoice Reminders Disable reminders for all invoices on this account |
Checkbox | ||
electronicInvoiceAddress | E-Invoice Address Electronic Invoice Address |
Text | ||
electronicInvoiceOperator | E-Invoice Operator Electronic Invoice Operator |
Text | ||
employees | Employees Number of employees |
Text | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
id | Id | Guid | ||
imageUrl | Image Account logo |
Image | ||
inactive | Inactive If account is inactive |
Checkbox | ||
invoiceCount | Invoice count Number of invoices |
Integer | ||
invoiceDeliveryMethod | Invoice delivery method Invoice delivery method for this account |
Enum |
Allowed values:
Email
Print
ElectronicInvoice
ExternalPrint
AutomaticElectronicRouting
|
|
invoiceEmailAddress | Invoice email Email address invoices for this account get sent to |
|||
invoiceEmailCcAddresses | Invoice email Cc List of emails to whom should receive a copy of the invoice email |
Text | ||
invoiceSubsidiary | Invoice subsidiary Indicates whether usage reported for a subsidiary should be invoiced on the subsidiary account or if not, the parent account |
Checkbox | ||
invoiceTemplate | Invoice Template Account Invoice Template |
Text | ||
invoicedTotalExTax | Invoiced total, ex tax | Amount | ||
lastInvoiced | Last invoiced Date of latest invoice that was invoiced for this account |
Date | ||
name | Name | Text | ||
organizationNumber | Org number Organization number |
Text | ||
salesReference | Our reference Salesreference for this account |
Text | ||
parentAccount | Parent account Only used for subsidiary accounts. Points to the parent account of the subsidiary. |
Reference |
Referenced entity
account
|
|
parentAccountName | Parent Account | Text | ||
paymentTerm | Payment term (deprecated) | Integer | ||
reminderEmailAddress | Reminder email Email address invoice reminders are sent to, if other than invoice email (optional) |
|||
domain | Site Website of account |
Text | ||
stripeCredentialStatus | Stripe credential status | Enum |
Allowed values:
MissingCredential
CredentialRequested
CredentialCollected
|
|
subsidiaryAccounts | Subsidiaries Only used for account type customes. Reference to all subsidiary accounts for a customer. |
ReferenceCollection |
Referenced entity
account
|
|
taxRegistrationNumber | Tax reg. nr Tax registration number |
Text | ||
taxTemplate | Tax Template The default payment term applied to new orders for this account. |
Reference |
Referenced entity
taxtemplate
|
|
founded | Year founded The year the account was founded |
Text | ||
yourReference | Your reference Your reference default value on orders |
Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
city | City | Text | ||
country | Country | Reference |
Referenced entity
country
|
|
county | County | Text | ||
description | Description | Text | ||
id | Id | Guid | ||
name | Name Address name |
Text | ||
state | State | Text | ||
street | Street | Text | ||
street2 | Street 2 | Text | ||
zip | Zip Zip code |
Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
accountCategory | Account category | Enum |
Allowed values:
New
Existing
Lost
|
|
displayAcv | ACV Annual contract value |
Calculated | ||
acvAmount | ACV amount | Amount | ||
acvBaseCurrencyAmount | ACV amount (Base) | Amount | Read-Only | |
acvCurrencyCode | ACV currency | Text | ||
acvBaseCurrencyCode | ACV currency (Base) | Text | Read-Only | |
acvCurrencyConversionDate | ACV currency conversion date | Date | Read-Only | |
bookingLines | Booking Lines | ReferenceCollection |
Referenced entity
bookingline
|
|
bookingType | Booking type Type of the booking |
Enum |
Allowed values:
New
Change
Churn
|
|
changeType | Change type | Enum |
Allowed values:
Upsell
Downsell
Renewal
None
PriceAdjustment
Milestone
CancelledDelivery
AssociatedCharge
SplitOrder
CancelOrderProduct
|
|
displayCmrr | CMRR Contracted monthly recurring revenue |
Calculated | ||
cmrrAmount | CMRR amount | Amount | ||
cmrrBaseCurrencyAmount | CMRR amount (Base) | Amount | Read-Only | |
cmrrCurrencyCode | CMRR currency | Text | ||
cmrrBaseCurrencyCode | CMRR currency (Base) | Text | Read-Only | |
cmrrCurrencyConversionDate | CMRR currency conversion date | Date | Read-Only | |
created | Created Creation date of the booking |
DateTime | ||
effectiveDate | Effective date | Date | ||
displayEmrr | EMRR Estimated monthly recurring revenue |
Calculated | ||
emrrAmount | EMRR amount | Amount | ||
emrrBaseCurrencyAmount | EMRR amount (Base) | Amount | Read-Only | |
emrrCurrencyCode | EMRR currency | Text | ||
emrrBaseCurrencyCode | EMRR currency (Base) | Text | Read-Only | |
emrrCurrencyConversionDate | EMRR currency conversion date | Date | Read-Only | |
fmrrAmount | FMRR amount | Amount | ||
fmrrBaseCurrencyAmount | FMRR amount (Base) | Amount | Read-Only | |
fmrrCurrencyCode | FMRR currency | Text | ||
fmrrBaseCurrencyCode | FMRR currency (Base) | Text | Read-Only | |
fmrrCurrencyConversionDate | FMRR currency conversion date | Date | Read-Only | |
id | Id | Guid | ||
notes | Notes The bookings notes |
Text | ||
displayOneTimeFees | One time fees | Calculated | ||
orderId | Order Id Id of the order this booking belongs to |
Text | ||
otfAmount | OTF amount | Amount | ||
otfBaseCurrencyAmount | OTF amount (Base) | Amount | Read-Only | |
otfCurrencyCode | OTF currency | Text | ||
otfBaseCurrencyCode | OTF currency (Base) | Text | Read-Only | |
otfCurrencyConversionDate | OTF currency conversion date | Date | Read-Only | |
displayTCV | Tcv | Calculated | ||
tcvAmount | TCV amount | Amount | ||
tcvBaseCurrencyAmount | TCV amount (Base) | Amount | Read-Only | |
tcvCurrencyCode | TCV currency | Text | ||
tcvBaseCurrencyCode | TCV currency (Base) | Text | Read-Only | |
tcvCurrencyConversionDate | TCV currency conversion date | Date | Read-Only |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
acv | ACV Annual contract value |
CurrencyAmount | ||
acvAmount | ACV amount | Amount | ||
acvBaseCurrencyAmount | ACV amount (Base) | Amount | Read-Only | |
acvCurrencyCode | ACV currency | Text | ||
acvBaseCurrencyCode | ACV currency (Base) | Text | Read-Only | |
acvCurrencyConversionDate | ACV currency conversion date | Date | Read-Only | |
bookingId | Booking id Id of the booking for this booking lines belongs to |
Guid | ||
chargeId | Charge id Id of the charge for this booking lines belongs to |
Guid | ||
cmrr | CMRR Contracted monthly recurring revenue |
CurrencyAmount | ||
cmrrAmount | CMRR amount | Amount | ||
cmrrBaseCurrencyAmount | CMRR amount (Base) | Amount | Read-Only | |
cmrrCurrencyCode | CMRR currency | Text | ||
cmrrBaseCurrencyCode | CMRR currency (Base) | Text | Read-Only | |
cmrrCurrencyConversionDate | CMRR currency conversion date | Date | Read-Only | |
created | Created Creation date of the booking |
DateTime | ||
emrr | EMRR Estimated monthly recurring revenue |
CurrencyAmount | ||
emrrAmount | EMRR amount | Amount | ||
emrrBaseCurrencyAmount | EMRR amount (Base) | Amount | Read-Only | |
emrrCurrencyCode | EMRR currency | Text | ||
emrrBaseCurrencyCode | EMRR currency (Base) | Text | Read-Only | |
emrrCurrencyConversionDate | EMRR currency conversion date | Date | Read-Only | |
fmrr | FMRR Forecasted monthly recrring revenue |
CurrencyAmount | ||
fmrrAmount | FMRR amount | Amount | ||
fmrrBaseCurrencyAmount | FMRR amount (Base) | Amount | Read-Only | |
fmrrCurrencyCode | FMRR currency | Text | ||
fmrrBaseCurrencyCode | FMRR currency (Base) | Text | Read-Only | |
fmrrCurrencyConversionDate | FMRR currency conversion date | Date | Read-Only | |
id | Id | Guid | ||
oneTimeFees | One time fees | CurrencyAmount | ||
otfAmount | OTF amount | Amount | ||
otfBaseCurrencyAmount | OTF amount (Base) | Amount | Read-Only | |
otfCurrencyCode | OTF currency | Text | ||
otfBaseCurrencyCode | OTF currency (Base) | Text | Read-Only | |
otfCurrencyConversionDate | OTF currency conversion date | Date | Read-Only | |
tcv | TCV Total contract value |
CurrencyAmount | ||
tcvAmount | TCV amount | Amount | ||
tcvBaseCurrencyAmount | TCV amount (Base) | Amount | Read-Only | |
tcvCurrencyCode | TCV currency | Text | ||
tcvBaseCurrencyCode | TCV currency (Base) | Text | Read-Only | |
tcvCurrencyConversionDate | TCV currency conversion date | Date | Read-Only |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
billingDay | Billing day When to charge the account in respect to the charge period (for very specific scenarios) |
Enum |
Allowed values:
None
FirstDayOfMonth
LastDayOfMonth
FromOrder
FromCharge
FromAccount
SpecificDay
DaysOffset
|
|
billingPeriod | Billing period How frequent the account will be billed for the charge |
Enum | ||
periodAlignment | Billing period alignment How the billing of the charge will sync with the order cycle |
Enum |
Allowed values:
None
AlignToOrder
AlignToCharge
AlignToMonth
AlignToCalendarQuarter
AlignToDate
|
|
billingTiming | Billing Timing If the charge should be billed in advance of the billing period or in arrears of the billing period |
Enum |
Allowed values:
InAdvance
InArrears
|
|
chargeNumber | Charge number | Text | ||
defaultQuantity | Default quantity If the Charge Model is quantity, this is the default quantity of units for the charge |
DecimalNumber | ||
deferredRevenue | Deferred revenue account The financial account that should be used for deferred revenue |
Reference |
Referenced entity
financialaccount
|
|
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
productFeatures | Features | EntityList | ||
id | Id | Guid | ||
createInvoiceLinesPerTier | Invoice lines per tier If enabled, separate invoice lines will be created for each ative tier. Currently only applicable for the Fortnox Connector |
Checkbox | ||
measurementsRule | Measurements rule Rule of measurements |
Enum |
Allowed values:
LatesDate
|
|
model | Model The pricing structure of the charge |
Enum |
Allowed values:
Flat
Quantity
Volume
Tiered
Rated
|
|
name | Name Describes the charge, will also be the description of the line item on the customer invoice |
Text | ||
offsetBillingDays | Offset billing days | Integer | ||
chargeDetails | Price details All price details for a charge |
ReferenceCollection |
Referenced entity
chargedetails
|
|
pricePeriod | Price period The period length the price is for |
Enum | ||
recognizedRevenue | Recognized revenue account The financial account that should be used for recognized revenue |
Reference |
Referenced entity
financialaccount
|
|
revenueRecognitionRule | Revenue recognition rule The revenue recognition rule decides how revenue for a charge is recognized and distributed |
Reference |
Referenced entity
revenuerecognitionrule
|
|
specificBillingDay | Specific billing day | Integer | ||
taxIncluded | Tax included If this box is checked, the tax will be included in the price, if not, a tax amount according to the tax template will be added on top of the subtotal price |
Checkbox | ||
taxTemplate | Tax template The tax template defines how taxes are applied to a charge |
Reference |
Referenced entity
taxtemplate
|
|
chargeType | Type The billing structure of the charge |
Enum |
Allowed values:
OneOff
Recurring
Usage
Measured
|
|
unitOfMeasure | Unit of measure | Reference |
Referenced entity
unitofmeasure
|
|
usageRating | Usage rating | Enum | ||
useRecognizedRevenueTemplate | Use Recognized Revenue Template | Checkbox |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
charge | Charge | Reference |
Referenced entity
charge
|
|
currencyCode | Currency code | Text | ||
description | Description Tier description |
Text | ||
fromQuantity | From quantity | DecimalNumber | ||
id | Id | Guid | ||
price | Price | Amount | ||
priceBase | Price base | Enum |
Allowed values:
Flat
PerUnit
|
|
tier | Tier Tier number |
Integer | ||
toQuantity | To quantity | DecimalNumber |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
name | Charge plan name Name of the charge plan |
Text | ||
chargePlanNumber | Charge plan number | Text | ||
charges | Charges All charges for a charge plan |
ReferenceCollection |
Referenced entity
charge
|
|
effectiveEndDate | Effective end Effective end date of charge plan |
Date | ||
effectiveStartDate | Effective start Effective start date of charge plan |
Date | ||
endOfNewSalesDate | End of sales | Date | ||
id | Id | Guid |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
active | Active | Checkbox | ||
id | Id | Guid | ||
legalEntityName | Legal entity The legal entity in which this product is managed |
Text | ||
name | Name | Text | ||
threeAlphaCode | Three Alpha Code Three alphabetic code for country |
Text | ||
twoAlphaCode | Two Alpha Code Two alphabetic code for country |
Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
code | Code Code of financial account |
Text | ||
description | Description | Text | ||
externalCode | External code | Text | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
id | Id | Guid | ||
inActive | Inactive | Checkbox | ||
legalEntityName | Legal entity The legal entity in which this product is managed |
Text | ||
name | Name | Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
averageLineamount | Average line amount | Amount | ||
unsettledAmount | Balance amount Balance amount |
CurrencyAmount | ||
unsettledAmountInTable | Balance amount Balance amount |
Amount | ||
invoiceBatchId | Batch id | Guid | ||
referenceNumber | Buyer reference Buyer reference |
Text | ||
posted | Date of posting | DateTime | ||
daysPastDue | Days past due | Integer | ||
disableAutomaticInvoiceReminder | Disable invoice reminder | Checkbox | ||
dueDate | Due date | Date | ||
electronicInvoiceStatus | Electronic invoice status | Enum |
Allowed values:
Default
Processing
Delivered
Failed
|
|
exchangeRate | Exchange rate | DecimalNumber | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
id | Id | Guid | ||
invoiceDate | Invoice date | Date | ||
invoiceDeliveryMethod | Invoice delivery method | Enum |
Allowed values:
Email
Print
ElectronicInvoice
ExternalPrint
AutomaticElectronicRouting
|
|
invoiceLineCount | Invoice lines Invoice lines |
Integer | ||
invoiceNumber | Invoice number | Text | ||
invoiceSubsidiaryId | Invoice Subsidiary id | Guid | ||
lastPaymentDate | Last Payment Date | DateTime | ||
lastReminderDate | Last Reminder Date Last reminder date of invoice |
Date | ||
nbrOfReminders | No. of Reminders Number of Invoice Reminders |
Integer | ||
notes | Notes | LongText | ||
ocrNumber | OCR number | Text | ||
uniqueOnlinePaymentKey | Online payment link | Text | ||
orderId | Order id | Guid | ||
ourReference | Our reference | Text | ||
paymentTerm | Payment term days | Integer | ||
sendMethod | Sent If invoice has been sent |
Text | ||
settledAmount | Settled amount Amount that has been settled |
CurrencyAmount | ||
settledAmountInTable | Settled amount Amount that has been settled |
Amount | ||
paymentDate | Settled Date Date when the invoice got settled |
DateTime | ||
settledNotes | Settled notes | Text | ||
status | Status Status of the invoice |
Enum |
Allowed values:
Draft
Posted
Cancelled
Settled
|
|
onlinePaymentStatus | Stripe Status Status of online payment (Stripe). |
Enum |
Allowed values:
Default
Succeeded
Processing
Failed
|
|
subtotalAmount | Subtotal amount | Amount | ||
subtotal | Subtotal Amount | CurrencyAmount | ||
subtotalBaseCurrencyAmount | Subtotal amount (Base) | Amount | Read-Only | |
subtotalCurrencyCode | Subtotal currency | Text | ||
subtotalBaseCurrencyCode | Subtotal currency (Base) | Text | Read-Only | |
subtotalCurrencyConversionDate | Subtotal currency conversion date | Date | Read-Only | |
targetDate | Target date | Date | ||
targetDateMeasured | Target date measured | Date | ||
targetDateOneOff | Target date oneoff | Date | ||
targetDateRecurringInAdvance | Target date recurring in advance | Date | ||
targetDateRecurringInArrears | Target date recurring in arrears | Date | ||
targetDateUsage | Target date usage | Date | ||
taxAmount | Tax amount | Amount | ||
tax | Tax Amount | CurrencyAmount | ||
taxBaseCurrencyAmount | Tax amount (Base) | Amount | Read-Only | |
taxCurrencyCode | Tax currency | Text | ||
taxBaseCurrencyCode | Tax currency (Base) | Text | Read-Only | |
taxCurrencyConversionDate | Tax currency conversion date | Date | Read-Only | |
taxIncluded | Tax included | Checkbox | ||
totalAmountAmount | Total amount | Amount | ||
totalAmount | Total Amount | CurrencyAmount | ||
totalAmountBaseCurrencyAmount | Total amount (Base) | Amount | Read-Only | |
totalAmountCurrencyCode | Total currency | Text | ||
totalAmountBaseCurrencyCode | Total currency (Base) | Text | Read-Only | |
totalAmountCurrencyConversionDate | Total currency conversion date | Date | Read-Only | |
totalRoundingAmount | Total Rounding Amount | CurrencyAmount | ||
yourOrderNumber | Your order number Reference to external order number |
Text | ||
yourReference | Your reference | Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
code | Code The code for the invoice batch group |
Text | ||
description | Description | Text | ||
id | Id | Guid |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
chargeDescription | Charge | Text | ||
chargeNumber | Charge number | Text | ||
description | Description | Text | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
hasUnitPrice | Has unit price Indicates if the invoice line has a unit price. Only one-off charges with model quantity or volumne (with price base per unit) will have unit prices |
Checkbox | ||
id | Id | Guid | ||
isZeroAmountRecurring | IsZeroAmountRecurring True if this invoiceline has recurring posts that equals zero amount. |
Checkbox | ||
isZeroAmountUsageOrMeasured | IsZeroAmountUsageOrMeasured True if this invoiceline has usage posts that equals zero amount. |
Checkbox | ||
notes | Notes | LongText | ||
price | Price Price of the product |
CurrencyAmount | ||
productName | Product name | Text | ||
productNumber | Product number | Text | ||
quantity | Quantity | DecimalNumber | ||
servicePeriodEndDate | Service period end | Date | ||
servicePeriodStartDate | Service period start | Date | ||
subtotalAmount | Subtotal amount | Amount | ||
subtotalBaseCurrencyAmount | Subtotal amount (Base) | Amount | Read-Only | |
subtotalCurrencyCode | Subtotal currency | Text | ||
subtotalBaseCurrencyCode | Subtotal currency (Base) | Text | Read-Only | |
subtotalCurrencyConversionDate | Subtotal currency conversion date | Date | Read-Only | |
subtotalPreDiscountAmount | Subtotal pre Discount amount | Amount | ||
subtotalPreDiscountBaseCurrencyAmount | Subtotal pre Discount amount (Base) | Amount | Read-Only | |
subtotalPreDiscountCurrencyCode | Subtotal pre Discount currency | Text | ||
subtotalPreDiscountBaseCurrencyCode | Subtotal pre Discount currency (Base) | Text | Read-Only | |
subtotalPreDiscountCurrencyConversionDate | Subtotal pre Discount currency conversion date | Date | Read-Only | |
taxAmount | Tax amount | Amount | ||
taxBaseCurrencyAmount | Tax amount (Base) | Amount | Read-Only | |
taxCategoryName | Tax category name | Text | ||
taxCurrencyCode | Tax currency | Text | ||
taxBaseCurrencyCode | Tax currency (Base) | Text | Read-Only | |
taxCurrencyConversionDate | Tax currency conversion date | Date | Read-Only | |
taxPreDiscountAmount | Tax pre Discount amount | Amount | ||
taxPreDiscountBaseCurrencyAmount | Tax pre Discount amount (Base) | Amount | Read-Only | |
taxPreDiscountCurrencyCode | Tax pre Discount currency | Text | ||
taxPreDiscountBaseCurrencyCode | Tax pre Discount currency (Base) | Text | Read-Only | |
taxPreDiscountCurrencyConversionDate | Tax pre Discount currency conversion date | Date | Read-Only | |
taxRate | Tax rate | DecimalNumber | ||
total | Total amount | CurrencyAmount | ||
totalAmount | Total amount | Amount | ||
totalBaseCurrencyAmount | Total amount (Base) | Amount | Read-Only | |
totalCurrencyCode | Total currency | Text | ||
totalBaseCurrencyCode | Total currency (Base) | Text | Read-Only | |
totalCurrencyConversionDate | Total currency conversion date | Date | Read-Only | |
totalPreDiscountAmount | Total pre Discount amount | Amount | ||
totalPreDiscountBaseCurrencyAmount | Total pre Discount amount (Base) | Amount | Read-Only | |
totalPreDiscountCurrencyCode | Total pre Discount currency | Text | ||
totalPreDiscountBaseCurrencyCode | Total pre Discount currency (Base) | Text | Read-Only | |
totalPreDiscountCurrencyConversionDate | Total pre Discount currency conversion date | Date | Read-Only | |
tax | Total Tax | CurrencyAmount | ||
priceAmount | Unit price amount | Amount | ||
priceBaseCurrencyAmount | Unit price amount (Base) | Amount | Read-Only | |
priceCurrencyCode | Unit price currency | Text | ||
priceBaseCurrencyCode | Unit price currency (Base) | Text | Read-Only | |
priceCurrencyConversionDate | Unit price currency conversion date | Date | Read-Only |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
externalERPId | External ERP Id | Text | ||
id | Id | Guid | ||
journalNumber | Journal number | Text | ||
journalType | Journal type | Enum |
Allowed values:
Invoice
RevenueRecognition
Payment
Payout
Order
|
|
description | Notes | LongText | ||
posted | Posted If journal has been posted |
Checkbox | ||
postedDate | Posted date Date journal was posted |
Date | ||
transferredToERP | Transferred to External ERP Date when journal was transferred to external ERP |
Date |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
invoiceBatchGroup | The batch group this order belongs to for invoicing. When creating an invoice batch, an invoice for this order will be created along with invoices for all orders included in this group, separated from other orders |
Reference |
Referenced entity
invoicebatchgroup
|
|
account | Account The account associated with this order |
Reference |
Referenced entity
account
|
|
acvAmount | ACV amount | Amount | Read-Only | |
acvBaseCurrencyAmount | ACV amount (Base) | Amount | Read-Only | |
acvCurrencyCode | ACV currency | Text | Read-Only | |
acvBaseCurrencyCode | ACV currency (Base) | Text | Read-Only | |
acvCurrencyConversionDate | ACV currency conversion date | Date | Read-Only | |
isAutoRenewed | Auto-renewal Check if the order should be auto-renewed after the effective end date |
Checkbox | ||
orderBillingPeriod | Billing period How frequent the account will be billed for all product charges |
Enum |
Allowed values:
Monthly
Quarterly
Annual
EndOfTerm
Biannual
|
|
setBillingPeriodOnOrderLevel | Billing period on order Set billing period on order level |
Checkbox | ||
referenceNumber | Buyer reference Buyer reference |
Text | ||
cmrrAmount | CMRR amount | Amount | Read-Only | |
cmrrBaseCurrencyAmount | CMRR amount (Base) | Amount | Read-Only | |
cmrrCurrencyCode | CMRR currency | Text | Read-Only | |
cmrrBaseCurrencyCode | CMRR currency (Base) | Text | Read-Only | |
cmrrCurrencyConversionDate | CMRR currency conversion date | Date | Read-Only | |
created | Created Date the order was initially created |
DateTime | Read-Only | |
currency | Currency The currency for the order |
Reference |
Referenced entity
currency
|
|
currencyCodeText | Currency code | Text | ||
deliveryAddress | Delivery addresss Address the order will be delivered to |
Reference |
Referenced entity
address
|
|
description | Description Description of the order for internal use |
Text | ||
disableInvoicing | Disable invoicing If this box is checked, you can't send invoices from the order. |
Checkbox | ||
cancellationDate | Effective cancellation date The date this order effectively will be/was cancelled |
Date | ||
effectiveChangeDate | Effective change date Date the change will take effect |
Date | ||
effectiveEndDate | Effective end date Date the order will end, calculated field using Effective start date and initial term. This field will be updated by renewals |
Date | Read-Only | |
effectiveStartDate | Effective start date Date the order will start/take effect |
Date | ||
emrrAmount | EMRR amount | Amount | Read-Only | |
emrrBaseCurrencyAmount | EMRR amount (Base) | Amount | Read-Only | |
emrrCurrencyCode | EMRR currency | Text | Read-Only | |
emrrBaseCurrencyCode | EMRR currency (Base) | Text | Read-Only | |
emrrCurrencyConversionDate | EMRR currency conversion date | Date | Read-Only | |
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
fmrrAmount | FMRR amount | Amount | ||
fmrrBaseCurrencyAmount | FMRR amount (Base) | Amount | Read-Only | |
fmrrCurrencyCode | FMRR currency | Text | ||
fmrrBaseCurrencyCode | FMRR currency (Base) | Text | Read-Only | |
fmrrCurrencyConversionDate | FMRR currency conversion date | Date | Read-Only | |
id | Id | Guid | Read-Only | |
term | Initial term (months) This specifies the initial duration (in complete months) for which the order will remain active until it needs to be renewed |
Integer | ||
invoiceAccount | Invoice Account The account that will be invoiced for this order |
Reference |
Referenced entity
account
|
|
invoiceAddress | Invoice addresss Address the invoice will be billed to |
Reference |
Referenced entity
address
|
|
invoiceBatchGroupCode | Invoice Batch Group Code Invoice Batch Group Code |
Text | ||
CurrencyCodeToUseWhenInvoiceText | Invoice currency Currency code to use when invoice |
Text | ||
invoiceSeparatly | Invoice separate If this box is checked, this order will be invoiced separately from other orders on this account, otherwise, it will be invoiced on shared invoices with the other invoices. This applies to invoice batches, invoicing from the order will create a separate invoice regardless of the box being checked |
Checkbox | ||
isDraft | Is draft If the order is status Draft (Subscription) or Order Draft (Sales order) |
Checkbox | Read-Only | |
inProgress | Is in progress If the order is in progress, i.e. not status inactive, cancelled, deleted, draft or paid |
Checkbox | Read-Only | |
lastRenewalDate | Last renewal | Date | Read-Only | |
isLastVersion | Last version If this version is the latest of the order |
Checkbox | Read-Only | |
milestonesCount | Milestones count Number of milestones on the order |
Integer | Read-Only | |
milestonesOpen | Milestones open Number of open milestones on the order |
Integer | Read-Only | |
modified | Modified Date the order was last modified |
DateTime | Read-Only | |
notDelivered | Not delivered | Checkbox | Read-Only | |
noticePeriod | Notice Period (months) Instead of the order being renewed the day after the effective end date, the notice period (in months), moves back the day the order will automatically be renewed (if auto-renewal is checked), unless the account cancels the order before this date |
Integer | ||
noticePeriodDate | Notice Period Date The notice period date, calculated from Notice Period (months) |
Date | ||
orderDate | Order date Date the order was requested from the account, has no functional effect, only used for reporting |
Date | ||
ordermilestones | Order milestones All the milestones on the order |
ReferenceCollection |
Referenced entity
ordermilestone
|
|
orderNumber | Order number | Text | Read-Only | |
orderType | Order type Type of order, if it is a subscription or a sales order |
Enum |
Allowed values:
Subscription
SalesOrder
|
|
oneTimeFeesAmount | OTF amount | Amount | Read-Only | |
oneTimeFeesBaseCurrencyAmount | OTF amount (Base) | Amount | Read-Only | |
oneTimeFeesCurrencyCode | OTF currency | Text | Read-Only | |
oneTimeFeesBaseCurrencyCode | OTF currency (Base) | Text | Read-Only | |
oneTimeFeesCurrencyConversionDate | OTF currency conversion date | Date | Read-Only | |
salesReference | Our reference Our reference |
Text | ||
orderPaymentMethod | Payment method The method this account will use to pay order invoices |
Enum |
Allowed values:
Invoice
Stripe
|
|
paymentTerm | PaymentTerm The number of days from the invoice is sent that it needs to be paid |
Reference |
Referenced entity
paymentterm
|
|
productcount | Product count Number of products on the order |
Integer | Read-Only | |
products | Products All products on this order |
ReferenceCollection |
Referenced entity
orderproduct
|
|
remarks | Remarks Additional remarks on the order that should be communicated to the customer, the remarks are copied to invoices sent to the account |
LongText | ||
renewalTerm | Renewal term (months) The number of months this order will be extended for after the effective end date, if renewed |
Integer | ||
status | Status Status of the order |
Enum |
Allowed values:
Draft
Active
Cancelled
Inactive
Deleted
OrderDraft
Order
PartiallyDelivered
Delivered
Invoiced
PartiallyPaid
Paid
|
|
termType | Subscription type Type of subscription, evergreen if the order is active in perpetuity until cancelled, and termed if the order is active a specific time period with renewal terms |
Enum |
Allowed values:
Termed
Evergreen
|
|
tcvAmount | TCV amount | Amount | Read-Only | |
tcvBaseCurrencyAmount | TCV amount (Base) | Amount | Read-Only | |
tcvCurrencyCode | TCV currency | Text | Read-Only | |
tcvBaseCurrencyCode | TCV currency (Base) | Text | Read-Only | |
tcvCurrencyConversionDate | TCV currency conversion date | Date | Read-Only | |
useAccountInvoiceBatchGroup | Use Account Invoice Batch Group If the account has an assigned batch group, check this box if that batch group should be used for this order |
Checkbox | ||
version | Version The version of the order based on changes |
Integer | Read-Only | |
yourOrderNumber | Your order number Reference to external order number |
Text | ||
accountReference | Your reference Reference of the account |
Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
charges | ReferenceCollection |
Referenced entity
orderproductcharge
|
||
chargeplan | Reference |
Referenced entity
chargeplan
|
||
calculatedAcv | ACV Annual contract value |
Calculated | Read-Only | |
acvAmount | ACV amount | Amount | Read-Only | |
acvBaseCurrencyAmount | ACV amount (Base) | Amount | Read-Only | |
acvCurrencyCode | ACV currency | Text | Read-Only | |
acvBaseCurrencyCode | ACV currency (Base) | Text | Read-Only | |
acvCurrencyConversionDate | ACV currency conversion date | Date | Read-Only | |
anyBillableCharges | Any billable charges Any billable charges |
Checkbox | Read-Only | |
anyRenewalCharges | Any charges for renewal | Checkbox | Read-Only | |
anyCurrentCharges | Any current and future charges | Checkbox | Read-Only | |
calculatedCmrr | CMRR Contracted monthly reccurring revenue |
Calculated | Read-Only | |
cmrrAmount | CMRR amount | Amount | Read-Only | |
cmrrBaseCurrencyAmount | CMRR amount (Base) | Amount | Read-Only | |
cmrrCurrencyCode | CMRR currency | Text | Read-Only | |
cmrrBaseCurrencyCode | CMRR currency (Base) | Text | Read-Only | |
cmrrCurrencyConversionDate | CMRR currency conversion date | Date | Read-Only | |
isDeleted | Deleted This field is only used when updating orders through the api. If a product should be removed from the order this field should be set to true. If set to true, the product and all its charges will be removed during the order update |
Checkbox | ||
calculatedEmrr | EMRR Estimated monthly reccuring revenue |
Calculated | Read-Only | |
emrrAmount | EMRR amount | Amount | Read-Only | |
emrrBaseCurrencyAmount | EMRR amount (Base) | Amount | Read-Only | |
emrrCurrencyCode | EMRR currency | Text | Read-Only | |
emrrBaseCurrencyCode | EMRR currency (Base) | Text | Read-Only | |
emrrCurrencyConversionDate | EMRR currency conversion date | Date | Read-Only | |
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
calculatedFmrr | FMRR Forecasted monthly reccuring revenue |
Calculated | Read-Only | |
fmrrAmount | FMRR amount | Amount | Read-Only | |
fmrrBaseCurrencyAmount | FMRR amount (Base) | Amount | Read-Only | |
fmrrCurrencyCode | FMRR currency | Text | Read-Only | |
fmrrBaseCurrencyCode | FMRR currency (Base) | Text | Read-Only | |
fmrrCurrencyConversionDate | FMRR currency conversion date | Date | Read-Only | |
id | Id Id of product in order |
Guid | Read-Only | |
isAddedCharge | Is added charge | Checkbox | ||
isFrameworkProduct | Is framework product If it is a framework product |
Checkbox | ||
orderId | Order Id Id of order |
Guid | Read-Only | |
oneTimeFeesAmount | OTF amount | Amount | Read-Only | |
oneTimeFeesBaseCurrencyAmount | OTF amount (Base) | Amount | Read-Only | |
oneTimeFeesCurrencyCode | OTF currency | Text | Read-Only | |
oneTimeFeesBaseCurrencyCode | OTF currency (Base) | Text | Read-Only | |
oneTimeFeesCurrencyConversionDate | OTF currency conversion date | Date | Read-Only | |
productLineNumber | Product line number | Integer | ||
name | Product name | Text | ||
productNumber | Product number | Text | Read-Only | |
splitFromOrderNumber | Split From Order Order number of the order that this product was split from |
Text | Read-Only | |
splitFromOrderId | Split From Order (Id) Id of the order that this product was split from |
Guid | Read-Only | |
splitToOrderNumber | Split To Order Order number of the order that this product was split to |
Text | Read-Only | |
splitToOrderId | Split To Order (Id) Id of the order that this product was split to |
Guid | Read-Only | |
status | Status Status of the product |
Enum |
Allowed values:
Active
Cancelled
|
|
calculatedTcv | TCV Total contract value |
Calculated | Read-Only | |
tcvAmount | TCV amount | Amount | Read-Only | |
tcvBaseCurrencyAmount | TCV amount (Base) | Amount | Read-Only | |
tcvCurrencyCode | TCV currency | Text | Read-Only | |
tcvBaseCurrencyCode | TCV currency (Base) | Text | Read-Only | |
tcvCurrencyConversionDate | TCV currency conversion date | Date | Read-Only |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
calculatedAcv | ACV Annual contract value |
Calculated | ||
acvAmount | ACV amount | Amount | ||
acvBaseCurrencyAmount | ACV amount (Base) | Amount | Read-Only | |
acvCurrencyCode | ACV currency | Text | ||
acvBaseCurrencyCode | ACV currency (Base) | Text | Read-Only | |
acvCurrencyConversionDate | ACV currency conversion date | Date | Read-Only | |
alignmentDate | Alignment date Alignment date to use when period alignment is set to Align-to-date |
Date | ||
billingDay | Billing day When to charge the account in respect to the charge period (for very specific scenarios) |
Enum |
Allowed values:
None
FirstDayOfMonth
LastDayOfMonth
FromOrder
FromCharge
FromAccount
SpecificDay
DaysOffset
|
|
billingPeriod | Billing period How frequent the account will be billed for the charge |
Enum |
Allowed values:
Monthly
Quarterly
Annual
EndOfTerm
Biannual
|
|
billingTiming | Billing timing If the charge should be billed in advance of the billing period or in arrears of the billing period |
Enum |
Allowed values:
InAdvance
InArrears
|
|
chargeId | Charge Id Id of charge |
Guid | Read-Only | |
model | Charge model The pricing structure of the charge |
Enum |
Allowed values:
Flat
Quantity
Volume
Tiered
Rated
|
|
chargeNumber | Charge number | Text | ||
chargeType | Charge type The billing structure of the charge |
Enum |
Allowed values:
OneOff
Recurring
Usage
Measured
|
|
calculatedCmrr | CMRR Contracted monthly recurring revenue |
Calculated | ||
cmrrAmount | CMRR amount | Amount | ||
cmrrBaseCurrencyAmount | CMRR amount (Base) | Amount | Read-Only | |
cmrrCurrencyCode | CMRR currency | Text | ||
cmrrBaseCurrencyCode | CMRR currency (Base) | Text | Read-Only | |
cmrrCurrencyConversionDate | CMRR currency conversion date | Date | Read-Only | |
contractedEndDate | Contracted End When charge ends accordint to contract |
Date | ||
deferredRevenue | Deferred revenue account The financial account that should be used for deferred revenue |
Reference |
Referenced entity
financialaccount
|
|
isDeleted | Deleted This field is only used when updating orders through the api. If a charge should be removed from a product this field should be set to true. |
Checkbox | ||
name | Description Describes the charge, will be the description of the line item on the customer invoice |
Text | ||
displayPrice | Display price | CurrencyAmount | Read-Only | |
effectiveEndDate | Effective End Effective end date of charge |
Date | ||
effectiveStartDate | Effective Start Effective start date of charge |
Date | ||
calculatedEmrr | EMRR Estimated monthly recurring revenue |
Calculated | ||
emrrAmount | EMRR amount | Amount | ||
emrrBaseCurrencyAmount | EMRR amount (Base) | Amount | Read-Only | |
emrrCurrencyCode | EMRR currency | Text | ||
emrrBaseCurrencyCode | EMRR currency (Base) | Text | Read-Only | |
emrrCurrencyConversionDate | EMRR currency conversion date | Date | Read-Only | |
endDate | End date End date of charge |
Date | ||
endOn | End on The specific end date of the charge relative to the order |
Enum |
Allowed values:
AlignToSubscription
SpecificDate
Milestone
|
|
estimatedQuantity | Estimated quantity | DecimalNumber | ||
estimatedUsage | Estimated usage | Integer | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
productFeatures | Features | EntityList | ||
calculatedFmrr | FMRR Forecasted monthly recrring revenue |
Calculated | ||
fmrrAmount | FMRR amount | Amount | ||
fmrrBaseCurrencyAmount | FMRR amount (Base) | Amount | Read-Only | |
fmrrCurrencyCode | FMRR currency | Text | ||
fmrrBaseCurrencyCode | FMRR currency (Base) | Text | Read-Only | |
fmrrCurrencyConversionDate | FMRR currency conversion date | Date | Read-Only | |
id | Id | Guid | Read-Only | |
createInvoiceLinesPerTier | Invoice lines per tier If enabled, separate invoice lines will be created for each active tier. Currently only applicable for the Fortnox and Exact Online Connector |
Checkbox | ||
chargedThroughDate | Invoiced to The date this charge has been invoiced to, I.e. one day after the last day of the latest billing period invoiced for. |
Date | ||
isBillable | Is billable | Checkbox | Read-Only | |
isCurrent | Is current | Checkbox | Read-Only | |
isLastVersion | Is last version If it is the last verision |
Checkbox | Read-Only | |
isOverridenFrameworkProductCharge | Is overriden framework product charge If the order charge orverrides the framework product properties |
Checkbox | ||
isPartitalDelivery | Is partial delivery | Checkbox | ||
isRenewal | Is renewal | Checkbox | Read-Only | |
lastRenewalDate | Last renewal | Date | Read-Only | |
measurementsRule | Measurements rule | Enum |
Allowed values:
LatesDate
|
|
recurringMonthlyAmountAmount | Monthly recurring amount | Amount | ||
recurringMonthlyAmountBaseCurrencyAmount | Monthly recurring amount (Base) | Amount | Read-Only | |
recurringMonthlyAmountCurrencyCode | Monthly recurring currency | Text | ||
recurringMonthlyAmountBaseCurrencyCode | Monthly recurring currency (Base) | Text | Read-Only | |
recurringMonthlyAmountCurrencyConversionDate | Monthly recurring currency conversion date | Date | Read-Only | |
offsetBillingDate | Offset billing date | Date | ||
offsetBillingDays | Offset billing days | Integer | ||
orderPaymentTermDays | Order Payment Term Days | Integer | Read-Only | |
orderProductId | Order Product Id | Guid | Read-Only | |
orderedQuantity | Ordered quantity | DecimalNumber | Read-Only | |
originalStartDate | Original Start Original start date of charge |
Date | ||
oneTimeFeesAmount | OTF amount | Amount | ||
oneTimeFeesBaseCurrencyAmount | OTF amount (Base) | Amount | Read-Only | |
oneTimeFeesCurrencyCode | OTF currency | Text | ||
oneTimeFeesBaseCurrencyCode | OTF currency (Base) | Text | Read-Only | |
oneTimeFeesCurrencyConversionDate | OTF currency conversion date | Date | Read-Only | |
periodAlignment | Period alignment How the billing of the charge will sync with the order cycle |
Enum |
Allowed values:
None
AlignToOrder
AlignToCharge
AlignToMonth
AlignToCalendarQuarter
AlignToDate
|
|
price | PPU Price per unit the account is using and will be billed for |
CurrencyAmount | Read-Only | |
ppuAmount | PPU amount Price Per Unit |
Amount | ||
ppuBaseCurrencyAmount | PPU amount (Base) | Amount | Read-Only | |
ppuCurrencyCode | PPU currency | Text | ||
ppuBaseCurrencyCode | PPU currency (Base) | Text | Read-Only | |
ppuCurrencyConversionDate | PPU currency conversion date | Date | Read-Only | |
flatPrice | Price The price the account will be billed for the charge |
CurrencyAmount | Read-Only | |
lastPriceAdjustment | Price adjusted Last date the price of the charge was adjusted |
Date | ||
flatPriceAmount | Price amount | Amount | ||
flatPriceBaseCurrencyAmount | Price amount (Base) | Amount | Read-Only | |
flatPriceCurrencyCode | Price currency | Text | ||
flatPriceBaseCurrencyCode | Price currency (Base) | Text | Read-Only | |
flatPriceCurrencyConversionDate | Price currency conversion date | Date | Read-Only | |
priceDetails | Price details All price details for a charge |
ReferenceCollection |
Referenced entity
orderproductchargedetails
|
|
pricePeriod | Price period The period length the price is for |
Enum |
Allowed values:
Monthly
Quarterly
Annual
|
|
quantity | Quantity If the Charge Model is quantity, this is the quantity of units the account is using of the product |
DecimalNumber | ||
recognizeddRevenue | Recognized revenue account The financial account that should be used for recognized revenue |
Reference |
Referenced entity
financialaccount
|
|
remainingQuantity | Remaining quantity | DecimalNumber | Read-Only | |
remarks | Remarks Remarks are copied to the corresponding invoice line comment when invoices are created |
LongText | ||
revenueRecognitionRule | Revenue recognition rule The revenue recognition rule decides how revenue for a charge is recognized and distributed |
Reference |
Referenced entity
revenuerecognitionrule
|
|
revenueRecognitionRuleName | Revenue recognition rule How the revenue from the charge will be recognized |
Text | ||
recognizedRevenueTemplateName | Revenue recognition template | Text | ||
specificBillingDay | Specific billing day | Integer | ||
specificDateFirstInvoice | Specific date first invoice | Date | ||
startDate | Start date Start date of charge |
Date | ||
startOn | Start on The specific start date of the charge relative to the order |
Enum |
Allowed values:
AlignToSubscription
SpecificDate
Milestone
|
|
changeState | Status Status of charge chage state |
Enum |
Allowed values:
NotChanged
New
Cancelled
NewFromChange
CancelledFromChange
Credit
PartialDelivery
ClosedPartialDelivery
Credited
|
|
taxIncluded | Tax included If the tax will be included in the price (otherwise a tax amount according to the tax template will be added on top of the subtotal price) |
Checkbox | ||
taxTemplate | Tax template The tax template defines how taxes are applied to a charge |
Reference |
Referenced entity
taxtemplate
|
|
calculatedTcv | TCV Total contract value |
Calculated | ||
tcvAmount | TCV amount | Amount | ||
tcvBaseCurrencyAmount | TCV amount (Base) | Amount | Read-Only | |
tcvCurrencyCode | TCV currency | Text | ||
tcvBaseCurrencyCode | TCV currency (Base) | Text | Read-Only | |
tcvCurrencyConversionDate | TCV currency conversion date | Date | Read-Only | |
trvAmount | Term Value amount | Amount | ||
trvBaseCurrencyAmount | Term Value amount (Base) | Amount | Read-Only | |
trvCurrencyCode | Term Value currency | Text | ||
trvBaseCurrencyCode | Term Value currency (Base) | Text | Read-Only | |
trvCurrencyConversionDate | Term Value currency conversion date | Date | Read-Only | |
unit | Unit Unit of measure |
Reference |
Referenced entity
unitofmeasure
|
|
usageRating | Usage rating | Enum |
Allowed values:
Sum
Max
Average
|
|
useRecognizedRevenueTemplate | Use Recognized Revenue Template | Checkbox | ||
version | Version Version of charge |
Integer |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
OrderProductChargeId | Charge Id Id of Charge |
Guid | Read-Only | |
description | Description Tier description |
Text | ||
lineDiscountPercent | Discount % A percentage discount based on the list price, which will calculate and determine the price |
Percent | ||
lineDiscountAmountAmount | Discount amount | Amount | ||
lineDiscountAmount | Discount Amount A discount amount based on the list price, which will calculate and determine the price |
CurrencyAmount | ||
lineDiscountAmountBaseCurrencyAmount | Discount amount (Base) | Amount | Read-Only | |
lineDiscountAmountCurrencyCode | Discount currency | Text | ||
lineDiscountAmountBaseCurrencyCode | Discount currency (Base) | Text | Read-Only | |
lineDiscountAmountCurrencyConversionDate | Discount currency conversion date | Date | Read-Only | |
fromQuantity | From quantity Quantity starts from |
DecimalNumber | ||
id | Id | Guid | Read-Only | |
listPrice | List Price The standard base price of the product |
CurrencyAmount | ||
listPriceAmount | List price amount | Amount | ||
listPriceBaseCurrencyAmount | List price amount (Base) | Amount | Read-Only | |
listPriceCurrencyCode | List price currency | Text | ||
listPriceBaseCurrencyCode | List price currency (Base) | Text | Read-Only | |
listPriceCurrencyConversionDate | List price currency conversion date | Date | Read-Only | |
price | Price Price of product |
CurrencyAmount | ||
priceAmount | Price amount | Amount | ||
priceBaseCurrencyAmount | Price amount (Base) | Amount | Read-Only | |
priceBase | Price base | Enum |
Allowed values:
Flat
PerUnit
|
|
priceCurrencyCode | Price currency | Text | ||
priceBaseCurrencyCode | Price currency (Base) | Text | Read-Only | |
priceCurrencyConversionDate | Price currency conversion date | Date | Read-Only | |
tier | Tier Tier number |
Integer | ||
toQuantity | To quantity To quantity |
DecimalNumber |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
days | Days | Integer | ||
description | Description | Text | ||
id | Id | Guid | ||
name | Name | Text | ||
termType | Term Value | Enum |
Allowed values:
NetDays
|
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
creditAmount | Credit Credit amount |
Amount | ||
creditBaseCurrencyAmount | Credit (Base) Credit base currency amount |
Amount | ||
creditCurrencyCode | Credit currency Credit currency code |
Text | ||
creditBaseCurrencyCode | Credit currency (Base) Credit currency code (Base) |
Text | ||
debitAmount | Debit Debit amount |
Amount | ||
debitBaseCurrencyAmount | Debit (Base) | Amount | ||
debitCurrencyCode | Debit currency Currency for debit |
Text | ||
debitBaseCurrencyCode | Debit currency (Base) | Text | ||
description | Description | Text | ||
paymentId | Payment id | Guid | ||
id | Posting Id | Guid |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
activationDate | Activation Activation date |
Date | ||
afterEndOfSales | Active product | Checkbox | Read-Only | |
chargePlans | Charge plans All charge plans for a product |
ReferenceCollection |
Referenced entity
chargeplan
|
|
endOfLifeDate | End of life End of life date |
Date | ||
endOfRenewalDate | End of renewal End of renewal date |
Date | ||
endOfNewSalesDate | End of sales Date for end of sales |
Date | ||
externalCRMId | External CRM Id | Text | ||
externalERPId | External ERP Id | Text | ||
id | Id | Guid | ||
isFrameworkProduct | Is framework product | Checkbox | ||
isVirtual | Is shared A shared product is a product that is defined in a virtual parent legal entity |
Checkbox | ||
owner | Legal entity The legal entity in which this product is managed |
Text | ||
name | Name | Text | ||
category | Product category | Reference |
Referenced entity
productcategory
|
|
productCategoryName | Product category name | Text | ||
productNumber | Product number | Text | ||
productType | Product Type | Enum |
Allowed values:
Simple
MultipleCharges
MultipleChargePlans
Full
|
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
mixedUpfrontPercentageBasedOnListPrice | Base upfront on list price If a list price is available on the charge, it will be used to calculate the upfront percentage. If the list price is 0, the actual price will be used. |
Checkbox | ||
distribution | Distribution Default distribution for revenue recognition |
Enum |
Allowed values:
None
FrontLoad
BackLoad
Prorated
FullPeriodsOrDays
|
|
id | Id | Guid | ||
revenueRecognitionMethod | Method Default Method of revenue recognition |
Enum |
Allowed values:
None
FullRecognitionUponInvoicing
MonthlyRecognitionOverTime
MixedUpfrontAndOverTime
ManualDistribution
|
|
name | Name | Text | ||
revenueRecognitionType | Revenue recognition type evenue recognition based on invoice or order |
Enum |
Allowed values:
InvoiceBased
OrderBased
|
|
mixedUpfrontOnlyOnFirstInvioce | Upfront only on first invoice Should the upfront percentage only be applied to the first invoice, or should it apply to all invoices |
Checkbox | ||
mixedUpfrontPercentage | Upfront percentage The percentage to recognize upfront |
Percent |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
description | Description | Text | ||
effectiveFrom | Effective from | Date | ||
effectiveTo | Effective to | Date | ||
id | Id | Guid | ||
legalEntityName | Legal entity The legal entity in which tax template is managed |
Text | ||
name | Name | Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
effectiveDate | Effective date | Date | ||
externalCRMId | External CRM Id External CRM Id |
Text | ||
externalERPId | External ERP Id External ERP Id |
Text | ||
journalId | Journal The journal this transaction belongs to |
Guid | ||
source | Source | Enum |
Allowed values:
Invoicing
RevenueRecognition
Payment
Payout
Order
|
|
transactionNumber | Transaction number Number for the transaction |
Text |
Field name | Description | Type | Read-only | Remarks |
---|---|---|---|---|
id | Id | Guid | ||
legalEntityName | Legal entity The legal entity in which this unit of measure is managed |
Text | ||
name | Name | Text | ||
numberOfDecimals | Number of decimals | Integer | ||
displayName | Unit Display name for unit of measure |
Text | ||
unit | Unit code | Text |