Payer functions.

The following operations are supported. For a formal definition, please review the Service Description.

• ApplyVendorCredit
  Applies vendor credit for related bills
• CreateExtendedPayeeStatusFile
  Create a file with the status of all payees in the system.
  listType possible values: (1-All (Default),2-Payable,3-UnPayable).
  changesSinceDate is an optional parameter to limit the report to the payees that changed their info since that date.
  The CSV file is placed in the payer's SFTP folder. If a file by this name already exists, it will be removed.
  EAT - saveToFile
• CreateOrUpdateCustomFields
  Create update or delete custom fields. Custom fields type can be created as: .
  1. Free text - the user can enter any free text.
  2. Unique text - the value can enter any text. The value will be validated as unique.
  3. Multiple values - the user can select multiple values from a predefined list of values.
  4. List of values - the user can select a single value from a predefined list of values.
  EAT - null
• CreateOrUpdateGLAccounts
  Creates, updates or closes G/L accounts.
  If G/L Account does not exist, it will be created.
  If G/L Account is closed, it will be updated and reactivated.
  If G/L account is assigned to outstanding unpaid bill(s), Close action will be rejected.
• CreateOrUpdateGrns
  Create new goods recieved notifications or update existing ones.
  EAT - null
• CreateOrUpdateInvoices
  create new invoices or update existing ones.
  EAT - null
• CreateOrUpdatePurchaseOrders
  Create new purchase orders or update existing ones.
  EAT - null
• CreatePayeeStatusFile
  Create a file with the status of all payees in the system.
  changesSinceDate is an optional paramter to limit the report to the payees that changed their info since that date.
  The CSV file is placed in the payer's SFTP folder and has the following format: payee ID, payment method, status, reason.
  If a file by this name already exists, it will be removed.
  EAT - saveToFile
• CreatePaymentOrdersReport
  Create payment orders report. Return value is the report file name that is written to the SFTP folder.
  The details file format may change over time. Columns may be added. When reading the file ensure you have functionality that can ignore new, additional, columns.
  The report is on all the payment orders between startTime and endTime parameters.
  EAT - none
• GetBalances
  Get balances in your accounts. Returns account provider, account identifier, currency and amount in balance.
  Note: when submitting a payment, the balance may take some time before it is updated
  EAT - none
• GetCustomFields
  Return the payer custom fields
• GetDynamicKey
  Returns a dynamic security key that can be used to sign the content of the Tipalti iFrame Query String.
  The SecurityToken object returns contains a key and a token. Use the key to sign the query string.
  You must send the token within the query string of the iFrame. To do that, set its value to a Query String parameter named 'token'
  The key is a temporary key and will expire within the time limit you have set in the administration console
  Do not send the key over the wire or include it in the query string. Store it in a secure location.
  EAT - none
• GetDynamicKeyOfSubPayer
  Get dynamic encryption key of sub payer. the dynamic key is encrypted with the parent payer key.The SecurityToken object returns contains an encrypted key and a token. Use the key to sign the query string.
  You must send the token within the query string of the iFrame. To do that, set its value to a Query String parameter named 'token'.
  The key is a temporary key and will expire within the time limit you have set in the administration console.
  Do not send the key over the wire or include it in the query string. Store it in a secure location.
  EAT - subPayerName
• GetPayeeInvoicesListDetails
  Return list of payee invoices.
  EAT - null
• GetPayerFees
  Return list of payer fees charged between specific dates.
  EAT - null
• GetProcessingRequestStatus
  Returns the current status of an ansynchronous processing request.
  Return value includes warnings and errors.
  EAT - requestId
• GetProviderAccounts
  Return the payer provider accounts info
• GetUpdatedPayments
  Return ref codes of POs which were updated since a given timestamp.
  EAT - null
• LogIntegrationError
  Log integration errors from Tipalti/Apps (NetSuite/QuickBooks/etc...) Integrations
• ProcessMultiCurrencyPaymentFile
  Submit file for payment. File should be pre-loaded to the SFTP folder assigned by Tipalti.Return value includes warnings and errors, including line number in file. An 'OK' errorMessage means that the payments were submitted.
  EAT - fileName
• ProcessMultiCurrencyPaymentFileAsync
  Process a multi currency payment file asynchronously.
  File should be pre-loaded to the SFTP folder assigned by Tipalti.
  Return value includes warnings, errors, and request idRequest id can be used to check the processing status and get the processing result.
  EAT - totalAmount
• ProcessPaymentFile
  Submit file for payment. File should be pre-loaded to the SFTP folder assigned by Tipalti.Return value includes warnings and errors, including line number in file. An 'OK' errorMessage means that the payments were submitted.
  EAT - totalAmount
• ProcessPaymentFileAsync
  Process file for payment asynchronously.
  File should be pre-loaded to the SFTP folder assigned by Tipalti.
  Return value includes warnings, errors, and request idRequest id can be used to check the processing status and get the processing result.
  EAT - totalAmount
• ProcessPayments
  Process payments in a list.
  Return value includes warnings and errors.
  Payment list can be no more than 250 item long.
  EAT - paymentGroupTitle
• ProcessPaymentsAsync
  Process payments in a list asynchronously.
  Return value includes warnings, errors and request idRequest id can be used to check the processing status and get the processing result.
  Payment list can be no more than 250 item long.
  EAT - paymentGroupTitle
• ProcessPaymentsAsyncResult
  Returns the result of an ansynchronous process payments call.
  Return value includes warnings and errors.
  EAT - requestId
• TestMultiCurrencyPaymentFile
  Test a payment file. File should be pre-loaded to the SFTP folder assigned by Tipalti.Return value includes warnings and errors, including line number in file. An 'OK' errorMessage means that the payment file can be submitted. NO PAYMENTS WILL BE EXECUTED.
  EAT - fileName
• TestMultiCurrencyPaymentFileAsync
  Test a multi currency payment file asynchronously.
  File should be pre-loaded to the SFTP folder assigned by Tipalti.
  Return value includes warnings, errors, and request idRequest id can be used to check the processing status and get the processing result.
  EAT - totalAmount
• TestPaymentFile
  Test a payment file. File should be pre-loaded to the SFTP folder assigned by Tipalti.Return value includes warnings and errors, including line number in file. An 'OK' errorMessage means that the payment file can be submitted. NO PAYMENTS WILL BE EXECUTED.
  EAT - totalAmount
• TestPaymentFileAsync
  Test payment file asynchronously.
  File should be pre-loaded to the SFTP folder assigned by Tipalti.
  Return value includes warnings, errors, and request idRequest id can be used to check the processing status and get the processing result.
  EAT - totalAmount
• TestPayments
  Test payments in a list.
  Return value includes warnings and errors.
  Payment list can be no more than 250 item long. NO PAYMENTS WILL BE EXECUTED
  EAT - paymentGroupTitle
• TestPaymentsAsync
  Test payments in a list asynchronously.
  Return value includes warnings, errors and request idRequest id can be used to check the processing status and get the processing result.
  Payment list can be no more than 250 item long.
  EAT - paymentGroupTitle