POST api/apcheck

Creates an APCheck record for a customer refund.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CheckID	Autonumber for AP_Check record	integer	None.
CategoryCode	Category from AR_Category table	string	Required
Amount	check amount	decimal number	Required
Memo	check memo	string	None.
InPrintQueue	set to false if payment has already been processed; set to true to print the check (defaults to true if not supplied)	boolean	None.
CheckDate	date on check; accounting period for this date must be open	string	Required
CustomerNumber	Customer Number	string	Required String length: inclusive between 0 and 15
Other		string	None.
Address1	Address1 to print on check (for Window envelopes)	string	None.
Address2	Address2 to print on check (for Window envelopes)	string	None.
Address3	Address3 to print on check (for Window envelopes)	string	None.
BranchCode	Value from AR_Branch table; defaults to config setting for branchCode if not supplied; list of valid options can be retrieved from GET: api/branch	string	String length: inclusive between 0 and 25
Printed	set to true if payment has already been processed; set to false to print the check (defaults to false if not supplied)	boolean	None.
CheckExpenseDescription	Description for the Check Expense line	string	String length: inclusive between 0 and 25

Request Formats

application/json, text/json

Sample:

{
  "CheckID": 1,
  "CategoryCode": "sample string 2",
  "Amount": 3.0,
  "Memo": "sample string 4",
  "InPrintQueue": true,
  "CheckDate": "sample string 6",
  "CustomerNumber": "sample string 7",
  "Other": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "Address3": "sample string 11",
  "BranchCode": "sample string 12",
  "Printed": true,
  "CheckExpenseDescription": "sample string 14"
}

application/xml, text/xml

Sample:

<APCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address1>sample string 9</Address1>
  <Address2>sample string 10</Address2>
  <Address3>sample string 11</Address3>
  <Amount>3</Amount>
  <BranchCode>sample string 12</BranchCode>
  <CategoryCode>sample string 2</CategoryCode>
  <CheckDate>sample string 6</CheckDate>
  <CheckExpenseDescription>sample string 14</CheckExpenseDescription>
  <CheckID>1</CheckID>
  <CustomerNumber>sample string 7</CustomerNumber>
  <InPrintQueue>true</InPrintQueue>
  <Memo>sample string 4</Memo>
  <Other>sample string 8</Other>
  <Printed>true</Printed>
</APCheck>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'APCheck'.

Response Information

Resource Description

APCheck

Name	Description	Type	Additional information
CheckID	Autonumber for AP_Check record	integer	None.
CategoryCode	Category from AR_Category table	string	Required
Amount	check amount	decimal number	Required
Memo	check memo	string	None.
InPrintQueue	set to false if payment has already been processed; set to true to print the check (defaults to true if not supplied)	boolean	None.
CheckDate	date on check; accounting period for this date must be open	string	Required
CustomerNumber	Customer Number	string	Required String length: inclusive between 0 and 15
Other		string	None.
Address1	Address1 to print on check (for Window envelopes)	string	None.
Address2	Address2 to print on check (for Window envelopes)	string	None.
Address3	Address3 to print on check (for Window envelopes)	string	None.
BranchCode	Value from AR_Branch table; defaults to config setting for branchCode if not supplied; list of valid options can be retrieved from GET: api/branch	string	String length: inclusive between 0 and 25
Printed	set to true if payment has already been processed; set to false to print the check (defaults to false if not supplied)	boolean	None.
CheckExpenseDescription	Description for the Check Expense line	string	String length: inclusive between 0 and 25

Response Formats

application/json, text/json

Sample:

{
  "CheckID": 1,
  "CategoryCode": "sample string 2",
  "Amount": 3.0,
  "Memo": "sample string 4",
  "InPrintQueue": true,
  "CheckDate": "sample string 6",
  "CustomerNumber": "sample string 7",
  "Other": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "Address3": "sample string 11",
  "BranchCode": "sample string 12",
  "Printed": true,
  "CheckExpenseDescription": "sample string 14"
}

application/xml, text/xml

Sample:

<APCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address1>sample string 9</Address1>
  <Address2>sample string 10</Address2>
  <Address3>sample string 11</Address3>
  <Amount>3</Amount>
  <BranchCode>sample string 12</BranchCode>
  <CategoryCode>sample string 2</CategoryCode>
  <CheckDate>sample string 6</CheckDate>
  <CheckExpenseDescription>sample string 14</CheckExpenseDescription>
  <CheckID>1</CheckID>
  <CustomerNumber>sample string 7</CustomerNumber>
  <InPrintQueue>true</InPrintQueue>
  <Memo>sample string 4</Memo>
  <Other>sample string 8</Other>
  <Printed>true</Printed>
</APCheck>