Create Invoice Payment

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "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"
}

POST

accounting

invoice_payments

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "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.

curl --request POST \
  --url https://api.rootfi.dev/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

data.invoice_id

string | null

The accounting platform’s unique identifier for the invoice associated with this invoice payment

data.account_id

string | null

The accounting platform’s unique identifier for the account associated with this invoice payment

data.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this invoice payment

data.credit_note_id

string | null

The accounting platform’s unique identifier for the credit note associated with this invoice payment

data.currency_id

string | null

The accounting platform’s unique identifier for the currency associated with this invoice payment

data.amount

number<double> | null

The amount of the invoice payment

data.payment_date

string | null

The date of the invoice payment

data.payment_mode

string | null

The payment mode of the invoice payment

data.document_number

string | null

Reference number for the invoice payment

data.memo

string | null

Description of the invoice payment

data.raw_data

object

A JSON containing fields that you can directly pass to the accounting platform.

Response

200 - application/json

data

accountingtypesCreateInvoicePaymentsResponseData · object

required

Show child attributes

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

accountingtypesInvoicepaymentsResponse · object[]

required

Show child attributes

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

accountingtypesInvoicePaymentsWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this account

data.data.response.payment_id

string | null

The accounting platform’s unique identifier for this specific payment

data.data.response.invoice_id

string | null

The accounting platform’s unique identifier for the invoice associated with this invoice payment

data.data.response.account_id

string | null

The accounting platform’s unique identifier for the account associated with this invoice payment

data.data.response.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this invoice payment

data.data.response.credit_note_id

string | null

The accounting platform’s unique identifier for the credit note associated with this invoice payment

data.data.response.currency_id

string | null

The accounting platform’s unique identifier for the currency associated with this invoice payment

data.data.response.amount

number<double> | null

The amount of the invoice payment

data.data.response.payment_date

string | null

The date of the invoice payment

data.data.response.payment_mode

string | null

The payment mode of the invoice payment

data.data.response.document_number

string | null

Reference number for the invoice payment

data.data.response.memo

string | null

Description of the invoice payment

data.data.response.currency_rate

number<double> | null

Rate between the currency of the payment and the base currency

data.data.response.updated_at

string | null

The last ISO 8601 timestamp at which the payment data was updated

data.data.response.raw_data

object

The raw JSON response we receive from the accounting platform for this invoice payment

data.data.error

ErrorObject · object

The error message if the job failed.

Show child attributes

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object

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

Create Invoice Payments Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create Invoice Payment

Authorizations

Body

Response