Payment Import

The application requires an IIS server with .NET Framework 4 installed.

The application accepts a formalized XML request in accordance with the attached schema. The XML request contains authentication information for Aviabit and a set of input parameters. After processing, the application returns an XML response in accordance with the attached schema. The web services were developed using an object-oriented approach.

The web service is intended for importing payment data from an accounting system or third-party applications into Aviabit. The complete description of the web service can be found by opening the following page:

http://<server-address>/ImportPays.asmx?wsdl.

In addition to the authentication methods, the web service contains the following methods:

• General. Method for checking web service availability and database connection - GetDateTime;
• General. Retrieving currency type information from Aviabit - GetCurrencyTypes;
• General. Retrieving the Companies reference directory from Aviabit - GetCompanys;
• General. Retrieving the Contracts reference directory from Aviabit - GetContracts;
• General. Retrieving the Agency Contracts reference directory from Aviabit - GetTicketContracts;
• General. Retrieving the list of requests - GetContractRequests.

• Customers. Retrieving payment data from Aviabit - GetCustomerPays;
• Customers. Adding a payment to Aviabit - CreateCustomerPay;
• Customers. Deleting previously added payment data from Aviabit - DeleteCustomerPay;
• Customers. Retrieving balance data from Aviabit - GetCustomerBalances;
• Customers. Adding an opening balance to Aviabit - CreateCustomerBalance;
• Customers. Deleting previously added balance data from Aviabit - DeleteCustomerBalance.

• Suppliers. Retrieving payment data from Aviabit - GetSupplierPays;
• Suppliers. Adding a payment to Aviabit - CreateSupplierPay;
• Suppliers. Deleting previously added payment data from Aviabit - DeleteSupplierPay;
• Suppliers. Retrieving balance data from Aviabit - GetSupplierBalances;
• Suppliers. Adding an opening balance to Aviabit - CreateSupplierBalance;
• Suppliers. Deleting previously added balance data from Aviabit - DeleteSupplierBalance.

• Agents. Retrieving payment data from Aviabit - GetAgencyPays;
• Agents. Adding a payment to Aviabit - CreateAgencyPay;
• Agents. Deleting previously added payment data from Aviabit - DeleteAgencyPay;
• Agents. Retrieving balance data from Aviabit - GetAgencyBalances;
• Agents. Adding an opening balance to Aviabit - CreateAgencyBalance;
• Agents. Deleting previously added balance data from Aviabit - DeleteAgencyBalance.

The CustomerPay object is returned by the GetCustomerPays method and contains the fields listed in the table below.

The CustomerBalance object is returned by the GetCustomerBalances method and contains the fields listed in the table below.

The SupplierPay object is returned by the GetSupplierPays method and contains the fields listed in the table below.

The SupplierBalance object is returned by the GetSupplierBalances method and contains the fields listed in the table below.

The AgencyPay object is returned by the GetAgencyPays method and contains the fields listed in the table below.

The AgencyBalance object is returned by the GetAgencyBalances method and contains the fields listed in the table below.

The ContractRequest object is returned by the GetContractRequests method and contains the fields listed in the table below.

The GetCompanys method returns a list of Companys objects. This object represents a company card containing the following information:

The GetCurrencyTypes method returns a list of CurrencyTypes objects. This object represents a short reference directory of currency types containing the following information:

The GetContracts method returns a list of Contract objects. This object represents a short reference directory of contracts containing the following information:

The GetTicketContracts method returns a list of TicketContract objects. The data source is the Agency Contracts reference directory (Airline Finance System → Card Files → Contracts → Transportation Sales → Sales Conditions). The object contains the following information:

Methods for recording payments in the system (CreateCustomerPay, CreateSupplierPay, CreateAgencyPay) return a status as an enumeration. It can take the following values:

Methods for recording opening balances in the system (CreateCustomerBalance, CreateSupplierBalance, CreateAgencyBalance) return a status as an enumeration. It can take the following values:

Methods for deleting acts and services return the deletion status as an enumeration. It can take the following values:

The AuthHeader object has a single text property field, AuthenticatedToken, which receives a special key (session identifier) after authentication is performed. This object must be created, initialized by calling the Login method, and then passed as one of the parameters to all methods used.

Authentication on the web service is performed by calling the Login(String UserName, String Password) method, to which two text parameters are passed: the user name and password. One of the user accounts in Aviabit is used for these parameters.

!!! An important requirement is that the group to which this user account belongs must have rights to work with the web service. To do this, log in as an administrator, open the “User Groups” window, press “Enter” on the relevant group, select the “Access Rights to System Sections” menu item, and add access to “Accounting System Web Service”.

If authentication is successful, a string containing the session identifier is returned.

The session identifier must be passed as one of the parameters on each method call.

To end a session with the system, call the Logout(AuthHeader authHeader) method, passing the previously created AuthHeader object as a parameter.

Using the GetCurrencyTypes, GetCompanys, GetContracts, and GetTicketContracts methods, you can retrieve the contents of the system reference directories for further use. All listed methods accept a single input parameter: AuthHeader. The method returns the corresponding data objects (CurrencyType, Company, Contract, TicketContract).

Example call:

GetCurrencyTypes(AuthHeader authHeader)

To retrieve the list of requests, call the GetContractRequests(AuthHeader authHeader, int? contractID, int? contractRequestID, int? companyID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the contractID, contractRequestID, or companyID parameters are specified, the request will be filtered by contract, request ID, or customer respectively.

Parameter values:

To retrieve payment information, call the GetCustomerPays(AuthHeader authHeader, int? customerPayID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the customerPayID parameter is specified, the service will return the record for a specific payment.

Parameter values:

The CreateCustomerPay method is intended for adding a payment to the system. The method call format is as follows:

CreateCustomerPay(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DatePay, double Amount, double AmountTax, string Comment, int? ContractID, int? ContractRequestID)

The method returns information about the addition in a SyncPay object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncPay, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteCustomerPay method allows you to delete previously added payment information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteCustomerPay(AuthHeader authHeader, int customerPayID)

customerPayID is the ID of the added payment.

To retrieve information on “opening balances”, call the GetCustomerBalances(AuthHeader authHeader, int? customerBalanceID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the customerBalanceID parameter is specified, the service will return the record for a specific balance.

Parameter values:

The CreateCustomerBalance method is intended for adding an opening balance to the system. The method call format is as follows:

CreateCustomerBalance(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DateBalance, double Amount, string Comment, int? ContractID, int? ContractRequestID)

The method returns information about the addition in a SyncBalance object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncBalance, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteCustomerBalance method allows you to delete previously added balance information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteCustomerBalance(AuthHeader authHeader, int customerBalanceID)

customerBalanceID is the ID of the previously added balance.

To retrieve supplier payment information, call the GetSupplierPays(AuthHeader authHeader, int? supplierPayID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the supplierPayID parameter is specified, the service will return the record for a specific payment.

Parameter values:

The CreateSupplierPay method is intended for adding a payment to the system. The method call format is as follows:

CreateSupplierPay(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DatePay, double Amount, double AmountTax, string Comment, int? ContractID)

The method returns information about the addition in a SyncPay object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncPay, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteSupplierPay method allows you to delete previously added payment information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteSupplierPay(AuthHeader authHeader, int supplierPayID)

supplierPayID is the ID of the added payment.

To retrieve information on “opening balances”, call the GetSupplierBalances(AuthHeader authHeader, int? supplierBalanceID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the supplierBalanceID parameter is specified, the service will return the record for a specific balance.

Parameter values:

The CreateSupplierBalance method is intended for adding an opening balance to the system. The method call format is as follows:

CreateSupplierBalance(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DateBalance, double Amount, string Comment, int? ContractID)

The method returns information about the addition in a SyncBalance object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncBalance, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteSupplierBalance method allows you to delete previously added balance information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteSupplierBalance(AuthHeader authHeader, int supplierBalanceID)

supplierBalanceID is the ID of the previously added balance.

To retrieve payment information, call the GetAgencyPays(AuthHeader authHeader, int? agencyPayID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the agencyPayID parameter is specified, the service will return the record for a specific payment.

Parameter values:

The CreateAgencyPay method is intended for adding a payment to the system. The method call format is as follows:

CreateAgencyPay(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DatePay, double Amount, double AmountTax, string Comment, int? ContractID)

The method returns information about the addition in a SyncPay object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncPay, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteAgencyPay method allows you to delete previously added payment information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteAgencyPay(AuthHeader authHeader, int agencyPayID)

agencyPayID is the ID of the added payment.

To retrieve information on “opening balances”, call the GetAgencyBalances(AuthHeader authHeader, int? agencyBalanceID, DateTime dateBegin, DateTime dateEnd) method.

The following objects must be passed as input: AuthHeader received as a result of authentication, and the selection period. If the agencyBalanceID parameter is specified, the service will return the record for a specific balance.

Parameter values:

The CreateAgencyBalance method is intended for adding an opening balance to the system. The method call format is as follows:

CreateAgencyBalance(AuthHeader authHeader, int CompanyID, int CurrencyTypeID, DateTime DateBalance, double Amount, string Comment, int? ContractID)

The method returns information about the addition in a SyncBalance object.

Method parameter description:

All parameters are required.

If the information is successfully added, the method returns SyncBalance, where the RecordID field contains the ID of the added payment (0 if the information was not added). If the payment is not created, the most likely reason is incorrect input data.

The DeleteAgencyBalance method allows you to delete previously added balance information. The method allows only data created via the web service to be deleted. As a result of method execution, a DeleteStatus object is returned.

Method call format:

DeleteAgencyBalance(AuthHeader authHeader, int agencyBalanceID)

agencyBalanceID is the ID of the previously added balance.