References

Account

Type FieldName
string AccountNumber
AccountType AccountType
List<Account> Subsidiaries  
string Name  
List<Address> Addresses  
Address DefaultInvoiceAddress
Address DefaultDeliveryAddress
Currency Currency  
string SalesReference
string YourReference
string InvoiceEmailAddress
string InvoiceEmailCcAddresses
InvoiceDeliveryMethod InvoiceDeliveryMethod
PaymentTerm DefaultPaymentTerm
string TaxRegistrationNumber
string OrganizationNumber
string ElectronicInvoiceAddress
string ElectronicInvoiceAddressScheme
InvoiceBatchGroup InvoiceBatchGroup
bool Inactive  
TaxTemplate TaxTemplate
FinancialAccount AccountsReceivable
string Domain  
OnlinePaymentDetails OnlinePaymentDetails
DocumentTemplate InvoiceTemplate
CustomFields CustomFields
List<Invoice> Invoices  
List<Order> Orders  
string ExternalERPId  
string ExternalCRMId  
     
enum AccountType
  Customer = 0
  Reseller = 1
  Subsidiary = 2
  Prospect = 3
  Other = 99

 

Order

 

Type FieldName
string OrderNumber
OrderStatus Status
string Description
string Remarks
DateTime EffectiveStartDate
DateTime? EffectiveEndDate
DateTime? CancellationDate
DateTime? EffectiveChangeDate
DateTime? OrderDate
DateTime? NoticePeriodDate
DateTime? LastRenewalDate
int NoticePeriod
int Term
int RenewalTerm
bool IsAutoRenewed
OrderType OrderType
TermType TermType
OrderPaymentMethod OrderPaymentMethod
bool InvoiceSeparatly
string AccountReference
string SalesReference
string YourOrderNumber
Address InvoiceAddress
Address DeliveryAddress
PaymentTerm PaymentTerm
InvoiceBatchGroup InvoiceBatchGroup
bool UseAccountInvoiceBatchGroup
int Version
bool IsLastVersion
Account ContractedAccount
Account Account
Account PartnerAccount
Account InvoiceAccount
List<OrderProduct> OrderProducts
List<Note> Notes
string CurrencyCode
Currency Currency
CurrencyAmount CMRR
CurrencyAmount ACV
CurrencyAmount TCV
CurrencyAmount EMRR
CurrencyAmount OneTimeFees
CurrencyAmount FMRR
DocumentTemplate InvoiceTemplate
List<OrderMilestone> OrderMilestones
FinancialAccount AccountsReceivable
string CurrencyCodeToUseWhenInvoice
CustomFields CustomFields
List<OrderProductCharge> OneOffCharges()
List<OrderProductCharge> RecurringAndUsageCharges()
string ExternalERPId
string ExternalCRMId
List<OrderDiscount>
OrderDiscounts
   
enum OrderType
   
Subscription = 0
SalesOrder = 1
   
enum OrderStatus
   
Draft = 0
Active = 1
Cancelled = 2
Inactive = 3
Deleted = 4
OrderDraft = 5
Order = 6
PartiallyDelivered = 7
Delivered = 8
Invoiced = 9
PartiallyPaid = 10
Paid = 11
   
enum TermType
   
Termed = 0
Evergreen = 1
   
enum OrderPaymentMethod
   
Invoice = 0
Stripe = 1

 

OrderProduct

Type FieldName
string ProductNumber
int ProductLineNumber
string Name string
bool IsDeleted bool
string Identifier string
List<OrderProductCharge> Charges
Order Order
ChargePlan ChargePlan ChargePlan
CurrencyAmount CMRR
CurrencyAmount ACV
CurrencyAmount TCV
CurrencyAmount EMRR
CurrencyAmount OneTimeFees
CurrencyAmount FMRR
bool IsFrameworkProduct
bool IsAddedCharge
CustomFields CustomFields
string ExternalERPId
string ExternalCRMId
Type FieldName Type
string ProductNumber
int ProductLineNumber
string Name string
bool IsDeleted
string Identifier
List<OrderProductCharge> Charges
Order Order Order
ChargePlan ChargePlan ChargePlan
CurrencyAmount CMRR CurrencyAmount
CurrencyAmount ACV CurrencyAmount
CurrencyAmount TCV CurrencyAmount
CurrencyAmount EMRR
CurrencyAmount OneTimeFees CurrencyAmount
CurrencyAmount FMRR CurrencyAmount
bool IsFrameworkProduct bool
bool IsAddedCharge bool
CustomFields CustomFields CustomFields

 

OrderProductCharge

Type FieldName
string ChargeNumber
ChargeStartAndEndOptions StartOn
ChargeStartAndEndOptions EndOn
OrderMilestone StartMilestone
OrderMilestone EndMilestone
DateTime? EffectiveStartDate
DateTime? EffectiveEndDate
DateTime? ChargedThroughDate
DateTime? LastRenewalDate
DateTime? LastPriceAdjustmentDate
string Name
int Version
bool IsLastVersion
bool IsDeleted
ChargeModel Model
ChargeType ChargeType
decimal? Quantity
decimal? RemainingQuantity
decimal? OrderedQuantity
bool IsPartitalDelivery
PricePeriod PricePeriod
UsageRating UsageRating
MeasurementsRule MeasurementsRule
RevenueRecognitionRule RevenueRecognitionRule
BillingDay BillingDay
int SpecificBillingDay
BillingPeriod BillingPeriod
BillingTiming BillingTiming
BillingPeriodAlignment PeriodAlignment
DateTime? AlignmentDate
TaxTemplate TaxTemplate
bool TaxIncluded
bool CreateInvoiceLinesPerTier
string Remarks
FinancialAccount AccountsReceivable
FinancialAccount DeferredRevenue
FinancialAccount RecognizedRevenue
ChargeChangeState ChangeState
List<OrderProductChargeDetails> OrderProductChargeDetails
List<ServicePeriod> ServicePeriods
List<InvoiceLine> InvoiceLines
OrderProductCharge CreditedCharge
RevenueSchedule RevenueSchdeule
List<RevenueScheduleItem> RevenueScheduleItems
UnitOfMeasure UnitOfMeasure
OrderProduct OrderProduct
Charge Charge
bool IsOverridenFrameworkProductCharge
AssociatedChargeTemplate AssociatedChargeTemplate
List<ProductFeature> ProductFeatures
List<OrderDiscounts_OrderProductCharges> OrderDiscounts
List<string> OrderDiscountsMappedKeys
CurrencyAmount CMRR
CurrencyAmount ACV
CurrencyAmount TCV
CurrencyAmount EMRR
int EstimatedUsage
int EstimatedQuantity
CurrencyAmount FMRR
CurrencyAmount OneTimeFees
CurrencyAmount RecurringMonthlyAmount
List<Usage> LinkedUsage
List<Measurement> LinkedM
Account InvoiceSubsidiary
decimal? DisplayPrice
CustomFields CustomFields
decimal? PPU()
string ExternalERPId
string ExternalCRMId
DateTime BillingDate
CurrencyAmount Amount
   
enum ChargeChangeState
   
NotChanged = 0
New = 1
Cancelled = 2
NewFromChange = 3
CancelledFromChange = 4
Credit = 5
PartialDelivery = 6
ClosedPartialDelivery = 7
Credited = 8
   
   
enum ChargeStartAndEndOptions
   
AlignToSubscription = 0
SpecificeDate = 1
Milestone = 2

 

OrderProductChargeDetails

Type FieldName
string Description
decimal FromQuantity
decimal ToQuantity
CurrencyAmount Price
int Tier
PriceBase PriceBase
OrderProductCharge OrderProductCharge
CurrencyAmount LineDiscountAmount
decimal? LineDiscountPercent
CurrencyAmount ListPrice
decimal TierQuantity(decimal qty)
CurrencyAmount TierPrice(decimal qty)
CurrencyAmount TierListPrice(decimal qty)

 

OrderDiscount

Type FieldName
List<OrderProductCharge> OrderProductCharges
Order Order
OrderDiscountStartAndEndOptions StartOn
OrderDiscountStartAndEndOptions EndOn
DateTime? StartDate
DateTime? EndDate
decimal? Percent
bool IsSpecificOrderProductCharges

 

Milestone

Type FieldName
string Name
string Description
bool IsActive

 

Invoice

Type FieldName
string InvoiceNumber
Account Account
string Notes
DateTime? TargetDate
DateTime? TargetDateOneOff
DateTime? TargetDateUsage
DateTime? TargetDateMeasured
DateTime? TargetDateRecurringInAdvance
DateTime? TargetDateRecurringInArrears
DateTime InvoiceDate
DateTime DueDate
int PaymentTerm
PaymentTerm PaymentTermReference
Currency Currency
DateTime? Posted
CurrencyAmount TotalAmount
CurrencyAmount Subtotal
CurrencyAmount Tax
InvoiceStatus Status
Address InvoiceAddress
Address DeliveryAddress
CurrencyAmount TotalRoundingAmount
InvoiceBatch InvoiceBatch
List<InvoiceLine> InvoiceLines
List<PaymentSettlement> PaymentSettlements
string YourReference
string OurReference
string YourOrderNumber
string ReferenceNumber
Order Order
List<InvoiceReminder> InvoiceReminders
InvoiceType InvoiceType
bool TaxIncluded
string SendMethod
decimal? ExchangeRate
string SettledNotes
PaymentMethodForInvoice PaymentMethodForInvoice
List<OnlinePaymentLog> OnlinePaymentLog
DocumentTemplate InvoiceTemplate
bool DisableAutomaticInvoiceReminder
string UniqueOnlinePaymentKey
FinancialAccount AccountsReceivable
InvoiceDeliveryMethod InvoiceDeliveryMethod
string OCRNumber
CurrencyAmount SettledAmount
CurrencyAmount UnsettledAmount
int? DaysPastDue
CustomFields CustomFields
string CustomField(string
string ExternalERPId
string ExternalCRMId

 

Invoiceline

Type FieldName
string Notes
string ProductNumber
string ProductName
string ChargeDescription
string ChargeNumber
decimal? Quantity
bool HasPrice
CurrencyAmount Price
CurrencyAmount Subtotal
CurrencyAmount Total
CurrencyAmount Tax
DateTime? ServicePeriodStartDate
DateTime? ServicePeriodEndDate
UnitOfMeasure UnitOfMeasure
OrderProductCharge OrderProductCharge
Invoice Invoice
List<RevenueScheduleItem> RevenueScheduleItems
List<InvoiceLineUsage> InvoiceLineUsages
List<Usage> Usage
List<TaxItem> TaxItems
List<AccountingTransaction> Transactions
CustomFields CustomFields
FinancialAccount AccountsReceivable
FinancialAccount DeferredRevenue
FinancialAccount RecognizedRevenue
TaxTemplate TaxTemplate
InvoiceLine CreditedInvoiceLine
bool IsZeroAmountUsage
string ExternalERPId
string ExternalCRMId
CurrencyAmount
SubtotalPreDiscount
CurrencyAmount
TotalPreDiscount
CurrencyAmount
TaxPreDiscount

 

Quote

Type FieldName
string Number
int Version
bool IsLastVersion
string Description
ApplicationUser OwnerUser
Order ConvertedToOrder
Account Account
Account InvoiceAccount
QuoteStatus Status
OrderType OrderType
Currency Currency
string CurrencyCode
DateTime QuoteDate
DateTime ValidToDate
DateTime EffectiveStartDate
DateTime EffectiveEndDate
TermType TermType
int InitialTerm
int RenewalTerm
bool AutoRenewal
int NoticePeriod
CurrencyAmount TCV
CurrencyAmount CMRR
CurrencyAmount ACV
string YourReference
string OurReference
string Remarks
List<QuoteProduct> Products
List<QuoteMilestone> Milestones
CustomFields CustomFields
   
enum QuoteStatus
   
Draft,  
Closed,  
Converted,

 

QuoteProduct

Type FieldName
Quote Quote
string Name
string Number
ChargePlan ChargePlan
CurrencyAmount TCV
CurrencyAmount CMRR
CurrencyAmount ACV
List<QuoteProductCharge> QuoteProductCharges
CustomFields CustomFields

 

QuoteProductCharge

Type FieldName
QuoteProduct QuoteProduct
Charge Charge
string Name
ChargeType ChargeType
ChargeModel ChargeModel
ChargeStartAndEndOptions StartOn
ChargeStartAndEndOptions EndOn
DateTime? EffectiveStartDate
DateTime? EffectiveEndDate
QuoteMilestone StartMilestone
QuoteMilestone EndMilestone
BillingPeriod BillingPeriod
PricePeriod PricePeriod
UsageRating UsageRating
int EstimatedUsage
MeasurementsRule MeasurementsRule
decimal? Quantity
UnitOfMeasure UnitOfMeasure
decimal? DisplayPrice
decimal? PPU
CurrencyAmount TCV
CurrencyAmount CMRR
CurrencyAmount ACV
string Remarks
List<QuoteProductChargeDetails> QuoteProductChargeDetails
List<ProductFeature> ProductFeatures
CustomFields CustomFields

 

QuoteProductChargeDetails

Type FieldName
QuoteProductCharge QuoteProductCharge
decimal FromQuantity
decimal ToQuantity
CurrencyAmount Price
int Tier
PriceBase PriceBase
CurrencyAmount LineDiscountAmount
decimal? LineDiscountPercent
CurrencyAmount ListPrice

 

QuoteMilestone

Type FieldName
Quote Quote
string Name
string Description
DateTime? PlannedDate

 

ApplicationUser

Type FieldName
string FirstName
string LastName
string Title

 

Address

Type FieldName
string Description
string Name
string Street
string Street2
string City
Country Country
string State
string County
string Zip
   
Account Account

 

PaymentTerm

Type FieldName
string Description
string Name
PaymentTermType TermType
int Days

 

Country

Type FieldName
string Name
string TwoAlphaCode
string ThreeAlphaCode
bool Active
CustomFields CustomFields

 

Currency

Type FieldName
string Code
string Description

 

CurrencyAmount

Type FieldName
decimal Amount
string CurrencyCode
DateTime? CurrencyConversionDate
decimal BaseCurrencyAmount
string BaseCurrencyCode
bool IsZero()
bool IsZeroAmount()

 

TaxTemplate

Type FieldName
string Name
string Description
DateTime EffectiveFrom
DateTime EffectiveTo
FinancialAccount TaxAccount
List<TaxTemplateDetails> Details

 

TaxTemplateDetails

Type FieldName
TaxTemplate TaxTemplate
Country Country
string City
string State
string County
string Zip
decimal? Tax1
decimal? Tax2
decimal? Tax3
bool IsDeleted
bool UseTaxJar
TaxCategory TaxCategoryType

 

TaxCategory

Type FieldName
string Name
string Description
bool IsActive
bool IsEUTax