Skip to main content
POST
/
v2
/
accounts-payable
/
payables
/
{payable_id}
/
pay
Pay a payable
curl --request POST \
  --url https://api.dots.dev/api/v2/accounts-payable/payables/{payable_id}/pay \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acting_user_id": 123
}
'
{
  "action_history": [
    {
      "comment": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "user_id": 123,
      "user_name": "<string>"
    }
  ],
  "amount": 123,
  "ap_payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ap_payment_method_name": "<string>",
  "ap_vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ap_vendor_name": "<string>",
  "api_app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approval_steps": [
    {
      "completed": true,
      "completed_timestamp": "2023-11-07T05:31:56Z",
      "num_approvals_required": 123,
      "user_approvals": [
        {
          "approval_comment": "<string>",
          "approval_given": true,
          "approval_timestamp": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "user_id": 123
        }
      ]
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "file_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "amount": 2,
      "description": "<string>",
      "name": "<string>",
      "quantity": 2,
      "unit_price": 2
    }
  ],
  "number": "<string>",
  "status": "<string>",
  "status_history": [
    {
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "transfer_history": [
    {
      "created_timestamp": "2023-11-07T05:31:56Z",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
payable_id
string
required

The ID of the Payable

Body

application/json
​
acting_user_id
integer
required

The ID of the user performing this action. This will be displayed in the developer dashboard.

Response

200 - application/json

OK

​
action_history
object[]
​
amount
number

Total payable amount in cents.

​
funding_source
enum<string>
Available options:
dots_balance,
ach
​
ap_payment_method_id
string<uuid>
​
ap_payment_method_name
string
​
ap_vendor_id
string<uuid>
​
ap_vendor_name
string
​
api_app_id
string<uuid>
​
approval_steps
object[]
​
created
string<date-time>
​
currency
string
​
description
string | null
​
external_id
string | null
​
file_url
string<uri> | null
​
id
string<uuid>
​
items
object[]
​
number
string
​
status
string
​
status_history
object[]
​
transfer_history
object[]
​
transfer_id
string<uuid>
​
updated
string<date-time>