Function: GetPayeeInvoiceFile

The GetPayeeInvoiceFile function returns a payee's invoice file that is attached to a bill.

The following is a sample SOAP 1.2 request and response. In the request, you need to replace the data types in yellow with actual values.

SOAP 1.2: Request

POST /v13/payerfunctions.asmx HTTP/1.1

Host: api.tipalti.com

Content­Type: application/soap+xml; charset=utf­8

Content-Length: length

<?xml version="1.0" encoding="utf­8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-­instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap­envelope">

<soap12:Body>

<GetPayeeInvoiceFile xmlns="http://Tipalti.org/">

<payerName>​string​</payerName>

<timestamp>​double​</timestamp>

<key>​string​</key>

<invoiceRefCode>string​</invoiceRefCode>

</GetPayeeInvoiceFile>

</soap12:Body>

</soap12:Envelope>

SOAP 1.2: Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf­8

Content­Length: length

<?xml version="1.0" encoding="utf­8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-­instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://www.w3.org/2003/05/soap­envelope">

<soap12:Body>

<GetPayeeInvoiceFileResponse xmlns="http://Tipalti.org/">

<GetPayeeInvoiceFileResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<FileName>string</FileName>

<FileSize>long</FileSize>

<File>base64Binary</File>

</GetPayeeInvoiceFileResult>

</GetPayeeInvoiceFileResponse>

</soap12:Body>

</soap12:Envelope>

Request parameters

element

description

limitation

Mandatory?

data type
payerName The name of the payer, as assigned by Tipalti
  • Max. length = 50
  • Value is case sensitive
 Mandatory string
timestamp

Current time (UTC) when the request is sent

 Unix time Mandatory double
key Encryption key   Mandatory string
invoiceRefCode The reference code for the invoice
  • ASCII: max. length = 16 (Account Direction model: max. length = 15)
  • Valid special characters: hyphens, underscores
 Mandatory string

Response parameters

element

description

data type
GetPayeeInvoiceFileResult Contains the response parameters GetInvoiceFileResult (extension of type TipaltiResponse)

GetInvoiceFileResult

element

description

Limitation

data type
errorMessage A description of the error See API error codes. string
errorCode The status of the error See API error codes. string
b If the return code is Boolean, this parameter will carry the value.   boolean
i If the return code is integer, this parameter will carry the value.   integer
d If the return code is double, this parameter will carry the value.   double
s If the return code is string, this parameter will carry the value.   string
FileName Name of the file   string
FileSize The size of the invoice file Tipalti invoice file size is up to 20 MB and NetSuite is 10 MB long
File Contains the entirety of the invoice file requested   base64Binary