REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
  • Common Datatypes
  • AccountService Datatypes
  • AttachmentService Datatypes
  • AuthenticateService Datatypes
  • BudgetService Datatypes
  • ClientService Datatypes
  • CompanyService Datatypes
  • FileService Datatypes
  • InvoiceService Datatypes
  • PaymentService Datatypes
  • PersonService Datatypes
  • ProductService Datatypes
  • ProjectService Datatypes
  • SalesOppService DataTypes
  • TemplateService DataTypes
  • TimeService Datatypes
  • TransactionService DataTypes

InvoiceService Datatypes

Back to InvoiceService

InvoiceOrder

PropertyTypeDescription
OrderIdInt32Can be specified in requests to SaveInvoices, otherwise set by the system. If an existing orderId is set the request is treated as an update for an InvoiceOrder. Default value: Int32.MinValue
CustomerIdInt32Required. Must exist in system. Default value: Int32.MinValue
CustomerNameStringDefault value: “”. Max length 100 characters.
CustomerDeliveryNameStringDefault value: “”. Use this property when getting the Customer Delivery Name. the Delivery Name property under ‘Addresses’ can also be used for setting the name, but only this property can be used for both getting and setting the Delivery Name. Max length 250 characters
CustomerDeliveryPhoneStringCustomer Delivery Phone. Max length 25 characters
DeliveryAlternativeStringDefault value: “”. Max length 250 characters
AddressesAddressesDefault value: null
OrderStatusOrderSlipStateTypeDefault value: Web
InvoiceIdInt32Cannot be specified in requests to SaveInvoices, this is always defined by the system. Default value: Int32.MinValue
DateOrderedDateTimeDefault value: DateTime.MinValue
DateInvoicedDateTimeDefault value: DateTime.MinValue
DateChangedDateTimeDefault value: DateTime.MinValue
PaymentTimeInt16Default (no change): Int16.MinValue
>=1: number of days
0: no credit time
-1: end of month + 30 days
-2: end of month + 60 days
-3: end of month + 90 days
-4: end of month
-5:end of month + 45 days
If the value received is less than -5 and greater than -10.000 is set to "end of month + custom(egendefinert) where you have to subtract the value from 10000 to receive the value. Example: you receive -9940. Then you need to subtract that value from 10000 to get the result of end of month + 60 days.
If the value received is less than -10.000 and greater than -100.000 is set to a fixed Date. The value + 100.000 represent the number of days since epoch. Example: -99999 represents Jan 02 1900 (1 day after epoch), while -79545 represents Jan 01 2026 (20455 days since epoch)
CustomerReferenceNoStringDeprecated
ProjectIdInt32If set, must exist in system. Default value: Int32.MinValue
OurReferenceInt32EmployeeId. If set, must exist in system. Default value: Int32.MinValue
IncludeVATBoolean?Default value: null
YourReferenceStringDefault value: “”. Max length 50 characters
OrderTotalIncVatDecimalDefault value: Decimal.MinValue. Read only
OrderTotalVatDecimalDefault value: Decimal.MinValue. Read only
InvoiceTitleStringDefault value: “”. Max length 300 characters. This is the "comment" field of an invoice.
InvoiceTextStringDefault value: “”. Max length 750 characters
PaidDateTimeDefault value: DateTime.MinValue
OCRStringDefault value: “”. This is the invoice KID number. Max length 32 characters
CustomerOrgNoStringDefault value: “”. Max length 20 characters
CurrencyCurrencyDefault value: null
PaymentMethodIdInt32Default value: Int32.MinValue
PaymentAmountDecimalWrite only property. Used for registering payments. Default value: Decimal.MinValue
ProductionManagerIdInt32If set, must exist in system. Default value: Int32.MinValue
SalesOpportunityIdInt32If set, must exist in system. Default value: Int32.MinValue
TypeOfSaleIdInt32Default value: Int32.MinValue. You can get the values from GetTypeGroupList in the ClientService
DistributorCommon.DistributorDefault value: Default
DistributionMethodCommon.DistributionMethodDefault value: Unchanged
DepartmentIdInt32If set, must exist in system. Default value: Int32.MinValue
ExternalStatusInt32Default value: Int32.MinValue
DeliveryDateDateTimeDefault value: DateTime.MinValue
SkipStockBooleanDefault value: false
ProductionNumberStringDefault value: “”. Max length 20 characters
ReferenceInvoiceIdInt32Default value: Int32.MinValue. Used for reference to original invoice when making a credit note.
ReferenceOrderIdInt32Default value: Int32.MinValue. Used for reference to original order when making a credit note.
ReferenceNumberStringDefault value: “”. Max length 50 characters
InvoiceEmailAddressStringDefault value: “”. Max length 250 characters
AccrualDateDateTimeDefault value: DateTime.MinValue. Determines the start date for the accrual period(s)
AccrualLengthInt32Default value: Int32.MinValue. Sets the number of accrual months
RoundFactorDecimalDefault value: Decimal.MinValue. May be set to 0.1, 0.5 or 1.0
InvoiceTemplateIdGuidDefault value: 00000000-0000-0000-0000-000000000000
VippsNumberStringDeprecated
DeliveryMethodDeliveryMethodDefault value: null
SendToFactoringBoolean?Default value: true
CommissionDecimalDefault value: Decimal.MinValue
InvoiceRowsInvoiceRow[]Default value: null
APIExceptionCommon.APIExceptionDefault value: null
UserDefinedDimensionsUserDefinedDimensions[]Dimensions defined by the user
GLNNumberStringDefault value: “”. Uses Customer GLNNumber if default value is used and customer card has GLNNumber. To override this logic and set GLNNumber to the value NULL, the value in your request should be set to the string value NULL. Max length 13 characters
CustomerDeliveryIdInt32Default value: Int32.MinValue. CustomerId of recipient, in cases where it differs from CustomerId

InvoiceSearchParameters

PropertyTypeDescription
ChangedAfterDateTimeDefault value: DateTime.MinValue
InvoiceIdsInt32[]Max 1000 values. Default value: null
OrderIdsInt32[]Max 1000 values. Default value: null
CustomerIdsInt32[]Max 1000 values. Default value: null
ExternalStatusInt32[]Max 1000 values. Default value: null
OrderStatesOrderSlipStateType[]Default value: null

InvoiceRow

PropertyTypeDescription
ProductIdInt32Required for Row Type Normal. Must exist in system. Default value: Int32.MinValue
ProductNoStringRead only. When creating orders with SaveInvoices you must use ProductId
RowIdInt32Used when editing an existing order. Default value: Int32.MinValue
VatRateDecimalDefault value: Decimal.MinValue. Read only
PriceDecimalDefault value: Decimal.MinValue
NameStringDefault value: “”. Max length 300 characters
DiscountRateDecimalDefault value: Decimal.MinValue
QuantityDecimalDefault value: Decimal.MinValue
QuantityDeliveredDecimalDefault value: Decimal.MinValue
QuantityOrderedDecimalDefault value: Decimal.MinValue
QuantityRestDecimal-1. This property is used for creating rest orders
CostDecimalDefault value: Decimal.MinValue
InPriceDecimalDefault value: Decimal.MinValue
SequenceNumberInt16Default value: Int16.MinValue
HiddenBooleanDefault value: false. Makes the row hidden on the actual invoice statement.
TypeRowTypeNormal or Text. Default value: Normal. Please note that TextBold is deprecated
AccrualDateDateTimeDefault value: DateTime.MinValue
AccrualLengthInt32Default value: Int32.MinValue
ChangeStateChangeStateThis property must be used when editing an already exisiting order. Default value: ChangeState.None
TypeGroupIdInt32
AccountProjectBooleanN/A
DepartmentIdInt32
ProjectIdInt32
UserDefinedDimensionsUserDefinedDimensions[]Dimensions defined by the user
TaxSettingsTaxSettingsOverride the typegroup tax rate for this invoice row
SerialNumberString

TaxSettings

PropertyTypeDescription
TaxAccountInt32The account Id. Get this from GetAccountList in the AccountService
TaxCodeInt32Get this from GetTaxCodeList in the AccountService
TaxRateDecimalThe tax rate you wish to set

TemplateModel

PropertyTypeDescription
FileNameStringTemplate File name
NameStringTemplate name
IdGuidTemplate Id, used for specifying templates in SaveInvoices
LanguageStringTwo character country code
IsSystemTemplateBooleanSystem Templates are standard templates set up in the system
IsDefaultBooleanSpecifies if Template is set as default. Multiple Templates can be set to default
ModifiedDateTimeLast date modified
CustomersInt[]An array of CustomerIds that are linked to the Invoice Template

DeliveryMethod

PropertyTypeDescription
IdIntDeliveryId
DescriptionStringDescription

PaymentMethod

PropertyTypeDescription
IdIntPayment Id
NameStringName

Parameters

PropertyTypeDescription
InvoiceIdInt
TemplateIdGUID

syncParams

PropertyTypeDescription
ChangedAfterDateTime
RegisteredAfterDateTime

OrderSlipStateType

ValueDescription
None
Offer
Pack
Invoiced
Web
Repeating
CollectionOrder
Return
Distribution
Rest
ForInvoicing
OvertimeRent
Confirmed
OrderState_Sent
Production
PaymentReminderNot in use
OnAccount
Lending
InvoiceCashAccount
InvoicedPack
Inactive
Hours
OrderState_SuperStoreNot in use
Draft

ChangeState

NameValueDescription
NoneDefault
Add
Edit
Delete

RowType

NameValue
Normal
Text
TextBold

Back to InvoiceService

Last Updated: 1/7/26, 11:20 AM
Prev
FileService Datatypes
Next
PaymentService Datatypes