Create Invoice Payments

Create a new invoice payments in the database.

POST /accounting/invoice_payments

cURL

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"
    }
  ]
}'

200

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "3770712000001688003",
          "payment_id": "3770712000001688001",
          "invoice_id": "3770712000000707001",
          "account_id": "3770712000000000361",
          "credit_note_id": "1234567890123456789",
          "contact_id": "3770712000000226001",
          "currency_id": "3770712000000000099",
          "amount": 19,
          "payment_date": "2023-03-01T00:00:00.000Z",
          "payment_mode": "Cash",
          "document_number": "S77",
          "memo": "Invoice payment",
          "currency_rate": 12,
          "updated_at": "2023-10-27T00:00:00.000Z",
          "raw_data": {
            "platform_id": "123456",
            "nominal_code": "Rootfi 01",
            "name": "Test Account",
            "description": "Test Description",
            "category": "LIABILITY",
            "sub_category": "Long Term Liabilities",
            "status": "ACTIVE"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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

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

company_id · integer · required

Example:

1

data · accountingtypesInvoicePaymentsWriteRequestFields · object[] · required

Show child attributes

Response

200 - application/json

data · accountingtypesCreateInvoicePaymentsResponseData · object · required

Show child attributes

request_timestamp · string<date-time> · required

The time at which the request was received by the server

response_timestamp · string<date-time> · required

The time at which the response was sent by the server

request_id · string · required

The unique ID of the request