Payee API

The payee API is used to get or update payee information. The current version of the APIs is V14. All elements are case sensitive and API timeout is 10 minutes.

There are limitations you need to consider if you plan on using the Tipalti API along with our IPN An Instant Payment Notification (IPN) is a messaging service that enables you to receive notifications from Tipalti. IPNs are triggered when defined events occur (e.g., updating payee details). and app integrations. Please reach out to your Implementation Manager or Support for any questions.
A maximum of 250 records are allowed per API call. Exceeding this limit causes the call to time out, so you may need to consider a change in workflow depending on volume.

Category	api function
Get payee details	PayeePayable PayeePaymentMethod GetPayeeDetails GetExtendedPayeeDetails GetExtendedPayeeDetailsList GetPODetails GetExtendedPODetails GetExtendedPODetailsList PaymentsBetweenDates GetPayeeInvoiceList GetPayeeInvoicesChangedSinceTimestamp GetPayeesChangedSinceTimestamp GetTipaltiPayeeID GetLastPaymentDetailsByIDAP
Update payee	CreatePayeeInfoAutoIdap CancelInvoice ClosePayeeAccount UpdateOrCreatePayeeInfo PayeeUpdateAddress PayeeUpdateEmail UpdatePayeeCustomFields PayeeStatusUpdate

Changelog

Select a payee API version below to view the changes made to various functions of the API.

Version 9

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate> Mexico state 3-letter ISO code returned in the <State> element (if applicable) - relevant for v1-v9
GetExtendedPayeeDetailsList	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoListRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate> Mexico state 3-letter ISO code returned in the <State> element (if applicable) - relevant for v1-v9
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
CreatePayeeInfoAutoIdap	Request Added new element: <Language> Dashes allowed in the <Zip> element Mexico state 3-letter ISO codes allowed in the <State> element - relevant for v1-v9
UpdateOrCreatePayeeInfo	Request Added new elements: <Language> <ExternalID> Dashes allowed in the <Zip> element Mexico state 3-letter ISO codes allowed in the <State> element - relevant for v1-v9
PayeeUpdateAddress	Request Mexico state 3-letter ISO codes allowed in the <State> element - relevant for v1-v9

Version 8

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoListRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
UpdateOrCreatePayeeInfo	Request Added new element: <ExternalID>

Version 7

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Request Changed existing elements from camel case (e.g., payerName) to Pascal case (e.g., PayerName) Nested existing elements within <payeeInfoListRequest> array Response Added new element: <ExternalID> <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
UpdateOrCreatePayeeInfo	Request Added new element: <ExternalID>

Version 6

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
CreatePayeeInfoAutoIdap	Added <item> array to nest all payee-related elements Changed existing payee-related elements from camel case to Pascal case and nested the elements in the <item> array: <FirstName> <LastName> <Street1> <Street2> <City> <State> <Zip> <Country> <Email> <Alias> <Company> <ApAccountNumber> <PayerEntityName> Added new elements to <item> array: <Idap> <PreferredPayerEntity> <PaymentTermId> <CountryName> <ErpCurrency> <PayeeEntityType> <MiddleName> <ApAccountExternalId>
UpdateOrCreatePayeeInfo	Request Added <item> array to nest all payee-related elements Changed existing payee-related elements from camel case to Pascal case and nested the elements in the <item> array: <FirstName> <LastName> <Street1> <Street2> <City> <State> <Zip> <Country> <Email> <Alias> <Company> <PreferredPayerEntity> <ApAccountNumber> Added new elements to the <item> array: <Idap> <PayerEntityName> <PaymentTermId> <CountryName> <ErpCurrency> <PayeeEntityType> <MiddleName> <ApAccountExternalId>

Version 5

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order element <BankAccount> (or <CreditCard>)
GetExtendedPODetailsList	Response Added new payment order element <BankAccount> (or <CreditCard>)
CreatePayeeInfoAutoIdap	Request Added new element: <apAccountNumber>
UpdateOrCreatePayeeInfo	Request Added new element: <apAccountNumber>

Version 4

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
CreatePayeeInfoAutoIdap	Request Added new element: <payerEntityName>

Version 3

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetPayeeInvoiceList	Response Added new element: <TotalScheduledForPayment> In <PayeeInvoiceStatus> array: Changed <InvoiceNumber> from type "integer" to "string" Added new elements: <InvoiceStatus> <ApprovalDate> <ScheduledAmount> <TotalScheduledForPayment> Added new arrays: `<Approvers> <TipaltiInvoiceApprover> <Name>string</Name> <Email>string</Email> <Order>integer</Order> </TipaltiInvoiceApprover> </Approvers> <VendorCredits> <TipaltiVendorCredit> <RefCode>string</RefCode> <AppliedAmount>double</AppliedAmount> </TipaltiVendorCredit> </VendorCredits>`

Version 2

API FUNCTIONS	CHANGES
GetExtendedPayeeDetails	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPayeeDetailsList	Response Added new element: <StatusReason> <StatusUpdateDate> <TaxFormSubmittedBy> <TaxFormSubmittedDate>
GetExtendedPODetails	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
GetExtendedPODetailsList	Response Added new payment order elements: <BankAccount> (or <CreditCard>) <PayerEntityCountryISO>
UpdateOrCreatePayeeInfo	Request Added new elements: <preferredPayerEntity> <overridePayableCountry>