DocCloud API

CreateCashBankRecordCommand

The following routes are available for this service:
POST	/cashbank/record	Create cash bank record

**CashBankRecordDto** Parameters:
Name	Parameter	Data Type	Required
CashBankAccountId	form	uint	No
CashBankAccountType	form	int	No
ReportId	form	uint	No
NumberInReport	form	string	No
Document	form	string	No
DocumentNumber	form	string	No
DocumentForeignNumber	form	string	No
IdentifierHashCode	form	int	No
IsDuplicate	form	bool	No
OperationDate	form	DateTime	No
OperationType	form	int	No
OperationAmount	form	decimal	No
RegulatedAmount	form	decimal	No
IsCleared	form	bool	No
IsIncome	form	bool	No
Income	form	decimal	No
Outgoing	form	decimal	No
IncomeInCurrency	form	decimal	No
OutgoingInCurrency	form	decimal	No
RegulationStatus	form	int	No
ToRegulate	form	decimal	No
Recipient	form	RecipientDto	No
RecipientDetails	form	string	No
RecipientIban	form	string	No
UpdateRecipient	form	bool	No
CategoryName	form	string	No
CategoryId	form	uint	No
Description	form	string	No
OppositeAccount	form	string	No
DocumentCurrency	form	string	No
DocumentCurrencyId	form	uint	No
RegulationCurrency	form	string	No
RegulationCurrencyId	form	uint	No
Salary	form	bool	No
MppSplitPayment	form	bool	No
TaxAmount	form	bool	No
ValidateAmountWithDocuments	form	bool	No
Status	form	int	No
StatusMW	form	int	No
Documents	form	IList<CashBankRecordDocumentDto>	No
Labels	form	string	No

**BaseKeyLongDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	ulong	No

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

**BaseKeyDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	uint	No

**CashBankRecordDocumentDto** Parameters:
Name	Parameter	Data Type	Required
InvoiceNumber	form	string	No
InvoiceSellDate	form	DateTime	No
InvoiceDeadLine	form	DateTime	No
CashBankRecordNumber	form	string	No
RegulatedAmount	form	decimal	No
CashBankRecordId	form	ulong	No
SettlementId	form	ulong	No
IsDeleted	form	bool	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 .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 /cashbank/record HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCashBankRecordCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Command">
  <CreatedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</CreatedById>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</Id>
  <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</ModifiedById>
  <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</ModifiedDate>
  <CashBankAccountId xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</CashBankAccountId>
  <CashBankAccountType xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</CashBankAccountType>
  <CategoryId xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</CategoryId>
  <CategoryName xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</CategoryName>
  <Description xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</Description>
  <Document xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</Document>
  <DocumentCurrency xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</DocumentCurrency>
  <DocumentCurrencyId xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</DocumentCurrencyId>
  <DocumentForeignNumber xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</DocumentForeignNumber>
  <DocumentNumber xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</DocumentNumber>
  <Documents i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model" />
  <IdentifierHashCode xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</IdentifierHashCode>
  <Income xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</Income>
  <IncomeInCurrency xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</IncomeInCurrency>
  <IsCleared xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</IsCleared>
  <IsDuplicate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</IsDuplicate>
  <IsIncome xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</IsIncome>
  <Labels xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</Labels>
  <MppSplitPayment xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</MppSplitPayment>
  <NumberInReport xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</NumberInReport>
  <OperationAmount xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</OperationAmount>
  <OperationDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0001-01-01T00:00:00</OperationDate>
  <OperationType xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</OperationType>
  <OppositeAccount xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</OppositeAccount>
  <Outgoing xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</Outgoing>
  <OutgoingInCurrency xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</OutgoingInCurrency>
  <Recipient xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Model" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">
    <CreatedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</CreatedById>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</Id>
    <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</ModifiedById>
    <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</ModifiedDate>
    <d2p1:BankAccName>String</d2p1:BankAccName>
    <d2p1:BankAccNumber>String</d2p1:BankAccNumber>
    <d2p1:CatId>0</d2p1:CatId>
    <d2p1:CategoryId>0</d2p1:CategoryId>
    <d2p1:CategoryName>String</d2p1:CategoryName>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CountryId>0</d2p1:CountryId>
    <d2p1:DefaultCurrency>String</d2p1:DefaultCurrency>
    <d2p1:DefaultCurrencyId>0</d2p1:DefaultCurrencyId>
    <d2p1:DefaultDiscount>0</d2p1:DefaultDiscount>
    <d2p1:DefaultPaymentTerm>0</d2p1:DefaultPaymentTerm>
    <d2p1:DefaultPaymentType>String</d2p1:DefaultPaymentType>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FaxNumber>String</d2p1:FaxNumber>
    <d2p1:IsoCountry>String</d2p1:IsoCountry>
    <d2p1:Krs>String</d2p1:Krs>
    <d2p1:MobileNumber>String</d2p1:MobileNumber>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Nip>String</d2p1:Nip>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:PhoneNumber1>String</d2p1:PhoneNumber1>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:RecipientCType>String</d2p1:RecipientCType>
    <d2p1:Regon>String</d2p1:Regon>
    <d2p1:ShortName>String</d2p1:ShortName>
    <d2p1:StreetFlatNumber>String</d2p1:StreetFlatNumber>
    <d2p1:StreetName>String</d2p1:StreetName>
    <d2p1:StreetNumber>String</d2p1:StreetNumber>
    <d2p1:Town>String</d2p1:Town>
    <d2p1:TypeId>0</d2p1:TypeId>
    <d2p1:WebSite>String</d2p1:WebSite>
  </Recipient>
  <RecipientDetails xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</RecipientDetails>
  <RecipientIban xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</RecipientIban>
  <RegulatedAmount xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</RegulatedAmount>
  <RegulationCurrency xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">String</RegulationCurrency>
  <RegulationCurrencyId xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</RegulationCurrencyId>
  <RegulationStatus xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</RegulationStatus>
  <ReportId xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</ReportId>
  <Salary xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</Salary>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</Status>
  <StatusMW xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">0</StatusMW>
  <TaxAmount xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</TaxAmount>
  <UpdateRecipient xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</UpdateRecipient>
  <ValidateAmountWithDocuments xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.Model">false</ValidateAmountWithDocuments>
</CreateCashBankRecordCommand>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCashBankRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.CashBankRecord.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>
</CreateCashBankRecordResponse>