Create Document

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'api_key: <api-key>' \
  --form file='@example-file' \
  --form company_id=123 \
  --form 'document_type_id=<string>' \
  --form document_type=BILLS \
  --form 'base64_file=<string>' \
  --form 'file_name=<string>'

{
  "data": {
    "rootfi_id": 157,
    "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",
    "rootfi_deleted_at": "2023-11-07T05:31:56Z",
    "platform_unique_id": "<string>",
    "raw_data": {},
    "data_hash": "<string>",
    "file_name": "<string>",
    "file_type": "<string>",
    "file_size": "<string>",
    "document_type_id": "<string>",
    "document_type": "<string>",
    "document_uploaded": true,
    "updated_at": "<string>"
  },
  "sync_id": "<string>"
}

POST

accounting

documents

Create Document

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'api_key: <api-key>' \
  --form file='@example-file' \
  --form company_id=123 \
  --form 'document_type_id=<string>' \
  --form document_type=BILLS \
  --form 'base64_file=<string>' \
  --form 'file_name=<string>'

{
  "data": {
    "rootfi_id": 157,
    "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",
    "rootfi_deleted_at": "2023-11-07T05:31:56Z",
    "platform_unique_id": "<string>",
    "raw_data": {},
    "data_hash": "<string>",
    "file_name": "<string>",
    "file_type": "<string>",
    "file_size": "<string>",
    "document_type_id": "<string>",
    "document_type": "<string>",
    "document_uploaded": true,
    "updated_at": "<string>"
  },
  "sync_id": "<string>"
}

The Documents Data Model simplifies the handling of document documents across various accounting platforms, providing a standardised approach to accessing and managing document-related information. To Upload a file using Node JS SDK, you can use the following code:

import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "*****" });
await rootfi.accounting.documents.create(fs.createReadStream("./helpers/test_img.png"), {
  companyId: 12,
  documentType: "BILLS",
  documentTypeId: "3770712000000689685",
});

Authorizations

api_key

string

header

required

Body

multipart/form-data

file

company_id

integer

The company ID of the document

document_type_id

string | null

The document type ID of the document

document_type

enum<string>

The document type of the document

Available options:

BILLS,

INVOICES,

BILL_CREDIT_NOTES,

INVOICE_CREDIT_NOTES,

EXPENSES,

PURCHASE_ORDERS,

SALES_ORDERS

base64_file

string | null

The base64 file of the document

file_name

string | null

The file name of the document

Response

data

accountingDocumentObject · object

The data of the created document

Show child attributes

data.rootfi_id

number<double>

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string<date-time>

required

The date at which RootFi first synced this data

Example:

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

data.rootfi_updated_at

string<date-time>

required

The latest date at which RootFi updated this data

Example:

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

data.rootfi_company_id

number<double>

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<date-time> | 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

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

data.data_hash

string | null

The hash of the data

data.file_name

string | null

The file name of the document

data.file_type

string | null

The file type of the document

data.file_size

string | null

The file size of the document

data.document_type_id

string | null

The platform_id of the voucher to which the file will be linked to.

data.document_type

string | null

The document type of the document

data.document_uploaded

boolean | null

The document uploaded of the document

data.updated_at

string | null

The updated date of the document

sync_id

string | null

The sync id of the request

Get All Documents Download Document

⌘I

General

Server Side SDKs

Core API

Unified API

Create Document

Authorizations

Body

Response