PUT PurchaseInvoice/VoidPurchaseInvoice

Voids a purchase invoice.

Request Information

URI Parameters

Body Parameters

Purchase Invoice object used to void a purchase invoice.

clsPurInvVoid
NameDescriptionTypeAdditional Information
VendorID

Vendor ID of Purchase Invoice to Void

 string

Required

Max length: 10
InvoiceNumber

Invoice Number of Purchase Invoice to Void

 string

Required

Max length: 15

Must not contain a space or a tic (')
ElectronicNewBill

If EFT Vendor, is New AP Bill Electronic?

 boolean

Request Formats

application/json, text/json

Sample: 
{
  "VendorID": "sample string 3",
  "InvoiceNumber": "sample string 4",
  "ElectronicNewBill": true
}

application/xml, text/xml

Sample: 
<InvoiceVoid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Inv">
  <ElectronicNewBill>true</ElectronicNewBill>
  <InvoiceNumber>sample string 4</InvoiceNumber>
  <VendorID>sample string 3</VendorID>
</InvoiceVoid>

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

Response Information

Resource Description

Voids a purchase invoice.

AgvPurchaseInvoiceVoid
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: 
<AgvPurchaseInvoiceVoid 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>
</AgvPurchaseInvoiceVoid>