GET api/customercheck/{id}/{option}

Returns a set of Customer Check records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all check records for Customer where id = customerId.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
option		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerCheck

Name	Description	Type	Additional information
DepositCheckId	Sedona internal autonumber for the check record	integer	None.
TransactionDate		string	None.
PaymentMethodId	Foreign key from AR_Payment_Method table	integer	None.
PaymentMethodCode		string	String length: inclusive between 0 and 25
CustomerId	Foreign key from AR_Customer table	integer	None.
CheckNumber		string	String length: inclusive between 0 and 20
CheckDate		string	None.
Amount		decimal number	None.
Memo		string	String length: inclusive between 0 and 50

Response Formats

application/json, text/json

Sample:

[
  {
    "DepositCheckId": 1,
    "TransactionDate": "sample string 2",
    "PaymentMethodId": 3,
    "PaymentMethodCode": "sample string 4",
    "CustomerId": 5,
    "CheckNumber": "sample string 6",
    "CheckDate": "sample string 7",
    "Amount": 8.0,
    "Memo": "sample string 9"
  },
  {
    "DepositCheckId": 1,
    "TransactionDate": "sample string 2",
    "PaymentMethodId": 3,
    "PaymentMethodCode": "sample string 4",
    "CustomerId": 5,
    "CheckNumber": "sample string 6",
    "CheckDate": "sample string 7",
    "Amount": 8.0,
    "Memo": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CustomerCheck>
    <Amount>8</Amount>
    <CheckDate>sample string 7</CheckDate>
    <CheckNumber>sample string 6</CheckNumber>
    <CustomerId>5</CustomerId>
    <DepositCheckId>1</DepositCheckId>
    <Memo>sample string 9</Memo>
    <PaymentMethodCode>sample string 4</PaymentMethodCode>
    <PaymentMethodId>3</PaymentMethodId>
    <TransactionDate>sample string 2</TransactionDate>
  </CustomerCheck>
  <CustomerCheck>
    <Amount>8</Amount>
    <CheckDate>sample string 7</CheckDate>
    <CheckNumber>sample string 6</CheckNumber>
    <CustomerId>5</CustomerId>
    <DepositCheckId>1</DepositCheckId>
    <Memo>sample string 9</Memo>
    <PaymentMethodCode>sample string 4</PaymentMethodCode>
    <PaymentMethodId>3</PaymentMethodId>
    <TransactionDate>sample string 2</TransactionDate>
  </CustomerCheck>
</ArrayOfCustomerCheck>