GET api/Suppliers/GetByVat

Retrieves a supplier by a VAT number and country code

Request Information

URI Parameters

Name	Description	Type	Additional information
VatCountryCode	VAT country code ex. BE, DE, NL	string	Required Max length: 2 Min length: 2
VatNumber	VAT number without the prefix	string	Required Max length: 12

Name

Description

Type

Additional information

VatCountryCode

VAT country code ex. BE, DE, NL

string

Required

Max length: 2

Min length: 2

VatNumber

VAT number without the prefix

string

Required

Max length: 12

URI Example

api/Suppliers/GetByVat?VatCountryCode={VatCountryCode}&VatNumber={VatNumber}

Body Parameters

None.

Response Information

Resource Description

A wrapper class with a supplier

Oresto.API.Models.GET.Suppliers.SupplierByVatData

Name	Description	Type	Additional information
Errors	Possible errors that were experienced when processing the request	Collection of string	None.
RequestInformation	Additional information about the request	Oresto.API.Models.Shared.RequestInformation	None.
Supplier	A supplier	Oresto.API.Models.GET.Suppliers.Supplier	None.

Response Formats

application/json, text/json

Sample:

{
  "Supplier": {
    "Id": 1,
    "Name": "sample string 2",
    "VatCountryCode": "sample string 3",
    "VatNumber": "sample string 4",
    "Active": true
  },
  "RequestInformation": {
    "RequestDuration": 1,
    "WholesalerId": 2,
    "UserId": 3
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<SupplierByVatData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.Suppliers">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
    <RequestDuration>1</RequestDuration>
    <UserId>3</UserId>
    <WholesalerId>2</WholesalerId>
  </RequestInformation>
  <Supplier>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <VatCountryCode>sample string 3</VatCountryCode>
    <VatNumber>sample string 4</VatNumber>
  </Supplier>
</SupplierByVatData>