The CrossAd WebService API offers a way to create and update entities such as orders, customers, contacts etc.
Please refer to Files and Libraries for general documents such as Developers Guide, Release notes etc.
It is strongly recommended to use SoapUI, Swagger or Postman for exploring and testing the
services.
Also, when reporting issues with CAI, please reproduce the issue and send the request/response attached to the report.
This documentation is mainly automatically generated using the tool Enunciate.
The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.
| name | path | methods | description |
|---|---|---|---|
| AdapterService |
|
|
Integration service for adapter based data |
| BaseService |
|
|
|
| CustomerService |
|
|
|
| DataWarehouseService |
|
|
|
| MCOrderService |
|
|
|
| PrintOrderService |
|
|
|
| RestNMIService |
|
|
Integration service for NMI-Tables |
| type | description |
|---|---|
| AbstractOrderPrice | Represents a summary of the total order value (gross and net) and partial sums for
applied discounts (incl. customer deal), commissions and VAT.
Used as base class for total order value and shared value between order customers |
| AdapterMailDTO | |
| AdapterMapNodeDTO | |
| Address | |
| AddressAMD | Models the intention to update an extra customer-address. Most fields/elements in this object
are optional and when left out, the corresponding property will be left
unchanged. If a value is provided, the corresponding property will be updated
to that specified value.
In some cases, when the property is "nillable", i.e. /NillableString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset the value
of a property (effectively setting the associated database field value to null) by
setting the nil attribute to true and not providing any value.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - N/A. If action is "Delete", only key-field(s) are mandatory. Key(s) = cuadrAdrid |
| AdserverAdapter | |
| AdserverAdspace | Class representing inventory for a unit. |
| AdserverAdspaceVariant | Class representing inventory for a unit. |
| AdserverInterval | |
| AdserverInventory | Class representing inventory for a unit. |
| AdserverInventoryDetail | Class representing inventory for a unit during the specified time(from startDate to endDate). |
| AdserverInventoryRequest | |
| AdserverInventoryResponse | |
| AdserverKeyValue | |
| AdserverMapEntity | Class respresenting a map-able entity. Could contain anything, both in crossad and in any adserver. Should be stored with the key in db. |
| AdserverMappable | Class respresenting a mappable entity. Key is the unique, together with the sourceSystem, name of this entity that should be stored in db. It contains mapEntities A typical use is for addon:s that should be mapped. An addon is of some type(single-select, multiselect, tree etc). |
| AdserverMappablesResponse | |
| AdserverPriority | |
| AdserverProduct | Class representing inventory for a unit. |
| AdserverProductsResponse | |
| AdserverSection | Class representing inventory for a unit. |
| Adspace | |
| AgreementInfo | |
| ArkInvdet | |
| ArkInvhead | |
| Bransch | |
| BudgetCu | |
| BudgetCuAMD | Models the intention to update a customer-budget. Most fields/elements in this object
are optional and when left out, the corresponding property will be left
unchanged. If a value is provided, the corresponding property will be updated
to that specified value.
In some cases, when the property is "nillable", i.e. /NillableString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset the value
of a property (effectively setting the associated database field value to null) by
setting the nil attribute to true and not providing any value.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = bcPeriod and bcLpcode |
| BudgetInc | |
| BudgetIncAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = buiYear |
| BusinessModel | |
| BusinessUnit | |
| CaiFault | All SOAP-based WebService operations in the WS API may generate a SOAP 1.2 fault. The Detail element will contain a caiFault element with detailed, application specific information. |
| CalendarDayDTO | |
| CalendarMessageDTO | |
| CalendarMonthDTO | |
| CalendarWeekDTO | |
| CampaignDTO | |
| CassLog | |
| CassPaymentForm | |
| CassPaymentFormFields | |
| CassPaymentFormParam | |
| CassThirdPartyTokenRequest | |
| CassThirdPartyTokenResponse | |
| CassVerify | |
| Category | |
| ChargesCriteria | |
| ChatMessage | |
| CodeName_DTO | |
| Contact | |
| ContactAMD | Note! There is no unique id for one contact re-used among customers. So some redundancy exist.
Models the intention to update a customer-contact. Most fields/elements in this object
are optional and when left out, the corresponding property will be left
unchanged. If a value is provided, the corresponding property will be updated
to that specified value.
In some cases, when the property is "nillable", i.e. /NillableString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset the value
of a property (effectively setting the associated database field value to null) by
setting the nil attribute to true and not providing any value.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cucoContid |
| CountryCode | |
| CreditReportingBureau | |
| CreditReportingBureauRiskAssessment | |
| CustActivity | Activity record Key(s) = saplActid |
| CustActivityAsset | |
| CustExtSystem | |
| CustdealH | |
| CustdealHAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values
are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cdhDealno, cdhHistlevel, cdhLpcode |
| CustdealU | |
| CustdealUAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values
are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cduDealId, cduDatemin, cduIntervalmin |
| Custextsysno | |
| CustextsysnoAMD |
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cesnCuescode |
| CustomField | |
| CustomListItem | |
| Customer | The complete representation of a customer. |
| CustomerAddressInfo | |
| CustomerAgency | |
| CustomerAgencyAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cuagAgencyno and cuagCategory |
| CustomerBrand | Brand (Swedish: varumärke), e.g. "Pepsodent", "GB Glace" etc |
| CustomerBrandAMD | Models the intention to update a customer-brand. Most fields/elements in this object
are optional and when left out, the corresponding property will be left
unchanged. If a value is provided, the corresponding property will be updated
to that specified value.
In some cases, when the property is "nillable", i.e. /NillableString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset the value
of a property (effectively setting the associated database field value to null) by
setting the nil attribute to true and not providing any value.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - N/A. If action is "Delete", only key-field(s) are mandatory. Key(s) = cubdId |
| CustomerBransch | |
| CustomerBranschAMD |
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - N/A D - Delete If action is "Delete", only key-field(s) are mandatory. Key(s) = cubrBransch Note that AMD_TYPE MODIFY has no effect, this is because all properties are part of the key. |
| CustomerCategory | |
| CustomerCreate | Represents the intention to create a new complete customer. |
| CustomerEan | |
| CustomerEanAMD | The CustomerEanUpdate data object represents the intention to update an EAN code
associated with the customer.
Most fields/elements in this object are optional and when left out, the corresponding property will be left unchanged. If a value is provided, the corresponding property will be updated to that specified value.
In some cases, when the property is "nillable", i.e. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cueanId + cueanReferens |
| CustomerEdi | |
| CustomerEdiAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cuediEdicode |
| CustomerINetAddress | |
| CustomerINetAddressAMD | This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - N/A Either you got the id or you dont. If action is "Delete", only key-field(s) are mandatory. Key(s) = naAddrdetno |
| CustomerInfo | |
| CustomerInfoResponse | |
| CustomerOutputFilter | |
| CustomerPrice | Summary of customer price-calculation, Reflects the customer price in WE. |
| CustomerPriceDetails | Detailed information about a customer price-calculation. |
| CustomerProdFlow | |
| CustomerProdFlowAMD | The CustomerProdFlowUpdate data object represents the intention to update a production
flow associated with the customer.
Most fields/elements in this object are optional and when left out, the corresponding property will be left unchanged. If a value is provided, the corresponding property will be updated to that specified value. In some cases, when the property is "nillable", i.e.(NillabString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset
the value of a property (effectively setting the associated database field value to
null) by setting the nil attribute to true and not providing any value.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = cupfPrflowcode |
| CustomerProfile | |
| CustomerRiskClass | |
| CustomerSearchInput | |
| CustomerSearchResultItem | Simple customer object. Returned by searchmethods as "findCustomersByAttributes" |
| CustomerType | |
| CustomerUpdate | Models the intention to update a customer. Most fields/elements in this object are
optional and when left out, the corresponding customer property will be left unchanged.
If a value is provided, the corresponding customer property will be updated to that
specified value.
In some cases, when the property is "nillable", i.e. /
NillableString, NillableDate,
NillableShort, NillableLong or NillableDecimal) it is possible to clear/reset
the value of a property (effectively setting the associated database field value to
null) by setting the nil attribute to true and not providing any value.
|
| Customerperlp | In a crossAd setup there is normally several legalPersons configured. Representing different papers etc. The LegalPersonMappings makes it possible to configure customer related things like responsible salesman and more per legalPerson. |
| CustomerperlpUpdate | In a crossAd setup there is normally several legalPersons configured. Representing different papers etc. The LegalPersonMappings makes it possible to configure customer related things like responsible salesman and more per legalPerson. |
| DBVersion | |
| Deadlines | |
| DiscountDetail | Discount mapping in an order
Key = Discount |
| DiscountDetailAMD | Discount mapping in an order
Key = Discount |
| DiscountType | |
| ExternalJobAsset | |
| ExternalMaterialUpdate | |
| ExternalOrder | The complete representation of an External order, should be considered read-only. |
| ExternalOrderItem | |
| ExternalOrderSamling | |
| ExternalPage | |
| ExternalUser | |
| InData | Encapsulates ad-data for inEntry. Model from InData.sef V72 |
| InDataWrapper | Wrapper for inData |
| IntCustaddress | |
| IntCustagency | |
| IntCustbrand | |
| IntCustcont | |
| IntCustomer | |
| IntCustsynonym | |
| IntInvbilag | |
| IntInvdet | |
| IntInvhead | |
| IntNavision | |
| IssueDateDetail | IssueDate mapping in an order
Key = odIssueDate |
| IssueDateDetailAMD | IssueDate mapping in an order
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = odIssueDate |
| IssueLimit | |
| IssueLimitAMD | Issue Limit mapping representation in an OFFER order.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = orPacode and orPricelist |
| JobAMD | Represents the intention to create/update a order job
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values
are:A - Add M - Modify D - Delete If action is "Delete", only key-field, delCorrectionCode and delComment are mandatory. Key(s) = mcjId |
| JobOrderChargeAMD | |
| JobOrderDetAMD | |
| LastOrdersInput | Input filter for fetching last orders |
| LegalPerson | |
| LevelDiscountDetail | Level-discount detail with both the defined discount (% or amount) and the calculated counterpart, in addition to the corr.code, level, sort order, type and component (space/color). |
| LineitemOrderlineProperties | Represents the editable properties of an Orderline with type LINETEM |
| LineitemProduct | |
| LogLevel | |
| LogMessage | |
| LogMessage | |
| MCAdspaceSize | Adspace variant-size for online orderlines (F_BANNERSIZE) |
| MCAdvertiser | The representation of an advertiser, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCAdvertiserAMD | Represents the intention to create a new multichannel advertiser
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete If action is "Delete", only key-field(s) are mandatory. Key(s) = custno |
| MCAdvertiserProfile | Stores profile data per legal person for a customer of the order. |
| MCAdvertiserProfileUpdate | The profiles are generated by the system, and cannot be manually added or removed. Values can be updated |
| MCJob | The representation of a job, should be considered read-only. In order to create or update a job there are other representations in the ws-api to use. |
| MCJobAMD | Represents the intention to create/update a order job
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values
are:A - Add M - Modify D - Delete If action is "Delete", only key-field, delCorrectionCode and delComment are mandatory. Key(s) = mcjId |
| MCJobAdMaterial | |
| MCJobComment | The representation of a Job comment, should be considered read-only. In order to create or update connections there are other representations in the ws-api to use. |
| MCJobOrderLine | The representation of a connection between an Orderline and a Job, should be considered read-only. In order to create or update connections there are other representations in the ws-api to use. |
| MCJobOrderLineAMD | Represents the intention to create/update job/orderline connection
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete If action is "Delete", only key-field(s) are mandatory. Key(s) = mcjolId |
| MCLastOrdersInput | Input filter for fetching last orders |
| MCLineItem | |
| MCLineItemPricelist | The complete representation of a LineItemProduct, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCLineItemProduct | The complete representation of a LineItemProduct, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCLineitemOrderline | Lineitem orderline, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCOnlineOrderLineAddon | Addon for online orderlines |
| MCOnlineOrderLineAddonAMD | Addon for online orderlines |
| MCOnlineOrderLineAddonValue | Addon for online orderlines |
| MCOnlineOrderLineAdspace | Adspace (variant) for online orderlines |
| MCOnlineOrderLineAdspaceAMD | Adspace (variant) for online orderlines
This is a AMD-object, i.e. This object is used for ADD or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values
are:A - Add M - NOTE! Not allowed, you can only add and remove adspaces.. D - Delete If action is "Delete", only key-field, delCorrectionCode and delComment are mandatory. Key(s) = advId |
| MCOnlineOrderLineProduct | Product for online orderlines |
| MCOnlineOrderLineProductAMD | Product for online orderlines |
| MCOnlineOrderLineSection | Section for online orderlines |
| MCOnlineOrderLineSectionAMD | Section for online orderline |
| MCOnlineOrderline | Online orderline, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCOrder | The complete representation of an order, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| MCOrderCreate | The complete representation of a multichannel-order creation.. |
| MCOrderDiscount | Discount |
| MCOrderExclusion | |
| MCOrderExclusionDetail | |
| MCOrderGroupedVolumes | |
| MCOrderGroupedVolumesDetail | |
| MCOrderMaterialLineUpdate | |
| MCOrderSummary | Object that holds summary of an order |
| MCOrderUpdate | The complete representation of a multichannel-order for update. |
| MCOrderlineAMD | Represents the intention to create a new multichannel Orderline
An orderline can be one of these types: ONLINE or LINEITEM, this is determined by the type-property.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete If action is "Delete", only key-field are mandatory. Note!Depending on system settings delCorrectionCode and delComment may also be mandatory when deleting an orderline. Key(s) = index |
| MCOrderlineDateInfo | Orderline date |
| MCOrderlineDateInfoAMD | Represents the intention to create a new dateInfo object connected to lineitem
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete If action is "Delete", only key-field are mandatory. Key(s) = date |
| MCPrice | Abstract superclass of price. |
| MCPriceDetail | PriceDetail |
| MCPriceOrderSummary | OrderSummary multi-channel order price. |
| MCPriceSummary | Summary multi-channel order price. |
| MappableResponse | |
| MappedAddon | |
| MappedCategory | |
| MappedCrossadAddonResponse | |
| MappedCrossadAdspacesResponse | |
| MappedCrossadNode | |
| MappedDTO | |
| MaterialStatus | |
| McOrderMaterialResponse | |
| MetaData | Contains information how the CrossAd Integration Webservice is configured... READ-ONLY data |
| MinMaxOfLong | |
| MinMaxOfString | |
| NetSaleRow | Representation of a netSaleRow. |
| Network | |
| NillableDate | A NillableDate is used for differentiating between three states of an
entity field representing a specific instant in time, defined in
ISO8601 format using UTC as the reference time zone, when creating or updating data:
NOTE: It is not allowed for a nillable to be both NIL and have a non-null value, or to have a null value and be defined as not NIL. Create Examples: <!-- Use the default date --> <!-- <date /> --> <!-- Explicitly set date to an undefined (null) value --> <date nil="true" /> <!-- Use a specific date value --> <date>2012-11-29T00:00:00+01:00</date>Update Examples: <!-- Do not update the date --> <-- <date /> --> <!-- Explicitly reset date to an undefined (null) value --> <date nil="true" /> <!-- Update the date to a new value --> <date>2013-01-06T00:00:00+01:00</date> |
| NillableDecimal | A NillableDecimal is used for differentiating between three states of an
entity field representing a signed decimal value when creating or
updating data:
NOTE: It is not allowed for a nillable to be both NIL and have a non-null value, or to have a null value and be defined as not NIL. Create Examples: <!-- Use the default integer value --> <!-- <decimal /> --> <!-- Explicitly set integer to an undefined (null) value --> <decimal nil="true" /> <!-- Use a specific integer value --> <decimal>12345.67</decimal>Update Examples: <!-- Do not update the integer --> <-- <decimal /> --> <!-- Explicitly reset integer to an undefined (null) value --> <decimal nil="true" /> <!-- Update the integer to a new value --> <decimal>123.456</decimal> |
| NillableLong | A NillableLong is used for differentiating between three states of an
entity field representing a 64bit signed integer when creating or
updating data:
NOTE: It is not allowed for a nillable to be both NIL and have a non-null value, or to have a null value and be defined as not NIL. Create Examples: <!-- Use the default integer value --> <!-- <long /> --> <!-- Explicitly set integer to an undefined (null) value --> <long nil="true" /> <!-- Use a specific integer value --> <long>1234567890</long>Update Examples: <!-- Do not update the integer --> <-- <long /> --> <!-- Explicitly reset integer to an undefined (null) value --> <long nil="true" /> <!-- Update the integer to a new value --> <long>1337</long> |
| NillableOfDouble | |
| NillableOfString | |
| NillableShort | A NillableShort is used for differentiating between three states of an
entity field representing a 16bit signed integer when creating or
updating data:
NOTE: It is not allowed for a nillable to be both NIL and have a non-null value, or to have a null value and be defined as not NIL. Create Examples: <!-- Use the default integer value --> <!-- <short /> --> <!-- Explicitly set integer to an undefined (null) value --> <short nil="true" /> <!-- Use a specific integer value --> <short>8080</short>Update Examples: <!-- Do not update the integer --> <-- <short /> --> <!-- Explicitly reset integer to an undefined (null) value --> <short nil="true" /> <!-- Update the integer to a new value --> <short>-1</short> |
| NillableString | A NillableStrong is used for differentiating between three states of an entity
field representing a string of characters when creating or updating
data:
NOTE: It is not allowed for a nillable to be both NIL and have a non-null value, or to have a null value and be defined as not NIL. Create Examples: <!-- Use the default string value --> <!-- <string /> --> <!-- Explicitly set string to an undefined (null) value --> <string nil="true" /> <!-- Use a specific string value --> <string>Novice</string>Update Examples: <!-- Do not update the string --> <-- <string /> --> <!-- Explicitly reset string to an undefined (null) value --> <string nil="true" /> <!-- Update the string to a new value --> <string>Expert</string> |
| OnlineAgreementDetail | |
| OnlineAgreementInfo | |
| OnlineOrderlineProperties | Represents the editable properties of an Orderline with type ONLINE |
| OnlineRow | Representation of a row in table F_WHOUSEONLINE. |
| Operator | |
| Options | |
| Order | The complete representation of an order, should be considered read-only. In order to create or update an order there are other representations in the ws-api to use. |
| OrderAMD | |
| OrderCreate | Represents the intention to create a new complete order, including order details such as placements and services. |
| OrderDTO | |
| OrderDetailMaterialProdstatusUpdate | Represents the intention to update the production status for order detail records where they share a common Material reference. This is only valid if the order has been split on multiple issues and/or editions/zones. |
| OrderDetailProdstatusUpdate | Represents the intention to update the production status for a given product detail. This is only valid if the order has been split on multiple issues and/or editions/zones. |
| OrderDetailProductionUpdate | Represents the intention to update the production status for a given product detail. This is only valid if the order has been split on multiple issues and/or editions/zones. TODO: Should it be possible to identify a detail by its material number rather than the date/prodcode/edition/zone? |
| OrderKund | The orderKund representation.
It contains the customer related mappings of the order. In order to create or update an orderKund there are other representations in the ws-api to use. |
| OrderKundAMD | Represents the intention to create a new orderKund representation.
It contains the customer related mappings of the order. This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = okCustno |
| OrderKundPerLp | The orderKundPerLp representation.
It contains the LegelPerson related customer commission for an orderKund |
| OrderKundPerLpAMD | Represents the intention to create a new orderKundPerLp representation.
It contains the customer commission related mappings of the order. This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions.Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = okCustno |
| OrderMaterialDetailInfo | |
| OrderMaterialInfo | |
| OrderPrice | Partial amounts for row-level gross, discounts, net and also late order discounts. individually presented for issue volume, issue color and services/insertions. |
| OrderPriceMainSummary | Main order summary, reflecting the order summary in MBooker main order window. |
| OrderPriceSecondarySummary | Secondary order summary, reflecting the order summary in MBooker price window. |
| OrderPriceShareStatus | Information about the validity of customer sharing of an order. |
| OrderPriceSummaryDetails | Partial amounts for row-level gross, discounts, net and also late order discounts. individually presented for issue volume, issue color and services/insertions. |
| OrderProdflow | |
| OrderProductionUpdate | Represents the intention to update one or many production-related properties of an order. This maps more or less to what a user can accomplish in MProd. |
| OrderSalesmenShare | The OrderSalesmen representation.
It contains the Salesmen related mappings of the order. In order to create or update an Salesmen share amount for order. |
| OrderSalesmenShareAMD | The OrderSalesmen representation.
It contains the Salesmen related mappings of the order. In order to create or update an Salesmen share amount for order. |
| OrderSamling | |
| OrderServiceUpdate | |
| OrderStats | Order statistics |
| OrderSummary | Object that holds summary of an order |
| OrderUpdate | Encapsulates data about a print order that is to be updated. |
| OrderlineStats | Order statistics |
| PackageDetail | Package mapping representation in an order.
Keys = orPacode and orPricelist |
| PackageDetailAMD | Package mapping representation in an order.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = orPacode and orPricelist |
| Packet | |
| Pagination | |
| ParInfo | PostensAdressRegister PAR (F_ParInfo) |
| ParInfoSearchResult | |
| PaymentDetailAMD | |
| PaymentDetailDTO | |
| Peneplan | |
| PeneplanAMD | |
| Placement | |
| PlacementDetail | Placement mappings in an order
Key = orPlcode |
| PlacementDetailAMD | Placement mappings in an order
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = orPlcode |
| PopHeading | |
| PrintCharges | |
| PrintColPriceDTO | |
| PrintEditionDTO | |
| PrintFixedSize | |
| PrintGeometryLimits | |
| PrintListPricePlacement | |
| PrintListPriceProduct | |
| PrintListPriceResponse | |
| PrintOrderDetailStatus | |
| PrintOrderStatus | |
| PrintPacketDTO | |
| PrintPacketPricelistDTO | |
| PrintPlacementDTO | |
| PrintPriceCurveDTO | |
| PrintPriceDTO | |
| PrintPricelistDTO | |
| PrintProductDTO | |
| PrintServPriceDTO | |
| PrintZoneDTO | |
| ProdFlow | |
| ProdStatus | |
| Product | |
| Product | |
| ProductionCodeAMD | Production codes can be added to the order to be used to know what should be done in
production. But it can also be used for other purpose.
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = opPrflowcode |
| ProductionCodeDetail | Production codes can be added to the order to be used to know what should be done in production. But it can also be used for other purpose. |
| ProgramLanguage | |
| ProofContact | Proof contact |
| Property | |
| SalesAmount | Object that holds summary for the amounts in F_Order_Kund |
| SalesAmountInput | Input for filtering record in F_Order_Kund that should be summarized. |
| Salesgroup | |
| Salesman | |
| SearchCustomerParInfoInput | |
| SearchModifiedActivitiesInput | Input for searching customer activities that have been modified between dates. |
| SearchModifiedCustomersInput | Input for searching customers that have been modified between dates. |
| SearchModifiedCustomersResultItem | Simple customer object. Returned by search-methods as "searchCustomersModifiedBetween"
Logic for detecting customer creation and deletion.
Create: - cuhWhat = "CU_CUSTNO" - cuhCustno = New customer no. - cuhOldvalue= Null - cuhNewvalue= New customer no. Delete: - cuhWhat = "CU_CUSTNO" - cuhCustno = Null - cuhOldvalue= Deleted customer no. - cuhNewvalue= Null |
| SearchModifiedMCOrdersInput | |
| SearchModifiedMCOrdersResultItem | |
| SearchModifiedOrdersInput | Input for searching orders that have been modified between dates. |
| SearchModifiedOrdersResultItem | Simple order object. Returned by search-methods as "searchOrdersModifiedBetween" |
| Section | |
| Service | |
| ServiceDetail | |
| ServiceDetailAMD | Services can be added to the order and can be e.g. insertions or some extra that you
charge the customer for. Service can be on the same order as the print order or it can
be a "service order".
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add M - Modify D - Delete AM - Add if non existing, else Modify. If action is "Delete", only key-field(s) are mandatory. Key(s) = ocServcode and ocOcdate |
| Stamp | The representation of an event, should be considered read-only. |
| Status | |
| StopCode | |
| SubscriptionOrder | |
| SubscriptionOrderCreate | Subscription order creation |
| SubscriptionOrderLineitemProductAMD | |
| SubscriptionOrderOnlineProductAMD | |
| SubscriptionOrderPrintFixedSizeAMD | |
| SubscriptionOrderUpdate | Subscription order update |
| SummaryDTO | |
| Synonym | |
| SynonymAMD |
This is a AMD-object, i.e. This object is used for ADD, MODIFY or DELETE actions. Type of action is determined by the AMD_TYPE attribute. Possible values are:A - Add D - Delete . If action is "Delete", only key-field(s) are mandatory. Key(s) = cusSynonym Note that AMD_TYPE MODIFY has no effect, this is because all properties are part of the key. |
| UtData | Encapsulates ad-data from inEntry. Model from UtData.sef V72 |