DDAPI Help page

Account

Controller for account

API	Description
GET api/Account	Gets all accounts

AccountingEntryTemplate

API	Description
GET api/AccountingEntryTemplate	Gets all AccountingEntryTemplates.

Agreements

API	Description
DELETE api/Agreements/{agreementNumber}	Deletes an agreement.
DELETE api/agreements/articlegroupline/{id}	Deletes an article groupline on agreement.
DELETE api/agreements/articleline/{articleNumber}/{agreementNumber}	Deletes an article line on agreement.
DELETE api/agreements/customer/{agreementNumber}/{customerNumber}	Deletes an customer on agreement.
GET api/Agreements	Gets all agreements not including agreement lines. To get detailed information about an agreement, including agreement lines, call GET - api\Agreements\1
GET api/Agreements/{agreementNumber}	Gets an agreement with specified number, including agreement lines.
GET api/Agreements/{date}	Gets all agreements changed after [date], not including agreement lines. To get detailed information about an agreement, including agreement lines, call GET - api\Agreements\1
GET api/agreements/customer?agreementNumber={agreementNumber}	Get all customers on an agreement.
GET api/agreements/zones	Gets all zones.
POST api/Agreements	Add an agreement.
POST api/agreements/articlegroupline	Add an article group line to agreement.
POST api/agreements/articleline	Add an article line to agreement.
POST api/agreements/customer	Add an customer to agreement.
PUT api/Agreements	Updates an agreement.
PUT api/agreements/articlegroupline	Updates an article group line on agreement.
PUT api/agreements/articleline	Updates an article line on agreement.
PUT api/agreements/customer	Update customer on agreement.

ArticleCustomFields

Handle all requests regarding article custom fields.

API	Description
DELETE api/ArticleCustomFields/{articleId}	Removes all the values on custom article fields that has specified article id.
DELETE api/ArticleCustomFields/{templateId}	Removes all the values on custom article fields that has specified template id.
DELETE api/ArticleCustomFields/{templateId}/{articleId}	Removes the value on a custom article field
GET api/ArticleCustomFields/{articleId}	Gets all custom fields for specified article.
GET api/ArticleCustomFields/{templateId}	Gets all custom fields for specified template.
GET api/ArticleCustomFields/{templateId}/{articleId}	Gets article custom field for specified article and template.
GET api/ArticleCustomFields/Templates	Gets all custom field templates for the article module.
GET api/ArticleCustomFields/Templates/{templateId}	Gets a specific article custom field template based on template id.
POST api/ArticleCustomFields	Creates a new article custom field.
PUT api/ArticleCustomFields	Updates an existing article custom field.

ArticlePackage

Controller for article packages

API	Description
GET api/ArticlePackage	Get all article packages paged.
GET api/ArticlePackage/{id}	Gets a specific article package

Articles

API	Description
GET api/Articles/{articleNumber}	Get a specific articles details.
GET api/articles/{date}?includeInactive={includeInactive}	Get all articles that has been changed since the specified date.
GET api/articles/netnetcalculation	Method that gets all NET NET calculations.
GET api/articles/netnetcalculation/type	Method that gets all NET NET calculation types.
GET api/articles/speedrating	Method that gets all speed ratings.
GET api/articles/tyretype	Method that gets all tyre types.
POST api/articles	Method for adding an article
POST api/articles/endoflife/{articleNumber}	Method that sets end of life on an article
POST api/articles/inactivate/{articleNumber}	Method that inactivates an article
POST api/articles/rim	Method for adding an article rim
POST api/articles/service	Method for adding an service article
POST api/articles/tube	Method for adding article tube
POST api/articles/tyre	Method for add article tyre
POST api/articles/wheel	Method for add article wheel
PUT api/articles	Method for updating an article
PUT api/articles/rim	Method for update article rim
PUT api/articles/service	Method for updating an service article
PUT api/articles/tube	Method for updating article tube
PUT api/articles/tyre	Method for updating an article tyre
PUT api/articles/wheel	Method for update article wheel

Bookings

API	Description
DELETE api/Bookings/{id}	DELETE: api/Bookings/5<br/> Deletes a booking where id is a not started work order.<br/>
POST api/Bookings	POST: api/Bookings<br/> Adds a new booking using the <para>bookingData</para>.<br/>

Branches

API	Description
GET api/Branches	Gets all branches
GET api/Branches/{id}	Gets a specific branch by id.
GET api/Branches/BranchCalendars/{branchId}/{includeShared}	Gets all calendars for a specific branch.
GET api/Branches/BranchCalendars/{branchId}?includeShared={includeShared}	Gets all calendars for a specific branch.
GET api/Branches/BranchCalendars/{includeShared}	Gets all calendars for all branches.
GET api/Branches/BranchCalendars?includeShared={includeShared}	Gets all calendars for all branches.
GET Branches/BranchCalendars/{branchId}/{includeShared}	Gets all calendars for a specific branch.
GET Branches/BranchCalendars/{branchId}?includeShared={includeShared}	Gets all calendars for a specific branch.
GET Branches/BranchCalendars/{includeShared}	Gets all calendars for all branches.
GET Branches/BranchCalendars?includeShared={includeShared}	Gets all calendars for all branches.

Carriers

Controller class for Carriers.

API	Description
GET api/Carriers	Gets a list of carriers.

Company

API	Description
GET api/Company	Get basic company information.

Contacts

API	Description
DELETE api/Contacts?contactId={contactId}	Deletes an contact.
GET api/Contacts/{contactID}	Get contact by contactID
GET api/Contacts/{customerNumber}	Gets all contacts for a customer with customernumber
GET api/Contacts/{licensePlate}	Gets all contacts by a licenseplate
POST api/Contacts	Creates a contact
PUT api/Contacts	Updates a contact

Contracts

Contains all methods exposed trough the API related to methods.

API	Description
DELETE api/Contracts/{id}	Deletes a specific contract by id.
GET api/Contracts/{id}	Gets a specific contract by id. <br/> Not implemented.<br/>
GET api/Contracts?lastChangedDate={lastChangedDate}	Gets all contracts that has been changed since provided date.<br/> Not implemented.<br/> <para /> If no date is provided, all contracts will be returned<br/>
POST api/Contracts	Creates a contract
PUT api/Contracts	Updates a contract<br/> Not implemented.<br/>

Country

Controller for Country methods

API	Description
GET api/Country	Get all Countries

Currencies

API	Description
GET api/Currencies	Gets all currencies.
GET api/Currencies/{id}	Gets a specific currency by id.

Customers

Controller class for customers API calls.

API	Description
DELETE api/customers/accountsreceivable?customerNumber={customerNumber}	Deletes customer accounts receivable
DELETE api/customers/deliveryaddress?id={id}	Deletes customer delivery address
DELETE api/customers/einvoicesetting?id={id}	Deletes customer einvoice
DELETE api/customers/invoice?customerNumber={customerNumber}	Deletes customer invoice
DELETE api/customers/ordersetting?customerNumber={customerNumber}	Deletes order setting for customer
GET api/Customers	Gets all customers using paging.
GET api/Customers/{customerNumber}	Gets a specific customer by customer number.
GET api/customers/{date}	Gets all customers that are changed since the specified date. Returns pages result.
GET api/customers/accountsreceivable?customerNumber={customerNumber}	Get customer accounts receivable
GET api/customers/breakdownservicetype	Gets all break down service types
GET api/customers/category	Gets all customer categories
GET api/customers/deliveryaddress?customerNumber={customerNumber}	Get all delivery addresses for a customer
GET api/customers/deliveryaddress?id={id}	Get customer delivery address
GET api/customers/district	Gets all districts
GET api/customers/einvoicesetting?id={id}	Get customer einvoice setting
GET api/customers/invoice?customerNumber={customerNumber}	Get customer invoice
GET api/Customers/licensePlate/{licensePlate}	Gets all customers by licenseplate
GET api/customers/ordersetting?customerNumber={customerNumber}	Gets order setting for customer.
GET api/customers/ordersettingstate	Gets all customer order setting states
GET api/customers/region	Gets all regions
GET api/customers/statementtype	Gets all statement types
POST api/customers	Adds an customer
POST api/customers/accountsreceivable	Create customer accounts receivable.
POST api/customers/deliveryaddress	Add customer delivery address.
POST api/customers/einvoicesetting	Add customer einvoice setting.
POST api/customers/invoice	Add customer invoice.
POST api/customers/ordersetting	Add order setting for customer.
PUT api/customers	Update customer
PUT api/customers/accountsreceivable	Update customer accounts receivable.
PUT api/Customers/activate?customerNumber={customerNumber}	Activates an customer
PUT api/Customers/deactivate?customerNumber={customerNumber}	Deactivates an customer
PUT api/customers/deliveryaddress	Update customer delivery address.
PUT api/customers/einvoicesetting	Update customer einvoice setting.
PUT api/customers/invoice	Update customer invoice.
PUT api/customers/ordersetting	Update order setting for customer.

DebitModels

Debit model controller.

API	Description
GET api/DebitModels	Gets all debit models.
GET api/DebitModels/{id}	Gets a debit model by id.

Departments

API	Description
GET api/Departments?branchId={branchId}	Gets all departments by branchid

Images

API	Description
GET api/images/{id}	Get image

Indelivery

API	Description
GET api/Indelivery/{id}?branchId={branchId}	Gets a specific indelivery by id and branchId.
POST api/indelivery	Method for creating an indelivery

Inventory

Controller for inventory.

API	Description
DELETE api/Inventory/Head	Delete a single inventory basis head and its associated inventory basis lines
DELETE api/Inventory/Line	Delete a single inventory basis line
GET api/Inventory/Head/{headId}	Get a single inventory basis head
GET api/Inventory/Heads	Get all inventory basis heads in paged format
GET api/Inventory/HeadsLight?branchId={branchId}	Get all inventory basis heads light version in paged format, sorted by [StartedDate, InventoryNumber, Id]
GET api/Inventory/Lines/{headId}	Get all inventory basis lines associated with a given inventory basis head in paged format
GET api/Inventory/Reasons	Get all inventory reasons
POST api/Inventory/Create	Creates a inventory basis based on the request parameter.
POST api/Inventory/Finalize	Request a specific inventory basis to be finalized.
PUT api/Inventory/Lines	Updates a list of existing inventory basis lines

Invoice

API	Description
GET api/invoice/einvoicetype	Gets all einvoice types
GET api/invoice/interesttype	Gets all interest types
GET api/invoice/invoicecycle	Gets all invoicecycles
GET api/invoice/invoicetype	Gets all invoice types
GET api/invoice/termsofpayment	Get all terms of payments

Logs

Controller for accessing logs of DDAPI

API	Description
DELETE api/Logs/{toDate}	Deletes all logs to a specified date
GET api/Logs/{correlationID}	Get all logs by correlationid
GET api/Logs/{fromDate}	Gets all logs for a specified date
GET api/Logs/{id}	Get logs by log type id
GET api/Logs/NOC	Gets specific data for surveillance by NOC.<br/> Returns statistics for DDAPI requests and responses last hour.<br/>

MainGroups

API	Description
GET api/MainGroups	Gets all main groups.

Orders

Controller class for order API calls.

API	Description
GET api/orders/{customerNumber}	Gets open orders by customer number {customerNumber}.
GET api/orders/{customerNumber}/{fromDate}/{toDate}	Gets orders by customer number {customerNumber} where orderdate is equal or later than {fromDate}.<br/> and if {toDate} is specified orderdate is between {fromDate} and {toDate}.<br/>
GET api/orders/{id}/{branchId}	Gets a specific order.
GET api/orders/GetStatusFromDate/{fromDate}?branchId={branchId}&onlyClosed={onlyClosed}	Get CloseOrderTypeId and OrderStatusId, paged, for all orders for specific branch from fromDate
GET api/orders/paymentCardTypes	Gets all payment card types
GET api/orders/pointOfSales	Gets all point of sales
GET api/orders/pointOfSales/{branchId}	Gets all point of sales for a specific branch
GET api/orders/search/{branchId}/{fromDate}/{toDate}	Gets orders by branch id {branchId} where orderdate is equal or later than {fromDate}<br/> and if {toDate} is specified orderdate is between {fromDate} and {toDate}.<br/>
POST api/Orders	Add an order.
POST api/orders/finalize	Finalize order as cash or as deliverynote.
POST api/orders/Waybill	Adds a waybill number to the order
POST api/orders/wmsstatus	Sets the WMS status of specified order.
PUT api/Orders	Updates an order

Packinglist

Controller for packing list.

API	Description
GET api/packinglist/{deliveryDate}	Get a list of all the packing lists for a specific delivery date.
GET api/packinglist/lines/{headId}	Gets all the packing list lines for a specific packing list.
GET api/packinglist/linestatuses	Gets all the packing list line statuses.
GET api/packinglist/returngoods/{branchId}	Gets all return items expected.

Pricat

Controller used for handling the import of .csv PriCat price lists

API	Description
GET pricatMainGroups	Endpoint used to get a collection of VISIBLE MainGroups
GET pricatSubGroups	Endpoint used to get a collection of VISIBLE SubGroups
GET pricatSuppliers	No documentation available.
POST cacheAndImport	No documentation available.
POST pricatImportPriceList	Endpoint used to IMPORT the price list items from the .csv file.<br/> The row data is validated in the business layer and is saved to the EditArticle table and the related tables.<br/>
POST pricatSupplierMainGroups	No documentation available.
POST pricatSupplierSubGroups	No documentation available.
PUT pricatSupplierMainGroups	No documentation available.
PUT pricatSupplierSubGroups	No documentation available.

Pricelists

API	Description
DELETE api/pricelists/pricelistline/{articleNumber}/{priceListId}	Deletes an pricelist line
GET api/Pricelists	Gets all pricelist heads.
GET api/Pricelists/{id}	Gets a pricelist using paging for the pricelist lines.
GET api/Pricelists/{id}?date={date}	Gets changed prices in a pricelist using paging for the pricelist lines.
POST api/pricelists/pricelistline	Adds price list line to an pricelist
POST api/pricelists/pricelistlines?id={id}&date={date}	Gets pricelist lines changed since a date for selected articles.
PUT api/pricelists/pricelistline	Updates price list line to an pricelist

Signature

API	Description
DELETE api/signature/delete/{id}/{type}	Method that deleted a signature
GET api/signature?includeCompleted={includeCompleted}	Get a list of pending or completed signatures
POST api/signature/add	Method for adding a signature

Status

Methods for gettings statuses

API	Description
GET api/Status/SupplierOrder	Gets all the statuses for SupplierOrderHead
GET api/Status/SupplierOrderLine	Gets all the statuses for SupplierOrderLine
GET api/Status/WMS	Gets all the status for WMS

StockBalances

API	Description
GET api/StockBalances/changes/{branchId}?from={from}	Retrieves any changed rows since the specified time<br/> NOTE: To use this endpoint CDC (change data capture) needs to be enabled on the target database and running on the StockBalance table<br/>
GET api/StockBalances?branchId={branchId}	Gets all stockbalances for a branch[id] using paging.
GET api/StockBalances?branchId={branchId}&locationId={locationId}	Gets all stockbalances for a branch[id] and location[id] using paging.
POST api/StockBalances/{branchId}	Gets all stockbalances for the specified articles in the body for a specific branch.
POST api/StockBalances/{branchId}?locationId={locationId}	Gets all stockbalances for the specified articles in the body for a specific branch.

StockPlace

Controller for GET/POST stockplaces

API	Description
GET api/StockPlace?stockId={stockId}&includeIsOccupied={includeIsOccupied}	Gets stock places for stock with id StockId
GET api/StockPlace?storageCardID={storageCardID}&includeIsOccupied={includeIsOccupied}	Gets specific stock places for stock where storage card is stored.
POST api/StockPlace	Adds stockplaces to a specific stock.
POST api/stockPlace/AddNamedStockPlace	Adds stockplaces with names to a specific stock.
PUT api/stockPlace/UpdateStockPlace	Update names on stock places

Stocks

API	Description
GET api/Stocks/{id}	Get specific stock
GET api/Stocks?stockType={stockType}	Gets all stocks

StockTransfers

Stock transfer controller.

API	Description
GET api/stocktransfer/{id}	Gets a specific stock transfer
GET api/stocktransfer/date/{fromDate}	Gets the stock transfer heads with an order date on or after fromDate
POST api/stocktransfer/ConfirmDelivery	Confirms delivery from WMS for a specific stock transfer.<br/> Will create an indelivery basis for the receiving branch and add quantities to the rows of the stockTransfer (WMSConfirmedQuantity)<br/>
POST api/stocktransfer/Create	Creates a new stock transfer.
POST api/stocktransfer/wmsstatus	Sets the WMS status of specified stock transfer.
POST api/StockTransfers	[DEPRECATED] Adds a stock transfer.

StorageCards

Controller for suppling tyre hotel storage card information.

API	Description
GET api/storageCards/{licensePlate}?includeInactive={includeInactive}	Get storage cards associated with a certain licenseplate
GET api/storageCards/{storageCardID}	Gets speicific storage card
GET api/storageCards/Closed	Get closed storage cards in paged format
GET api/storageCards/workorders/{licensePlate}	Get the latest workorders associated with a licenseplate
GET api/StorageCards?changeDate={changeDate}&customerNo={customerNo}&includeInactive={includeInactive}	Get storage cards in paged format
POST api/storageCards/GetMultipleStorageCards?changedDate={changedDate}&includeInactive={includeInactive}	Get storagecard information for multiple storage card Ids.
POST api/storageCards/InsertEquipment	Inserts a new equipment
POST api/storageCards/InsertStorageCard	Inserts a new storagecard
POST api/storageCards/ShiftStorageCardEquipmentSets/{storageCardID}	Shifts the previous equipmentset (on vehicle) with the equipmentset (in storage)
PUT api/storageCards/UpdateEquipment	Updates an existing equipment
PUT api/storageCards/UpdateEquipmentSet	Updates an existing equipmentset
PUT api/storageCards/UpdateStorageCard	Get storage card and update parameters.

StorageStatistics

API	Description
GET api/StorageStatistics	Gets storagestatistics per branch
GET api/StorageStatistics/reportNotCharged?branchId={branchId}&includeStorageCardsWithReservations={includeStorageCardsWithReservations}&currentSeason={currentSeason}&stockId={stockId}&vehicleTypeId={vehicleTypeId}	Gets a report of not charged storage cards.

SubGroups

API	Description
GET api/SubGroups	Gets all subgroups sorted by the <br/> <see cref="P:Compilator.DDAPI.DTO.Article.SubGroupResponse.Priority">Priority</see> field and <br/> <see cref="P:Compilator.DDAPI.DTO.Article.SubGroupResponse.Id">Id</see>

Supplier

Methods for supplier and it's related entities

API	Description
DELETE api/supplier/contact/{id}	Deletes an contact on supplier
GET api/Supplier	Gets all suppliers
GET api/supplier/{id}	Gets a supplier by id
GET supplier/suppliercategories	Gets all supplier categories
POST api/Supplier	Adds an supplier
POST api/supplier/activate/{id}	Activate supplier
POST api/supplier/contact	Adds an contact to supplier
POST api/supplier/inactivate/{id}	Inactivate supplier
PUT api/Supplier	Updates an supplier
PUT api/supplier/contact	Updates an contact on supplier

SupplierOrder

Methods for supplier orders

API	Description
GET api/supplierorder/{id}/{branchId}	Gets a specific order.
GET api/supplierorder/status/{orderStatus}/{branchId}	Gets all orders with a specific status.
GET api/supplierorder/supplierorderdeliverydetails/{supplierOrderId}	Returns a list of the SupplierOrderDeliveryDetails assosicted with the supplierOrderId
POST api/supplierorder/Create	Created a supplier order (purchase order)
POST api/supplierorder/EdiWheelDetails	Add EDI Wheel schedule to an existing Supplier order
POST api/supplierorder/supplierorderdeliverydetails/Update	Removes the current SupplierOrderDeliveryDetails on all SupplierOrderLines included in the request <br/> and adds the new SupplierOrderDeliveryDetails to the specified SupplierOrderLine<br/>
POST api/supplierorder/Update	Update a supplier order (purchase order)
POST api/supplierorder/wmsstatus	Sets the WMS status of specified supplier order.
PUT api/supplierorder/line	Updates a single specific SupplierOrderLine.
PUT api/supplierorder/lines	Updates several SupplierOrderLines

ThirdPartyOrders

API	Description
POST api/ThirdPartyOrders	Add an order.
POST api/ThirdPartyOrders/Finalize	Finalizes a third party order

TireScan

API that receives tire scanner data and forwards it to the TIS.

API	Description
POST api/tirescan	[DEPRECATED]

TireScanV2_0

API that receives tire scanner data and forwards it to the TIS.

API	Description
GET api/tirescanv2/{tireScanId}	No documentation available.
GET api/tirescanv2/date/{fromDate}/{toDate}	No documentation available.
GET api/tirescanv2/search/{licensePlate}	No documentation available.
POST api/tirescanv2	Adds a new tire scan.
POST api/tirescanv2/connect	Connects a storage card with a tire scan

Tracking

API	Description
GET api/tracking/information/{storageCardId}	Get tracking information about a storage card
GET api/tracking/position/{trackingPositionId}	Get information about a tracking position
POST api/tracking/equipmentposition/{equipmentId}	Store equipment position to log
POST api/tracking/position/{trackingPositionId}/{branchId}	Update geographical location for a tracking position

TransportationSchedules

Controller for operations on transportation schedules.

API	Description
GET api/TransportationSchedules	Gets a list of transportation schedules.

Type

Methods for gettings types

API	Description
GET api/Type/SupplierOrder	Gets the types for supplier orders

Unit

Controller for Unit

API	Description
GET api/Unit	Gets all units

VAT

Controller for VAT

API	Description
GET api/VAT	Gets all VAT's

Vehicle

API	Description
GET api/vehicle/{licensePlate}/{branchId}	Get a vehicle by license plate
PUT api/Vehicle	Update a specific vehicle
PUT UpdateVehicle	Get storage card and update parameters.

VersioningLog

API	Description
POST api/VersioningLog	Saves log info

WholesaleArticle

API	Description
GET api/wholesale/articles/{sectionWidth}/{aspectRatio}/{diameter}/{branchId}/{page}/{pageSize}	Get a list of articles including prices

WholesaleOrder

API	Description
POST api/wholesale/order	Send a tire order

WholesaleSettings

API	Description
GET api/wholesale/settings/{branchId}	Get wholesale settings for specific branch