Description

Returns a temporary public download link for an invoice PDF stored in pixi document storage. Use this call to generate a shareable URL that allows external systems or end users to download an invoice PDF without requiring pixi credentials.

You may identify the invoice by InvoiceId, InvoiceNr, or both. When both are supplied, they must refer to the same invoice record — a mismatch returns an error. The returned DownloadLink is valid until LinkExpirationDate.

Request Parameters

#	Name	Type	Required	Example	Description
1	InvoiceId	int	0	12345	Invoice primary key. At least one of InvoiceId or InvoiceNr must be provided.
2	InvoiceNr	string	0	INV-2026-0001	Invoice number. At least one of InvoiceId or InvoiceNr must be provided. Leading and trailing whitespace is ignored.

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pipiGetInvoicePublicLink>
         <dem:InvoiceId>12345</dem:InvoiceId>
         <dem:InvoiceNr>INV-2026-0001</dem:InvoiceNr>
      </dem:pipiGetInvoicePublicLink>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Invoice download link

#	Name	Type	Description
1	InvoiceId	int	Invoice primary key.
2	InvoiceNr	string	Invoice number.
3	DownloadLink	string	Temporary public URL to download the invoice PDF.
4	LinkExpirationDate	datetime	Date and time when the download link expires.

Body 2: Error response

#	Name	Type	Description
1	Status	string	Always Error.
2	Message	string	Description of the error. Possible values: Either InvoiceId or InvoiceNr must be provided. \| InvoiceId and InvoiceNr do not match. \| Invoice Not Found. \| Document Not Found. \| Failed to generate invoice download link.

Additional Notes

At least one of InvoiceId or InvoiceNr must be supplied. If both are provided they must refer to the same invoice record; a mismatch returns an error.

The download link is temporary and expires at the date and time returned in LinkExpirationDate.
Clients should not cache or store the link for long-term use.

Error responses are returned as a single-row result set with Status = 'Error' and a Message describing the problem.

pixiGetInvoicePublicLink