Function: GetPayeeInvoicesChanged
SinceTimestamp
The GetPayeeInvoicesChangedSinceTimestamp function returns the reference codes of invoices/ bills changed after a given date. Updates to financial information or bill status (post-review) are considered changes.
- EAT Encryption Additional Terms parameter: timestamp from when to start the system check (in UTC Coordinated Universal Time)
- API version: V1
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 /payeefunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: application/soap+xml; charset=utf8
Content-Length: length
<?xml version="1.0" encoding="utf8"?>
<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/soapenvelope">
<soap12:Body>
<GetPayeeInvoicesChangedSinceTimestamp xmlns="http://Tipalti.org/">
<payerName>string</payerName>
<timestamp>double</timestamp>
<key>string</key>
<changedSince>double</changedSince>
</GetPayeeInvoicesChangedSinceTimestamp>
</soap12:Body>
</soap12:Envelope>
SOAP 1.2: Response
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf8
Content-Length: length
<?xml version="1.0" encoding="utf8"?>
<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/soapenvelope">
<soap12:Body>
<GetPayeeInvoicesChangedSinceTimestampResponse
xmlns="http://Tipalti.org/">
<GetPayeeInvoicesChangedSinceTimestampResult>
<errorMessage>string</errorMessage>
<errorCode>string</errorCode>
<b>boolean</b>
<i>integer</i>
<d>double</d>
<s>string</s>
<changedInvoicesRefCode>
<string>string</string>
<string>string</string>
</changedInvoicesRefCode>
</GetPayeeInvoicesChangedSinceTimestampResult>
</GetPayeeInvoicesChangedSinceTimestampResponse>
</soap12:Body>
</soap12:Envelope
Request parameters
|
element |
description |
limitation |
Mandatory? |
data type |
|---|---|---|---|---|
| payerName | The name of the payer, as assigned by Tipalti |
|
Mandatory | string |
| timestamp |
Current time (UTC) when the request is sent |
Unix time | Mandatory | double |
| key | Encryption key | Mandatory | string | |
| changedSince | The starting date to return all changed invoices/ bills | Unix time | Mandatory | double |
Response parameters
|
element |
description |
data type |
|---|---|---|
| GetPayeeInvoicesChanged SinceTimestampResult |
Contains the response parameters | TipaltiGetPayeeInvoicesChanged SinceTimestampResponse (extension of type TipaltiResponse) |
TipaltiGetPayeeInvoicesChangedSinceTimestampResponse
|
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 | |
| changedInvoicesRefCode | List of invoice reference codes | Array of string |
string
|
element |
description |
limitation |
data type |
|---|---|---|---|
| string | The reference code for the invoice |
|
string |