POST api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Request Information

URI Parameters

Name	Type	Additional information
VendorID	string	Required
VendorPassword	string	Required
APIGUID	string	Required

Body Parameters

VendorPayWorkOrder

Name	Type	Additional information
VendorPayKey	integer	None.
VendorLocationKey	integer	None.
CompanyKey	integer	None.
vp_Amount	decimal number	None.
vp_Date	date	None.
vp_Due	date	None.
vp_Memo	string	None.
vp_Type	integer	None.
GLAccountKey	integer	None.
vp_PaymentMethod	integer	None.
vp_Approved	boolean	None.
vp_Modified	boolean	None.
ResidentKey	integer	None.
vp_Workorder	boolean	None.
vp_WOEmployeeCreated	integer	None.
vp_WOEmployeeApproved	integer	None.
vp_WODate	date	None.
vp_WODue	date	None.
vp_WOApproved	date	None.
vp_WOCompleted	date	None.
vp_WOType	string	None.
vp_Recurring	integer	None.
vp_RecurringPeriod	integer	None.
vp_NextNextRecurring	date	None.
vp_WOModified	boolean	None.
vp_WOJobNumber	string	None.
vp_WOStatus	string	None.
vp_Memorized	boolean	None.
vp_MemorizeName	string	None.
UnitAddress	string	None.
ResidentName	string	None.
UnitKey	integer	None.
vp_DefaultUnitKey	integer	None.
VendorLocation	string	None.
VendorName	string	None.
VendorType	string	None.
vpd_FileName	string	None.
VendorPayDetailKey	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "VendorPayKey": 1,
  "VendorLocationKey": 2,
  "CompanyKey": 3,
  "vp_Amount": 4.0,
  "vp_Date": "2024-12-18T12:24:09.9209457-05:00",
  "vp_Due": "2024-12-18T12:24:09.9209457-05:00",
  "vp_Memo": "sample string 7",
  "vp_Type": 8,
  "GLAccountKey": 9,
  "vp_PaymentMethod": 10,
  "vp_Approved": true,
  "vp_Modified": true,
  "ResidentKey": 13,
  "vp_Workorder": true,
  "vp_WOEmployeeCreated": 15,
  "vp_WOEmployeeApproved": 16,
  "vp_WODate": "2024-12-18T12:24:09.9209457-05:00",
  "vp_WODue": "2024-12-18T12:24:09.9209457-05:00",
  "vp_WOApproved": "2024-12-18T12:24:09.9209457-05:00",
  "vp_WOCompleted": "2024-12-18T12:24:09.9209457-05:00",
  "vp_WOType": "sample string 21",
  "vp_Recurring": 22,
  "vp_RecurringPeriod": 23,
  "vp_NextNextRecurring": "2024-12-18T12:24:09.9209457-05:00",
  "vp_WOModified": true,
  "vp_WOJobNumber": "sample string 26",
  "vp_WOStatus": "sample string 27",
  "vp_Memorized": true,
  "vp_MemorizeName": "sample string 29",
  "UnitAddress": "sample string 30",
  "ResidentName": "sample string 31",
  "UnitKey": 32,
  "vp_DefaultUnitKey": 33,
  "VendorLocation": "sample string 34",
  "VendorName": "sample string 35",
  "VendorType": "sample string 36",
  "vpd_FileName": "sample string 37",
  "VendorPayDetailKey": 38
}

application/xml, text/xml

Sample:

<VendorPayWorkOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesAP">
  <CompanyKey>3</CompanyKey>
  <GLAccountKey>9</GLAccountKey>
  <ResidentKey>13</ResidentKey>
  <ResidentName>sample string 31</ResidentName>
  <UnitAddress>sample string 30</UnitAddress>
  <UnitKey>32</UnitKey>
  <VendorLocation>sample string 34</VendorLocation>
  <VendorLocationKey>2</VendorLocationKey>
  <VendorName>sample string 35</VendorName>
  <VendorPayDetailKey>38</VendorPayDetailKey>
  <VendorPayKey>1</VendorPayKey>
  <VendorType>sample string 36</VendorType>
  <vp_Amount>4</vp_Amount>
  <vp_Approved>true</vp_Approved>
  <vp_Date>2024-12-18T12:24:09.9209457-05:00</vp_Date>
  <vp_DefaultUnitKey>33</vp_DefaultUnitKey>
  <vp_Due>2024-12-18T12:24:09.9209457-05:00</vp_Due>
  <vp_Memo>sample string 7</vp_Memo>
  <vp_MemorizeName>sample string 29</vp_MemorizeName>
  <vp_Memorized>true</vp_Memorized>
  <vp_Modified>true</vp_Modified>
  <vp_NextNextRecurring>2024-12-18T12:24:09.9209457-05:00</vp_NextNextRecurring>
  <vp_PaymentMethod>10</vp_PaymentMethod>
  <vp_Recurring>22</vp_Recurring>
  <vp_RecurringPeriod>23</vp_RecurringPeriod>
  <vp_Type>8</vp_Type>
  <vp_WOApproved>2024-12-18T12:24:09.9209457-05:00</vp_WOApproved>
  <vp_WOCompleted>2024-12-18T12:24:09.9209457-05:00</vp_WOCompleted>
  <vp_WODate>2024-12-18T12:24:09.9209457-05:00</vp_WODate>
  <vp_WODue>2024-12-18T12:24:09.9209457-05:00</vp_WODue>
  <vp_WOEmployeeApproved>16</vp_WOEmployeeApproved>
  <vp_WOEmployeeCreated>15</vp_WOEmployeeCreated>
  <vp_WOJobNumber>sample string 26</vp_WOJobNumber>
  <vp_WOModified>true</vp_WOModified>
  <vp_WOStatus>sample string 27</vp_WOStatus>
  <vp_WOType>sample string 21</vp_WOType>
  <vp_Workorder>true</vp_Workorder>
  <vpd_FileName>sample string 37</vpd_FileName>
</VendorPayWorkOrder>

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 'VendorPayWorkOrder'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.