---
title: "Enable the provider chat for a payable"
method: POST
path: "/v1/erp/payouts/payables/{payable_id}/enable_chat"
tags: ["Payable"]
---

# Enable the provider chat for a payable

`POST /v1/erp/payouts/payables/{payable_id}/enable_chat`

## Request

- Base URL: `https://api.cardda.com`
- URL: `https://api.cardda.com/v1/erp/payouts/payables/{payable_id}/enable_chat`
- Auth: HTTP bearer

Manually starts the provider chat for the payable: ensures a portal access token exists
for the business partner (creating it if needed, preserving the fixed portal URL), sends
the invitation email with the access code, and enables the chat on the payable.

## Path parameters

- `payable_id` string, required

## Parameters

- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0` (unresolved $ref)

## Response `200`

The payable, augmented with the resulting portal link status.

- object
  - `id` string, uuid, required
  - `source_type` string
  - `source_id` string
  - `amount` integer, required
  - `status` 'pending' | 'approved' | 'declined' | 'partially_paid' | 'paid' | 'overpaid' | 'scheduled' | 'delegated', required: **Derived, read-only.** There is no `status` column: the value is computed from `review_status` and `payment_status` on every read. * `paid` or `overpaid` whenever `payment_status` is one of those two — the payment outcome wins over the review outcome. * otherwise, once the payable is approved *and* something has been paid or scheduled, the `payment_status` shows through (`partially_paid`, `scheduled`, `delegated`). * otherwise the `review_status` (`pending`, `approved`, `declined`). So `approved` here means "approved and nothing paid yet". Filter and sort on `review_status` / `payment_status` if you need the two axes separately.
  - `due_date` string, date-time: The date in which the payable is due.
  - `payment_status` 'non_paid' | 'partially_paid' | 'paid' | 'overpaid' | 'scheduled' | 'delegated': How much of the payable has been settled. `scheduled` and `delegated` mean the payment was handed off (scheduled at the bank, or delegated to a third party) and are not terminal.
  - `company_id` string, uuid, required
  - `issue_date` string, date-time: The date in which the payable was issued.
  - `currency` string, required
  - `document_type` integer, required: An integer representing the type of document. Refer to the `document_types` mapping for possible values and their corresponding document types.
  - `sender_id` string, uuid
  - `recipient_id` string, uuid
  - `counterpart_company_id` string, uuid, required: The id of the counterpart company. This is the company that will receive the payment.
  - `description` string
  - `discarded` boolean: Whether the payable has been discarded or not. A discarded payable will not be obtained in the index.
  - `partially_paid_amount` integer
  - `paid_amount` integer: The amount that has been paid for this payable. This amount is calculated using the partially_paid_amount param, the amount of the bank transactions related to the payable and the amount of the credit notes related.
  - `counterpart_company` object
    - `id` string
    - `name` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `reviewers` Reviewer[]
    - `id` string, uuid, required
    - `company_id` string, uuid, required
    - `user_id` string, uuid, required: The id of the user that is the reviewer.
    - `source_id` string, uuid, required: The id of the object being reviewed (payable or purchase order).
    - `source_type` string, required: The polymorphic type of the object being reviewed, e.g. `Erp::Payouts::Payable` or `Erp::Payouts::PurchaseOrder`.
    - `level` integer: The approval level of this reviewer in the review chain.
    - `enabled` boolean: Whether this reviewer is currently active in the review chain.
    - `approved` boolean: Whether this reviewer has approved. Derived server-side; not modifiable through the endpoints.
    - `current_status` 'comment' | 'file' | 'approval' | 'change_request': The current status of the review. This is not modifiable using the endpoints.
    - `user` User (unresolved $ref)
    - `role` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `portal_link` object
    - `exists` boolean
    - `created` boolean
    - `portal_url` string, uri
    - `invitation_email_sent` boolean

## Other responses

- `401`: Unauthorized
- `404`: Payable not found
- `422`: Unprocessable Entity — the payable has no business partner.

---

[API](https://skmtc.dev/cardda/apis/erp-api.md) - [All operations](https://skmtc.dev/cardda/apis/erp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cardda/apis/erp-api/revisions/0730ed26bc3c?raw)