--- canonical_url: "https://docs.composio.dev/toolkits/tipalti" markdown_url: "https://docs.composio.dev/toolkits/tipalti.md" product: "platform" version: null last_updated: null --- # Tipalti Tipalti is an accounts payable automation platform for managing payees, invoices, payments, tax data, and financial account configuration. - **Category:** accounting - **Auth:** OAUTH2, S2S_OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 36 - **Triggers:** 0 - **Slug:** `TIPALTI` - **Version:** 00000000_00 ## Tools ### Create Custom Field Value Option **Slug:** `TIPALTI_CREATE_CUSTOM_FIELD_VALUE_OPTION` Create an allowed value for an existing Tipalti custom field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | Display value for the option. | | `external_id` | string | Yes | External-system identifier for the value option. | | `custom_field_id` | string | Yes | Tipalti ID of the custom field that will own the option. | | `payer_entity_ids` | array | No | Payer entity IDs that may use the option; an empty list means all payer entities. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Invoice Batch **Slug:** `TIPALTI_CREATE_INVOICE_BATCH` Start asynchronous creation of up to 200 Tipalti invoices. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoices` | array | No | Invoices to create in this asynchronous batch (up to 200). | | `operation_type` | string | No | Batch operation type. Tipalti supports CREATE for this endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Payee **Slug:** `TIPALTI_CREATE_PAYEE` Create a Tipalti payee with optional profile and custom-field details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ref_code` | string | Yes | Payer-provided unique reference code for the payee. | | `entity_type` | string ("INDIVIDUAL" | "COMPANY") | No | Whether the payee is an individual or a company. | | `contact_information` | object | No | Contact, address, phone, country, birth, and language details. | | `custom_field_values` | array | No | Custom-field values to assign to the payee. | | `preferred_payer_entity_id` | string | No | Unique ID of the payer entity assigned to the payee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Payee Invitation **Slug:** `TIPALTI_CREATE_PAYEE_INVITATION` Send a Supplier Hub invitation to an existing Tipalti payee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payee_id` | string | Yes | Tipalti ID of the payee to invite to Supplier Hub. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Payment Batch **Slug:** `TIPALTI_CREATE_PAYMENT_BATCH` Send a batch of up to 5,000 Tipalti payment instructions that can pay out real money and cannot be undone once processed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the payment batch. | | `payment_instructions` | array | Yes | Payment instructions to submit in this batch (up to 5,000). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Payment Term **Slug:** `TIPALTI_CREATE_PAYMENT_TERM` Create a Tipalti payment term with an ERP identifier, name, and due-day offset; optionally make it the sole default, which unsets the previous default. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | Yes | Number of business days added to the invoice date to determine the payment due date. | | `name` | string | Yes | Name of the payment term. | | `is_default` | boolean | No | Whether to make this the sole default payment term; setting true automatically unsets the previous default. | | `external_id` | string | Yes | Unique ERP identifier for the payment term, or a GUID when no ERP integration exists. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Tax Code **Slug:** `TIPALTI_CREATE_TAX_CODE` Create a Tipalti tax code with an ERP identifier, rate, active state, and optional payer-entity assignments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the tax code. | | `rate` | number | Yes | Tax rate represented as the numeric value expected by Tipalti. | | `is_active` | boolean | Yes | Whether the tax code is active; inactive tax codes remain in Tipalti and may appear in searches. | | `external_id` | string | Yes | Unique ERP identifier for the tax code. | | `payer_entity_ids` | array | No | Payer entity IDs assigned to the tax code; an empty list means the tax code applies to all payer entities. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Field **Slug:** `TIPALTI_GET_CUSTOM_FIELD` Retrieve one custom-field definition by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `custom_field_id` | string | Yes | Tipalti ID of the custom field to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Field Value Option **Slug:** `TIPALTI_GET_CUSTOM_FIELD_VALUE_OPTION` Retrieve one allowed value from a specific Tipalti custom field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `custom_field_id` | string | Yes | Tipalti ID of the parent custom field. | | `value_option_id` | string | Yes | Tipalti ID of the custom-field value option to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get GL Account **Slug:** `TIPALTI_GET_GL_ACCOUNT` Retrieve one general-ledger account by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gl_account_id` | string | Yes | Tipalti ID of the GL account to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice **Slug:** `TIPALTI_GET_INVOICE` Retrieve one invoice by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_id` | string | Yes | Tipalti ID of the invoice to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice Batch **Slug:** `TIPALTI_GET_INVOICE_BATCH` Return one page of processing results for an invoice batch upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `page_size` | integer | No | Number of invoice processing results to return in this page. | | `invoice_batch_id` | string | Yes | Tipalti ID of the invoice batch to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice Line **Slug:** `TIPALTI_GET_INVOICE_LINE` Retrieve one line item from a specific Tipalti invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_id` | string | Yes | Tipalti ID of the parent invoice. | | `invoice_line_id` | string | Yes | Tipalti ID of the invoice line to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payee **Slug:** `TIPALTI_GET_PAYEE` Retrieve one payee by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payee_id` | string | Yes | Tipalti ID of the payee to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payee Invitation **Slug:** `TIPALTI_GET_PAYEE_INVITATION` Retrieve Supplier Hub invitation information for a payee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payee_id` | string | Yes | Tipalti ID of the payee whose Supplier Hub invitation to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payer Entity **Slug:** `TIPALTI_GET_PAYER_ENTITY` Retrieve one payer entity by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payer_entity_id` | string | Yes | Tipalti ID of the payer entity to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payment **Slug:** `TIPALTI_GET_PAYMENT` Retrieve one payment by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payment_id` | string | Yes | Unique Tipalti ID of the payment to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payment Batch **Slug:** `TIPALTI_GET_PAYMENT_BATCH` Retrieve summary and processing status for a Tipalti payment batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payment_batch_id` | string | Yes | Tipalti ID of the payment batch to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Payment Term **Slug:** `TIPALTI_GET_PAYMENT_TERM` Retrieve one payment term by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payment_term_id` | string | Yes | Tipalti ID of the payment term to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tax Code **Slug:** `TIPALTI_GET_TAX_CODE` Retrieve one tax code by its Tipalti ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tax_code_id` | string | Yes | Tipalti ID of the tax code to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Fields **Slug:** `TIPALTI_LIST_CUSTOM_FIELDS` Return one filtered page of Tipalti custom-field definitions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page. | | `filter` | string | No | Tipalti filter expression for narrowing the returned custom fields. | | `page_size` | integer | No | Number of custom fields to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Custom Field Value Options **Slug:** `TIPALTI_LIST_CUSTOM_FIELD_VALUE_OPTIONS` Return one filtered page of allowed values for a Tipalti custom field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression for narrowing the returned value options. | | `page_size` | integer | No | Number of value options to return in this page. | | `custom_field_id` | string | Yes | Tipalti ID of the custom field whose options to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List GL Accounts **Slug:** `TIPALTI_LIST_GL_ACCOUNTS` Return one filtered page of Tipalti general-ledger accounts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression for narrowing the returned GL accounts. | | `page_size` | integer | No | Number of GL accounts to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Invoice Lines **Slug:** `TIPALTI_LIST_INVOICE_LINES` Return one page of line items for a Tipalti invoice. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `page_size` | integer | No | Number of invoice lines to return in this page. | | `invoice_id` | string | Yes | Tipalti ID of the invoice whose lines to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Invoices **Slug:** `TIPALTI_LIST_INVOICES` Return one filtered page of Tipalti invoices and their line details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression. Supported fields are refCode and status with = or IN, and invoiceDate, dueDate, creationDate, and updatedDate with =, <, <=, >, or >=. Omit to return all invoices. | | `page_size` | integer | No | Number of invoices to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payees **Slug:** `TIPALTI_LIST_PAYEES` Return one filtered page of Tipalti payees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression for narrowing the returned payees. Omit to return all payees. | | `page_size` | integer | No | Number of payees to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payer Entities **Slug:** `TIPALTI_LIST_PAYER_ENTITIES` Return one filtered page of Tipalti payer entities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression. Supported fields are id, entityName, legalName, and brandName with = or IN, and isDefault with =. Omit to return all payer entities. | | `page_size` | integer | No | Number of payer entities to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payment Batch Instructions **Slug:** `TIPALTI_LIST_PAYMENT_BATCH_INSTRUCTIONS` Return one page of instructions and results for a Tipalti payment batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `page_size` | integer | No | Number of payment instructions to return in this page. | | `payment_batch_id` | string | Yes | Tipalti ID of the payment batch whose instructions to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payments **Slug:** `TIPALTI_LIST_PAYMENTS` Return one filtered page of Tipalti payments and payment details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression. Supported fields are id (=, IN), payeeId (=), batchId (=; decimal value), status (=, IN), refCode (=, IN; up to 200 values), amountSubmitted.amount (all comparison operators), amountSubmitted.currency (=), scheduledDate (=, <, <=, >, >=, null), submissionDate (=, <, <=, >, >=), and valueDate (=, <, <=, >, >=). | | `page_size` | integer | No | Number of payments to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Payment Terms **Slug:** `TIPALTI_LIST_PAYMENT_TERMS` Return one filtered page of Tipalti payment terms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression. Supported fields are id, name, and externalId with = or IN; days with numeric operators; and isDefault with =. Omit to return all payment terms. | | `page_size` | integer | No | Number of payment terms to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tax Codes **Slug:** `TIPALTI_LIST_TAX_CODES` Return one filtered page of Tipalti tax codes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next-page cursor returned by a previous call. Omit for the first page and pass a returned cursor back unchanged. | | `filter` | string | No | Tipalti filter expression. Supported fields are id and externalId with = or IN, and isActive with =. Omit to return all tax codes. | | `page_size` | integer | No | Number of tax codes to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Custom Field Value Option **Slug:** `TIPALTI_UPDATE_CUSTOM_FIELD_VALUE_OPTION` Update the external ID, display value, active state, or payer-entity assignment of an existing Tipalti custom-field value option. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | No | Replacement display value, or null to clear it. | | `is_active` | boolean | No | Whether the custom-field value option is active, or null to clear the setting. | | `external_id` | string | No | Replacement external-system identifier, or null to clear it. | | `custom_field_id` | string | Yes | Tipalti ID of the parent custom field. | | `value_option_id` | string | Yes | Tipalti ID of the custom-field value option to update. | | `payer_entity_ids` | array | No | Replacement payer-entity IDs. An empty list makes the option relevant to all payer entities; null clears the assignment. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Payee **Slug:** `TIPALTI_UPDATE_PAYEE` Update a Tipalti payee's entity type, status, contact information, or custom fields; optionally close the account, which makes it uneditable. Omitted fields remain unchanged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("ACTIVE" | "BLOCKED" | "SUSPENDED") | No | Replacement payee status. This field cannot be null or empty. | | `payee_id` | string | Yes | Tipalti ID of the payee to update. | | `entity_type` | string ("INDIVIDUAL" | "COMPANY") | No | Replacement payee entity type. This field cannot be null or empty. | | `status_reason` | string | No | Reason for a blocked, suspended, or closed status; null clears it. | | `is_account_closed` | boolean | No | Whether to close the payee account; null clears the setting. Closed accounts remain stored and become uneditable. | | `contact_information` | object | No | Replacement contact information. This field cannot be null or empty. | | `custom_field_values` | array | No | Custom-field changes. Provide value or values_ids, or only custom_field_id to delete a value. This field cannot be null or empty. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Payee Payment Method **Slug:** `TIPALTI_UPDATE_PAYEE_PAYMENT_METHOD` Replace where a Tipalti payee's future payouts go using complete ACH, check, e-check, or PayPal details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payee_id` | string | Yes | Unique Tipalti ID of the payee whose payment method to update. | | `payment_method_type` | string ("ACH" | "CHECK" | "E_CHECK" | "PAYPAL") | Yes | Payment method discriminator; determines the required information shape. | | `payment_method_information` | string | Yes | Complete ACH, check, e-check, or PayPal details for the selected method. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Payment Term **Slug:** `TIPALTI_UPDATE_PAYMENT_TERM` Update an existing Tipalti payment term's name, business-day due-date offset, or default status; making it default unsets the previous default. Omitted request fields remain unchanged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | Replacement number of business days added to the invoice date, or null to clear it. | | `name` | string | No | Replacement payment-term name, or null to clear it. | | `is_default` | boolean | No | Whether this becomes the default payment term, or null to clear the setting. Setting a term to true makes the previous default false; the only payment term cannot be set to false. | | `payment_term_id` | string | Yes | Tipalti ID of the payment term to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Tax Code **Slug:** `TIPALTI_UPDATE_TAX_CODE` Update an existing Tipalti tax code's name, active state, rate, or payer-entity assignments. Omitted fields remain unchanged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Replacement tax-code name, or null to clear it. | | `rate` | number | No | Replacement tax-code rate, or null to clear it. | | `is_active` | boolean | No | Whether the tax code is active, or null to clear the setting. | | `tax_code_id` | string | Yes | Unique Tipalti ID of the tax code to update. | | `payer_entity_ids` | array | No | Replacement payer-entity IDs. An empty list makes the tax code relevant to all payer entities; null clears the assignment. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |