POST api/ApiIntegration/SBSetJobPayment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
JobOrQuoteNumber	string	None.
PayDetail1	string	None.
PayDetail2	string	None.
PayDetail3	string	None.
Date1Str	string	None.
Date2Str	string	None.
Date3Str	string	None.
PaidAmt1	string	None.
PaidAmt2	string	None.
PaidAmt3	string	None.
PayType1	string	None.
PayType2	string	None.
PayType3	string	None.
PayNotes	string	None.
IsSplit	boolean	None.
SplitMode	integer	None.
UpdatePay1	boolean	None.
UpdatePay2	boolean	None.
UpdatePay3	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobOrQuoteNumber": "sample string 2",
  "payDetail1": "sample string 3",
  "payDetail2": "sample string 4",
  "payDetail3": "sample string 5",
  "date1Str": "sample string 6",
  "date2Str": "sample string 7",
  "date3Str": "sample string 8",
  "paidAmt1": "sample string 9",
  "paidAmt2": "sample string 10",
  "paidAmt3": "sample string 11",
  "payType1": "sample string 12",
  "payType2": "sample string 13",
  "payType3": "sample string 14",
  "payNotes": "sample string 15",
  "isSplit": true,
  "splitMode": 17,
  "updatePay1": true,
  "updatePay2": true,
  "updatePay3": true
}

application/xml, text/xml

Sample:

<ApiSetJobPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Date1Str>sample string 6</Date1Str>
  <Date2Str>sample string 7</Date2Str>
  <Date3Str>sample string 8</Date3Str>
  <IsSplit>true</IsSplit>
  <JobOrQuoteNumber>sample string 2</JobOrQuoteNumber>
  <PaidAmt1>sample string 9</PaidAmt1>
  <PaidAmt2>sample string 10</PaidAmt2>
  <PaidAmt3>sample string 11</PaidAmt3>
  <PayDetail1>sample string 3</PayDetail1>
  <PayDetail2>sample string 4</PayDetail2>
  <PayDetail3>sample string 5</PayDetail3>
  <PayNotes>sample string 15</PayNotes>
  <PayType1>sample string 12</PayType1>
  <PayType2>sample string 13</PayType2>
  <PayType3>sample string 14</PayType3>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <SplitMode>17</SplitMode>
  <UpdatePay1>true</UpdatePay1>
  <UpdatePay2>true</UpdatePay2>
  <UpdatePay3>true</UpdatePay3>
</ApiSetJobPayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "8cc4239a-5d41-4f1f-be2d-1dd0903e6212",
  "responseNote": "sample string 2"
}

application/xml, text/xml

Sample:

<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>8cc4239a-5d41-4f1f-be2d-1dd0903e6212</ReturnKey>
</ApiResponse>