Function: CreateOrUpdateTaxCodes

The CreateOrUpdateTaxCodes function allows you to create or update tax codes and link the tax codes to payer entities.

EAT Encryption Additional Terms parameter: None
API version: V13

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 /v13/payerfunctions.asmx HTTP/1.1

Host: api.qa.payrad.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<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/soap-envelope">

<soap12:Body>

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

<ExternalId>string</ExternalId>

<Name>string</Name>

<Active>boolean</Active>

<Rate>decimal</Rate>

<string>string</string>

</PayerEntities>

</TipaltiTaxCode>

<ExternalId>string</ExternalId>

<Name>string</Name>

<Active>boolean</Active>

<Rate>decimal</Rate>

<string>string</string>

</PayerEntities>

</TipaltiTaxCode>

</taxCodes>

</CreateOrUpdateTaxCodes>

</soap12:Body>

</soap12:Envelope>

SOAP 1.2: Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<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/soap-envelope">

<soap12:Body>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<ExternalId>string</ExternalId>

<Name>string</Name>

<Active>boolean</Active>

<Rate>decimal</Rate>

<string>string</string>

</PayerEntities>

</TipaltiTaxCode>

<ExternalId>string</ExternalId>

<Name>string</Name>

<Active>boolean</Active>

<Rate>decimal</Rate>

<string>string</string>

</PayerEntities>

</TipaltiTaxCode>

</TaxCodes>

</CreateOrUpdateTaxCodesResult>

</CreateOrUpdateTaxCodesResponse>

</soap12:Body>

</soap12:Envelope>

Request parameters

Element	description	limitation	Mandatory?	data type
payerName	The name of the payer, as assigned by Tipalti	Max. length = 50 Value is case sensitive	Mandatory	string
timestamp	Current time (UTC) when the request is sent	Unix time	Mandatory	double
key	Encryption key		Mandatory	string
taxCodes	List of tax codes Each tax code is of type TipaltiTaxCode.		Mandatory	Array of TipaltiTaxCode

TipaltiTaxCode

Element	Description	Mandatory?	Data Type
ExternalId	The tax code identifier in the payer's ERP	Mandatory	string
Name	The name of the tax code (e.g., VAT-UK) If you change the name of an existing tax code, it is changed on all bills linked to the tax code. Bill status is not affected.	Mandatory	string
Active	Indicates if the tax code is active or inactive If an active tax code becomes inactive: It is removed from bills pending internal or payee approval/ invoice. The bills are sent back to AP so that a new tax code can be assigned. Bills in a "PendingPayment" status or later remain unaffected. It is removed from bills in any other status.	Mandatory	boolean
Rate	The rate of the tax code (e.g., 20.0 for 20% tax) If the rate of an existing tax code is changed: Bills in a status earlier than "PendingPayment" are updated. Bills in status "PendingPayment" or later remain unaffected.		decimal
PayerEntities	List of payer entity names, as used in the Tipalti Hub To apply the tax code to all payer entities, exclude the element in the request. If an entity linked to the tax code has been updated and is no longer available for existing bills, the bills are treated the same as when tax codes become inactive (refer to the description for the "Active" element above).	Optional to include the element, but if tags are included, a value is mandatory. Otherwise, an error is returned.	Array of string

string

element	description	data type
string	The payer entity name	string

Response parameters

element	description	data type
CreateOrUpdateTaxCodesResult	Contains the response parameters	CreateOrUpdateTaxCodesResult (extension of type TipaltiResponse)

CreateOrUpdateTaxCodesResult

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
TaxCodes	List of tax codes Each tax code is of type TipaltiTaxCode.		Array of TipaltiTaxCode

TipaltiTaxCode

Element	Description	Data Type
ExternalId	The tax code identifier in the payer's ERP	string
Name	The name of the tax code (e.g., VAT-UK) If you change the name of an existing tax code, it is changed on all bills linked to the tax code. Bill status is not affected.	string
Active	Indicates if the tax code is active or inactive If an active tax code becomes inactive: It is removed from bills pending internal or payee approval/ invoice. The bills are sent back to AP so that a new tax code can be assigned. Bills in a "PendingPayment" status or later remain unaffected. It is removed from bills in any other status.	boolean
Rate	The rate of the tax code (e.g., 20.0 for 20% tax) If the rate of an existing tax code is changed: Bills in a status earlier than "PendingPayment" are updated. Bills in status "PendingPayment" or later remain unaffected.	decimal
PayerEntities	List of payer entity names, as used in the Tipalti Hub To apply the tax code to all payer entities, exclude the element in the request. If an entity linked to the tax code has been updated and is no longer available for existing bills, the bills are treated the same as when tax codes become inactive (refer to the description for the "Active" element above).	Array of string