POST api/PaymentSetup/CheckAddUpdate

Add/Update Check Configuration.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DocumentId	Unique Document Id - Not required	integer	None.
ClientId	Client Id - Required	integer	None.
VendorCode	Vendor Code - Required, 50 character max	string	None.
PayeeName1	Payee Name 1 - Required, 150 character max	string	None.
PayeeName2	Payee Name 2 - Not Required, 150 character max	string	None.
Address1	Address Line 1 - Required, 150 character max	string	None.
Address2	Address Line 2 - Not Required, 150 character max	string	None.
City	City - Required, 50 character max	string	None.
State	State - Required, 50 character max	string	None.
Zip	Zip Code - Required, 50 character max	string	None.
Country	Country - Required, 50 character max	string	None.
IsValid	Is Valid - Not required	boolean	None.
IsApproved	Is Approved - Not required	boolean	None.
ClientName	Client Name - Read Only	string	None.
CompanyCode	Comany Code - Not Required, 50 character max	string	None.
CompanyName	Company Name - Read Only	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "ClientId": 2,
  "VendorCode": "sample string 3",
  "PayeeName1": "sample string 4",
  "PayeeName2": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "Zip": "sample string 10",
  "Country": "sample string 11",
  "IsValid": true,
  "IsApproved": true,
  "ClientName": "sample string 14",
  "CompanyCode": "sample string 15",
  "CompanyName": "sample string 16"
}

application/xml, text/xml

Sample:

<PaymentSetupController.CheckConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <City>sample string 8</City>
  <ClientId>2</ClientId>
  <ClientName>sample string 14</ClientName>
  <CompanyCode>sample string 15</CompanyCode>
  <CompanyName>sample string 16</CompanyName>
  <Country>sample string 11</Country>
  <DocumentId>1</DocumentId>
  <IsApproved>true</IsApproved>
  <IsValid>true</IsValid>
  <PayeeName1>sample string 4</PayeeName1>
  <PayeeName2>sample string 5</PayeeName2>
  <State>sample string 9</State>
  <VendorCode>sample string 3</VendorCode>
  <Zip>sample string 10</Zip>
</PaymentSetupController.CheckConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResult

Name	Description	Type	Additional information
IsValid	API call result	boolean	None.
Comments	Comments about the activities of the API call	string	None.
Errors	List of 0 to many errors encountered processing the API call	Collection of ErrorMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "Comments": "sample string 2",
  "Errors": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
  <Comments>sample string 2</Comments>
  <Errors>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
  </Errors>
  <IsValid>true</IsValid>
</APIResult>