DocCloud API

<back to all web services

GetCashBankRecordQuery

Requires Authentication
The following routes are available for this service:
GET/cashbank/record/{id}Get cashBankRecord by Id
GetCashBankRecordQuery Parameters:
NameParameterData TypeRequiredDescription
IdpathulongNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
CashBankRecordDto Parameters:
NameParameterData TypeRequiredDescription
CashBankAccountIdformuintNo
CashBankAccountTypeformintNo
ReportIdformuintNo
NumberInReportformstringNo
DocumentformstringNo
DocumentNumberformstringNo
DocumentForeignNumberformstringNo
IdentifierHashCodeformintNo
IsDuplicateformboolNo
OperationDateformDateTimeNo
OperationTypeformintNo
OperationAmountformdecimalNo
RegulatedAmountformdecimalNo
IsClearedformboolNo
IsIncomeformboolNo
IncomeformdecimalNo
OutgoingformdecimalNo
IncomeInCurrencyformdecimalNo
OutgoingInCurrencyformdecimalNo
RegulationStatusformintNo
ToRegulateformdecimalNo
RecipientformRecipientDtoNo
RecipientDetailsformstringNo
RecipientIbanformstringNo
UpdateRecipientformboolNo
CategoryNameformstringNo
CategoryIdformuintNo
DescriptionformstringNo
OppositeAccountformstringNo
DocumentCurrencyformstringNo
DocumentCurrencyIdformuintNo
RegulationCurrencyformstringNo
RegulationCurrencyIdformuintNo
SalaryformboolNo
MppSplitPaymentformboolNo
TaxAmountformboolNo
ValidateAmountWithDocumentsformboolNo
StatusformintNo
StatusMWformintNo
DocumentsformIList<CashBankRecordDocumentDto>No
LabelsformstringNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
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
CashBankRecordDocumentDto Parameters:
NameParameterData TypeRequiredDescription
InvoiceNumberformstringNo
InvoiceSellDateformDateTimeNo
InvoiceDeadLineformDateTimeNo
CashBankRecordNumberformstringNo
RegulatedAmountformdecimalNo
CashBankRecordIdformulongNo
SettlementIdformulongNo
IsDeletedformboolNo

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.

GET /cashbank/record/{id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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