GET PurchaseInvoice/GetPurchaseInvoiceDocument?purchaseInvoiceGuid={purchaseInvoiceGuid}

Returns the S3 Presigned Url for a Purchase Invoice document

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
purchaseInvoiceGuid

globally unique identifier

Required

Body Parameters

Response Information

Resource Description

Returns the S3 Presigned Url for a Purchase Invoice document

AgvPurchaseInvoiceDocument
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of errors from the API

Collection of string
WarningList

List of warnings from the API

Collection of string
PreSignedUrl

The presigned url of the file

string

Will be "null" when the S3 file can not be created.

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"
  ],
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample:
<AgvPurchaseInvoiceDocument 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>
  <PreSignedUrl>sample string 3</PreSignedUrl>
  <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>
</AgvPurchaseInvoiceDocument>