Sales Orders

Endpoints

Get Sales Orders

POST/api/RPC.common.Api.So.get?token=<TOKEN>

Key So.get · Open page

Parameters

4 body parameters inside data[]
FieldTypeDescription
for_dateStringSales Order date
from_dateStringFrom date
to_dateStringTo date
pos_codeStringPoint of sale (POS)

Request example

Get So:
{
   "data" : [
      {
         "for_date" : "2026-09-03"
      }
   ]
}

cURL

Get So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "for_date" : "2026-09-03"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.get?token=<TOKEN>"

Retrieving a POS for addition-editing

POST/api/RPC.common.Api.So.getDataForEdit?token=<TOKEN>

Key So.getDataForEdit · Open page

Parameters

2 body parameters inside data[]
FieldTypeDescription
idIntegerSales Order ID
numrequiredStringSales Order ID

Request example

Get Data For Edit By Num:
{
   "data" : [
      {
         "num" : "CO10003101"
      }
   ]
}
Get Data For Edit By Id:
{
   "data" : [
      {
         "id" : 3293188
      }
   ]
}

cURL

Get Data For Edit By Num:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10003101"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.getDataForEdit?token=<TOKEN>"
Get Data For Edit By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 3293188      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.getDataForEdit?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : {
      "data" : [
         {
            "tax_deal_code" : 1,
            "pay_type" : "cash",
            "store_type" : "wait",
            "pos_code" : "13BG",
            "for_date" : "2021-09-05",
            "sale_type_code" : 1234567,
            "partner" : {
               "is_client" : 1,
               "client_type" : "client_real",
               "dds_num" : "BG202724488",
               "phone" : "+35929890995",
               "is_company" : 1,
               "eik" : 202724488,
               "name" : "Mansion Technology Center",
               "email" : null
            },
            "currency" : "BGN",
            "sale_type" : "Main Sales",
            "fin_type" : "invoice",
            "id" : 3293188,
            "rows" : [
               {
                  "quantity" : "1.00",
                  "description" : "2.3GHz dual-core 7th-generation Intel Core i5 processor\nTurbo Boost up to 3.6GHz\n8GB 2133MHz memory, configurable to 16GB\n1TB hard drive1\nIntel Iris Plus Graphics 640\nTwo Thunderbolt 3 ports\n1920-by-1080 sRGB display",
                  "price" : "1835.1000",
                  "discount" : "0.00",
                  "sku" : 10005
               },
               {
                  "price" : "31.7250",
                  "quantity" : "1.00",
                  "description" : "\nConnect your iPhone, iPad or iPod with Lightning connector to your USB-C– or Thunderbolt 3 (USB-C)–enabled Mac for syncing and charging.",
                  "discount" : "0.00",
                  "sku" : 10016
               },
               {
                  "sku" : 10015,
                  "discount" : "0.00",
                  "price" : "15.0250",
                  "quantity" : "1.00",
                  "description" : "5.8-inch display, Silver, 255GB"
               },
               {
                  "price" : "31.7250",
                  "description" : "The 1.8-metre Power Adapter Extension Cable is an AC extension lead that provides extra length for your Apple power adapter.",
                  "quantity" : "1.00",
                  "discount" : "0.00",
                  "sku" : 10026
               },
               {
                  "quantity" : "1.00",
                  "description" : "3.0GHz 8-Core Intel Xeon E5 processor\n16GB 1866MHz DDR3 ECC memory\nDual AMD FirePro D700 with 6GB GDDR5 VRAM each\n256GB PCIe-based SSD1",
                  "price" : "6677.4920",
                  "discount" : "0.00",
                  "sku" : 10009
               },
               {
                  "sku" : 10021,
                  "discount" : "0.00",
                  "price" : "65.1250",
                  "description" : "\nMade from specially tanned and finished European leather, these Apple-designed cases look and feel luxurious.",
                  "quantity" : "1.00"
               },
               {
                  "discount" : "0.00",
                  "sku" : 10003,
                  "description" : "2.3GHz dual-core 7th-generation Intel Core i5 processor\nTurbo Boost up to 3.6GHz\nIntel Iris Plus Graphics 640\n8GB 2133MHz LPDDR3 memory\n128GB SSD storage1\nRetina display\nTwo Thunderbolt 3 ports",
                  "quantity" : "1.00",
                  "price" : "2169.0580"
               },
               {
                  "discount" : "0.00",
                  "sku" : 10002,
                  "quantity" : "1.00",
                  "description" : "\n13.3-inch (diagonal) LED-backlit widescreen display\n1.8GHz dual-core Intel Core i5 or 2.2GHz dual-core Intel Core i7 processor\nTurbo Boost up to 3.2GHz\n",
                  "price" : "1584.6330"
               }
            ],
            "num" : "CO10003101"
         }
      ]
   }
}

Get a single Sales Order

POST/api/RPC.common.Api.So.getOneData?token=<TOKEN>

Key So.getOneData · Open page

Parameters

2 body parameters inside data[]
FieldTypeDescription
idIntegerSales Order ID
numrequiredStringSales Order ID

Request example

Search One So By Num:
{
   "data" : [
      {
         "num" : "CO10000285"
      }
   ]
}
Search One So By Id:
{
   "data" : [
      {
         "id" : 3235115
      }
   ]
}

cURL

Search One So By Num:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10000285"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.getOneData?token=<TOKEN>"
Search One So By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 3235115      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.getOneData?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "sale_type_nm" : "Main Sales",
         "id" : 3235115,
         "receiver_nm" : null,
         "tax_deal_nm" : "Sales",
         "num" : "CO10000285",
         "action_date" : null,
         "rows" : [
            {
               "trans_id" : 3235115,
               "single_price_before_discounts" : "64.65800000000000000000",
               "taxes" : "12.93200000000000000000",
               "category_name" : "Proteins",
               "label" : null,
               "total_price" : "64.65800000000000000000",
               "description" : "\nDesigned by Apple to complement iPhone X, the form of the silicone case fits snugly over the volume buttons, side button and curves of your device without adding bulk.",
               "total_price_with_taxes" : "77.59000000000000000000",
               "sku" : 10020,
               "measure_nm" : "Pieces",
               "quantity" : "1.00000000000000000000"
            },
            {
               "single_price_before_discounts" : "31.50000000000000000000",
               "quantity" : "1.00000000000000000000",
               "total_price_with_taxes" : "37.80000000000000000000",
               "total_price" : "31.50000000000000000000",
               "description" : "The 1.8-metre Power Adapter Extension Cable is an AC extension lead that provides extra length for your Apple power adapter.",
               "label" : null,
               "category_name" : "Amino acids",
               "trans_id" : 3235115,
               "taxes" : "6.30000000000000000000",
               "measure_nm" : "Pieces",
               "sku" : 10026
            },
            {
               "total_price" : "64.65800000000000000000",
               "description" : "\nMade from specially tanned and finished European leather, these Apple-designed cases look and feel luxurious.",
               "label" : null,
               "category_name" : "Proteins",
               "trans_id" : 3235115,
               "single_price_before_discounts" : "64.65800000000000000000",
               "taxes" : "12.93200000000000000000",
               "quantity" : "1.00000000000000000000",
               "measure_nm" : "Pieces",
               "total_price_with_taxes" : "77.59000000000000000000",
               "sku" : 10021
            },
            {
               "measure_nm" : "Pieces",
               "sku" : 10017,
               "total_price_with_taxes" : "69.63000000000000000000",
               "quantity" : "1.00000000000000000000",
               "category_name" : "Amino acids",
               "trans_id" : 3235115,
               "single_price_before_discounts" : "58.02500000000000000000",
               "taxes" : "11.60500000000000000000",
               "total_price" : "58.02500000000000000000",
               "description" : "\nConnect your iPhone, iPad or iPod with Lightning connector to your USB-C– or Thunderbolt 3 (USB-C)–enabled Mac for syncing and charging.",
               "label" : null
            },
            {
               "quantity" : "1.00000000000000000000",
               "measure_nm" : "Pieces",
               "total_price_with_taxes" : "17.91000000000000000000",
               "sku" : 10014,
               "total_price" : "14.92500000000000000000",
               "description" : "5.8-inch display, Silver, 64GB",
               "label" : null,
               "category_name" : "Smartphones",
               "trans_id" : 3235115,
               "taxes" : "2.98500000000000000000",
               "single_price_before_discounts" : "14.92500000000000000000"
            }
         ],
         "from_nm" : "Online Sales",
         "description" : null,
         "status" : "done",
         "currency" : "BGN",
         "rel_trans" : [
            {
               "num" : "0000000285",
               "trans_id" : 3235115,
               "for_date" : "2021-03-08",
               "rel_trans_id" : 3235136,
               "type" : "invoice"
            },
            {
               "num" : "0110000046",
               "trans_id" : 3235115,
               "for_date" : "2021-03-08",
               "rel_trans_id" : 3235144,
               "type" : "cash_income"
            },
            {
               "for_date" : "2021-03-08",
               "rel_trans_id" : 3235123,
               "type" : "store_out",
               "num" : "STO2000138",
               "trans_id" : 3235115
            }
         ],
         "sender_nm" : "London",
         "for_date" : "2021-03-08",
         "trader_nm" : "Prim Support",
         "action_name" : "Sale",
         "partners" : {
            "nm" : "EUROPE Insurance Company, Ltd",
            "eik" : 121261531,
            "mail" : "",
            "phone" : "+359988396137",
            "id" : 3139449
         },
         "internal_description" : null,
         "pay_type_nm" : "Cash",
         "to_nm" : "EUROPE Insurance Company, Ltd",
         "curs" : "0.51129188119621848525",
         "speditor_data" : null
      }
   ]
}

Create Sales Orders

POST/api/RPC.common.Api.So.set?token=<TOKEN>

Key So.set · Open page

Parameters

88 body parameters inside data[]
FieldTypeDescription
idIntegerSales Order ID
for_dateStringSales Order date
action_dateStringDispatch Order date
sale_typerequiredStringSales Order type name
sale_type_coderequiredStringSO type code
numStringSales Order ID
traderStringMerchant
pos_coderequiredStringPoint of sale (POS)
tax_deal_codeStringTax template
store_codeStringReserve quantity in warehouse
currencyStringCurrency
fin_typeStringFinancial document type
pay_typeStringPayment method
account_codeStringAccount ID
store_typeStringHandover
delivery_codeStringDelivery method ID
descriptionStringDescription
internal_descriptionStringComment
invoice_nowBooleanIssue a financial document
pay_nowBooleanPay automatically
create_requestBooleanCreate stock request for the entire document
create_request_unavailableBooleanMark entire document as out of stock
discountStringDocument discount %
promo_cardStringLoyalty card
partnerrequiredObjectPartner object.
partner.idStringCustomer ID
partner.is_companyBooleanCustomer is a company
partner.client_typeStringCustomer type
partner.namerequiredStringName
partner.eikStringUIC
partner.egnStringID
partner.dds_numStringVAT Number
partner.emailStringE-mail
partner.phoneStringPhone
partner.contact_nameStringContact
delivery_addressrequiredObjectDelivery_address object.
delivery_address.to_speditor_officeStringShipping operator office ID
delivery_address.idStringAddress ID
delivery_address.phoneStringPhone
delivery_address.emailStringE-mail
delivery_address.countryrequiredStringCountry
delivery_address.districtStringCounty
delivery_address.settlementStringCity
delivery_address.streetStringStreet
delivery_address.nbhStringDistrict
delivery_address.addressStringAddress
delivery_address.numStringNumber
delivery_address.buildingStringBuilding
delivery_address.building_entranceStringEntrance
delivery_address.building_floorStringFloor
delivery_address.building_apartmentStringApartment
delivery_address.zipStringPostal code
delivery_address.zip_numStringMailbox
tax_addressrequiredObjectTax_address object.
tax_address.idStringAddress ID
tax_address.phoneStringPhone
tax_address.emailStringE-mail
tax_address.countryrequiredStringCountry
tax_address.districtStringCounty
tax_address.settlementStringCity
tax_address.streetStringStreet
tax_address.nbhStringDistrict
tax_address.addressStringAddress
tax_address.numStringNumber
tax_address.buildingStringBuilding
tax_address.building_entranceStringEntrance
tax_address.building_floorStringFloor
tax_address.building_apartmentStringApartment
tax_address.zipStringPostal code
tax_address.zip_numStringMailbox
rowsrequiredObjectRows object.
rows.skurequiredStringItem ID (SKU)
rows.skurequiredStringService ID (SKU)
rows.bom_identStringBOM identifier
rows.bom_iterStringBOM counter
rows.bom_positionStringBOM position
rows.quantityrequiredStringQuantity
rows.measure_codeStringUnit of measurement ID
rows.pricerequiredStringUnit price
rows.discountStringDiscount %
rows.descriptionStringDescription
rows.row_requestBooleanCreate stock request for this row
rows.row_request_unavailableBooleanMark this row as out of stock
integrationsrequiredObjectIntegrations object.
integrations.system_nameStringIntegration system name
integrations.integration_idStringOrder ID in integration system
contractrequiredObjectContract object.
contract.numStringContract

Request example

Create So Simple:
{
   "data" : [
      {
         "pos_code" : "13BG",
         "partner" : {
            "name" : "YON COMPUTERS LTD",
            "mail" : "simeonska@ionbg.com",
            "is_company" : 1,
            "eik" : 131398329
         },
         "rows" : [
            {
               "quantity" : 2,
               "price" : "13.00",
               "sku" : 10030
            },
            {
               "price" : "89.00",
               "quantity" : 5,
               "sku" : 10243
            },
            {
               "quantity" : 2,
               "price" : "69.00",
               "sku" : 10254
            },
            {
               "quantity" : 3,
               "price" : "72.00",
               "sku" : 10288
            },
            {
               "quantity" : 5,
               "price" : "63.00",
               "sku" : 10324
            }
         ],
         "sale_type" : "ExVan Sales"
      }
   ]
}
Create So With Delivery:
{
   "data" : [
      {
         "delivery_code" : "Fedex",
         "store_type" : "delivery",
         "pos_code" : "13BG",
         "rows" : [
            {
               "quantity" : 2,
               "price" : "13.00",
               "sku" : 10030
            },
            {
               "quantity" : 5,
               "price" : "89.00",
               "sku" : 10243
            },
            {
               "sku" : 10254,
               "quantity" : 2,
               "price" : "69.00"
            },
            {
               "sku" : 10288,
               "quantity" : 3,
               "price" : "72.00"
            },
            {
               "quantity" : 5,
               "price" : "63.00",
               "sku" : 10324
            }
         ],
         "delivery_address" : {
            "settlement" : "Sofia",
            "country" : "Bulgaria",
            "address" : null,
            "district" : "Sofia District"
         },
         "partner" : {
            "name" : "YON COMPUTERS LTD",
            "eik" : 131398329,
            "mail" : "simeonska@ionbg.com",
            "is_company" : 1
         },
         "sale_type" : "ExVan Sales"
      }
   ]
}

cURL

Create So Simple:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "pos_code" : "13BG",         "partner" : {            "name" : "YON COMPUTERS LTD",            "mail" : "simeonska@ionbg.com",            "is_company" : 1,            "eik" : 131398329         },         "rows" : [            {               "quantity" : 2,               "price" : "13.00",               "sku" : 10030            },            {               "price" : "89.00",               "quantity" : 5,               "sku" : 10243            },            {               "quantity" : 2,               "price" : "69.00",               "sku" : 10254            },            {               "quantity" : 3,               "price" : "72.00",               "sku" : 10288            },            {               "quantity" : 5,               "price" : "63.00",               "sku" : 10324            }         ],         "sale_type" : "ExVan Sales"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.set?token=<TOKEN>"
Create So With Delivery:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "delivery_code" : "Fedex",         "store_type" : "delivery",         "pos_code" : "13BG",         "rows" : [            {               "quantity" : 2,               "price" : "13.00",               "sku" : 10030            },            {               "quantity" : 5,               "price" : "89.00",               "sku" : 10243            },            {               "sku" : 10254,               "quantity" : 2,               "price" : "69.00"            },            {               "sku" : 10288,               "quantity" : 3,               "price" : "72.00"            },            {               "quantity" : 5,               "price" : "63.00",               "sku" : 10324            }         ],         "delivery_address" : {            "settlement" : "Sofia",            "country" : "Bulgaria",            "address" : null,            "district" : "Sofia District"         },         "partner" : {            "name" : "YON COMPUTERS LTD",            "eik" : 131398329,            "mail" : "simeonska@ionbg.com",            "is_company" : 1         },         "sale_type" : "ExVan Sales"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.set?token=<TOKEN>"

Create Dispatch Orders

POST/api/RPC.common.Api.So.createExpedition?token=<TOKEN>

Key So.createExpedition · Open page

Parameters

2 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
descriptionStringDescription

Request example

Create Expedition From So:
{
   "data" : [
      {
         "description" : "Create Expedition From So CO10002616",
         "num" : "CO10002616"
      }
   ]
}

cURL

Create Expedition From So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "description" : "Create Expedition From So CO10002616",         "num" : "CO10002616"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createExpedition?token=<TOKEN>"

Create Store-outs

POST/api/RPC.common.Api.So.createStoreOut?token=<TOKEN>

Key So.createStoreOut · Open page

Parameters

3 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
store_codeStringOutbound warehouse ID
descriptionStringDescription

Request example

Create StoreOut From So:
{
   "data" : [
      {
         "description" : "Create StoreOut From So CO10003341",
         "num" : "CO10003341"
      }
   ]
}
Create StoreOut From So With Store:
{
   "data" : [
      {
         "store_code" : "8976HKJH",
         "num" : "CO10003341",
         "description" : "Create StoreOut From So CO10003341"
      }
   ]
}

cURL

Create StoreOut From So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "description" : "Create StoreOut From So CO10003341",         "num" : "CO10003341"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createStoreOut?token=<TOKEN>"
Create StoreOut From So With Store:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "store_code" : "8976HKJH",         "num" : "CO10003341",         "description" : "Create StoreOut From So CO10003341"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createStoreOut?token=<TOKEN>"

Create a stock request for insufficient quantities

POST/api/RPC.common.Api.So.createQuantityRequest?token=<TOKEN>

Key So.createQuantityRequest · Open page

Parameters

2 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
store_codesStringCode of warehouse(s)

Request example

Create Quantity Request:
{
   "data" : [
      {
         "num" : "CO10000754"
      }
   ]
}
Create Quantity Request With Stores:
{
   "data" : [
      {
         "num" : "CO10000754",
         "store_codes" : [
            "STORE1",
            "STORE2"
         ]
      }
   ]
}

cURL

Create Quantity Request:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10000754"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createQuantityRequest?token=<TOKEN>"
Create Quantity Request With Stores:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10000754",         "store_codes" : [            "STORE1",            "STORE2"         ]      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createQuantityRequest?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "count" : 3,
   "result" : [
      {
         "item_num" : "Items Code 1",
         "item_nm" : "Item Name 1",
         "qty" : "2.00"
      },
      {
         "item_num" : "Items Code 2",
         "qty" : "7.00",
         "item_nm" : "Item Name 2"
      },
      {
         "item_num" : "Items Code 3",
         "item_nm" : "Item Name 3",
         "qty" : "3.00"
      }
   ]
}

Create Reversal

POST/api/RPC.common.Api.So.createCredit?token=<TOKEN>

Key So.createCredit · Open page

Parameters

18 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
store_codeStringWarehouse ID
account_codeStringAccount ID
pay_nowBooleanAutomatically refund payment
quantity_creditBooleanReversal of goods quantity
invoice_offsetBooleanOffsetting the payment amount from the financial document
invoice_nowBooleanIssue the financial document immediately (by default: 1)
store_typeStringGoods receipt: direct (immediately) | wait (deferred)
for_dateStringReversal date
descriptionStringDescription
rowsrequiredObjectRows object.
rows.skurequiredStringItem ID (SKU)
rows.skurequiredStringService ID (SKU)
rows.labelStringBatch
rows.quantityStringQuantity
rows.all_quantityBooleanTotal quantity
rows.priceStringPrice
rows.all_priceBooleanTotal amount

Request example

Create So Reversal Quantity:
{
   "data" : [
      {
         "quantity_credit" : 1,
         "num" : "CO10002311",
         "rows" : [
            {
               "quantity" : "1.00",
               "sku" : 10014
            }
         ]
      }
   ]
}
Create So Reversal Price:
{
   "data" : [
      {
         "num" : "CO10002311",
         "rows" : [
            {
               "price" : "17.91000000000000000000",
               "sku" : 10014
            }
         ]
      }
   ]
}
Create So Reversal Deferred (no financial document, deferred goods reception):
{
   "data" : [
      {
         "num" : "CO10002311",
         "rows" : [
            {
               "quantity" : "1.00",
               "sku" : 10014
            }
         ],
         "quantity_credit" : 1,
         "invoice_now" : 0,
         "store_type" : "wait"
      }
   ]
}

cURL

Create So Reversal Quantity:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "quantity_credit" : 1,         "num" : "CO10002311",         "rows" : [            {               "quantity" : "1.00",               "sku" : 10014            }         ]      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createCredit?token=<TOKEN>"
Create So Reversal Price:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10002311",         "rows" : [            {               "price" : "17.91000000000000000000",               "sku" : 10014            }         ]      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createCredit?token=<TOKEN>"
Create So Reversal Deferred (no financial document, deferred goods reception):
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10002311",         "rows" : [            {               "quantity" : "1.00",               "sku" : 10014            }         ],         "quantity_credit" : 1,         "invoice_now" : 0,         "store_type" : "wait"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createCredit?token=<TOKEN>"

Create financial documents

POST/api/RPC.common.Api.So.createFinDoc?token=<TOKEN>

Key So.createFinDoc · Open page

Parameters

6 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
pay_nowBooleanPay
currencyStringCurrency code
account_codeStringAccount ID
account_nameStringAccount name
descriptionStringDescription

Request example

Create FinDoc From So:
{
   "data" : [
      {
         "description" : "Create FinDoc From So CO10003291",
         "num" : "CO10003291"
      }
   ]
}
Create FinDoc From So With Payment:
{
   "data" : [
      {
         "description" : "Create FinDoc From So CO10003291",
         "pay_now" : 1,
         "num" : "CO10003291"
      }
   ]
}

cURL

Create FinDoc From So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "description" : "Create FinDoc From So CO10003291",         "num" : "CO10003291"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createFinDoc?token=<TOKEN>"
Create FinDoc From So With Payment:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "description" : "Create FinDoc From So CO10003291",         "pay_now" : 1,         "num" : "CO10003291"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.createFinDoc?token=<TOKEN>"

Cancel Sales Order

POST/api/RPC.common.Api.So.annulSo?token=<TOKEN>

Key So.annulSo · Open page

Parameters

3 body parameters inside data[]
FieldTypeDescription
idrequiredStringSales Order ID
numrequiredStringSales Order ID
annul_descriptionStringDescription of cancelation

Request example

Annul So:
{
   "data" : [
      {
         "annul_description" : "Test for Annul So CO10003395",
         "num" : "CO10003395"
      }
   ]
}

cURL

Annul So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "annul_description" : "Test for Annul So CO10003395",         "num" : "CO10003395"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.annulSo?token=<TOKEN>"

Complete Sales Order cancelation

POST/api/RPC.common.Api.So.fullAnnulSo?token=<TOKEN>

Key So.fullAnnulSo · Open page

Parameters

4 body parameters inside data[]
FieldTypeDescription
idrequiredStringSales Order ID
numrequiredStringSales Order ID
annul_descriptionStringDescription of cancelation
delete_baseBooleanDelete sale

Request example

Complete Annul So:
{
   "data" : [
      {
         "annul_description" : "Test for Complete Annul So CO10002079",
         "num" : "CO10002079"
      }
   ]
}

cURL

Complete Annul So:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "annul_description" : "Test for Complete Annul So CO10002079",         "num" : "CO10002079"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.fullAnnulSo?token=<TOKEN>"

Get the financial document of a Sales Order

POST/api/RPC.common.Api.So.getSoInvoicePdf?token=<TOKEN>

Key So.getSoInvoicePdf · Open page

Parameters

2 body parameters inside data[]
FieldTypeDescription
numrequiredStringSales Order ID
blank_nameStringTemplate name

Request example

Request:
{
   "data" : [
      {
         "blank_name" : "test",
         "num" : "CO10000183"
      }
   ]
}

cURL

Request:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "blank_name" : "test",         "num" : "CO10000183"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.getSoInvoicePdf?token=<TOKEN>"

Change of description

POST/api/RPC.common.Api.So.changeDescription?token=<TOKEN>

Key So.changeDescription · Open page

Parameters

4 body parameters inside data[]
FieldTypeDescription
idIntegerSales Order ID
numrequiredStringSales Order ID
descriptionrequiredStringDescription
internal_descriptionrequiredStringInternal description

Request example

Change Description By Num:
{
   "data" : [
      {
         "num" : "CO10001440",
         "description" : "Lorem Ipsum Description",
         "internal_description" : "Lorem Ipsum Internal Description"
      }
   ]
}
Change Description By Id:
{
   "data" : [
      {
         "internal_description" : "Lorem Ipsum Internal Description",
         "id" : 3268154,
         "description" : "Lorem Ipsum Description"
      }
   ]
}

cURL

Change Description By Num:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "num" : "CO10001440",         "description" : "Lorem Ipsum Description",         "internal_description" : "Lorem Ipsum Internal Description"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.changeDescription?token=<TOKEN>"
Change Description By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "internal_description" : "Lorem Ipsum Internal Description",         "id" : 3268154,         "description" : "Lorem Ipsum Description"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.So.changeDescription?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "internal_description" : null,
         "type_action" : "so",
         "for_date_formated" : "06.01.2021",
         "for_date" : "2021-01-06",
         "pos_name" : "London",
         "type" : "so",
         "updatedon" : "2026-01-01 09:22:28",
         "createdon" : "2021-10-06 15:36:59",
         "description" : null,
         "rel_trans" : [
            {
               "num" : "0000001440",
               "trans_id" : 3268154,
               "type" : "invoice",
               "rel_trans_id" : 3268159,
               "for_date" : "2021-01-06"
            }
         ],
         "id" : 3268154,
         "num" : "CO10001440"
      }
   ]
}