Payments template

The following table lists the fields that can be selected in the payments template.

Field Display Name	Field data type	Description	Values
Account currency	String	The currency of the payer account
Account number	String	An identifier for the Tipalti provider account
Action type	List	The action to take on the payment: Update Create	Update Create
Address 1	String	Payee street address line 1
Address 2	String	Payee street address line 2
AP account external ID	String	An ID that uniquely identifies the AP account in the ERP
AP account name	String	The name of the AP account linked to the payment
AP account number	String	The number of the AP account linked to the payment AP account numbers must be unique
City	String	Payee city
Conversion factor	FloatingPoint	Conversion factor = 1/Exchange rate, it is used for currency conversion (In case the exchange rate is 0, the conversion factor will be 1).
Country	String	Payee country
Entity base currency	String	The base currency in the ERP that is defined for the entity the payment was made from
Entity based conversion factor	FloatingPoint	When the entity base currency is different from the payment currency, this header will produce an empty value
Entity based exchange rate	FloatingPoint	When the entity base currency is different from the payment currency, this header will produce an empty value
Exchange rate	FloatingPoint	The foreign exchange rate for conversion of submitted currency to payer account currency If both currencies are the same, the value is 1.
Journal entry account number	String	The GL account which is relevant to the journal entry line.
Number of lines	Integer	Total number of bill lines in the file
Payee alias	String	An alternate name for the payee, if applicable
Payee AP account external id	String	The default ap account external id of the payee linked to the payment
Payee AP account name	String	The default ap account name of the payee linked to the payment
Payee AP account number	String	The default ap account number of the payee linked to the payment
Payee currency	String	The currency the payee chose to get paid in
Payee external ID	String	The external unique payee identifier
Payee ID	String	Unique payee identifier
Payee name	String	Full name of payee (for individuals) or company name (for companies)
Payee payment term days	Integer	The number of days of the payment term
Payee payment term name	String	The display name for the payment term in the Tipalti Hub
Payee payment term external ID	String	The ID associated with the payment term
Payee Zip	String	Payee zip/ postal code
Payees company name	String	Payee company name
Payer entity name	String	The payer's default entity
Payer entity name	Integer	The payer's default entity
Payment amount in account currency	FloatingPoint	The amount of the payment in the currency of the payer account
Payment amount in submitted currency	FloatingPoint	The amount submitted for payment in the currency of the payment order
Payment creation date	Datetime	The date the payment order was submitted to Tipalti
Payment method	List	Payee payment method	TIPALTICARD INTERCASH SKRILL ENTROPAY CUSTOM HOLDMYPAYMENTS ECHECK CASH CHECK ACH PAYONEER WIRETRANSFER NOPAYMENTMETHOD PAYPAL
Payment order ref. code	String	The reference code for the payment order
Payment status	List	The status of the payment	FRAUDREVIEW CLEARED CANCELED DEFERREDINTERNAL DEFERRED PENDING SUBMITTED SCHEDULED REJECTED PAID PENDINGPAYERFUNDS
Posting month	Datetime	The month in which the bill is being posted.
State	String	Payee state/ province
Submitted currency (bill currency)	String	The currency of the payment order If no currency has been provided, the payment is assumed to be in the currency of the payer s primary bank account
Transaction date	Datetime	The date the funds were withdrawn from or deposited to the account
Absolute paid amount	FloatingPoint	real paid amount + absolute value of VC applied for a bill line. actual VC applied amount (positive value) for the VC line
Amount absolute value	FloatingPoint	The absolute value of the bill amount
Bill amount / VC amount	FloatingPoint	The original amount of the bill
Bill applied VC amount	FloatingPoint	Vendor credit amount that was applied for the bill
Bill applied VC invoice number	String	Invoice number of the vendor credit which applies for the current bill
Bill applied VC ref. code	String	Ref. code of the vendor credit which applies for the current bill
Bill attachment	String	Bill's original invoice download link
Bill real paid amount	FloatingPoint	The actual paid amount after applying vendor credits when required
Bill ref. Code / VC ref. Code	String	The reference code for the bill/ vendor credit
Invoice amount	FloatingPoint	Total amount of the submitted invoice
Invoice creation date	Datetime	The date the invoice was created in Tipalti
Invoice date	Datetime	The date the invoice was created
Invoice description	String	A description of the invoice
Invoice due date	Datetime	The date the invoice is due to be paid
Invoice number	String	The number of the invoice
Invoice status	List	The status of the invoice	PARTIALLYPAID PENDINGAPPROVAL PENDINGPAYMENT DISPUTED DELETED DELETEDBYPAYEE SUBMITTEDTOPAYMENT PENDINGAPACTION PAID PENDINGSCAN DRAFT PENDINGPAYEEAPPROVAL PENDINGPAYEEINVOICE PENDINGMANAGEDSERVICES REVIEWMATCHING PENDINGMATCHING SCHEDULEDFORPAYMENT REVIEWCODING PENDINGREVIEW PAIDMANUALLY
Journal entry line type	List	The type of the Journal entry line (Credit or Debit).	Credit Debit
Paid amount	FloatingPoint	real paid amount + absolute value of VC applied for a bill line. actual VC applied amount (negative value) for the VC line
Payment index - from 0	Integer	This index is related to all rows of a specific payment in the file. For example, if a payment includes 4 rows (for 4 related bills), this field will include 0,1,2,3.
Payment index - from 1	Integer	This index is related to all rows of a specific payment in the file. For example, if a payment includes 3 rows (for 3 related bills), this field will include 1,2,3.
VC applied amount	FloatingPoint	Vendor credit amount that was used as part of the payment

ZD.4.log-1212665864.zip
20 KB Download

Articles in this section

Payments template