Function: CreateOrUpdateUnit

The CreateOrUpdateUnit function allows you to view units, which are used in PO matching The process of matching goods and services from purchase orders to invoices (2-way matching), and receipts (3-way matching).

  1. Go to Setup > Users/Roles > Manage Roles.
  2. On an existing or new Role record, go to Permissions > Lists.
  3. Add the "Units" permission.

 

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 /v7/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>

<CreateOrUpdateUnit xmlns="http://Tipalti.org/">

<payerName>string</payerName>

<timestamp>double</timestamp>

<key>string</key>

<unit>

<Unit>string</Unit>

<ExternalId>string</ExternalId>

<GroupExternalId>string</GroupExternalId>

<Factor>decimal</Factor>

<GroupName>string</GroupName>

</unit>

</reateOrUpdateUnit>

</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>

<CreateOrUpdateUnitResponse xmlns="http://Tipalti.org/">

<CreateOrUpdateUnitResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

<Succeeded>boolean</Succeeded>

<Unit>

<Unit>string</Unit>

<ExternalId>string</ExternalId>

<GroupExternalId>string</GroupExternalId>

<Factor>decimal</Factor>

<GroupName>decimal</GroupName>

</Unit>

</CreateOrUpdateUnitResult>

</CreateOrUpdateUnitResponse>

</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
unit List of unit details   Mandatory TipaltiUnitItem

TipaltiUnitItem

Element

Description

Mandatory?

Data Type
Unit The name or abbreviation of the unit (e.g., kg, g, etc.)   string
ExternalId The unit identifier in the payer's ERP Mandatory string
GroupExternalId The unit group identifier in the payer's ERP Mandatory string
Factor
  • The conversion from the base unit
  • If the current unit is the base unit, the conversion will be 1 (e.g., if the factor for kg is 1 (base), then the factor for "g" will be 0.001).
   decimal
GroupName The name of the unit group in the payer's ERP (e.g., weight, volume, length, etc.) Mandatory string

Response parameters

element

description

data type
CreateOrUpdateUnitResult Contains the response parameters CreateOrUpdateUnitResult (extension of type TipaltiResponse)

CreateOrUpdateUnitResult

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
Succeeded Indicates if the unit was created or updated successfully See API error codes. boolean
Unit List of unit details   TipaltiUnitItem
TipaltiUnitItem

Element

Description

Data Type
Unit The name or abbreviation of the unit (e.g., kg, g, etc.) string
ExternalId The unit identifier in the payer's ERP string
GroupExternalId The unit group identifier in the payer's ERP string
Factor
  • The conversion from the base unit
  • If the current unit is the base unit, the conversion will be 1 (e.g., if the factor for kg is 1 (base), then the factor for "g" will be 0.001).
 decimal
GroupName The name of the unit group in the payer's ERP (e.g., weight, volume, length, etc.) string