Share via


Standard Document Services

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Microsoft Dynamics AX 2012 contains many standard document services. Each service supports a particular business process. You can customize these standard documents or create custom documents that suit your individual business processes.

Document Services that are included with AX 2012

In many cases, standard document services use the same data that is presented on the corresponding form. For example, you can programmatically access data for customer records by using the CustCustomerService service and work with the same data in the Customer form. (Click Accounts Receivable > Customers > All customers.)

Each document is represented by a class and a query in AX 2012. The name of a document class is preceded by Axd. For example, AxdSalesOrder is the name of the document and also the name of the document class and the related query in the AOT. You will often see the terms "document" and "Axd document" and "document class" used interchangeably.

The following table lists the document services that are included with AX 2012. The version number specifies in which version of Microsoft Dynamics AX the document originally shipped. The service class name is the name displayed in the Select service operations form and appears in the Services node of the Application Object Tree (AOT). For more information about the Select service operations form, see Customize service contracts. In most cases, the corresponding query has the same name as the document. You can click the service name to read more information, if it is available.

You can generate a schema for each document by creating an enhanced inbound integration port and specifying the service operation. For more information, see the section “Viewing schemas” in Customize service contracts. You can generate sample XML for a particular schema when you use Visual Studio to view the schema.

Service Name

Document class name

Service class name

Version

Description

Supported service operations (Create, Read, Update, Delete, Find, findKeys, getKeys, getChangedKeys)

Advance shipping notice

AxdASN

InventASNService

4.0

Sent to the customer when the sales order packing-slip updated.

R

Exchange rates

AxdExchangeRates

AxdSendExchangeRates

LedgerExchangeRatesService

4.0

Enables you to send your exchange rates to another subsidiary.

CR

Free-text invoice

AxdFreeTextInvoice

CustFreeTextInvoiceService

4.0

Creates a sales order in the application. This document has significantly fewer restrictions on input data than the Sales Order document.

C

Inventory counting journal document

AxdCountingJournal

InventCountingJournalService

4.0

Updates inventory amounts and balances with inventory information from a third-party warehouse system.

C

Inventory on hand

AxdInventoryOnHand

InventInventoryOnHandService

4.0

Enables external users to receive up-to-date information about on-hand inventory amounts.

R

Inventory profit and loss journal

AxdProfitLossJournal

InventProfitLossJournalService

4.0

Creates an inventory profit and loss record that is based on information from a third-party warehouse management system.

C

Inventory transactions

AxdInventoryTransactions

InventInventoryTransactionsService

4.0

Describes the inventory transactions document.

R

Inventory transfer journal

AxdTransferJournal

InventTransferJournalService

4.0

Updates the inventory warehouse data from a third-party warehouse management system.

C

Packing slip

AxdSalesPackingSlip

SalesSalesPackingSlipService

4.0

Creates a packing slip record. The packing slip record is based on the data from a third-party warehouse management system.

C

Picking list

AxdPickingList

InventPickingListService

4.0

Sends a picking list to a third-party warehouse management system.

R

Price discount agreement journal

AxdPriceDiscountJournal

PricePriceDiscJournalService

4.0

Describes the price discount agreement document.

C

Price list

AxdPriceList

PricePriceListService

4.0

Sends a compiled price list to a customer. The price list is based on the trade agreements and discounts for the specific customer.

R

Purchase invoice

AxdPurchaseInvoice

LedgerPurchaseInvoiceService

4.0

Creates a purchase invoice that is based on the associated purchase order.

C

Purchase requisition

AxdPurchaseRequisition

PurchPurchReqService

4.0

Sends a purchase requisition to a vendor.

R

Sales invoice

AxdSalesInvoice

SalesSalesInvoiceService

4.0

Sends an invoice to a customer. The invoice is based on the sales order data of the customer.

R

Sales order

AxdSalesOrder

SalesSalesOrderService

4.0

Creates a new sales order record.

CRUD

Address

AxdAddress

DirAddressService

4.0 SP2

Enables external systems to read, update, create, and delete alternative addresses.

CRUD

Contact person

AxdContactPersons

DirContactPersonsService

4.0 SP2

Enables external system to read, create, update, and delete contact persons.

CRUD

Customer

AxdCustomer

CustCustomerService

4.0 SP2

Enables external systems to read, create, update, and delete customers.

CRUD

Customer group

AxdCustomerGroups

CustCustomerGroupsService

4.0 SP2

Enables external systems to read, create, update, and delete customer groups.

R

Item

AxdItem

InventItemService

4.0 SP2

Enables a two-way collaboration of the item master for the objective of synchronization in a dgusiness-to-business relation.

CR

Item dimension combination

AxdInventDimCombination

InventInventDimCombinationService

4.0 SP2

Enables external systems to read information about combinations of item dimensions, for example, color and size.

R

Payment terms

AxdPaymentTerms

PaymPaymentTermsService

4.0 SP2

Delivers a list of payment terms.

R

Product groups

AxdInventItemGroup

InventInventItemGroupService

4.0 SP2

Enables external systems to read information about product groups.

R

Shipping methods

AxdDeliveryModes

InventDeliveryModesService

4.0 SP2

Enables external systems to read information about shipping methods.

R

Warehouse

AxdInventLocation

InventInventLocationService

4.0 SP2

Enables external systems to receive information about a warehouse.

R

Bill of materials (BOM)

AxdBillsOfMaterials

BomBillsOfMaterialsService

5.0

Enables synchronization of a bill of materials with external systems, for example, when production is outsourced to a subcontractor.

CR

Cash discount

AxdCashDisc

LedgerCashDiscService

5.0

Delivers a list of cash discounts available to a specific user.

R

Credit card

AxdTrvPBSMaindata

TrvTrvPBSMaindataService

5.0

Enables the import of corporate credit card transactions.

C

Customer Payment Journal

AxdCustPaymJournal

LedgerCustPaymJournalService

5.0

Enables creating customer payment records based on a customer invoice.

C

Expense report

AxdExpense

TrvExpenseService

5.0

Enables the entry and submission of expense reports.

CR

Fixed asset

AxdFixedAsset

AssetFixedAssetService

5.0

Delivers a list of assets, and enables creating new fixed asset records.

CRU

Fixed asset condition

AxdAssetCondition

AssetAssetConditionService

5.0

Delivers a list of the asset conditions. Fixed asset conditions describe the physical status of a fixed asset, such as good, new, refurbished, improved, or used.

R

Fixed asset group

AxdAssetGroup

AssetAssetGroupService

5.0

Delivers a list of the asset groups.

R

Fixed asset location

AxdAssetLocation

AssetAssetLocationService

5.0

Delivers a list of the asset locations. Locations describe where a fixed asset resides and may include an address.

R

Fixed asset major type

AxdAssetMajorType

AssetAssetMajorTypeService

5.0

Delivers a list of the asset major types. Fixed asset major types are high-level asset groupings, used for reporting purposes only.

R

Ledger journal

AxdLedgerGeneralJournal

LedgerGeneralJournalService

5.0

Delivers a list of general journals, and enables creating new general journals with ledger account types supporting multicurrency and intercompany accounts.

CR

Product picking list

AxdProdPickingList

ProdProdPickingListService

5.0

Creates a production picking list journal. Enables a subcontractor to report consumption of items.

C

Project hour journal

AxdProjectHourJournal

ProjProjectHourJournalService

5.0

Enables external systems to create project hour journals.

C

Project invoice

AxdProjInvoice

ProdProjEInvoiceService

5.0

Project invoice for Danish e-invoice. Creates an electronic invoice for the Danish tax authorities.

R

Return order

AxdReturnOrderIn

ReturnReturnOrderInService

5.0

Enables the entry of customer return orders.

CUD

Return order acknowledgment

AxdReturnOrderOut

ReturnReturnOrderOutService

5.0

Enables the sending of a return order acknowledgement to the customer.

R

Route card

AxdRouteCard

ProdRouteCardService

5.0

Creates a production route card journal. Enables a subcontractor to report progress (hours spent, good quantity, error quantity, percent complete).

C

Sales e-invoice

AxdSalesInvoice_Einvoice

SalesSalesEInvoiceService

5.0

Sales invoice for Danish e-invoice. Creates an electronic invoice for the Danish tax authorities.

R

Service agreement

AxdServiceAgreement

SMAServiceAgreementService

5.0

Enables the exchange of electronic service agreements including the service agreement header and lines.

R

Service order

AxdServiceOrder

SMAServiceOrderService

5.0

Enable the exchange of electronic service orders including the service order header and lines.

CRUD

Vendor

AxdVendor

VendVendTableService

5.0

Enables synchronization of vendor data with external systems.

CRUD

Vendor group

AxdVendorGroup

VendVendGroupService

5.0

Enables synchronization of vendor groups with external systems.

CRUD

Vendor payment

AxdVendorPayment

LedgerVendorPaymentService

5.0

Delivers payment information for a specific vendor.

R

Budget transaction

AxdBudgetTransaction

BudgetTransactionService

AX 2012

Allows end user to create, read, update, and delete budget register entries

CRUDF, FK, GCK, GK

Catalog import

AxdCatImp

CatImpService

AX 2012

Allows end user (Vendor, Purchasing agent. Or Purchasing manager) to maintain the imported catalog of the vendor in Microsoft Dynamics AX

C, GCK, GK

Customer electronic payment

AxdCustPayments

CustPaymentsService

AX 2012

Customer electronic payment service

FR

Document handling

DocumentHandlingService

Note

The corresponding query is called DocumentHandling.

DocumentHandlingService

AX 2012

Allows users to submit unattached documents and push them into workflow for association with records.

C

Product master dimension values

AxdEcoResProductMasterDimValue

EcoResProductMasterDimValueService

AX 2012

Allows read and write of product dimension values for a product master.

CRF, FK, GCK, GK

Product service

AxdEcoResProduct

EcoResProductService

AX 2012

Enables external systems to read or write products into shared product repository.

CRF, FK, GCK, GK

Meter reading service

AxdEMSMeterReadingFlow

EMSMeterReadingFlowService

AX 2012

Allows external systems to record meter readings in the environmental sustainability dashboard.

C, GCK, GK

Substance flow

AxdEMSSubstanceFlow

EMSSubstanceFlowService

AX 2012

Allows external systems to record substance flow transactions in the environmental sustainability dashboard.

EU sales list reporting

AxdEUSLReporting

EUSLReportingService

AX 2012

Enables generation of EU sales list files which are used for reporting to government authorities.

R, F, GCK, GK

Warehouse item

AxdInventItemLocation

InventInventItemLocationService

AX 2012

Enables external systems to create and retrieve warehouse items.

CRF, FK, GCK, GK

Barcode service

AxdInventItemBarcode

InventItemBarcodeService

AX 2012

Enables external systems to retrieve barcode information for a released product.

RF, FK, GCK, GK

Create inventory transfer order

AxdTransferOrderCreate

InventTransferOrderCreateService

AX 2012

Enables external systems to create inventory transfer orders.

C, GCK, GK

Inventory transfer order posting

AxdTransferOrderPosting

InventTransferOrderPostingService

AX 2012

Enables external systems to post inventory transfer orders.

C, GCK, GK

Read inventory transfer order

AxdTransferOrder

InventTransferOrderService

AX 2012

Enables external systems to read inventory transfer orders.

RF, FK, GCK, GK

Request for quote reply

AxdRFQReply

PurchPurchRFQReplyService

AX 2012

Enables a customer to receive vendor quotes in response to a request for quote.

UF, GCK, GK

Request for quote send

AxdRFQSend

PurchPurchRFQSendService

AX 2012

Enables a customer to send requests for quote to vendors.

RF, FK, GCK, GK

Purchaser requisition

AxdPurchaseRequisition

PurchReqImportService

AX 2012

Enables the creation, retrieval, and cancellation of purchase requisitions.

Cancel, CRDF, FK, GCK, GK

Request for quote sites

AxdPurchRFQSites

PurchRFQSitesService

AX 2012

Enables the customer to manage request for quote documents.

CRUF, FK, GCK, GK

Sales quotation journal

AxdCustomerQuotation

SalesCustomerQuotationService

AX 2012

Enables external systems to read sales quotation journals.

RF, FK, GCK, GK

Line discount list

AxdLineDiscount

SalesLineDiscountService

AX 2012

Enables external systems to retrieve line discount lists.

Find, GCK, GK

Multiline discount list

AxdSalesMultilineDiscount

SalesMultilineDiscountService

AX 2012

Enables external systems to retrieve multiline discount lists.

F, GCK, GK

Sales confirmation

AxdSalesConfirmation

SalesSalesConfirmationService

AX 2012

Enables external systems to read sales order confirmations.

RF, FK, GCK, GK

Sales quotation

AxdSalesQuotation

SalesSalesQuotationService

AX 2012

Enables external systems to read, create, update, and delete sales quotations.

CRUDF, FK, GCK, GK

Total discount

AxdSalesTotalDiscount

SalesTotalDiscountService

AX 2012

Enables external systems to retrieve total discount lists.

F, GCK, GK

Expense policy violation

TrvExpensePolicyViolation

TrvExpensePolicyViolationService

AX 2012

Delivers a list of expense violations for a given expense report.

Custom service operation TrvExpensePolicyViolationService.getPolicyViolations

Warehouse location load service

WMSLocationLocationLoadService

WMSLocationLocationLoadService

AX 2012

Enables external systems to view load information (volume, weight) for warehouse locations.

R

Payroll earnings import

AxdPayrollEarningsImport

PayrollEarningsImportService

AX 2012 R2

Enables import of earnings statements from external systems.

C

Worker import

AxdHcmWorkerImport

HcmWorkerImportService

AX 2012 R2

Enables external systems to read, create, and update worker information.

C, R, U

Budget plan

AxdBudgetPlan

BudgetPlanService

AX 2012 R2

Enables external systems to read, create, update, and delete budget plans.

C, R, U, D

Bank statement

AxdBankStmt

BankStmtService

AX 2012 R2

Enables import of bank statements.

Note

You must select the Advanced bank reconciliation option on the Bank account form to import bank statements.

C, R, D, F, GK, GCK

Warehouse space utilization forecast

WMSSpaceUtilService

WMSSpaceUtilService

AX 2012 R2

Creates forecast data for a warehouse space utilization report.

Custom service operation buildForecast

Warehouse workload capacity forecast

WMSWorkLoadService

WMSWorkLoadService

AX 2012 R2

Creates forecast data for a warehouse work load capacity report.

Custom service operation buildForecast

Advanced Ledger Entry

AxdAdvancedLedgerEntry

AdvancedLedgerEntryService

AX 2012 R2

Imports different types of transactions, for example, payroll transactions, and uses the posting definitions to handle the balancing entries.

C, R, U, D, F, FK

Customer collections letter for Norway

AxdCustECollectionLetter_NO

CustCollectionLetterService_NO

AX 2012 R2

Sends collection letters in electronic format to customers that have electronic invoicing enabled. Applies to Norway only.

R

Customer transaction service

AxdCustomerTransaction

CustomerTransactionService

AX 2012 R2

Retrieves a list of a customer’s open and closed transactions.

F, FK, R

Routes service

AxdRoutes

RoutesService

AX 2012 R2

Supports synchronization of a route with external systems.

C, R, F, FK

Vendor invoice

AxdVendInvoice

VendInvoiceService

AX 2012 R2

Creates a new Vendor invoice.

Note

You must provide the InventTransId value for the desired Purchase Order line on VendInvoiceInfoLine if receiving against Purchase Order.

C, R, D, F, FK, GK, GCK

Asset depreciation rate for Japan

AxdAssetDepRateExpImp_JP

AssetDepRateExpImp_JPService

AX 2012 R3

Supports import and export of depreciation rates in Japan for fixed asset depreciation methods including old straight line, new straight line, old declining balance, and new declining balance by using Excel.

C, R, D, U

Asset depreciation method change for Japan

AxdAssetUndepBalanceExpImp_JP

AssetUndepBalanceExpImp_JPService

AX 2012 R3

Supportsimport and export of rate depreciation method change for Japan.

C, R, D, U

Job reporting service

JmgShopFloorService

JmgShopFloorServiceClass

AX 2012 R3

Creates, updates, and reads data for the shop floor companion app that enables shop floor operators to report on production jobs.

C, U, R

Expense fields visibility configuration

TrvAdminCustomFieldsService

TrvAdminCustomFieldsService

AX 2012 R3

Returns a list of all the expense report and line fields and how their visibility is configured: read-only, visible, or hidden.

R

Expense categories

TrvExpenseCategoryService

TrvExpenseCategoryService

AX 2012 R3

Returns a list of expense categories including their subcategories and information about the category.

R

Expense module configuration settings

TrvExpenseConfigurationService

TrvExpenseConfigurationService

AX 2012 R3

Returns configuration data for the user’s expense module, including default company, currency, and personnel number.

R

Expense lines

TrvExpenseLineCustomService

TrvExpenseLineCustomService

AX 2012 R3

Creates, reads, updates and deletes an expense line that belongs to an expense report.

C, R, U, D

Expense module reference data

TrvExpenseReferenceDataService

TrvExpenseReferenceDataService

AX 2012 R3

Returns reference data needed by the expense report module like locations, expense purpose, and the like.

R

Expense report

TrvExpenseReportCustomService

TrvExpenseReportCustomService

AX 2012 R3

Creates, reads, updates, deletes, submits and recalls an expense report.

C, R, U, D, submit, recall

Guest expense line

TrvExpGuestService

TrvExpGuestService

AX 2012 R3

Creates, reads, updates and deletes guest records on an expense line.

C, R, U, D

Expense report receipts

TrvReceiptService

TrvReceiptService

AX 2012 R3

Creates, updates, reads, deletes, attaches, detaches receipts from an expense report or an expense line.

C, R, U, D, and others

Warehouse Item Hierarchy Change

WHSChangeItemHierarchyService

WHSChangeItemHierarchyService

AX 2012 R3

Stateless service operation that changes the reservation on an item that already has transactions and inventory.

Custom service operation changeItemHierarchy

Warehouse Mobile Device Service

WHSMobileDevicesServiceFacade

WHSMobileDevicesService

AX 2012 R3

Custom service operations that enable the communication between the Warehouse Mobile Device Portal (WMDP) and the AX 2012 server (AOS).

Custom service operations: getNextFormHandHeld, getServiceUserLanguage, SessionLogFindTransacation, SessionLogUserList, WorkUserDisplaySettings

Warehouse Session Log Cleanup Service

WHSSessionLogCleanupService

WHSSessionLogCleanupService

AX 2012 R3

Stateless service operations for cleaning up the Warehouse worker user session logs.

Custom service operation doCleanup

Warehouse Shipment ASN Service

WHSShipmentASNService

WHSShipmentASNService

AX 2012 R3

Document service for import, create, delete or update Advance Shipment Notice (ASN) data.

C, D, F, FK, GCK, GK, R, U

Excluded field list

The following fields are excluded in all AIF XML documents. These fields are not imported during the inbound action and are not exported during outbound actions.

  • Fields starting with Del_.

  • Fields marked with status of Not visible.

Non-Editable Fields

In an inbound message, the XML cannot contain data for fields that are non-editable in the table (the AllowEdit property is set to No). That is, for each non-editable table field, the field element must not be in the inbound XML or the field element must be filtered out in the endpoint action data policy.

See also

Document Services Classes

AIF Class Naming Conventions

About Document Service Classes

About Axd<Document> Classes