Create Document

Create a new Document.

POST /accounting/documents

Create Document

cURL

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>'

200

{
  "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 · 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

200

application/json

data · accountingDocumentObject · object

The data of the created document

Show child attributes

sync_id · string | null

The sync id of the request