PUT ApDisburse/ApDisburseVoid

Void an AP disbursement.

Request Information

URI Parameters

Body Parameters

The AP Disburse object used to be voided.

clsApDisburseVoid
NameDescriptionTypeAdditional Information
VendorId

The Vendor ID of the disbursement to be voided.

 string

Required

Max length: 10
CheckNum

The Check Number of the disbursement to be voided.

 integer

Required
InvoiceNum

The invoice Number of the disbursement to be voided.

 string

Required

Max length: 25
CheckDate

The original date of the disbursement to be voided.

 string

Required

Data type: DateTime

Format must be MM/dd/yyyy
NewCheckDate

The new date of the disbursement to be voided.

 string

Data type: DateTime

Format must be MM/dd/yyyy
VoidReason

The reason for the void

 string

Max length: 255

Request Formats

application/json, text/json

Sample: 
{
  "VendorId": "sample string 1",
  "CheckNum": 2,
  "InvoiceNum": "sample string 3",
  "CheckDate": "sample string 4",
  "NewCheckDate": "sample string 5",
  "VoidReason": "sample string 6"
}

application/xml, text/xml

Sample: 
<APDisburseVoid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AP">
  <CheckDate>sample string 4</CheckDate>
  <CheckNum>2</CheckNum>
  <InvoiceNum>sample string 3</InvoiceNum>
  <NewCheckDate>sample string 5</NewCheckDate>
  <VendorId>sample string 1</VendorId>
  <VoidReason>sample string 6</VoidReason>
</APDisburseVoid>

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

Response Information

Resource Description

Void an AP disbursement.

AgvApDisburseVoid
NameDescriptionTypeAdditional Information
Status

Status of the API call.

 string
Message

Message of the API call.

 string
ErrorList

List of error messages of the API call.

 Collection of string
WarningList

List of warning messages of the API call.

 Collection of string

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<AgvApDisburseVoid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvApDisburseVoid>