Payer API

The payer API is used for payer administrative operations, such as processing and testing a payment file A CSV or TXT file that contains one or more payment orders/ instructions to Tipalti. It can be submitted via the Tipalti Hub or Tipalti's FTP path.. 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
Invoices and bills	GetPayeeInvoicesListDetails CreateOrUpdateInvoices ApplyVendorCredit CreateOrUpdateGLAccounts CreateOrUpdateTaxCodes CreateOrUpdatePurchaseOrders CreateOrUpdateGrns CreateOrUpdateUnit GetPayeeInvoiceFile
Payments and fees	ProcessPayments TestPayments ProcessPaymentFile TestPaymentFile CreatePaymentOrdersReport GetUpdatedPayments GetPayerFees GetPayerEntities
Payment terms	GetPaymentTerms CreateOrUpdatePaymentTerms DeletePaymentTerms
Custom fields	Manage Custom Fields
Payee status	CreatePayeeStatusFile
Provider accounts	GetBalances GetProviderAccounts
iFrame	GetDynamicKey GetDynamicKeyOfSubPayer

Changelog

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

Version 13

API FUNCTIONS CHANGES

CreateOrUpdateCustomFields

API FUNCTIONS	CHANGES
CreateOrUpdateCustomFields	Request & Response In <customFieldInfo> array: Changed <Entity> from an element to an array: `<Entity> <CustomFieldEntity>string</CustomFieldEntity> <CustomFieldEntity>string</CustomFieldEntity> </Entity>` In <CustomFieldValue> array: Added new array: `<LimitedToPayerEntities> <string>string</string> <string>string</string> </LimitedToPayerEntities>`
CreateOrUpdateCustomFieldValue	Request In <customFieldValueUpdateModel> array: Added new array: `<LimitedToPayerEntities> <string>string</string> <string>string</string> </LimitedToPayerEntities>` Response In <CustomFieldValue> array: Added new array: `<LimitedToPayerEntities> <string>string</string> <string>string</string> </LimitedToPayerEntities>`
GetCustomFields	Response In <CustomFieldValue> array: Added new array: `<LimitedToPayerEntities> <string>string</string> <string>string</string> </LimitedToPayerEntities>`

Request & Response

In <customFieldInfo> array:

Changed <Entity> from an element to an array:

<Entity>
    <CustomFieldEntity>string</CustomFieldEntity>
    <CustomFieldEntity>string</CustomFieldEntity>
</Entity>

                                                                                        

In <CustomFieldValue> array:

Added new array:

<LimitedToPayerEntities>
    <string>string</string>
    <string>string</string>
</LimitedToPayerEntities>

CreateOrUpdateCustomFieldValue

Request

In <customFieldValueUpdateModel> array:

Added new array:

<LimitedToPayerEntities>
    <string>string</string>
    <string>string</string>
</LimitedToPayerEntities>

Response

In <CustomFieldValue> array:

Added new array:

<LimitedToPayerEntities>
    <string>string</string>
    <string>string</string>
</LimitedToPayerEntities>

GetCustomFields

Response

In <CustomFieldValue> array:

Added new array:

<LimitedToPayerEntities>
    <string>string</string>
    <string>string</string>
</LimitedToPayerEntities>

Version 12

API FUNCTIONS CHANGES

CreateOrUpdateCustomFields

API FUNCTIONS	CHANGES
CreateOrUpdateCustomFields	Request & Response In <customFieldInfo> array: Changed <Entity> from an element to an array: `<Entity> <CustomFieldEntity>string</CustomFieldEntity> <CustomFieldEntity>string</CustomFieldEntity> </Entity>`

Request & Response

In <customFieldInfo> array:

Changed <Entity> from an element to an array:

<Entity>
    <CustomFieldEntity>string</CustomFieldEntity>
    <CustomFieldEntity>string</CustomFieldEntity>
</Entity>

                                                                                        

Version 11

API FUNCTIONS CHANGES

CreateOrUpdateCustomFields

API FUNCTIONS	CHANGES
CreateOrUpdateCustomFields	Request & Response In <customFieldInfo> array: Changed <Entity> from an element to an array: `<Entity> <CustomFieldEntity>string</CustomFieldEntity> <CustomFieldEntity>string</CustomFieldEntity> </Entity>`
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource

Request & Response

In <customFieldInfo> array:

Changed <Entity> from an element to an array:

<Entity>
    <CustomFieldEntity>string</CustomFieldEntity>
    <CustomFieldEntity>string</CustomFieldEntity>
</Entity>

                                                                                        

ProcessPayments

Request

In <TipaltiPaymentOrderItem> array:

Added new elements:
- AdditionalWithholding
- UsSource

TestPayments

Request

In <TipaltiPaymentOrderItem> array:

Added new elements:
- AdditionalWithholding
- UsSource

Version 10

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>`
CreateOrUpdateGLAccounts	Request Added new element: skipNulls

Version 9

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values as well as several other values compatible with NetSuite 2.0 and QuickBooks Online In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values as well as several other values compatible with NetSuite 2.0 and QuickBooks Online
CreateOrUpdateGLAccounts	Request In <UpdateGLAccountRequest> array: Added <Category> element Replaced <EntityName> element with <PayerEntities> array: `<PayerEntities> <string>string</string> <string>string</string> </PayerEntities>` In <TipaltiGLAccount> array: Changed <Number> element from mandatory to optional Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values as well as several other values compatible with NetSuite 2.0 and QuickBooks Online
CreateOrUpdateCustomFields	Request and response: In <CustomFieldValue> array: Added <IsActive> element
GetCustomFields	Response In <CustomFieldInfo> array: Added <Category> element In <CustomFieldValue> array: Added <IsActive> element

Version 8

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values

Version 7

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values

Version 6

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values

Version 5

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiInvoiceItemRequest> array: Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values

Version 4

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
CreateOrUpdateGrns	Request In <GoodsReceivedNotificationLine> array: Added <ItemUnitsExternalId> element
CreateOrUpdatePurchaseOrders	Request In <PurchaseOrderLine> array: Added <UnitsExternalId> element
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values Changed <TipaltiInvoiceItem> array to <TipaltiInvoiceItemResponse> Added new elements: <PayerEntityName> <AmountDue> <PurchaseOrderMatchingCompleted> Added new array: `<APAccount> <TipaltiGLAccount> <Name>string</Name> <Number>string</Number> <ExternalId>string</ExternalId> <Description>string</Description> <MiscBox1099>string</MiscBox1099> <Type>string</Type> </TipaltiGLAccount> </APAccount>` In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request Changed <TipaltiInvoiceItem> array to <TipaltiInvoiceItemRequest> Added new elements: <PayerEntityName> <InvoiceSubject> <ApAccountNumber> Removed <ApprovalDate> element Removed <VendorCredits> array: `<VendorCredits> <TipaltiVendorCredit> <RefCode>string</RefCode> <AppliedAmount>double</AppliedAmount> </TipaltiVendorCredit> </VendorCredits>` Added new array: `<ManualPaymentDetails> <GLAccountExternalId>string</GLAccountExternalId> TransactionDate>dateTime</TransactionDate> </ManualPaymentDetails>` In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values Response Nested <TipaltiResponse> within <CreateOrUpdateInvoiceResult> Added new array: `<InvoiceErrors> <TipaltiInvoiceItemResult> <ErrorMessage>string</ErrorMessage> <Succeeded>boolean</Succeeded> <InvoiceRefCode>string</InvoiceRefCode> </TipaltiInvoiceItemResult> </InvoiceErrors>`
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values
GetPayerFees	Response In <TipaltiFees> array: Added new elements: <PayerEntityName> <Provider> <AccountIdentifier>

Version 3

API FUNCTIONS	CHANGES
ProcessPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
TestPayments	Request In <TipaltiPaymentOrderItem> array: Added new elements: AdditionalWithholding UsSource
GetPayeeInvoicesListDetails	Response In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiInvoiceItem> array: Added new elements: <InvoiceStatus> <Currency> <InvoiceNumber> <ApprovalDate> 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>` In <InvoiceLine> array: Added new elements: <LineType> <LineExternalMetadata> <Quantity> <BillLineID> <TaxCodeExternalId> <TaxAmount> Added new arrays: <GLAccount> <TipaltiGLAccount> <Name>string</Name> <Number>string</Number> <ExternalId>string</ExternalId> <Description>string</Description> <MiscBox1099>string</MiscBox1099> <Type>string</Type> </TipaltiGLAccount> </GLAccount> <RelatedPurchaseOrders> <TipaltiRelatedPurchaseOrder> <PurchaseOrderNumber>string</PurchaseOrderNumber> <ItemNumber>string</ItemNumber> <Quantity>decimal</Quantity> <Amount>decimal</Amount> <ExternalLineId>string</ExternalLineId> </TipaltiRelatedPurchaseOrder> </RelatedPurchaseOrders> In <TipaltiRelatedPurchaseOrder> array: Added <PoLineGlAccountExternalId> element
CreateOrUpdateInvoices	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values In <TipaltiInvoiceItem> array: Added new elements: <InvoiceStatus> <Currency> <InvoiceNumber> <ApprovalDate> 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>` In <InvoiceLine> array: Added new elements: <LineType> <LineExternalMetadata> <Quantity> <BillLineID> <TaxCodeExternalId> <TaxAmount> Added new arrays: <GLAccount> <TipaltiGLAccount> <Name>string</Name> <Number>string</Number> <ExternalId>string</ExternalId> <Description>string</Description> <MiscBox1099>string</MiscBox1099> <Type>string</Type> </TipaltiGLAccount> </GLAccount> <RelatedPurchaseOrders> <TipaltiRelatedPurchaseOrder> <PurchaseOrderNumber>string</PurchaseOrderNumber> <ItemNumber>string</ItemNumber> <Quantity>decimal</Quantity> <Amount>decimal</Amount> <ExternalLineId>string</ExternalLineId> </TipaltiRelatedPurchaseOrder> </RelatedPurchaseOrders>
CreateOrUpdateGLAccounts	Request In <TipaltiGLAccount> array: Added <Currency> element For <Type> element, added "Bank" and "Credit card" as valid values

Version 2

API FUNCTIONS

CHANGES

ProcessPayments

Request

In <TipaltiPaymentOrderItem> array:

Added new elements:
- AdditionalWithholding
- UsSource

TestPayments

Request

In <TipaltiPaymentOrderItem> array:

Added new elements:
- AdditionalWithholding
- UsSource

GetBalances

Response

In <AccountInfos> array:

Deleted <AccountType>
Added <Provider>
Added <AccountIdentifier>
Changed existing element (<currency>) from camel case to Pascal case (<Currency>).