DocCloud API

<back to all web services

RecipientCreateCommand

Requires Authentication
The following routes are available for this service:
POST/recipientCreate Recipient
RecipientCreateCommand Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
ShortNamebodystringNo
NipbodystringNo
RegonbodystringNo
KrsbodystringNo
CatIdbodyuintNo
TypeIdbodyuintNo
RecipientCTypebodystringNo
DescriptionbodystringNo
StreetNamebodystringNo
StreetNumberbodystringNo
StreetFlatNumberbodystringNo
PostalCodebodystringNo
TownbodystringNo
CountryIdbodyintNo
IsoCountrybodystringNo
CountrybodystringNo
EmailbodystringNo
WebSitebodystringNo
PhoneNumberbodystringNo
FaxNumberbodystringNo
PhoneNumber1bodystringNo
MobileNumberbodystringNo
BankAccNamebodystringNo
BankAccNumberbodystringNo
DefaultPaymentTypebodystringNo
DefaultPaymentTermbodyuintNo
DefaultDiscountbodydecimalNo
DefaultCurrencyIdbodyuintNo
DefaultCurrencybodystringNo
CategoryIdbodyuintNo
CategoryNamebodystringNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RecipientCreateCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Command">
  <BankAccName>String</BankAccName>
  <BankAccNumber>String</BankAccNumber>
  <CatId>0</CatId>
  <CategoryId>0</CategoryId>
  <CategoryName>String</CategoryName>
  <Country>String</Country>
  <CountryId>0</CountryId>
  <DefaultCurrency>String</DefaultCurrency>
  <DefaultCurrencyId>0</DefaultCurrencyId>
  <DefaultDiscount>0</DefaultDiscount>
  <DefaultPaymentTerm>0</DefaultPaymentTerm>
  <DefaultPaymentType>String</DefaultPaymentType>
  <Description>String</Description>
  <Email>String</Email>
  <FaxNumber>String</FaxNumber>
  <IsoCountry>String</IsoCountry>
  <Krs>String</Krs>
  <MobileNumber>String</MobileNumber>
  <Name>String</Name>
  <Nip>String</Nip>
  <PhoneNumber>String</PhoneNumber>
  <PhoneNumber1>String</PhoneNumber1>
  <PostalCode>String</PostalCode>
  <RecipientCType>String</RecipientCType>
  <Regon>String</Regon>
  <ShortName>String</ShortName>
  <StreetFlatNumber>String</StreetFlatNumber>
  <StreetName>String</StreetName>
  <StreetNumber>String</StreetNumber>
  <Town>String</Town>
  <TypeId>0</TypeId>
  <WebSite>String</WebSite>
</RecipientCreateCommand>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecipientCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Command">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global" />
  <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global">0</Id>
</RecipientCreateResponse>