The identity and technical contract details declared by the specification.
subaccountInSalesOrderLineDto
object
Subaccount A subcategory of the account that carries identifying information.
3 properties
SalesOrderShipmentDto
object
10 properties
ArAdjustDto
object
16 properties
AttachmentDto
object
3 properties
SalesOrderLineDto
object
45 properties
customerInShipmentDto
object
The top part Customer The customer to whom the goods specified in the document should be shipped. (This field does not appear for transfers.)
3 properties
shipViaInShipmentDto
object
Delivery settings tab Shipping information section Ship via The carrier used for shipping the goods.
2 properties
paymentMethodInSalesOrderDto
object
Payment settings tab Payment method
2 properties
InventoryNumberDescriptionDto
object
2 properties
locationInShipmentDetailLineDto
object
Document details tab Location The location in the warehouse from which the item is shipped.
3 properties
DtoValueOfString
object
1 property
invoiceAddressInCustomerInvoiceDto
object
The Invoice address tab The Invoice address section.
9 properties
TaxDetailDto
object
This class represents a VAT Detail Line. Used for getting data.
7 properties
salesPersonInCustomerInvoiceDto
object
The document details tab Salesperson ID The salesperson involved.
2 properties
modeOfTrasportInShipmentDto
object
Delivery settings tab Intrastat section Mode of transportation The method of transportation.
2 properties
countyInShipmentAddressDto
object
County The county or province.
2 properties
shippingTermsInShipmentDto
object
Delivery settings tab Shipping information section Shipping terms The shipping terms used in relations with the customer.
2 properties
ShipmentDetailLineDto
object
30 properties
AllocationsDto
object
This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data.
8 properties
shippingZoneInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping zone
2 properties
CreatePurchaseOrderActionDto
object
2 properties
1 required
projectInCustomerInvoiceDto
object
The top part Project The identifier and description of the project with which this document is associated, or the code indicating that this document is not ass…
3 properties
SalesOrderDto
object
This class represents a SOOrder in SOOrderController. Used by getting data.
75 properties
soBillingAddressInSalesOrderDto
object
Financial settings tab Invoice address section
9 properties
customerVATZoneInSalesOrderDto
object
Financial settings tab Financial information section Customer VAT zone The customers VAT zone to be used to process customer sales orders, which generally is t…
6 properties
DtoValueOfNullableOfInt32
object
1 property
accountInCustomerInvoiceLineDto
object
Mandatory field: Account The sales account used for the transaction.
6 properties
PrepareInvoiceActionResultDto
object
5 properties
countryInSalesOrderAddressDto
object
Country The country.
4 properties
salesPersonInSalesOrderLineDto
object
Salesperson ID The salesperson associated with the sale of the line item.
2 properties
transactionTypeInSalesOrderDto
object
Delivery settings tab Intrastat section Transaction type
2 properties
salesPersonInSalesOrderDto
object
The Commissions tab Salesperson ID The salesperson.
2 properties
WarehouseIdDescriptionDto
object
2 properties
termsInSalesOrderDto
object
Mandatory field: Financial settings tab Financial information section Terms The credit terms used in relations with the customer. See also window CS206500.
2 properties
locationInSalesOrderDto
object
Mandatory field: The top part Location The customer location from which the goods or services have been ordered or, if the sales order is created from an oppor…
3 properties
SalesOrderContactUpdateDto
object
8 properties
ownerInSalesOrderDto
object
The Financial settings tab Financial information section Owner The user in the work group who is responsible for the sales order.
3 properties
soBillingContactInSalesOrderDto
object
The Financial settings tab The Invoice address section or on the Delivery address section
9 properties
saleOrderUpdateDtoInReopenSalesOrderActionDto
object
Mandatory
55 properties
ShipmentOrderLineDto
object
10 properties
RotRutDistributionUpdateDto
object
5 properties
locationInShipmentDto
object
Mandatory field: The top part Location The customer location to receive the shipment.
3 properties
ownerInShipmentDto
object
The top part Owner The user assigned to approve the document.
2 properties
subaccountInCustomerInvoiceLineDto
object
Mandatory field: Subaccount The corresponding subaccount used for this transaction.
9 properties
invoiceContactInCustomerInvoiceDto
object
The Invoice address tab The Invoice contact section.
6 properties
shippingZoneInShipmentDto
object
Delivery settings tab Shipping information section Shipping zone ID The shipping zone of the customer.
2 properties
DtoValueOfNullableOfInt16
object
1 property
DtoValueOfNullableOfInventoryReplenishmentSources
object
1 property
branchNumberInCustomerInvoiceDto
object
The Financial details tab Branch The branch with which this invoice or memo is associated. The field is available if your company is set up with branches.
2 properties
DtoValueOfNullableOfDateTime
object
1 property
soShippingContactInSalesOrderDto
object
Delivery settings tab Delivery address contact section
9 properties
DtoValueOfSalesOrderAddressUpdateDto
object
1 property
TaxCategoryNumberDescriptionDto
object
2 properties
WorkTypeDto
object
3 properties
CreateShipmentActionResultDto
object
5 properties
countryInCustomerDocumentAddressDto
object
Country The country.
4 properties
countryInShipmentAddressDto
object
Country The country.
4 properties
ReopenSalesOrderActionDto
object
1 property
1 required
BranchNumberDto
object
2 properties
vatRegistrationIdInSalesOrderUpdateDto
object
Mandatory field if Customer or GLN is not specified.
1 property
deliveryContactInShipmentDto
object
Delivery settings tab Delivery address contact section
9 properties
CustomerInvoiceDto
object
This class represents an invoice in InvoiceController. Used by getting data.
77 properties
customerInCustomerInvoiceDto
object
The top part Customer The customer associated with the document.
2 properties
DtoValueOfNullableOfRutRotTypes
object
1 property
SalesOrderUpdateDto
object
This class represent a Sales Order in Sales Order Controller. Used to pass data to server for creating or updating an order
55 properties
1 required
fobPointInSalesOrderDto
object
Delivery settings tab Shipping information section FOB point The point where ownership of the goods is transferred to the customer.
2 properties
DirectDebitMandateDto
object
This class represents a Customer Mandate
3 properties
SegmentUpdateDto
object
2 properties
SalesOrderLineUpdateDto
object
This class represent a Sales Order Line in Sales Order Controller. Used to pass data to server for creating or updating an order line
39 properties
1 required
SalesOrderAddressUpdateDto
object
8 properties
DtoValueOfNullableOfDecimal
object
1 property
shipViaInSalesOrderDto
object
The Delivery settings tab Shipping information section Ship via The Ship via code that represents the carrier and its service to be used for shipping the order…
2 properties
CustomerInvoiceLineDto
object
41 properties
CreateShipmentActionDto
object
5 properties
3 required
glnInSalesOrderUpdateDto
object
Mandatory field if Customer or VatRegistrationId is not specified.
1 property
warehouseInShipmentDetailLineDto
object
Mandatory field: Document details tab Warehouse The warehouse from which the items is shipped.
2 properties
ProjectTaskIdDescriptionDto
object
3 properties
SegmentDto
object
4 properties
contactInCustomerInvoiceDto
object
The top part Contact The contact associated with the customer.
2 properties
DtoValueOfNullableOfBoolean
object
1 property
ChildRecordDto
object
2 properties
toWarehouseInShipmentDto
object
The top part To warehouse The warehouse to which the goods should be shipped in case of a transfer.
2 properties
debtCollectionInCustomerInvoiceDto
object
Debt Collection information
4 properties
countyInCustomerDocumentAddressDto
object
County The county or province.
2 properties
inventoryNumberInSalesOrderLineUpdateDto
object
Mandatory field
1 property
MetadataDto
object
2 properties
SendEmailActionResultDto
object
3 properties
DtoValueOfSalesOrderContactUpdateDto
object
1 property
vatCodeInCustomerInvoiceLineDto
object
VAT category The VAT category (if applied) for the transaction. The category represents the type of goods or services.
2 properties
customerVatZoneInCustomerInvoiceDto
object
The Financial details tab The VAT info section Dunning letter date
2 properties
DtoValueOfNullableOfGuid
object
1 property
DtoValueOfNullableOfSalesOrderOperations
object
1 property
branchNumberInSalesOrderDto
object
Mandatory field: Document details tab Branch The branch of the company.
2 properties
DtoValueOfBoolean
object
1 property
subaccountInCustomerInvoiceDto
object
The Document details tab Subaccount The corresponding subaccount used for this transaction.
9 properties
vatIdInTaxDetailDto
object
VAT ID The ID of the specific VAT applied.
2 properties
customerInSalesOrderUpdateDto
object
Mandatory field if GLN or VatRegistrationId is not specified.
1 property
ReopenSalesOrderActionResultDto
object
3 properties
DtoValueOfNullableOfSalesOrderShipCompleteStatuses
object
1 property
creditTermsInCustomerInvoiceDto
object
Mandatory field: The top part Terms The credit terms used in relations with the customer.
2 properties
fobPointInShipmentDto
object
Delivery settings tab Shipping information section FOB point The point where obligation of goods passes to the customer.
2 properties
countyInSalesOrderAddressDto
object
County The county or province.
2 properties
customerInSalesOrderDto
object
The top part Customer The customer that has ordered the goods or services.
3 properties
sellerInCustomerInvoiceLineDto
object
Salesperson ID The identifier of the salesperson involved.
2 properties
accountInCustomerInvoiceDto
object
The Document details tab Account The sales account used for the transaction.
6 properties
inventoryIdInSalesOrderLineUpdateDto
object
InventoryId is deprecated, please use InventoryNumber instead.
1 property
ShipmentDto
object
This class represents a Shipment in ShipmentController. Used by getting data.
52 properties
PackageDetailLineDto
object
14 properties
BackgroundApiAcceptedDto
object
2 properties
transactionTypeInShipmentDto
object
Delivery settings tab Intrastat section Transaction type The 1-digit code that describes the nature of the transaction (according to EU regulations for Intrast…
2 properties
paymentMethodInCustomerInvoiceDto
object
The Financial details tab The Payment information section Payment method The identifier for the payment method that the customer will use to pay the document.
2 properties
preferredWarehouseInSalesOrderDto
object
The Delivery settings tab The shipping information section Preferred warehouse ID
2 properties
RotRutUpdateDto
object
6 properties
shippingTermsInSalesOrderDto
object
Delivery settings tab Shipping information section Shipping terms
2 properties
soShippingAddressInSalesOrderDto
object
Delivery settings tab Delivery address section
9 properties
orderTypeInSalesOrderUpdateDto
object
Mandatory field
1 property
fromWarehouseInShipmentDto
object
Mandatory field: The top part Warehouse ID The warehouse from which the goods should be shipped.
2 properties
CancelSalesOrderActionDto
object
1 property
1 required
locationInAllocationsDto
object
Location The location in the warehouse.
3 properties
locationInCustomerInvoiceDto
object
The top part Location The location of the customer related to the document. By default, it is the default location of the selected customer or, if the invoice…
3 properties
branchNumberInCustomerInvoiceLineDto
object
Mandatory field: Branch The branch that sells the line item or provides the service.
2 properties
CancelSalesOrderActionResultDto
object
3 properties
deliveryAddressInShipmentDto
object
Delivery settings tab Delivery address section
9 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Visma publishes across the network.