Update Invoice

Integrations Roadmap

Data Coverage Tool

General

Overview

Server Side SDKs

Typescript SDK

Core API

Companies
Invite Links
Sync
Passthrough
Real Time
Webhooks

Unified API

Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
  - Overview
  - Overview
  - GET
    Get All Invoices
  - POST
    Get Invoices
  - POST
    Create Invoice
  - PUT
    Update Invoice
  - POST
    Create Invoice
- Invoice Payments
- Items
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Payments
Ecommerce
CRM

PUT

accounting

invoices

curl --request PUT \
  --url https://api.rootfi.dev/v3/accounting/invoices \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 123,
  "data": [
    {
      "platform_id": "1af68894-ea9f-ee11-be36-7c1e520f50bc",
      "currency_id": "123456",
      "contact_id": "123456",
      "total_discount": 100,
      "document_number": "123456",
      "posted_date": "2024-01-25T09:00:00Z",
      "due_date": "2024-01-25T09:00:00Z",
      "memo": "Example Memo",
      "status": "Example Status",
      "currency_rate": 1,
      "sales_order_ids": [
        "123456"
      ],
      "line_items": [
        {
          "tracking_category_ids": [
            "123456"
          ],
          "project_id": "123456",
          "item_id": "123456",
          "tax_id": "123456",
          "account_id": "123456",
          "description": "This is a description",
          "quantity": 1,
          "unit_amount": 100,
          "total_discount": 100
        }
      ]
    }
  ]
}'

{
  "data": {
    "rootfi_id": 123,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-25T09:00:00Z",
    "rootfi_updated_at": "2024-01-25T09:00:00Z",
    "rootfi_company_id": 456,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "currency_id": "123456",
    "contact_id": "123456",
    "total_discount": 100,
    "sub_total": 1000,
    "tax_amount": 100,
    "total_amount": 1100,
    "amount_due": 1100,
    "document_number": "123456",
    "posted_date": "2024-01-25T09:00:00Z",
    "due_date": "2024-01-25T09:00:00Z",
    "memo": "Example Memo",
    "updated_at": "2024-01-25T09:00:00Z",
    "status": "Example Status",
    "currency_rate": 1,
    "sales_order_ids": [
      "123456"
    ],
    "line_items": [
      {
        "rootfi_id": 157,
        "platform_id": "123456",
        "line_item_type": "INVOICES",
        "line_item_type_id": "123456",
        "tracking_category_ids": [
          "123456"
        ],
        "project_id": "123456",
        "item_id": "123456",
        "tax_id": "123456",
        "account_id": "123456",
        "description": "This is a description",
        "quantity": 1,
        "unit_amount": 100,
        "total_amount": 100,
        "sub_total": 100,
        "tax_amount": 100,
        "total_discount": 100,
        "updated_at": "2024-01-22T05:07:31.000Z"
      }
    ]
  }
}

An invoice is an itemized record of goods sold or services provided to a customer.

Only supported for Zoho Books, Quickbooks, Xero

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

object[]

required

The data of the invoice to update

run_async

boolean | null

Run the request asynchronously

Response

200

application/json

data

object

The data of the created invoice

data.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.currency_id

string | null

The currency ID of the invoice

data.contact_id

string | null

The contact ID of the invoice

data.total_discount

number | null

The total discount of the invoice

data.sub_total

number | null

The sub total of the invoice

data.tax_amount

number | null

The tax amount of the invoice

data.total_amount

number | null

The total amount of the invoice

data.amount_due

number | null

The amount due of the invoice

data.document_number

string | null

The document number of the invoice

data.posted_date

string | null

The posted date of the invoice

data.due_date

string | null

The due date of the invoice

data.memo

string | null

The memo of the invoice

data.updated_at

string | null

The updated at of the invoice

data.status

string | null

The status of the invoice

data.currency_rate

number | null

The currency rate of the invoice

data.sales_order_ids

string[] | null

The sales order IDs of the invoice

data.line_items

object[] | null

The line items of the invoice

data.line_items.rootfi_id

number | null

The unique ID we assign for that data's information

data.line_items.platform_id

string | null

The platform id of the line item

data.line_items.line_item_type

enum<string>

The line item type of the line item

Available options:

BILLS,

INVOICES,

BILL_CREDIT_NOTES,

INVOICE_CREDIT_NOTES,

EXPENSES,

PURCHASE_ORDERS,

SALES_ORDERS

data.line_items.line_item_type_id

string | null

The line item type id of the line item

data.line_items.tracking_category_ids

string[] | null

The tracking category ids of the line item

data.line_items.project_id

string | null

The project id of the line item

data.line_items.item_id

string | null

The item id of the line item

data.line_items.item

object

The item of the line item

data.line_items.item.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.line_items.item.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.line_items.item.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.line_items.item.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.line_items.item.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.line_items.item.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.line_items.item.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.line_items.item.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.line_items.item.data_hash

string | null

The hash of the data

data.line_items.item.name

string | null

Name of the item

data.line_items.item.description

string | null

Description of the item

data.line_items.item.status

enum<string>

Status of the item. Values are ACTIVE, ARCHIVED, UNKNOWN

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.line_items.item.type

enum<string>

Type of the item. Values are INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN

Available options:

INVENTORY,

NON_INVENTORY,

SERVICE,

UNKNOWN

data.line_items.item.code

string | null

Reference code of the item

data.line_items.item.quantity_on_hand

integer | null

Quantity on hand

data.line_items.item.is_bill_item

boolean | null

Check if there are details (bill_item) of this item getting purchased

data.line_items.item.bill_item

object

Item details of this item getting purchased

data.line_items.item.is_invoice_item

boolean | null

Check if there are details (invoice_item) of this item getting sold

data.line_items.item.invoice_item

object

Item details of this item getting sold

data.line_items.item.updated_at

string | null

The date the item was last updated

data.line_items.tax_id

string | null

The tax id of the line item

data.line_items.tax

object

The tax of the line item

data.line_items.tax.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.line_items.tax.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.line_items.tax.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.line_items.tax.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.line_items.tax.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.line_items.tax.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.line_items.tax.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.line_items.tax.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.line_items.tax.data_hash

string | null

The hash of the data

data.line_items.tax.name

string | null

Display name

data.line_items.tax.code

string | null

Simple ID for the tax rate

data.line_items.tax.tax_type

string | null

The type of tax as mentioned in the accounting platform

data.line_items.tax.effective_tax_rate

number | null

The total tax rate after accounting for the compounding effects of the all tax components

data.line_items.tax.total_tax_rate

number | null

The sum of all the tax rate components

data.line_items.tax.components

object[] | null

The list of tax rate components

data.line_items.tax.updated_at

string | null

The last time the tax rate was updated

data.line_items.account_id

string | null

The account id of the line item

data.line_items.account

object

The account of the line item

data.line_items.account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.line_items.account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.line_items.account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.line_items.account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.line_items.account.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.line_items.account.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.line_items.account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.line_items.account.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.line_items.account.data_hash

string | null

The hash of the data

data.line_items.account.name

string | null

Name of the account

data.line_items.account.description

string | null

Description of the account

data.line_items.account.nominal_code

string | null

The nominal code of the account

data.line_items.account.current_balance

number | null

The current balance of the account

data.line_items.account.updated_at

string | null

The date the account was last updated

data.line_items.account.status

string | null

The status of the account

data.line_items.account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.line_items.account.sub_category

string | null

The sub category of the account

data.line_items.account.currency_id

string | null

The currency id of the account

data.line_items.account.parent_account_id

string | null

The parent account id of the account

data.line_items.account.parent_account

object

The parent account of the account.

data.line_items.account.parent_account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.line_items.account.parent_account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.line_items.account.parent_account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.line_items.account.parent_account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.line_items.account.parent_account.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.line_items.account.parent_account.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.line_items.account.parent_account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.line_items.account.parent_account.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.line_items.account.parent_account.data_hash

string | null

The hash of the data

data.line_items.account.parent_account.name

string | null

Name of the account

data.line_items.account.parent_account.description

string | null

Description of the account

data.line_items.account.parent_account.nominal_code

string | null

The nominal code of the account

data.line_items.account.parent_account.current_balance

number | null

The current balance of the account

data.line_items.account.parent_account.updated_at

string | null

The date the account was last updated

data.line_items.account.parent_account.status

string | null

The status of the account

data.line_items.account.parent_account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.line_items.account.parent_account.sub_category

string | null

The sub category of the account

data.line_items.account.parent_account.currency_id

string | null

The currency id of the account

data.line_items.account.parent_account.parent_account_id

string | null

The parent account id of the account

data.line_items.account.currency

object

The currency of the account.

data.line_items.description

string | null

The description of the line item

data.line_items.quantity

number | null

The quantity of the line item

data.line_items.unit_amount

number | null

The unit amount of the line item

data.line_items.total_amount

number | null

The total amount of the line item

data.line_items.sub_total

number | null

The sub total of the line item

data.line_items.tax_amount

number | null

The tax amount of the line item

data.line_items.total_discount

number | null

The total discount of the line item

data.line_items.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.currency

object

The currency of the invoice

data.contact

object

The contact of the invoice

data.contact.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.contact.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.contact.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.contact.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.contact.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.contact.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.contact.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.contact.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.contact.data_hash

string | null

The hash of the data

data.contact.name

string | null

Name of the contact

data.contact.contact_name

string | null

Name of the contact person for the contact

data.contact.contact_type

enum<string>

The type of contact. Values are either CUSTOMER or VENDOR

Available options:

CUSTOMER,

VENDOR

data.contact.currency_id

string | null

The ISO-4217 currency code

data.contact.tax_number

string | null

Contact’s tax number

data.contact.registration_number

string | null

Contact’s identifying number

data.contact.status

enum<string>

The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.contact.updated_at

string | null

The date the contact was last updated

data.contact.external_links

object[] | null

External links for the contact

data.contact.phone_numbers

object[] | null

Phone numbers for the contact

data.contact.addresses

object[] | null

Addresses for the contact

data.documents

object[] | null

The documents of the invoice

data.invoice_payments

object[] | null

The invoice payments of the invoice

data.invoice_payments.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.invoice_payments.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.invoice_payments.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.invoice_payments.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.invoice_payments.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.invoice_payments.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.invoice_payments.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.invoice_payments.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.invoice_payments.data_hash

string | null

The hash of the data

data.invoice_payments.payment_id

string | null

The payment id of the invoice payments

data.invoice_payments.invoice_id

string | null

The invoice id of the invoice payments

data.invoice_payments.account_id

string | null

The account id of the invoice payments

data.invoice_payments.credit_note_id

string | null

The credit note id of the invoice payments

data.invoice_payments.amount

number | null

The amount of the invoice payments

data.invoice_payments.payment_mode

string | null

The payment mode of the invoice payments

data.invoice_payments.currency_id

string | null

The currency id of the invoice payments

data.invoice_payments.currency_rate

string | null

The currency rate of the invoice payments

data.invoice_payments.memo

string | null

The memo of the invoice payments

data.invoice_payments.updated_at

string | null

The updated date of the invoice payments

data.invoice_payments.payment_date

string | null

The payment date of the invoice payments

data.invoice_payments.contact_id

string | null

The contact id of the invoice payments

data.invoice_payments.document_number

string | null

The document number of the invoice payments

sync_id

string | null

The sync id of the request

Create Invoice Create Invoice

curl --request PUT \
  --url https://api.rootfi.dev/v3/accounting/invoices \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 123,
  "data": [
    {
      "platform_id": "1af68894-ea9f-ee11-be36-7c1e520f50bc",
      "currency_id": "123456",
      "contact_id": "123456",
      "total_discount": 100,
      "document_number": "123456",
      "posted_date": "2024-01-25T09:00:00Z",
      "due_date": "2024-01-25T09:00:00Z",
      "memo": "Example Memo",
      "status": "Example Status",
      "currency_rate": 1,
      "sales_order_ids": [
        "123456"
      ],
      "line_items": [
        {
          "tracking_category_ids": [
            "123456"
          ],
          "project_id": "123456",
          "item_id": "123456",
          "tax_id": "123456",
          "account_id": "123456",
          "description": "This is a description",
          "quantity": 1,
          "unit_amount": 100,
          "total_discount": 100
        }
      ]
    }
  ]
}'

{
  "data": {
    "rootfi_id": 123,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-25T09:00:00Z",
    "rootfi_updated_at": "2024-01-25T09:00:00Z",
    "rootfi_company_id": 456,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "currency_id": "123456",
    "contact_id": "123456",
    "total_discount": 100,
    "sub_total": 1000,
    "tax_amount": 100,
    "total_amount": 1100,
    "amount_due": 1100,
    "document_number": "123456",
    "posted_date": "2024-01-25T09:00:00Z",
    "due_date": "2024-01-25T09:00:00Z",
    "memo": "Example Memo",
    "updated_at": "2024-01-25T09:00:00Z",
    "status": "Example Status",
    "currency_rate": 1,
    "sales_order_ids": [
      "123456"
    ],
    "line_items": [
      {
        "rootfi_id": 157,
        "platform_id": "123456",
        "line_item_type": "INVOICES",
        "line_item_type_id": "123456",
        "tracking_category_ids": [
          "123456"
        ],
        "project_id": "123456",
        "item_id": "123456",
        "tax_id": "123456",
        "account_id": "123456",
        "description": "This is a description",
        "quantity": 1,
        "unit_amount": 100,
        "total_amount": 100,
        "sub_total": 100,
        "tax_amount": 100,
        "total_discount": 100,
        "updated_at": "2024-01-22T05:07:31.000Z"
      }
    ]
  }
}