Skip to main content
POST
/
core
/
companies
/
{company_id}
/
bill_payments
Create Bill Payments
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/{company_id}/bill_payments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "data": {
    "payment_id": "123456",
    "bill_id": "123456",
    "account_id": "123456",
    "credit_note_id": "123456",
    "amount": "123456",
    "payment_mode": "123456",
    "currency_id": "123456",
    "currency_rate": "123456",
    "memo": "123456",
    "updated_at": "2024-01-22T05:07:31.465Z",
    "payment_date": "2024-01-22T05:07:31.465Z",
    "contact_id": "123456",
    "document_number": "123456"
  }
}
'
{
  "data": {
    "rootfi_id": 157,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-22T05:07:31.465Z",
    "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
    "rootfi_company_id": 1089,
    "platform_id": "123456_1",
    "payment_id": "123456",
    "bill_id": "123456",
    "account_id": "123456",
    "credit_note_id": "123456",
    "amount": "123456",
    "payment_mode": "123456",
    "currency_id": "123456",
    "currency_rate": "123456",
    "memo": "123456",
    "updated_at": "2024-01-22T05:07:31.465Z",
    "payment_date": "2024-01-22T05:07:31.465Z",
    "contact_id": "123456",
    "document_number": "123456"
  }
}

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

The Bill Payments Data Model is designed to standardise and simplify the management of bill payment information across various accounting platforms.

​
Additional Required Fields

To successfully create a bill payment, certain fields must be included in the raw_data object of the request body. The required fields are as follows:
IntegrationFieldDescription
MS_DYNAMICS_365payment_journal_idThe ID of the payment journal.

Authorizations

​
api_key
string
header
required

Path Parameters

​
company_id
integer
required

RootFi company ID for the company connection to read or write.

Query Parameters

​
run_async
boolean
default:false

When true, the write runs asynchronously and returns only a sync_id. Required when data contains two or more records. Optional for single-record writes.

Body

application/json
​
data
accountingBillPaymentsFields · object
required

Single record for synchronous writes (default). For two or more records, pass an array and set query parameter run_async=true.

Response

​
data
accountingBillPaymentsObject · object

The data of the bill payments endpoint

​
sync_id
string | null

The sync id of the request