GET api/Invoice/InvoiceFile
Returns pre-built file for Invoice and File Type Specified
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| InvoiceRefNumber | string |
Invoice Number |
Required |
| FileType | string |
File Type. Values: PDFSummary, PDFDetail, XLSXDetail, PDFMaster |
Required |
Body Parameters
None
Response Information
Resource Description
FileResponse| Name | Type | Description | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
|
|
| Message | string |
|
|
| Stream | string |
|
|
| ContentType | string |
|
|
| FileName | string |
|
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"Message": "sample string 2",
"Stream": "sample string 3",
"ContentType": "sample string 4",
"FileName": "sample string 5"
}
application/xml, text/xml
Sample:
<FileResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <IsSuccessful>true</IsSuccessful> <Message>sample string 2</Message> <Stream>sample string 3</Stream> <ContentType>sample string 4</ContentType> <FileName>sample string 5</FileName> </FileResponse>