Create Invoice Payments

Integrations Roadmap

Data Coverage Tool

General

Server Side SDKs

Core API

Unified API

POST

accounting

invoice_payments

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/invoice_payments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "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",
    "platform_unique_id": "123456",
    "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"
  }
}

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:

Integration	Field	Description
MS_DYNAMICS_365	payment_journal_id	The ID of the payment journal.
NETSUITE	arr_account_id	The ID of the account to which the payment is applied.

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/invoice_payments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "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

Body

application/json

Response

200