Create Sales Orders - Integrations by Commenda

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/sales_orders \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "contact_id": "123456",
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "delivery_date": "2021-09-28T15:00:00.000Z",
      "currency_id": "GBP",
      "invoice_ids": [],
      "line_items": [
        {
          "account_id": "123456",
          "quantity": 1,
          "item_id": "123456",
          "tax_id": "123456",
          "unit_amount": 100,
          "total_discount": 0,
          "description": "Test Item"
        }
      ]
    }
  ]
}'

import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "<api_key>" });

await rootfi.accounting.salesOrder.create({
  company_id: 1,
  data: [
    {
      contact_id: "123456",
      document_number: "ROOTFI01",
      posted_date: "2021-09-28T15:00:00.000Z",
      delivery_date: "2021-09-28T15:00:00.000Z",
      currency_id: "GBP",
      invoice_ids: [],
      line_items: [
        {
          account_id: "123456",
          quantity: 1,
          item_id: "123456",
          tax_id: "123456",
          unit_amount: 100,
          total_discount: 0,
          description: "Test Item",
        },
      ],
    },
  ],
});

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "3770712000001652001",
          "contact_id": "3770712000000080863",
          "invoice_ids": [
            "3770712000000000099"
          ],
          "currency_id": "3770712000000000099",
          "document_number": "PO-00073",
          "posted_date": "2023-04-01T00:00:00.000Z",
          "delivery_date": "2023-05-01T00:00:00.000Z",
          "description": "Test Invoice",
          "currency_rate": 12,
          "status": "SUBMITTED",
          "total_amount": 21.28,
          "sub_total": 19,
          "tax_amount": 2.28,
          "total_discount": 0,
          "updated_at": "2023-10-28T00:00:00.000Z",
          "raw_data": {
            "platform_id": "1013",
            "name": "Test",
            "contact_name": "Test",
            "contact_type": "CUSTOMER",
            "currency_id": "1",
            "status": "ARCHIVED"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2023-10-27T05:05:28.522Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

sales_orders

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/sales_orders \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "contact_id": "123456",
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "delivery_date": "2021-09-28T15:00:00.000Z",
      "currency_id": "GBP",
      "invoice_ids": [],
      "line_items": [
        {
          "account_id": "123456",
          "quantity": 1,
          "item_id": "123456",
          "tax_id": "123456",
          "unit_amount": 100,
          "total_discount": 0,
          "description": "Test Item"
        }
      ]
    }
  ]
}'

import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "<api_key>" });

await rootfi.accounting.salesOrder.create({
  company_id: 1,
  data: [
    {
      contact_id: "123456",
      document_number: "ROOTFI01",
      posted_date: "2021-09-28T15:00:00.000Z",
      delivery_date: "2021-09-28T15:00:00.000Z",
      currency_id: "GBP",
      invoice_ids: [],
      line_items: [
        {
          account_id: "123456",
          quantity: 1,
          item_id: "123456",
          tax_id: "123456",
          unit_amount: 100,
          total_discount: 0,
          description: "Test Item",
        },
      ],
    },
  ],
});

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "3770712000001652001",
          "contact_id": "3770712000000080863",
          "invoice_ids": [
            "3770712000000000099"
          ],
          "currency_id": "3770712000000000099",
          "document_number": "PO-00073",
          "posted_date": "2023-04-01T00:00:00.000Z",
          "delivery_date": "2023-05-01T00:00:00.000Z",
          "description": "Test Invoice",
          "currency_rate": 12,
          "status": "SUBMITTED",
          "total_amount": 21.28,
          "sub_total": 19,
          "tax_amount": 2.28,
          "total_discount": 0,
          "updated_at": "2023-10-28T00:00:00.000Z",
          "raw_data": {
            "platform_id": "1013",
            "name": "Test",
            "contact_name": "Test",
            "contact_type": "CUSTOMER",
            "currency_id": "1",
            "status": "ARCHIVED"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2023-10-27T05:05:28.522Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

A Sales order is a record of goods or services sold to a customer

Additional Required Fields

To successfully create a sales order, certain fields must be included in the raw_data object of the request body. The required fields are as follows:

Integration	Field	Description
MYOB_BUSINESS	tax_code	The tax code for the sales order
QOYOD	quotation_no	The quotation number for the sales order
QOYOD	expiry_date	The expiry date of the quotation
QOYOD	inventory_id	The inventory id of the sales order

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/sales_orders \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 1,
  "data": [
    {
      "contact_id": "123456",
      "document_number": "ROOTFI01",
      "posted_date": "2021-09-28T15:00:00.000Z",
      "delivery_date": "2021-09-28T15:00:00.000Z",
      "currency_id": "GBP",
      "invoice_ids": [],
      "line_items": [
        {
          "account_id": "123456",
          "quantity": 1,
          "item_id": "123456",
          "tax_id": "123456",
          "unit_amount": 100,
          "total_discount": 0,
          "description": "Test Item"
        }
      ]
    }
  ]
}'

import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "<api_key>" });

await rootfi.accounting.salesOrder.create({
  company_id: 1,
  data: [
    {
      contact_id: "123456",
      document_number: "ROOTFI01",
      posted_date: "2021-09-28T15:00:00.000Z",
      delivery_date: "2021-09-28T15:00:00.000Z",
      currency_id: "GBP",
      invoice_ids: [],
      line_items: [
        {
          account_id: "123456",
          quantity: 1,
          item_id: "123456",
          tax_id: "123456",
          unit_amount: 100,
          total_discount: 0,
          description: "Test Item",
        },
      ],
    },
  ],
});

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

Example:

1

data

accountingtypesSalesOrderWriteRequest · object[]

required

Show child attributes

Response

200 - application/json

data

accountingtypesCreateSalesOrderResponseData · 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

Get All Sales Orders

Overview

​Additional Required Fields

Authorizations

Body

Response

Additional Required Fields