Skip to main content
POST
/
core
/
companies
/
{company_id}
/
invoice_payments
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/1/invoice_payments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "data": {
    "invoice_id": "123456",
    "account_id": "123456",
    "contact_id": "123456",
    "amount": 100,
    "payment_date": "2021-09-28T15:00:00.000Z",
    "document_number": "ROOTFI01",
    "memo": "Test Memo"
  }
}'

{
  "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",
    "invoice_id": "123456",
    "account_id": "123456",
    "credit_note_id": "123456",
    "amount": 123.4,
    "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 Invoice Payments Data Model streamlines the representation and management of invoice payment information across multiple accounting platforms.

​
Additional Required Fields

To successfully create an invoice 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.
NETSUITEarr_account_idThe ID of the account to which the payment is applied.
Pass data as a single object for synchronous writes (default). For writes with two or more records, pass data as an array and add ?run_async=true. You can also set ?run_async=true with a single record to run asynchronously and receive only a sync_id.
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/1/invoice_payments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "data": {
    "invoice_id": "123456",
    "account_id": "123456",
    "contact_id": "123456",
    "amount": 100,
    "payment_date": "2021-09-28T15:00:00.000Z",
    "document_number": "ROOTFI01",
    "memo": "Test Memo"
  }
}'

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
accountingInvoicePaymentsFields · 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
accountingInvoicePaymentsObject · object

The data of the invoice payments endpoint

​
sync_id
string | null

The sync id of the request