Create a payable

curl --request POST \
  --url https://api.dots.dev/api/v2/accounts-payable/payables \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acting_user_id": 123,
  "number": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "ap_vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ap_payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 2,
  "funding_source": "dots_balance",
  "file": "aSDinaTvuI8gbWludGxpZnk=",
  "items": [
    {
      "name": "<string>",
      "unit_price": 2,
      "quantity": 2,
      "amount": 2,
      "description": "<string>"
    }
  ]
}
'

{
  "action_history": [
    {
      "action": "create",
      "comment": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "user_id": 123,
      "user_name": "<string>",
      "user_role": "admin"
    }
  ],
  "amount": 123,
  "funding_source": "dots_balance",
  "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": [
    {
      "status": "created",
      "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"
}

POST

accounts-payable

payables

Create a payable

curl --request POST \
  --url https://api.dots.dev/api/v2/accounts-payable/payables \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acting_user_id": 123,
  "number": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "ap_vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ap_payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 2,
  "funding_source": "dots_balance",
  "file": "aSDinaTvuI8gbWludGxpZnk=",
  "items": [
    {
      "name": "<string>",
      "unit_price": 2,
      "quantity": 2,
      "amount": 2,
      "description": "<string>"
    }
  ]
}
'

{
  "action_history": [
    {
      "action": "create",
      "comment": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "user_id": 123,
      "user_name": "<string>",
      "user_role": "admin"
    }
  ],
  "amount": 123,
  "funding_source": "dots_balance",
  "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": [
    {
      "status": "created",
      "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.

Body

application/json

acting_user_id

integer

required

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

number

string

required

description

string

external_id

string

ap_vendor_id

string<uuid>

ap_payment_method_id

string<uuid>

amount

number

Total payable amount in cents.

Required range: x >= 1

funding_source

enum<string>

The funding source for the payable.

If dots_balance is specified, uses the app's Dots wallet balance to pay the payable.

If ach is specified, uses a bank transfer from the app's linked bank account to pay the payable.

If not specified, defaults to ach.

Available options:

dots_balance,

ach

file

Base64 encoded pdf file to attach to payable.

items

object[]

Show child attributes

items.name

string

required

Minimum string length: 1

items.unit_price

number

required

Item unit price in cents.

Required range: x >= 1

items.quantity

number

required

Required range: x >= 1

items.amount

number

required

Total line item amount in cents. This should be the unit price multiplied by the quantity.

Required range: x >= 1

items.description

string

Response

201 - application/json

Created

action_history

object[]

Show child attributes

action_history.action

enum<string>

Available options:

create,

cancel,

submit_for_approval,

approve,

reject,

initiate_payment,

retry_payment

action_history.comment

string | null

action_history.timestamp

string<date-time>

action_history.user_id

integer

action_history.user_name

string

action_history.user_role

enum<string>

Available options:

admin,

viewer,

payer,

ap_approver,

ap_creator

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[]

Show child attributes

approval_steps.completed

boolean

approval_steps.completed_timestamp

string<date-time>

approval_steps.num_approvals_required

integer

approval_steps.user_approvals

object[]

Show child attributes

approval_steps.user_approvals.approval_comment

string | null

approval_steps.user_approvals.approval_given

boolean

approval_steps.user_approvals.approval_timestamp

string<date-time>

approval_steps.user_approvals.name

string

approval_steps.user_approvals.user_id

integer

created

string<date-time>

currency

string

description

string | null

external_id

string | null

file_url

string<uri> | null

string<uuid>

items

object[]

Show child attributes

items.amount

number

Total line item amount in cents. This should be the unit price multiplied by the quantity.

Required range: x >= 1

items.description

string

items.name

string

Minimum string length: 1

items.quantity

number

Required range: x >= 1

items.unit_price

number

Item unit price in cents.

Required range: x >= 1

number

string

status

string

status_history

object[]

Show child attributes

status_history.status

enum<string>

Available options:

created,

canceled,

submitted_for_approval,

rejected,

approved,

payment_initiated,

payment_failed,

payment_completed

status_history.timestamp

string<date-time>

transfer_history

object[]

Show child attributes

transfer_history.created_timestamp

string<date-time>

transfer_history.idempotency_key

string<uuid>

transfer_history.transfer_id

string<uuid>

transfer_id

string<uuid>

updated

string<date-time>

List all payables Create a payable from a file

⌘I

users

transfers

flows

payout-links

payouts

payout-batches

payments

payout-requests

transactions

payment-intents

transfer-batches

payment-customers

checkout-sessions

accounts-payable

apps

payment-methods

disputes

refunds

organizations

Create a payable

Authorizations

Body

Response