# Tipalti

> Read payees, invoices, payments and accounting reference data; manage payees, tax codes and payment terms.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/tipalti

## Actions

### Create a payment term

Create a payment term.

**Inputs**

- External ID (`external_id`, text, required): The unique external ID of the payment terms from the ERP. If no ERP integration exists, this is a GUID.
- Name (`name`, text, required): The name of the payment term.
- Days (`days`, number, required): The number of business days added to the invoice date to determine the payment due date.
- Is default (`is_default`, true/false): Sets the default payment term. Only one term can be set to default. Creating a new term with isDefault=true will automatically change the previous default term to false.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "days": 1,
    "externalId": "example",
    "id": "example",
    "isDefault": true,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create payee

Create payee.

**Inputs**

- Ref code (`ref_code`, text, required): The payee's unique reference code provided by the payer.
- Preferred payer entity ID (`preferred_payer_entity_id`, text): The unique identifier of the payer entity assigned to the payee.
- Entity type (`entity_type`, text): The type of payee. See Entity types for more information. One of: `INDIVIDUAL`, `COMPANY`.
- Contact information (`contact_information`, object): Additional structured contact information. Use the documented fields.
- Custom field values (`custom_field_values`, list): Represents the input model for custom field resource values. Values can be selected from a closed values list using their IDs or provided as free text. Either the ValuesIds or Value property must have a value.

**Outputs**

- `data` (object): The payee resource's schema
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "apAccountId": "example",
    "contactInformation": {
      "address": "example",
      "address2": "example",
      "alias": "example",
      "beneficiaryCountryCode": "example",
      "city": "example",
      "companyName": "example",
      "countryOfBirthCode": "example",
      "dateOfBirth": "example",
      "email": "example",
      "firstName": "example",
      "languageCode": "example",
      "lastName": "example",
      "middleName": "example",
      "paymentCountryCode": "example",
      "phone": "example",
      "phoneCountryCode": "example",
      "stateProvinceCode": "example",
      "zip": "example"
    },
    "customFieldValues": [],
    "entityType": "INDIVIDUAL",
    "id": "example",
    "isAccountClosed": true,
    "isPayable": true,
    "lastChangeDateTimeUTC": "example",
    "paymentMethod": {
      "currency": "example",
      "paymentMethodInformation": {},
      "paymentMethodType": "NO_PAYMENT_METHOD"
    },
    "paymentTermId": "example",
    "preferredPayerEntityId": "example",
    "refCode": "example",
    "status": "ACTIVE",
    "statusChangeDateTimeUTC": "example",
    "statusReason": "example",
    "unpayableReasons": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create tax code

Create tax code.

**Inputs**

- Name (`name`, text, required): The tax code's name.
- Is active (`is_active`, true/false, required): Indicates if the tax code is active. Inactive tax codes are not deleted from the system and can be displayed in certain searches.
- Rate (`rate`, number, required): The tax code's rate.
- External ID (`external_id`, text, required): The unique identifier of the tax code in the ERP.
- Payer entity IDs (`payer_entity_ids`, list): The payer entities assigned to the tax code. If the array is empty, it indicates the tax code is relevant to all payer entities.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "externalId": "example",
    "id": "example",
    "isActive": true,
    "name": "example",
    "payerEntityIds": [],
    "rate": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get custom field

Get custom field. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the custom field in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "attributes": [],
    "description": "example",
    "externalId": "example",
    "id": "example",
    "isActive": true,
    "name": "example",
    "resources": [],
    "valueType": "TEXT"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get gl account

Get gl account. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the GL account in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "category": "AP_ACCOUNT",
    "currency": "example",
    "description": "example",
    "erpAccountType": "example",
    "externalId": "example",
    "id": "example",
    "isClosed": true,
    "name": "example",
    "number": "example",
    "payerEntityIds": [],
    "report1099Type": "NON_APPLICABLE"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get invoice

Get invoice. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the invoice in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "apAccountId": "example",
    "creationDate": "example",
    "customFieldValues": [],
    "description": "example",
    "dueDate": "example",
    "id": "example",
    "incomeType": "Patents",
    "invoiceDate": "example",
    "invoiceNumber": "example",
    "lines": [],
    "links": [],
    "netAmount": {
      "amount": 1,
      "currency": "example"
    },
    "paidAmount": {
      "amount": 1,
      "currency": "example"
    },
    "payeeId": "example",
    "payeeVatNumber": "example",
    "payerEntityId": "example",
    "refCode": "example",
    "status": "PENDING_PAYMENT",
    "subject": "example",
    "taxAmount": {
      "amount": 1,
      "currency": "example"
    },
    "totalAmount": {
      "amount": 1,
      "currency": "example"
    },
    "unpaidAmount": {
      "amount": 1,
      "currency": "example"
    },
    "updatedDate": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get invoice line

Get invoice line. Returns the full service response for the connected account.

**Inputs**

- Line ID (`line_id`, text, required): The unique identifier of the invoice line in Tipalti.
- Id (`id`, text, required): The unique identifier of the invoice in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "customFieldValues": [],
    "description": "example",
    "expenseAccountId": "example",
    "id": "example",
    "netAmount": 1,
    "quantity": 1,
    "taxAmount": 1,
    "taxCodeId": "example",
    "totalAmount": 1,
    "unitPrice": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get payee

Get payee. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payee in Tipalti.

**Outputs**

- `data` (object): The payee resource's schema
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "apAccountId": "example",
    "contactInformation": {
      "address": "example",
      "address2": "example",
      "alias": "example",
      "beneficiaryCountryCode": "example",
      "city": "example",
      "companyName": "example",
      "countryOfBirthCode": "example",
      "dateOfBirth": "example",
      "email": "example",
      "firstName": "example",
      "languageCode": "example",
      "lastName": "example",
      "middleName": "example",
      "paymentCountryCode": "example",
      "phone": "example",
      "phoneCountryCode": "example",
      "stateProvinceCode": "example",
      "zip": "example"
    },
    "customFieldValues": [],
    "entityType": "INDIVIDUAL",
    "id": "example",
    "isAccountClosed": true,
    "isPayable": true,
    "lastChangeDateTimeUTC": "example",
    "paymentMethod": {
      "currency": "example",
      "paymentMethodInformation": {},
      "paymentMethodType": "NO_PAYMENT_METHOD"
    },
    "paymentTermId": "example",
    "preferredPayerEntityId": "example",
    "refCode": "example",
    "status": "ACTIVE",
    "statusChangeDateTimeUTC": "example",
    "statusReason": "example",
    "unpayableReasons": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get payer entity

Get payer entity. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payer entity in Tipalti.

**Outputs**

- `data` (object): The Payer Entity resource's schema
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "brandName": "example",
    "entityName": "example",
    "externalId": "example",
    "id": "example",
    "incomeTypes": [],
    "isDefault": true,
    "legalName": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get payment

Get payment. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payment in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "amountSubmitted": {
      "amount": 1,
      "currency": "example"
    },
    "bankingMessage": "example",
    "batchId": "example",
    "customFieldValues": [],
    "detailedStatus": "PAID",
    "eWalletMessage": "example",
    "emailSubject": "example",
    "exchangeRates": [],
    "fees": [],
    "id": "example",
    "payeeId": "example",
    "payeePaidAmount": {
      "amount": 1,
      "currency": "example"
    },
    "payeeReceivedAmountInPayerAccountCurrency": {
      "amount": 1,
      "currency": "example"
    },
    "payerEntityId": "example",
    "payerWithdrawAmount": {
      "amount": 1,
      "currency": "example"
    },
    "paymentMethod": "NO_PAYMENT_METHOD",
    "providerTransactionRefCode": "example",
    "refCode": "example",
    "scheduledDate": "example",
    "status": "PAID",
    "submissionDate": "example",
    "tax": {
      "region": "US",
      "usTaxInfo": {
        "incomeTypes": [],
        "taxWithholdingRate": 1,
        "treatyCountryCode": "example",
        "withholdingAmount": {
          "amount": 1,
          "currency": "example"
        }
      }
    },
    "transactionCompletionDate": "example",
    "valueDate": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get payment term

Get payment term. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payment term in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "days": 1,
    "externalId": "example",
    "id": "example",
    "isDefault": true,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get tax code

Get tax code. Returns the full service response for the connected account.

**Inputs**

- Id (`id`, text, required): The unique identifier of the tax code in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "externalId": "example",
    "id": "example",
    "isActive": true,
    "name": "example",
    "payerEntityIds": [],
    "rate": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get value option

Get value option. Returns the full service response for the connected account.

**Inputs**

- Option ID (`option_id`, text, required): The unique identifier of the custom field value option in Tipalti.
- Id (`id`, text, required): The unique identifier of the custom field in Tipalti.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "externalId": "example",
    "id": "example",
    "isActive": true,
    "payerEntityIds": [],
    "value": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List custom fields

List custom fields. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List gl accounts

List gl accounts. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List invoice lines

List invoice lines. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Id (`id`, text, required): The unique identifier of the invoice in Tipalti.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List invoices

List invoices. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List payees

List payees. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List payer entities

List payer entities. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List payment terms

List payment terms. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List payments

List payments. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List tax codes

List tax codes. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List value options

List value options. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Id (`id`, text, required): The unique identifier of the custom field in Tipalti.
- Filter (`filter`, text): The filter query string. See Filtering for query specifications. Available filterable parameters are described below.
- Page size (`page_size`, number): The number of results displayed per page. See Pagination - page size for details and limitations.
- Page cursor (`page_cursor`, text): A cursor for pagination across multiple pages of results. See Pagination - page cursor for details and limitations.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "hasNextPage": false,
      "nextPageCursor": null
    },
    "totalCount": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update a payment term

Update a payment term. Empty fields keep their current values.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payment term in Tipalti.
- Name (`name`, text): The name of the payment term.
- Days (`days`, number): The number of business days added to the invoice date to determine the payment due date.
- Is default (`is_default`, true/false): Sets the default payment term. To change the default, set another term to isDefault=true. This automatically changes the previous default to false. If there's only one payment term, it can't be set to false.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "days": 1,
    "externalId": "example",
    "id": "example",
    "isDefault": true,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update payee

Update payee. Empty fields keep their current values.

**Inputs**

- Id (`id`, text, required): The unique identifier of the payee in Tipalti.
- Entity type (`entity_type`, text): The type of payee. See Entity types for more information. One of: `INDIVIDUAL`, `COMPANY`.
- Status (`status`, text): The payee's current status. See Payee's status for more information. One of: `ACTIVE`, `BLOCKED`, `SUSPENDED`.
- Status reason (`status_reason`, text): The reason for the payee's status (blocked, suspended or closed). Tipalti can set the reasons automatically, or you can set them yourself.
- Is account closed (`is_account_closed`, true/false): Indicates whether this payee account is closed. Closed accounts are not deleted from the system and can be displayed in certain searches. These accounts are uneditable.
- Contact information (`contact_information`, object): The payee's contact information.
- Custom field values (`custom_field_values`, list): The input model for custom field resource values. Values can be selected from a closed values list using their IDs or provided as free text. To update a customFieldValue, provide the new value or valuesIds, not both. To delete a customFieldValue, send only the customFieldId (omit value/valueIds).

**Outputs**

- `data` (object): The payee resource's schema
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "apAccountId": "example",
    "contactInformation": {
      "address": "example",
      "address2": "example",
      "alias": "example",
      "beneficiaryCountryCode": "example",
      "city": "example",
      "companyName": "example",
      "countryOfBirthCode": "example",
      "dateOfBirth": "example",
      "email": "example",
      "firstName": "example",
      "languageCode": "example",
      "lastName": "example",
      "middleName": "example",
      "paymentCountryCode": "example",
      "phone": "example",
      "phoneCountryCode": "example",
      "stateProvinceCode": "example",
      "zip": "example"
    },
    "customFieldValues": [],
    "entityType": "INDIVIDUAL",
    "id": "example",
    "isAccountClosed": true,
    "isPayable": true,
    "lastChangeDateTimeUTC": "example",
    "paymentMethod": {
      "currency": "example",
      "paymentMethodInformation": {},
      "paymentMethodType": "NO_PAYMENT_METHOD"
    },
    "paymentTermId": "example",
    "preferredPayerEntityId": "example",
    "refCode": "example",
    "status": "ACTIVE",
    "statusChangeDateTimeUTC": "example",
    "statusReason": "example",
    "unpayableReasons": []
  },
  "has_more": false,
  "next_cursor": null
}
```
