Web Services

Form ID: (SM207040)

You use this form to configure the MYOB Acumatica screen-based web services API for your client application; you can also use the form to view the details of existing web services.

On this form, you can configure a service that provides the methods for working with the selected MYOB Acumatica forms. By using the methods of the created service, a client application can transfer data to and from MYOB Acumatica through these forms.

Form Toolbar

The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be shown as buttons on the form toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.


Command	Description
Generate	Starts the process of generating the WSDL description of the service with the selected parameters. After the service is generated, the Is Generated check box is selected for this service.
View Generated	Opens the browser window with the WSDL description of the service selected on the form. The address line contains the path that a client application should use to access this service. This button is available if the Is Generated check box is selected for the service.
View Untyped	Opens a browser window with the WSDL description of the service that provides untyped methods, which work with arrays of containers and fields instead of structured data for each MYOB Acumatica form with which the standard methods work. Untyped methods are not specific for each form: The same untyped method can work with different MYOB Acumatica forms.

Summary Area

By using the elements of this area, you can select a service on the form (by selecting its service ID) and view its main properties.


Element	Description
Service ID	The identifier of the service. When you are creating a service, you must specify a service ID.
Description	A user-provided description of the service.
Is Generated	A check box that indicates (if selected) that the WSDL description of the service has already been generated.
Current System Version	The build number of the current MYOB Acumatica application instance.
System Time	The system time when the selected service was most recently generated.
System Version	The build number of the MYOB Acumatica application instance on which the selected service was most recently generated.
Import	A check box that indicates (if selected) that by default, the import operation will be available for all forms of the service—that is, the Import check box will be selected for all newly added lines in the table in the lower right pane of the form.
Export	A check box that indicates (if selected) that by default, the export operation will be available for all forms of the service—that is, the Export check box will be selected for all newly added lines in the table in the lower right pane of the form.
Submit	A check box that indicates (if selected) that by default, the submit operation will be available for all forms of the service—that is, the Submit check box will be selected for all newly added lines in the table in the lower right pane of the form.
Include Untyped	A check box that indicates (if selected) that untyped methods should be included in the WSDL description of the service. The untyped methods in WSDL have the `Untyped` prefix in their names—for example, `UntypedExport`. The untyped methods work with arrays of containers and fields; the same untyped method can work with different MYOB Acumatica forms. Conversely, the standard methods work with structured data for each MYOB Acumatica form; standard methods are specific for each form.

Left Pane

On this pane, you can select the MYOB Acumatica forms your client application will work with through the service.

Table 1. Pane ToolbarThe toolbar on the pane includes only custom buttons, which are described in the following table.
Button	Description
Add to Grid	Adds the form that you have selected on the left pane to the list of forms that should be available through the service in the table on the right pane.

Right Pane

In the table on this pane, you can view and edit the list of MYOB Acumatica forms that should be available through the service and the list of operations for working with these forms. The API methods for the operations with these forms are included in the WSDL description of the service.

Table 2. Table Toolbar
The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are listed below.
Button	Description
Reset Usage	Sets the default values in the Import, Export, and Submit columns for all lines of the table. The default values are defined by the Import, Export, and Submit check boxes of the Summary area.

Table 3. Table Columns
Column	Description
Active	A check box that indicates (if selected) that the API methods for the MYOB Acumatica form specified in this line should be included in the WSDL description of the service.
Generated	A check box that indicates (if selected) that the WSDL description of the service already includes the API methods for the MYOB Acumatica form specified in this line.
Screen ID	The ID of the MYOB Acumatica form to be available through the service.
Title	The name of the MYOB Acumatica form to be available through the service.
Import	A check box that indicates (if selected) that the WSDL description of the service will include the import method for the MYOB Acumatica form specified in this line. If the import method for the MYOB Acumatica form is included in the WSDL description of the service, the client application can import records to this form.
Export	A check box that indicates (if selected) that the WSDL description of the service will include the export method for the MYOB Acumatica form specified in this line. If the export method for the MYOB Acumatica form is included in the WSDL description of the service, the client application can export records from this form.
Submit	A check box that indicates (if selected) that the WSDL description of the service will include the submit method for the MYOB Acumatica form specified in this line. If the submit method for the MYOB Acumatica form is included in the WSDL description of the service, the client application can submit data to this form and get the result of processing.