documentation
This commit is contained in:
parent
c1c47af913
commit
39ff60246b
8 changed files with 87 additions and 1 deletions
|
@ -24,6 +24,7 @@
|
||||||
<DefineConstants>DEBUG;TRACE</DefineConstants>
|
<DefineConstants>DEBUG;TRACE</DefineConstants>
|
||||||
<ErrorReport>prompt</ErrorReport>
|
<ErrorReport>prompt</ErrorReport>
|
||||||
<WarningLevel>4</WarningLevel>
|
<WarningLevel>4</WarningLevel>
|
||||||
|
<DocumentationFile>bin\Debug\FCS.Lib.Vies.xml</DocumentationFile>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
||||||
<DebugType>pdbonly</DebugType>
|
<DebugType>pdbonly</DebugType>
|
||||||
|
|
|
@ -28,12 +28,33 @@ using System;
|
||||||
|
|
||||||
namespace FCS.Lib.Vies;
|
namespace FCS.Lib.Vies;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Vies Entity Model
|
||||||
|
/// </summary>
|
||||||
public class ViesEntityModel
|
public class ViesEntityModel
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Business entity's country code of origin
|
||||||
|
/// </summary>
|
||||||
public string CountryCode { get; set; }
|
public string CountryCode { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Business entity vat number
|
||||||
|
/// </summary>
|
||||||
public string VatNumber { get; set; }
|
public string VatNumber { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Request date
|
||||||
|
/// </summary>
|
||||||
public DateTime RequestDate { get; set; }
|
public DateTime RequestDate { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Valid flag
|
||||||
|
/// </summary>
|
||||||
public bool Valid { get; set; }
|
public bool Valid { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Business entity name
|
||||||
|
/// </summary>
|
||||||
public string Name { get; set; }
|
public string Name { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Business entity address
|
||||||
|
/// </summary>
|
||||||
public string Address { get; set; }
|
public string Address { get; set; }
|
||||||
}
|
}
|
|
@ -29,11 +29,24 @@ using System.Threading.Tasks;
|
||||||
|
|
||||||
namespace FCS.Lib.Vies
|
namespace FCS.Lib.Vies
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// http request to vies registrar
|
||||||
|
/// </summary>
|
||||||
public class ViesHttpRequest
|
public class ViesHttpRequest
|
||||||
{
|
{
|
||||||
// "http://ec.europa.eu/taxation_customs/vies/services/checkVatService"
|
/// <summary>
|
||||||
|
/// Async http request to vies registrar
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="endpoint"></param>
|
||||||
|
/// <param name="countryCode"></param>
|
||||||
|
/// <param name="vatNumber"></param>
|
||||||
|
/// <param name="userAgent"></param>
|
||||||
|
/// <returns>Vies Response View model</returns>
|
||||||
|
/// <see cref="ViesResponseView"/>
|
||||||
|
/// <remarks>Service http://ec.europa.eu/taxation_customs/vies/services/checkVatService</remarks>
|
||||||
public async Task<ViesResponseView> GetResponseAsync(string endpoint, string countryCode, string vatNumber, string userAgent)
|
public async Task<ViesResponseView> GetResponseAsync(string endpoint, string countryCode, string vatNumber, string userAgent)
|
||||||
{
|
{
|
||||||
|
|
||||||
var xml = new StringBuilder();
|
var xml = new StringBuilder();
|
||||||
xml.Append($"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\"urn:ec.europa.eu:taxud:vies:services:checkVat:types\">");
|
xml.Append($"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\"urn:ec.europa.eu:taxud:vies:services:checkVat:types\">");
|
||||||
xml.Append($"<soapenv:Header/>");
|
xml.Append($"<soapenv:Header/>");
|
||||||
|
|
|
@ -25,8 +25,17 @@
|
||||||
// ***********************************************************************
|
// ***********************************************************************
|
||||||
namespace FCS.Lib.Vies;
|
namespace FCS.Lib.Vies;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Vies Query model
|
||||||
|
/// </summary>
|
||||||
public class ViesQuery
|
public class ViesQuery
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Country code for country to query
|
||||||
|
/// </summary>
|
||||||
public string CountryCode { get; set; }
|
public string CountryCode { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// Vat number to query
|
||||||
|
/// </summary>
|
||||||
public string VatNumber { get; set; }
|
public string VatNumber { get; set; }
|
||||||
}
|
}
|
|
@ -26,8 +26,17 @@
|
||||||
|
|
||||||
namespace FCS.Lib.Vies;
|
namespace FCS.Lib.Vies;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Vies Query Validator
|
||||||
|
/// </summary>
|
||||||
public static class ViesQueryValidator
|
public static class ViesQueryValidator
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Validate Vies query
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="query"></param>
|
||||||
|
/// <returns>bool indicating valid query</returns>
|
||||||
|
/// <see cref="ViesQuery"/>
|
||||||
public static bool ValidateViesQuery(ViesQuery query)
|
public static bool ValidateViesQuery(ViesQuery query)
|
||||||
{
|
{
|
||||||
return !string.IsNullOrWhiteSpace(query.VatNumber) && !string.IsNullOrWhiteSpace(query.CountryCode);
|
return !string.IsNullOrWhiteSpace(query.VatNumber) && !string.IsNullOrWhiteSpace(query.CountryCode);
|
||||||
|
|
|
@ -30,8 +30,17 @@ using System.Xml.Linq;
|
||||||
|
|
||||||
namespace FCS.Lib.Vies;
|
namespace FCS.Lib.Vies;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Vies http response parser
|
||||||
|
/// </summary>
|
||||||
public class ViesResponseParser
|
public class ViesResponseParser
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Parser
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="responseData"></param>
|
||||||
|
/// <returns>Vies Entity Model parsed from XML data</returns>
|
||||||
|
/// <see cref="ViesEntityModel"/>
|
||||||
public ViesEntityModel ParseViesResponse(string responseData)
|
public ViesEntityModel ParseViesResponse(string responseData)
|
||||||
{
|
{
|
||||||
var xml = XDocument.Parse(responseData);
|
var xml = XDocument.Parse(responseData);
|
||||||
|
|
|
@ -27,9 +27,21 @@ using System.Net;
|
||||||
|
|
||||||
namespace FCS.Lib.Vies;
|
namespace FCS.Lib.Vies;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Vies Response view
|
||||||
|
/// </summary>
|
||||||
public class ViesResponseView
|
public class ViesResponseView
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// http request status code
|
||||||
|
/// </summary>
|
||||||
public HttpStatusCode Code { get; set; }
|
public HttpStatusCode Code { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// boolean indicating success
|
||||||
|
/// </summary>
|
||||||
public bool IsSuccessStatusCode { get; set; }
|
public bool IsSuccessStatusCode { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
/// response message
|
||||||
|
/// </summary>
|
||||||
public string Message { get; set; } = "";
|
public string Message { get; set; } = "";
|
||||||
}
|
}
|
|
@ -30,8 +30,20 @@ using FCS.Lib.Common;
|
||||||
|
|
||||||
namespace FCS.Lib.Vies
|
namespace FCS.Lib.Vies
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Vies vat info mapper
|
||||||
|
/// </summary>
|
||||||
public class ViesVatInfoMapper
|
public class ViesVatInfoMapper
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// map vies response to Crm
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="viesEntity"></param>
|
||||||
|
/// <returns>Vat Info Data Transfer Object</returns>
|
||||||
|
/// <see cref="VatInfoDto"/>
|
||||||
|
/// <see cref="ViesEntityModel"/>
|
||||||
|
/// <see cref="VatState"/>
|
||||||
|
/// <see cref="TimeFrame"/>
|
||||||
public VatInfoDto MapViesToCrm(ViesEntityModel viesEntity)
|
public VatInfoDto MapViesToCrm(ViesEntityModel viesEntity)
|
||||||
{
|
{
|
||||||
var addressBlock = viesEntity.Address.Split('\n');
|
var addressBlock = viesEntity.Address.Split('\n');
|
||||||
|
|
Loading…
Reference in a new issue