Update a cash sale
curl --request PUT \
--url https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"data": {
"platform_id": "string",
"platform_unique_id": "string",
"document_number": "string",
"posted_date": "2024-01-01T00:00:00Z",
"currency_id": "AED",
"total_discount": 0,
"sub_total": 0,
"tax_amount": 0,
"is_tax_inclusive": false,
"total_amount": 0,
"memo": "string",
"shipping_amount": 0,
"status": "DRAFT",
"currency_rate": 0,
"contact_id": "string",
"updated_at": "2024-01-01T00:00:00Z",
"line_items": [
{
"platform_id": "string",
"tracking_category_ids": [
"string"
],
"parent_id": "string",
"parent_type": "BILL",
"item_id": "string",
"name": "string",
"description": "string",
"quantity": 0,
"unit_amount": 0,
"tax_amount": 0,
"is_tax_inclusive": false,
"discount_amount": 0,
"sub_total": 0,
"total_amount": 0,
"tax_id": "string",
"account_id": "string",
"variant_id": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"contact": [
{
"platform_id": "string",
"name": "string",
"contact_name": "string",
"email": "string",
"phone": "string",
"tax_number": "string",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "string",
"website": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"phone_numbers": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"number": "string",
"type": "MOBILE"
}
],
"external_links": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"link": "string",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"platform_id": "string",
"name": "string",
"code": "string",
"symbol": "string",
"is_base_currency": false,
"exchange_rate": 0,
"updated_at": "2024-01-01T00:00:00Z"
}
]
}
}
'import requests
url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales"
payload = { "data": {
"platform_id": "string",
"platform_unique_id": "string",
"document_number": "string",
"posted_date": "2024-01-01T00:00:00Z",
"currency_id": "AED",
"total_discount": 0,
"sub_total": 0,
"tax_amount": 0,
"is_tax_inclusive": False,
"total_amount": 0,
"memo": "string",
"shipping_amount": 0,
"status": "DRAFT",
"currency_rate": 0,
"contact_id": "string",
"updated_at": "2024-01-01T00:00:00Z",
"line_items": [
{
"platform_id": "string",
"tracking_category_ids": ["string"],
"parent_id": "string",
"parent_type": "BILL",
"item_id": "string",
"name": "string",
"description": "string",
"quantity": 0,
"unit_amount": 0,
"tax_amount": 0,
"is_tax_inclusive": False,
"discount_amount": 0,
"sub_total": 0,
"total_amount": 0,
"tax_id": "string",
"account_id": "string",
"variant_id": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"contact": [
{
"platform_id": "string",
"name": "string",
"contact_name": "string",
"email": "string",
"phone": "string",
"tax_number": "string",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "string",
"website": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"phone_numbers": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"number": "string",
"type": "MOBILE"
}
],
"external_links": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"link": "string",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"platform_id": "string",
"name": "string",
"code": "string",
"symbol": "string",
"is_base_currency": False,
"exchange_rate": 0,
"updated_at": "2024-01-01T00:00:00Z"
}
]
} }
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
platform_id: 'string',
platform_unique_id: 'string',
document_number: 'string',
posted_date: '2024-01-01T00:00:00Z',
currency_id: 'AED',
total_discount: 0,
sub_total: 0,
tax_amount: 0,
is_tax_inclusive: false,
total_amount: 0,
memo: 'string',
shipping_amount: 0,
status: 'DRAFT',
currency_rate: 0,
contact_id: 'string',
updated_at: '2024-01-01T00:00:00Z',
line_items: [
{
platform_id: 'string',
tracking_category_ids: ['string'],
parent_id: 'string',
parent_type: 'BILL',
item_id: 'string',
name: 'string',
description: 'string',
quantity: 0,
unit_amount: 0,
tax_amount: 0,
is_tax_inclusive: false,
discount_amount: 0,
sub_total: 0,
total_amount: 0,
tax_id: 'string',
account_id: 'string',
variant_id: 'string',
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z'
}
],
addresses: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
type: 'SHIPPING',
street: 'string',
street2: 'string',
locality: 'string',
city: 'string',
state: 'string',
postal_code: 'string',
country: 'string'
}
],
contact: [
{
platform_id: 'string',
name: 'string',
contact_name: 'string',
email: 'string',
phone: 'string',
tax_number: 'string',
type: 'CUSTOMER',
status: 'ACTIVE',
currency_id: 'AED',
registration_number: 'string',
website: 'string',
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z',
addresses: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
type: 'SHIPPING',
street: 'string',
street2: 'string',
locality: 'string',
city: 'string',
state: 'string',
postal_code: 'string',
country: 'string'
}
],
phone_numbers: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
number: 'string',
type: 'MOBILE'
}
],
external_links: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
link: 'string',
type: 'WEBSITE'
}
]
}
],
currency: [
{
platform_id: 'string',
name: 'string',
code: 'string',
symbol: 'string',
is_base_currency: false,
exchange_rate: 0,
updated_at: '2024-01-01T00:00:00Z'
}
]
}
})
};
fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'platform_id' => 'string',
'platform_unique_id' => 'string',
'document_number' => 'string',
'posted_date' => '2024-01-01T00:00:00Z',
'currency_id' => 'AED',
'total_discount' => 0,
'sub_total' => 0,
'tax_amount' => 0,
'is_tax_inclusive' => false,
'total_amount' => 0,
'memo' => 'string',
'shipping_amount' => 0,
'status' => 'DRAFT',
'currency_rate' => 0,
'contact_id' => 'string',
'updated_at' => '2024-01-01T00:00:00Z',
'line_items' => [
[
'platform_id' => 'string',
'tracking_category_ids' => [
'string'
],
'parent_id' => 'string',
'parent_type' => 'BILL',
'item_id' => 'string',
'name' => 'string',
'description' => 'string',
'quantity' => 0,
'unit_amount' => 0,
'tax_amount' => 0,
'is_tax_inclusive' => false,
'discount_amount' => 0,
'sub_total' => 0,
'total_amount' => 0,
'tax_id' => 'string',
'account_id' => 'string',
'variant_id' => 'string',
'created_at' => '2024-01-01T00:00:00Z',
'updated_at' => '2024-01-01T00:00:00Z'
]
],
'addresses' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'type' => 'SHIPPING',
'street' => 'string',
'street2' => 'string',
'locality' => 'string',
'city' => 'string',
'state' => 'string',
'postal_code' => 'string',
'country' => 'string'
]
],
'contact' => [
[
'platform_id' => 'string',
'name' => 'string',
'contact_name' => 'string',
'email' => 'string',
'phone' => 'string',
'tax_number' => 'string',
'type' => 'CUSTOMER',
'status' => 'ACTIVE',
'currency_id' => 'AED',
'registration_number' => 'string',
'website' => 'string',
'created_at' => '2024-01-01T00:00:00Z',
'updated_at' => '2024-01-01T00:00:00Z',
'addresses' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'type' => 'SHIPPING',
'street' => 'string',
'street2' => 'string',
'locality' => 'string',
'city' => 'string',
'state' => 'string',
'postal_code' => 'string',
'country' => 'string'
]
],
'phone_numbers' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'number' => 'string',
'type' => 'MOBILE'
]
],
'external_links' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'link' => 'string',
'type' => 'WEBSITE'
]
]
]
],
'currency' => [
[
'platform_id' => 'string',
'name' => 'string',
'code' => 'string',
'symbol' => 'string',
'is_base_currency' => false,
'exchange_rate' => 0,
'updated_at' => '2024-01-01T00:00:00Z'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales"
payload := strings.NewReader("{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sync_id": "<string>",
"data": {
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"platform_id": "<string>",
"rootfi_integration_type": "BUSY",
"platform_unique_id": "<string>",
"document_number": "<string>",
"posted_date": "2023-11-07T05:31:56Z",
"currency_id": "AED",
"total_discount": 123,
"sub_total": 123,
"tax_amount": 123,
"is_tax_inclusive": true,
"total_amount": 123,
"memo": "<string>",
"shipping_amount": 123,
"status": "DRAFT",
"currency_rate": 123,
"contact_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"line_items": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"tracking_category_ids": [
"<string>"
],
"parent_id": "<string>",
"parent_type": "BILL",
"item_id": "<string>",
"name": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"tax_amount": 123,
"is_tax_inclusive": true,
"discount_amount": 123,
"sub_total": 123,
"total_amount": 123,
"tax_id": "<string>",
"account_id": "<string>",
"variant_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"item": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"sku": "<string>",
"price": 123,
"currency_id": "AED",
"type": "INVENTORY",
"status": "DRAFT",
"quantity_on_hand": 123,
"is_bill_item": true,
"bill_item": "<unknown>",
"is_invoice_item": true,
"invoice_item": "<unknown>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variants": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"name": "<string>",
"sku": "<string>",
"price": 123,
"compare_at_price": 123,
"currency_id": "AED",
"status": "ACTIVE",
"attributes": "<unknown>"
}
]
}
],
"tax": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"code": "<string>",
"rate": 123,
"tax_type": "<string>",
"effective_tax_rate": 123,
"total_tax_rate": 123,
"components": "<unknown>",
"jurisdiction": "<string>",
"status": "ACTIVE",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"account": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"nominal_code": "<string>",
"name": "<string>",
"description": "<string>",
"currency_id": "AED",
"current_balance": 123,
"status": "ACTIVE",
"category": "ASSET",
"sub_category": "<string>",
"parent_account_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"name": "<string>",
"sku": "<string>",
"price": 123,
"compare_at_price": 123,
"currency_id": "AED",
"status": "ACTIVE",
"attributes": "<unknown>"
}
]
}
],
"addresses": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "<string>",
"street2": "<string>",
"locality": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
],
"contact": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"contact_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tax_number": "<string>",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "<string>",
"website": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"addresses": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "<string>",
"street2": "<string>",
"locality": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
],
"phone_numbers": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"number": "<string>",
"type": "MOBILE"
}
],
"external_links": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"link": "<string>",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"code": "<string>",
"symbol": "<string>",
"is_base_currency": true,
"exchange_rate": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
},
"request_id": "<string>"
}Cash Sales
Update a cash sale
PUT
/
v4
/
core
/
companies
/
{companyId}
/
cash_sales
Update a cash sale
curl --request PUT \
--url https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"data": {
"platform_id": "string",
"platform_unique_id": "string",
"document_number": "string",
"posted_date": "2024-01-01T00:00:00Z",
"currency_id": "AED",
"total_discount": 0,
"sub_total": 0,
"tax_amount": 0,
"is_tax_inclusive": false,
"total_amount": 0,
"memo": "string",
"shipping_amount": 0,
"status": "DRAFT",
"currency_rate": 0,
"contact_id": "string",
"updated_at": "2024-01-01T00:00:00Z",
"line_items": [
{
"platform_id": "string",
"tracking_category_ids": [
"string"
],
"parent_id": "string",
"parent_type": "BILL",
"item_id": "string",
"name": "string",
"description": "string",
"quantity": 0,
"unit_amount": 0,
"tax_amount": 0,
"is_tax_inclusive": false,
"discount_amount": 0,
"sub_total": 0,
"total_amount": 0,
"tax_id": "string",
"account_id": "string",
"variant_id": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"contact": [
{
"platform_id": "string",
"name": "string",
"contact_name": "string",
"email": "string",
"phone": "string",
"tax_number": "string",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "string",
"website": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"phone_numbers": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"number": "string",
"type": "MOBILE"
}
],
"external_links": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"link": "string",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"platform_id": "string",
"name": "string",
"code": "string",
"symbol": "string",
"is_base_currency": false,
"exchange_rate": 0,
"updated_at": "2024-01-01T00:00:00Z"
}
]
}
}
'import requests
url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales"
payload = { "data": {
"platform_id": "string",
"platform_unique_id": "string",
"document_number": "string",
"posted_date": "2024-01-01T00:00:00Z",
"currency_id": "AED",
"total_discount": 0,
"sub_total": 0,
"tax_amount": 0,
"is_tax_inclusive": False,
"total_amount": 0,
"memo": "string",
"shipping_amount": 0,
"status": "DRAFT",
"currency_rate": 0,
"contact_id": "string",
"updated_at": "2024-01-01T00:00:00Z",
"line_items": [
{
"platform_id": "string",
"tracking_category_ids": ["string"],
"parent_id": "string",
"parent_type": "BILL",
"item_id": "string",
"name": "string",
"description": "string",
"quantity": 0,
"unit_amount": 0,
"tax_amount": 0,
"is_tax_inclusive": False,
"discount_amount": 0,
"sub_total": 0,
"total_amount": 0,
"tax_id": "string",
"account_id": "string",
"variant_id": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"contact": [
{
"platform_id": "string",
"name": "string",
"contact_name": "string",
"email": "string",
"phone": "string",
"tax_number": "string",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "string",
"website": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"addresses": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "string",
"street2": "string",
"locality": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
],
"phone_numbers": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"number": "string",
"type": "MOBILE"
}
],
"external_links": [
{
"platform_id": "string",
"parent_id": "string",
"parent_type": "ACCOUNT",
"link": "string",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"platform_id": "string",
"name": "string",
"code": "string",
"symbol": "string",
"is_base_currency": False,
"exchange_rate": 0,
"updated_at": "2024-01-01T00:00:00Z"
}
]
} }
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
platform_id: 'string',
platform_unique_id: 'string',
document_number: 'string',
posted_date: '2024-01-01T00:00:00Z',
currency_id: 'AED',
total_discount: 0,
sub_total: 0,
tax_amount: 0,
is_tax_inclusive: false,
total_amount: 0,
memo: 'string',
shipping_amount: 0,
status: 'DRAFT',
currency_rate: 0,
contact_id: 'string',
updated_at: '2024-01-01T00:00:00Z',
line_items: [
{
platform_id: 'string',
tracking_category_ids: ['string'],
parent_id: 'string',
parent_type: 'BILL',
item_id: 'string',
name: 'string',
description: 'string',
quantity: 0,
unit_amount: 0,
tax_amount: 0,
is_tax_inclusive: false,
discount_amount: 0,
sub_total: 0,
total_amount: 0,
tax_id: 'string',
account_id: 'string',
variant_id: 'string',
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z'
}
],
addresses: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
type: 'SHIPPING',
street: 'string',
street2: 'string',
locality: 'string',
city: 'string',
state: 'string',
postal_code: 'string',
country: 'string'
}
],
contact: [
{
platform_id: 'string',
name: 'string',
contact_name: 'string',
email: 'string',
phone: 'string',
tax_number: 'string',
type: 'CUSTOMER',
status: 'ACTIVE',
currency_id: 'AED',
registration_number: 'string',
website: 'string',
created_at: '2024-01-01T00:00:00Z',
updated_at: '2024-01-01T00:00:00Z',
addresses: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
type: 'SHIPPING',
street: 'string',
street2: 'string',
locality: 'string',
city: 'string',
state: 'string',
postal_code: 'string',
country: 'string'
}
],
phone_numbers: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
number: 'string',
type: 'MOBILE'
}
],
external_links: [
{
platform_id: 'string',
parent_id: 'string',
parent_type: 'ACCOUNT',
link: 'string',
type: 'WEBSITE'
}
]
}
],
currency: [
{
platform_id: 'string',
name: 'string',
code: 'string',
symbol: 'string',
is_base_currency: false,
exchange_rate: 0,
updated_at: '2024-01-01T00:00:00Z'
}
]
}
})
};
fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'platform_id' => 'string',
'platform_unique_id' => 'string',
'document_number' => 'string',
'posted_date' => '2024-01-01T00:00:00Z',
'currency_id' => 'AED',
'total_discount' => 0,
'sub_total' => 0,
'tax_amount' => 0,
'is_tax_inclusive' => false,
'total_amount' => 0,
'memo' => 'string',
'shipping_amount' => 0,
'status' => 'DRAFT',
'currency_rate' => 0,
'contact_id' => 'string',
'updated_at' => '2024-01-01T00:00:00Z',
'line_items' => [
[
'platform_id' => 'string',
'tracking_category_ids' => [
'string'
],
'parent_id' => 'string',
'parent_type' => 'BILL',
'item_id' => 'string',
'name' => 'string',
'description' => 'string',
'quantity' => 0,
'unit_amount' => 0,
'tax_amount' => 0,
'is_tax_inclusive' => false,
'discount_amount' => 0,
'sub_total' => 0,
'total_amount' => 0,
'tax_id' => 'string',
'account_id' => 'string',
'variant_id' => 'string',
'created_at' => '2024-01-01T00:00:00Z',
'updated_at' => '2024-01-01T00:00:00Z'
]
],
'addresses' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'type' => 'SHIPPING',
'street' => 'string',
'street2' => 'string',
'locality' => 'string',
'city' => 'string',
'state' => 'string',
'postal_code' => 'string',
'country' => 'string'
]
],
'contact' => [
[
'platform_id' => 'string',
'name' => 'string',
'contact_name' => 'string',
'email' => 'string',
'phone' => 'string',
'tax_number' => 'string',
'type' => 'CUSTOMER',
'status' => 'ACTIVE',
'currency_id' => 'AED',
'registration_number' => 'string',
'website' => 'string',
'created_at' => '2024-01-01T00:00:00Z',
'updated_at' => '2024-01-01T00:00:00Z',
'addresses' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'type' => 'SHIPPING',
'street' => 'string',
'street2' => 'string',
'locality' => 'string',
'city' => 'string',
'state' => 'string',
'postal_code' => 'string',
'country' => 'string'
]
],
'phone_numbers' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'number' => 'string',
'type' => 'MOBILE'
]
],
'external_links' => [
[
'platform_id' => 'string',
'parent_id' => 'string',
'parent_type' => 'ACCOUNT',
'link' => 'string',
'type' => 'WEBSITE'
]
]
]
],
'currency' => [
[
'platform_id' => 'string',
'name' => 'string',
'code' => 'string',
'symbol' => 'string',
'is_base_currency' => false,
'exchange_rate' => 0,
'updated_at' => '2024-01-01T00:00:00Z'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales"
payload := strings.NewReader("{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/cash_sales")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"platform_id\": \"string\",\n \"platform_unique_id\": \"string\",\n \"document_number\": \"string\",\n \"posted_date\": \"2024-01-01T00:00:00Z\",\n \"currency_id\": \"AED\",\n \"total_discount\": 0,\n \"sub_total\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"total_amount\": 0,\n \"memo\": \"string\",\n \"shipping_amount\": 0,\n \"status\": \"DRAFT\",\n \"currency_rate\": 0,\n \"contact_id\": \"string\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"line_items\": [\n {\n \"platform_id\": \"string\",\n \"tracking_category_ids\": [\n \"string\"\n ],\n \"parent_id\": \"string\",\n \"parent_type\": \"BILL\",\n \"item_id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unit_amount\": 0,\n \"tax_amount\": 0,\n \"is_tax_inclusive\": false,\n \"discount_amount\": 0,\n \"sub_total\": 0,\n \"total_amount\": 0,\n \"tax_id\": \"string\",\n \"account_id\": \"string\",\n \"variant_id\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ],\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"contact\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"contact_name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"tax_number\": \"string\",\n \"type\": \"CUSTOMER\",\n \"status\": \"ACTIVE\",\n \"currency_id\": \"AED\",\n \"registration_number\": \"string\",\n \"website\": \"string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"addresses\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"type\": \"SHIPPING\",\n \"street\": \"string\",\n \"street2\": \"string\",\n \"locality\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"number\": \"string\",\n \"type\": \"MOBILE\"\n }\n ],\n \"external_links\": [\n {\n \"platform_id\": \"string\",\n \"parent_id\": \"string\",\n \"parent_type\": \"ACCOUNT\",\n \"link\": \"string\",\n \"type\": \"WEBSITE\"\n }\n ]\n }\n ],\n \"currency\": [\n {\n \"platform_id\": \"string\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"symbol\": \"string\",\n \"is_base_currency\": false,\n \"exchange_rate\": 0,\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sync_id": "<string>",
"data": {
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"platform_id": "<string>",
"rootfi_integration_type": "BUSY",
"platform_unique_id": "<string>",
"document_number": "<string>",
"posted_date": "2023-11-07T05:31:56Z",
"currency_id": "AED",
"total_discount": 123,
"sub_total": 123,
"tax_amount": 123,
"is_tax_inclusive": true,
"total_amount": 123,
"memo": "<string>",
"shipping_amount": 123,
"status": "DRAFT",
"currency_rate": 123,
"contact_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"line_items": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"tracking_category_ids": [
"<string>"
],
"parent_id": "<string>",
"parent_type": "BILL",
"item_id": "<string>",
"name": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"tax_amount": 123,
"is_tax_inclusive": true,
"discount_amount": 123,
"sub_total": 123,
"total_amount": 123,
"tax_id": "<string>",
"account_id": "<string>",
"variant_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"item": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"sku": "<string>",
"price": 123,
"currency_id": "AED",
"type": "INVENTORY",
"status": "DRAFT",
"quantity_on_hand": 123,
"is_bill_item": true,
"bill_item": "<unknown>",
"is_invoice_item": true,
"invoice_item": "<unknown>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variants": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"name": "<string>",
"sku": "<string>",
"price": 123,
"compare_at_price": 123,
"currency_id": "AED",
"status": "ACTIVE",
"attributes": "<unknown>"
}
]
}
],
"tax": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"code": "<string>",
"rate": 123,
"tax_type": "<string>",
"effective_tax_rate": 123,
"total_tax_rate": 123,
"components": "<unknown>",
"jurisdiction": "<string>",
"status": "ACTIVE",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"account": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"nominal_code": "<string>",
"name": "<string>",
"description": "<string>",
"currency_id": "AED",
"current_balance": 123,
"status": "ACTIVE",
"category": "ASSET",
"sub_category": "<string>",
"parent_account_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"variant": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"name": "<string>",
"sku": "<string>",
"price": 123,
"compare_at_price": 123,
"currency_id": "AED",
"status": "ACTIVE",
"attributes": "<unknown>"
}
]
}
],
"addresses": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "<string>",
"street2": "<string>",
"locality": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
],
"contact": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"contact_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tax_number": "<string>",
"type": "CUSTOMER",
"status": "ACTIVE",
"currency_id": "AED",
"registration_number": "<string>",
"website": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"addresses": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"type": "SHIPPING",
"street": "<string>",
"street2": "<string>",
"locality": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
],
"phone_numbers": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"number": "<string>",
"type": "MOBILE"
}
],
"external_links": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"parent_id": "<string>",
"parent_type": "ACCOUNT",
"link": "<string>",
"type": "WEBSITE"
}
]
}
],
"currency": [
{
"rootfi_id": 123,
"rootfi_created_at": "2023-11-07T05:31:56Z",
"rootfi_updated_at": "2023-11-07T05:31:56Z",
"rootfi_integration_type": "BUSY",
"platform_id": "<string>",
"name": "<string>",
"code": "<string>",
"symbol": "<string>",
"is_base_currency": true,
"exchange_rate": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
},
"request_id": "<string>"
}Authorizations
Your Commenda Integrations API key, sent in the api_key header.
Path Parameters
Commenda company id.
Query Parameters
Process the write asynchronously. Required when data is an array (batch write).
Body
application/json
- object
- object[]
Show child attributes
Show child attributes