DocCloud API

<back to all web services

GetRecipientGUSQuery

Requires Authentication
The following routes are available for this service:
GET/recipient/GUS/{NIP}Get recipient by it's NIP.
GetRecipientGUSQuery Parameters:
NameParameterData TypeRequiredDescription
NippathstringNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
RecipientDto Parameters:
NameParameterData TypeRequiredDescription
ShortNameformstringNo
NameformstringNo
NipformstringNo
RegonformstringNo
KrsformstringNo
CatIdformuintNo
TypeIdformintNo
RecipientCTypeformstringNo
DescriptionformstringNo
StreetNameformstringNo
StreetNumberformstringNo
StreetFlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
WebSiteformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
PhoneNumber1formstringNo
MobileNumberformstringNo
BankAccNameformstringNo
BankAccNumberformstringNo
DefaultPaymentTypeformstringNo
DefaultPaymentTermformuintNo
DefaultDiscountformdecimalNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /recipient/GUS/{NIP} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		shortName: String,
		name: String,
		nip: String,
		regon: String,
		krs: String,
		catId: 0,
		typeId: 0,
		recipientCType: String,
		description: String,
		streetName: String,
		streetNumber: String,
		streetFlatNumber: String,
		postalCode: String,
		town: String,
		countryId: 0,
		isoCountry: String,
		country: String,
		email: String,
		webSite: String,
		phoneNumber: String,
		faxNumber: String,
		phoneNumber1: String,
		mobileNumber: String,
		bankAccName: String,
		bankAccNumber: String,
		defaultPaymentType: String,
		defaultPaymentTerm: 0,
		defaultDiscount: 0,
		defaultCurrencyId: 0,
		defaultCurrency: String,
		categoryId: 0,
		categoryName: String,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}