DocCloud API

ListCashBankRecordQuery

The following routes are available for this service:
GET	/cashbank/record	List cash bank records

**ListCashBankRecordQuery** Parameters:
Name	Parameter	Data Type	Required
CashBankAccountId	query	List<uint>	No
CashBankAccountType	query	int	No
IsIncome	query	bool?	No
IsCleared	query	bool?	No
RecId	query	uint	No
IsRecIdEmpty	query	bool	No
RecName	query	string	No
RecShortName	query	string	No
DocumentNumber	query	string	No
OperationDateFrom	query	DateTime	No
OperationDateTo	query	DateTime	No
IncomeFrom	query	decimal	No
IncomeTo	query	decimal	No
OutgoingFrom	query	decimal	No
OutgoingTo	query	decimal	No
IncomeInCurrencyFrom	query	decimal	No
IncomeInCurrencyTo	query	decimal	No
OutgoingInCurrencyFrom	query	decimal	No
OutgoingInCurrencyTo	query	decimal	No
DocumentCurrency	query	string	No
DocumentCurrencyId	query	uint	No
RegulationCurrency	query	string	No
RegulationCurrencyId	query	uint	No
Category	query	string	No
Status	query	List<int>	No
StatusMW	query	List<int>	No

**PaginatedOrderedRequestBase** Parameters:
Name	Parameter	Data Type	Required
OrderBy	form	string	No
SortType	form	string	No
Pages	form	int	No
Amount	form	int	No

**BaseResponse<T>** Parameters:
Name	Parameter	Data Type	Required
MultipleResult	form	IList<T>	No
Total	form	int	No
Offset	form	int	No

**BaseSingleResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	T	No

**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

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 /cashbank/record HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv

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

{
	total: 0,
	offset: 0,
	result: 
	{
		cashBankAccountId: 0,
		cashBankAccountType: 0,
		reportId: 0,
		numberInReport: String,
		document: String,
		documentNumber: String,
		documentForeignNumber: String,
		identifierHashCode: 0,
		isDuplicate: False,
		operationDate: 0001-01-01,
		operationType: 0,
		operationAmount: 0,
		regulatedAmount: 0,
		isCleared: False,
		isIncome: False,
		income: 0,
		outgoing: 0,
		incomeInCurrency: 0,
		outgoingInCurrency: 0,
		regulationStatus: 0,
		toRegulate: 0,
		recipient: 
		{
			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
		},
		recipientDetails: String,
		recipientIban: String,
		updateRecipient: False,
		categoryName: String,
		categoryId: 0,
		description: String,
		oppositeAccount: String,
		documentCurrency: String,
		documentCurrencyId: 0,
		regulationCurrency: String,
		regulationCurrencyId: 0,
		salary: False,
		mppSplitPayment: False,
		taxAmount: False,
		validateAmountWithDocuments: False,
		status: 0,
		statusMW: 0,
		labels: String,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}