GET api/cheque/{id}

Get Cheque by unique ID.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/cheque/{id}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Cheque id.	integer	Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns a cheque for a given id.

ChequeDto

Name	Description	Type	Additional information
ChequeID	Unique identifier of a cheque.	integer
Amount	Cheque's Amount.	decimal number
SortCode	Sort code of a cheque.	string	This value will be ignored if user edits a cheque.
ChequeNumber	Number of a cheque.	string
Date	Cheque's Date.	string
PayType	Cheque PayType.	ChequePayTypes	This value will be ignored if user edits a cheque.
CurrencyID	CurrencyID of a cheque.	integer	This value will be ignored if user edits a cheque.
Status	Cheque's Status.	ChequeStatus	This value will be ignored if user edits a cheque.
ExchangeStatus	Cheque's exchnage status.	ChequeExchangeStatus	This value will be ignored if user edits a cheque.

Response Formats

application/json, text/json

Sample:

{
  "chequeID": 1,
  "amount": 1.0,
  "sortCode": "sample string 1",
  "chequeNumber": "sample string 2",
  "date": "sample string 3",
  "payType": 1,
  "currencyID": 1,
  "status": 0,
  "exchangeStatus": 0
}

application/xml, text/xml

Sample:

<ChequeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <Amount>1</Amount>
  <ChequeID>1</ChequeID>
  <ChequeNumber>sample string 2</ChequeNumber>
  <CurrencyID>1</CurrencyID>
  <Date>sample string 3</Date>
  <ExchangeStatus>Unknown</ExchangeStatus>
  <PayType>InternalPersonalCheque</PayType>
  <SortCode>sample string 1</SortCode>
  <Status>Unknown</Status>
</ChequeDto>