DocCloud API

RecipientCreateCommand

The following routes are available for this service:
POST	/recipient	Create Recipient

**RecipientCreateCommand** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
ShortName	body	string	No
Nip	body	string	No
Regon	body	string	No
Krs	body	string	No
CatId	body	uint	No
TypeId	body	uint	No
RecipientCType	body	string	No
Description	body	string	No
StreetName	body	string	No
StreetNumber	body	string	No
StreetFlatNumber	body	string	No
PostalCode	body	string	No
Town	body	string	No
CountryId	body	int	No
IsoCountry	body	string	No
Country	body	string	No
Email	body	string	No
WebSite	body	string	No
PhoneNumber	body	string	No
FaxNumber	body	string	No
PhoneNumber1	body	string	No
MobileNumber	body	string	No
BankAccName	body	string	No
BankAccNumber	body	string	No
DefaultPaymentType	body	string	No
DefaultPaymentTerm	body	uint	No
DefaultDiscount	body	decimal	No
DefaultCurrencyId	body	uint	No
DefaultCurrency	body	string	No
CategoryId	body	uint	No
CategoryName	body	string	No

**PostOperationResult<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	T	No

**OperationResult** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
ResponseStatus	form	ResponseStatus	No
Result	form	Object	No
IsSuccess	form	bool	No

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.

POST /recipient HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	shortName: 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
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	code: FAIL,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	result: {},
	isSuccess: False
}