Module CRM

Quản lý cơ hội, đơn hàng, Hoạch định KPI, hoạch định chiếc khấu, quản lý nguồn lực, Bài viết đào tạo.

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Report Seller MyReports

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

Branch

string

Branch

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfBegin

datetime

Date Of Begin

DateOfEnd

datetime

Date Of End

DateOfReport

datetime

Date Of Report

Id

numeric

Id

IsComplete

boolean

Is Complete

MainReportPart

string

Main Report Part

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Page

string

Page

Permission

string

Permission

ReportData

string

Report Data

ReportList

string

Report List

State

string

State

StateLabel

string

State Label

SubNote

string

Sub Note

Title

string

Title

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/report/seller/my-reports/{Code}: for get exacly item

  • GET /v4/collaborator/report/seller/my-reports: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/report/seller/my-reports

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/report/seller/my-reports/{Code}: for put exacly item

  • PUT /v4/collaborator/report/seller/my-reports: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/report/seller/my-reports/{Code}: for delete exacly item

  • DELETE /v4/collaborator/report/seller/my-reports?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Report Publisher Commissions

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

Branch

string

Branch

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfBegin

datetime

Date Of Begin

DateOfEnd

datetime

Date Of End

DateOfReport

datetime

Date Of Report

Id

numeric

Id

IsComplete

boolean

Is Complete

MainReportPart

string

Main Report Part

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Page

string

Page

Permission

string

Permission

ReportData

string

Report Data

ReportList

string

Report List

State

string

State

StateLabel

string

State Label

SubNote

string

Sub Note

Title

string

Title

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/report/publisher/commissions/{Code}: for get exacly item

  • GET /v4/collaborator/report/publisher/commissions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/report/publisher/commissions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/report/publisher/commissions/{Code}: for put exacly item

  • PUT /v4/collaborator/report/publisher/commissions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/report/publisher/commissions/{Code}: for delete exacly item

  • DELETE /v4/collaborator/report/publisher/commissions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Report Publisher ListCommissions

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfBegin

datetime

Date Of Begin

DateOfEnd

datetime

Date Of End

Description

string

Description

Id

numeric

Id

Page

string

Page

Permission

string

Permission

Progress

string

Progress

ProgressLabel

string

Progress Label

State

string

State

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/report/publisher/list-commissions/{Code}: for get exacly item

  • GET /v4/collaborator/report/publisher/list-commissions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/report/publisher/list-commissions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/report/publisher/list-commissions/{Code}: for put exacly item

  • PUT /v4/collaborator/report/publisher/list-commissions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/report/publisher/list-commissions/{Code}: for delete exacly item

  • DELETE /v4/collaborator/report/publisher/list-commissions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Publishers

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

datetime

Assigned

Avatar

serialize

Avatar

AwardMonthlyCheckpoint

string

Award Monthly Checkpoint

AwardQuarterlyCheckpoint

string

Award Quarterly Checkpoint

AwardWeeklyCheckpoint

string

Award Weekly Checkpoint

AwardYearlyCheckpoint

string

Award Yearly Checkpoint

Contact

string

Contact

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

LastOnline

datetime

Last Online

LastOrderDate

datetime

Last Order Date

Level

string

Level

LevelLabel

string

Level Label

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Publisher

string

Publisher

ReferredCode

string

Referred Code

Saler

string

Saler

SalerName

string

Saler Name

Signature

string

Signature

State

string

State

TokenHash

string

Token Hash

DateOfLog

datetime

Date Of Log

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/publishers/{Id}: for get exacly item

  • GET /v4/collaborator/publishers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/publishers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/publishers/{Id}: for put exacly item

  • PUT /v4/collaborator/publishers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/publishers/{Id}: for delete exacly item

  • DELETE /v4/collaborator/publishers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator SubscriptionPages

Primary Key: Page, Publisher

Schema

Field
Type
Description

Address

string

Address

Assigned

datetime

Assigned

Avatar

string

Avatar

AwardMonthlyCheckpoint

string

Award Monthly Checkpoint

AwardQuarterlyCheckpoint

string

Award Quarterly Checkpoint

AwardWeeklyCheckpoint

string

Award Weekly Checkpoint

AwardYearlyCheckpoint

string

Award Yearly Checkpoint

Contact

string

Contact

Created

string

Created

Creator

string

Creator

CreatorName

string

Creator Name

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

LastOnline

string

Last Online

LastOrderDate

string

Last Order Date

Level

string

Level

LevelLabel

string

Level Label

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Publisher

string

Publisher

ReferredCode

string

Referred Code

Saler

string

Saler

SalerName

string

Saler Name

Signature

string

Signature

State

string

State

TokenHash

string

Token Hash

Logo

object

Logo

Banner

object

Banner

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/subscription-pages/{Page}-{Publisher}: for get exacly item

  • GET /v4/collaborator/subscription-pages: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/subscription-pages

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/subscription-pages/{Page}-{Publisher}: for put exacly item

  • PUT /v4/collaborator/subscription-pages: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/subscription-pages/{Page}-{Publisher}: for delete exacly item

  • DELETE /v4/collaborator/subscription-pages?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Pages

Primary Key: Code

Schema

Field
Type
Description

AccMasterBook

string

Acc Master Book

Banner

serialize

Banner

Code

string

Code

CoreConnection

string

Core Connection

Created

datetime

Created

Description

string

Description

EndOfTheMonth

numeric

End Of The Month

EndOfTheQuarter

numeric

End Of The Quarter

EndOfTheYear

string

End Of The Year

EventUrl

string

Event Url

Id

numeric

Id

Logo

serialize

Logo

Name

string

Name

Permission

string

Permission

PlatformApiAccessToken

string

Platform Api Access Token

PlatformApiToken

string

Platform Api Token

PlatformApiUrl

string

Platform Api Url

PriceTable

string

Price Table

State

string

State

Summary

string

Summary

TagName

string

Tag Name

Type

string

Type

Weekend

numeric

Weekend

IsSubscribed

boolean

Is Subscribed

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/pages/{Code}: for get exacly item

  • GET /v4/collaborator/pages: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/pages

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/pages/{Code}: for put exacly item

  • PUT /v4/collaborator/pages: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/pages/{Code}: for delete exacly item

  • DELETE /v4/collaborator/pages?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator ProductUnits

Primary Key: Code, Page

Schema

Field
Type
Description

Code

string

Code

FullName

string

Full Name

Id

numeric

Id

IdNumber

string

Id Number

Name

string

Name

Page

string

Page

Sequence

numeric

Sequence

Symbol

string

Symbol

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/product-units/{Code}-{Page}: for get exacly item

  • GET /v4/collaborator/product-units: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/product-units

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/product-units/{Code}-{Page}: for put exacly item

  • PUT /v4/collaborator/product-units: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/product-units/{Code}-{Page}: for delete exacly item

  • DELETE /v4/collaborator/product-units?id0=123&id1=456&...: for delete multiple items with id0 id1,...

API thao tác Lấy (GET), Thêm (POST), Xóa (DELETE), Sửa (PUT) với thông tin sản phẩm

Primary Key: Id

Schema

Field
Type
Description

CommissionRatio

string

Commission Ratio

Level

string

Level

LevelLabel

string

Level Label

Mentor

string

Mentor

Page

string

Page

Product

string

Product

Signature

string

Signature

Subscribed

string

Subscribed

Subscriber

string

Subscriber

Unit

string

Unit

Pictures

serialize

Pictures

FeaturePicture

serialize

Feature Picture

RequireVatTax

boolean

Require Vat Tax

IsStopBusiness

boolean

Is Stop Business

Tags

serialize

Tags

Keywords

serialize

Keywords

Created

datetime

Created

LastUpdate

datetime

Last Update

Categories

array

children schema defined in Categories Schema below

Groups

array

children schema defined in Groups Schema below

UnitConversions

array

children schema defined in UnitConversions Schema below

Price

number

Price

Units

object

Units

Properties

array

children schema defined in Properties Schema below

ProductParts

array

children schema defined in ProductParts Schema below

Categories Schema

Field
Type
Description

Category

string

Category

CategoryName

string

Category Name

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Groups Schema

Field
Type
Description

Group

string

Group

GroupName

string

Group Name

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

UnitConversions Schema

Field
Type
Description

Containers

string

Containers

ConversionRatio

string

Conversion Ratio

Id

numeric

Id

IsAutoAdjustInventory

boolean

Is Auto Adjust Inventory

IsDefaultPurchase

boolean

Is Default Purchase

IsDefaultSales

boolean

Is Default Sales

IsExpirationGoods

boolean

Is Expiration Goods

IsManageByAccessNumber

boolean

Is Manage By Access Number

IsManageBySerialNumber

boolean

Is Manage By Serial Number

LastGoodsRecdeiptNote

string

Last Goods Recdeipt Note

LastPurchaseDate

string

Last Purchase Date

LastPurchaseObject

string

Last Purchase Object

LastPurchaseObjectName

string

Last Purchase Object Name

LastPurchasePrice

string

Last Purchase Price

LastPurchaseVoucher

string

Last Purchase Voucher

No

numeric

No

Product

string

Product

ProductName

string

Product Name

RelativeObjectIds

string

Relative Object Ids

RelativeObjects

string

Relative Objects

SearchRank

numeric

Search Rank

Unit

string

Unit

UnitLabel

string

Unit Label

Properties Schema

Field
Type
Description

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Property

string

Property

PropertyName

string

Property Name

PropertyValue

string

Property Value

PropertyValues

serialize

Property Values

ProductParts Schema

Field
Type
Description

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Property

string

Property

PropertyName

string

Property Name

PropertyValue

string

Property Value

PropertyValues

serialize

Property Values

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/product-subscriptions/{Id}: for get exacly item

  • GET /v4/collaborator/product-subscriptions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/product-subscriptions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/product-subscriptions/{Id}: for put exacly item

  • PUT /v4/collaborator/product-subscriptions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/product-subscriptions/{Id}: for delete exacly item

  • DELETE /v4/collaborator/product-subscriptions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator ProductCategories

Primary Key: Code, Page

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

FeaturePicture

serialize

Feature Picture

FindOrder

numeric

Find Order

FontIcon

string

Font Icon

Id

numeric

Id

ImageId

numeric

Image Id

Name

string

Name

Page

string

Page

Parent

string

Parent

Pictures

serialize

Pictures

Sequence

numeric

Sequence

UniqueKey

string

Unique Key

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/product-categories/{Code}-{Page}: for get exacly item

  • GET /v4/collaborator/product-categories: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/product-categories

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/product-categories/{Code}-{Page}: for put exacly item

  • PUT /v4/collaborator/product-categories: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/product-categories/{Code}-{Page}: for delete exacly item

  • DELETE /v4/collaborator/product-categories?id0=123&id1=456&...: for delete multiple items with id0 id1,...

API thao tác Lấy (GET), Thêm (POST), Xóa (DELETE), Sửa (PUT) với thông tin sản phẩm

Primary Key: Code, Page

Schema

Field
Type
Description

Barcode

string

Barcode

Brand

string

Brand

BrandName

string

Brand Name

Categories

array

children schema defined in Categories Schema below

Code

string

Code

CostOfGoodsSoldX

string

Cost Of Goods Sold X

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Description

string

Description

ExchangeProduct

string

Exchange Product

FeaturePicture

serialize

Feature Picture

Groups

array

children schema defined in Groups Schema below

IsApprove

numeric

Is Approve

IsRegenerateCode

numeric

Is Regenerate Code

IsRegenerateSku

numeric

Is Regenerate Sku

IsStopBusiness

boolean

Is Stop Business

Keyword

string

Keyword

Keywords

serialize

Keywords

LastUpdate

datetime

Last Update

LastUpdateBy

string

Last Update By

LastUpdateByName

string

Last Update By Name

ManualCode

string

Manual Code

ManufactureId

numeric

Manufacture Id

MarketingPrice

string

Marketing Price

Name

string

Name

OldCode

string

Old Code

OldCode2

string

Old Code2

Page

string

Page

ParentId

numeric

Parent Id

Permission

string

Permission

PictureId

string

Picture Id

PictureIdBk

numeric

Picture Id Bk

Pictures

serialize

Pictures

PurchaseCost

string

Purchase Cost

PurchasePrice

string

Purchase Price

RequireVatTax

boolean

Require Vat Tax

Revisions

string

Revisions

SearchRank

numeric

Search Rank

Sequence

numeric

Sequence

Sku

string

Sku

State

numeric

State

Tags

serialize

Tags

Tax

string

Tax

TaxName

string

Tax Name

Technical

string

Technical

Type

string

Type

TypeCode

string

Type Code

UniqueKey

string

Unique Key

UnitRatio

string

Unit Ratio

VatTax

string

Vat Tax

WarehouseUnit

string

Warehouse Unit

WarehouseUnitLabel

string

Warehouse Unit Label

UnitConversions

array

children schema defined in UnitConversions Schema below

Price

number

Price

IsSubscribed

boolean

Is Subscribed

ExtendTermPublishers

indexobjects

Extend Term Publishers

Properties

array

children schema defined in Properties Schema below

ProductParts

array

children schema defined in ProductParts Schema below

Categories Schema

Field
Type
Description

Category

string

Category

CategoryName

string

Category Name

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Groups Schema

Field
Type
Description

Group

string

Group

GroupName

string

Group Name

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

UnitConversions Schema

Field
Type
Description

Containers

string

Containers

ConversionRatio

string

Conversion Ratio

Id

numeric

Id

IsAutoAdjustInventory

boolean

Is Auto Adjust Inventory

IsDefaultPurchase

boolean

Is Default Purchase

IsDefaultSales

boolean

Is Default Sales

IsExpirationGoods

boolean

Is Expiration Goods

IsManageByAccessNumber

boolean

Is Manage By Access Number

IsManageBySerialNumber

boolean

Is Manage By Serial Number

LastGoodsRecdeiptNote

string

Last Goods Recdeipt Note

LastPurchaseDate

string

Last Purchase Date

LastPurchaseObject

string

Last Purchase Object

LastPurchaseObjectName

string

Last Purchase Object Name

LastPurchasePrice

string

Last Purchase Price

LastPurchaseVoucher

string

Last Purchase Voucher

No

numeric

No

Product

string

Product

ProductName

string

Product Name

RelativeObjectIds

string

Relative Object Ids

RelativeObjects

string

Relative Objects

SearchRank

numeric

Search Rank

Unit

string

Unit

UnitLabel

string

Unit Label

Properties Schema

Field
Type
Description

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Property

string

Property

PropertyName

string

Property Name

PropertyValue

string

Property Value

PropertyValues

serialize

Property Values

ProductParts Schema

Field
Type
Description

Id

numeric

Id

Product

string

Product

ProductName

string

Product Name

Property

string

Property

PropertyName

string

Property Name

PropertyValue

string

Property Value

PropertyValues

serialize

Property Values

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/products/{Code}-{Page}: for get exacly item

  • GET /v4/collaborator/products: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/products

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/products/{Code}-{Page}: for put exacly item

  • PUT /v4/collaborator/products: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/products/{Code}-{Page}: for delete exacly item

  • DELETE /v4/collaborator/products?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator ProductInPages

Primary Key: Page, Product

Schema

Field
Type
Description

CommissionRatio

serialize

Commission Ratio

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

ExtendTerm

string

Extend Term

ExtendTermLabel

string

Extend Term Label

ExtendTermPublishers

indexobjects

Extend Term Publishers

ExtendTermRatio

double

Extend Term Ratio

FeaturePicture

object

Feature Picture

Id

numeric

Id

IsAppliedForLevel1Monthly

boolean

Is Applied For Level1 Monthly

IsAppliedForLevel1Quarterly

boolean

Is Applied For Level1 Quarterly

IsAppliedForLevel1Weekly

boolean

Is Applied For Level1 Weekly

IsAppliedForLevel1Yearly

boolean

Is Applied For Level1 Yearly

IsAutoExtended

boolean

Is Auto Extended

IsDiscountByVoucher

boolean

Is Discount By Voucher

IsSelfOrder

boolean

Is Self Order

IsUsed

boolean

Is Used

Level1Badge

string

Level1 Badge

Level1CommissionRatio

double

Level1 Commission Ratio

Level1Description

string

Level1 Description

Level1Label

string

Level1 Label

Level1MonthlyAwardRatio

double

Level1 Monthly Award Ratio

Level1MonthlyKpi

double

Level1 Monthly Kpi

Level1MonthlyLabel

string

Level1 Monthly Label

Level1MonthlyOkr

double

Level1 Monthly Okr

Level1QuarterlyAwardRatio

double

Level1 Quarterly Award Ratio

Level1QuarterlyKpi

double

Level1 Quarterly Kpi

Level1QuarterlyLabel

string

Level1 Quarterly Label

Level1QuarterlyOkr

double

Level1 Quarterly Okr

Level1WeeklyAwardRatio

double

Level1 Weekly Award Ratio

Level1WeeklyKpi

double

Level1 Weekly Kpi

Level1WeeklyOkr

double

Level1 Weekly Okr

Level1YearlyAwardRatio

double

Level1 Yearly Award Ratio

Level1YearlyKpi

double

Level1 Yearly Kpi

Level1YearlyLabel

string

Level1 Yearly Label

Level1YearlyOkr

double

Level1 Yearly Okr

Level2ExtAwardRatio

double

Level2 Ext Award Ratio

Level2ExtBadge

string

Level2 Ext Badge

Level2ExtDescription

string

Level2 Ext Description

Level2ExtLabel

string

Level2 Ext Label

Level2ExtRequiredKpi

double

Level2 Ext Required Kpi

Level2ExtRequiredOkr

double

Level2 Ext Required Okr

Level2WeeklyLabel

string

Level2 Weekly Label

Level3ExtAwardRatio

double

Level3 Ext Award Ratio

Level3ExtBadge

string

Level3 Ext Badge

Level3ExtDescription

string

Level3 Ext Description

Level3ExtLabel

string

Level3 Ext Label

Level3ExtRequiredKpi

double

Level3 Ext Required Kpi

Level3ExtRequiredOkr

double

Level3 Ext Required Okr

Page

string

Page

PageName

string

Page Name

Pictures

object

Pictures

PlatformFee

double

Platform Fee

Price

string

Price

Product

string

Product

ProductName

string

Product Name

SelfOrderDiscount

double

Self Order Discount

Unit

string

Unit

UnitLabel

string

Unit Label

Units

fullobject

Units

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/page-products/{Page}-{Product}: for get exacly item

  • GET /v4/collaborator/page-products: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/page-products

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/page-products/{Page}-{Product}: for put exacly item

  • PUT /v4/collaborator/page-products: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/page-products/{Page}-{Product}: for delete exacly item

  • DELETE /v4/collaborator/page-products?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator PosOrders

Primary Key: Code

Schema

Field
Type
Description

Account

string

Account

Amount

double

Amount

Approved

string

Approved

Approver

string

Approver

Branch

string

Branch

CashAmount

double

Cash Amount

CashBack

float

Cash Back

CashReceipt

float

Cash Receipt

CashTransferAmount

double

Cash Transfer Amount

Code

string

Code

CodeTax

string

Code Tax

Contact

string

Contact

ContactAddress

string

Contact Address

ContactEmail

string

Contact Email

ContactIdentifiedNumber

string

Contact Identified Number

ContactName

string

Contact Name

ContactPhone

string

Contact Phone

Created

datetime

Created

Creator

string

Creator

DateOfDelivery

datetime

Date Of Delivery

DateOfSale

datetime

Date Of Sale

DebitFunds

double

Debit Funds

DebtAmount

string

Debt Amount

DecreaseForTotal

float

Decrease For Total

DeliveryAddress

string

Delivery Address

DeliveryLocation

numeric

Delivery Location

DirectReceiverName

string

Direct Receiver Name

Employee

string

Employee

Id

numeric

Id

IncludeTax

boolean

Include Tax

InventoryDeliveryVoucher

string

Inventory Delivery Voucher

Invoice

string

Invoice

InvoiceAddress

string

Invoice Address

InvoiceLocation

numeric

Invoice Location

IsDebt

boolean

Is Debt

IsExportVatInvoice

numeric

Is Export Vat Invoice

IsObjectRevenue

boolean

Is Object Revenue

IsPaid

numeric

Is Paid

LastUpdate

string

Last Update

MemberCard

string

Member Card

Money

string

Money

No

numeric

No

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectBankCode

string

Object Bank Code

ObjectBankName

string

Object Bank Name

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

PaidMoney

string

Paid Money

PaymentMethod

string

Payment Method

Permission

string

Permission

PriceReportVoucher

string

Price Report Voucher

PriceTable

string

Price Table

PromotePrograme

string

Promote Programe

Publishers

serialize

Publishers

ReceiptBankAccount

string

Receipt Bank Account

RelativeVouchers

string

Relative Vouchers

RequireInvoice

numeric

Require Invoice

Returns

string

Returns

Revision

numeric

Revision

SalesStaff

string

Sales Staff

State

string

State

SubNote

string

Sub Note

Tax

string

Tax

Thread

string

Thread

Title

string

Title

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/pos-orders/{Code}: for get exacly item

  • GET /v4/collaborator/pos-orders: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/pos-orders

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/pos-orders/{Code}: for put exacly item

  • PUT /v4/collaborator/pos-orders: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/pos-orders/{Code}: for delete exacly item

  • DELETE /v4/collaborator/pos-orders?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Orders

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

ApprovedDate

string

Approved Date

ApprovedUser

string

Approved User

ApprovedUserName

string

Approved User Name

Bot

string

Bot

BotName

string

Bot Name

BusinessOwner

string

Business Owner

BusinessOwnerName

string

Business Owner Name

Code

string

Code

CommonInfoReceivedEmail

string

Common Info Received Email

CommonInfoReceivedFullName

string

Common Info Received Full Name

CommonInfoReceivedPhone

string

Common Info Received Phone

CommonInfoReceivedTitle

string

Common Info Received Title

Country

string

Country

CountryLabel

string

Country Label

Created

string

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfComplete

datetime

Date Of Complete

DateOfDelivery

datetime

Date Of Delivery

DateOfDeployed

datetime

Date Of Deployed

DateOfOrder

datetime

Date Of Order

DateOfProcessing

datetime

Date Of Processing

DateOfTransport

datetime

Date Of Transport

DeliveryAddress

string

Delivery Address

DeliveryCost

double

Delivery Cost

DeliveryDistrict

string

Delivery District

DeliveryDistrictLabel

string

Delivery District Label

DeliveryMapLink

string

Delivery Map Link

DeliveryProvince

string

Delivery Province

DeliveryProvinceLabel

string

Delivery Province Label

DeliveryWard

string

Delivery Ward

DeliveryWardLabel

string

Delivery Ward Label

DeploymentAddress

string

Deployment Address

DeploymentMapLink

string

Deployment Map Link

DirectReceiver

string

Direct Receiver

DirectReceiverEmail

string

Direct Receiver Email

DirectReceiverName

string

Direct Receiver Name

DirectReceiverPhone

string

Direct Receiver Phone

District

string

District

DistrictLabel

string

District Label

FullDeliveryAddress

string

Full Delivery Address

Id

numeric

Id

InvoiceReceivedEmail

string

Invoice Received Email

InvoiceReceivedLegalAddress

string

Invoice Received Legal Address

InvoiceReceivedLegalName

string

Invoice Received Legal Name

InvoiceReceivedPhone

string

Invoice Received Phone

InvoiceReceivedTaxCode

string

Invoice Received Tax Code

IsExportVatInvoice

string

Is Export Vat Invoice

JobAccepted

datetime

Job Accepted

JobHandler

string

Job Handler

JobHandlerName

string

Job Handler Name

JobName

string

Job Name

Logs

string

Logs

ManagerInfoReceivedEmail

string

Manager Info Received Email

ManagerInfoReceivedFullName

string

Manager Info Received Full Name

ManagerInfoReceivedPhone

string

Manager Info Received Phone

ManagerInfoReceivedTitle

string

Manager Info Received Title

MonthlyCommissionCheckpoint

numeric

Monthly Commission Checkpoint

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectBank

string

Object Bank

ObjectBankAccount

string

Object Bank Account

ObjectBankName

string

Object Bank Name

ObjectCallcenterNumber

string

Object Callcenter Number

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

OriginDeliveryCost

double

Origin Delivery Cost

Page

string

Page

PaidAmount

double

Paid Amount

Permission

string

Permission

PriceTable

string

Price Table

Province

string

Province

ProvinceLabel

string

Province Label

Publisher

string

Publisher

PublisherAddress

string

Publisher Address

PublisherEmail

string

Publisher Email

PublisherName

string

Publisher Name

PublisherPhone

string

Publisher Phone

PublisherPlatform

string

Publisher Platform

PublisherRefId

string

Publisher Ref Id

PublisherSupporter

string

Publisher Supporter

PublisherSupporterAddress

string

Publisher Supporter Address

PublisherSupporterEmail

string

Publisher Supporter Email

PublisherSupporterName

string

Publisher Supporter Name

PublisherSupporterPhone

string

Publisher Supporter Phone

QuarterlyCommissionCheckpoint

numeric

Quarterly Commission Checkpoint

RequireInvoice

boolean

Require Invoice

SalesManager

string

Sales Manager

SalesManagerName

string

Sales Manager Name

Seller

string

Seller

SellerAddress

string

Seller Address

SellerEmail

string

Seller Email

SellerName

string

Seller Name

SellerPhone

string

Seller Phone

Shipper

string

Shipper

ShipperAddress

string

Shipper Address

ShipperEmail

string

Shipper Email

ShipperName

string

Shipper Name

ShipperPhone

string

Shipper Phone

Source

string

Source

SourceCode

string

Source Code

State

string

State

SubNote

string

Sub Note

Thread

string

Thread

Title

string

Title

Total

double

Total

Ward

string

Ward

WardLabel

string

Ward Label

WeeklyCommissionCheckpoint

numeric

Weekly Commission Checkpoint

YearlyCommissionCheckpoint

numeric

Yearly Commission Checkpoint

AmountOfRelative

double

Amount Of Relative

Sellers

objects

Sellers

PublisherSupporters

objects

Publisher Supporters

BusinessOwners

objects

Business Owners

SalesManagers

objects

Sales Managers

Publishers

objects

Publishers

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/orders/{Code}: for get exacly item

  • GET /v4/collaborator/orders: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/orders

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/orders/{Code}: for put exacly item

  • PUT /v4/collaborator/orders: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/orders/{Code}: for delete exacly item

  • DELETE /v4/collaborator/orders?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator OrderDetails

Primary Key: Voucher, SystemUuid

Schema

Field
Type
Description

AccessNumbers

string

Access Numbers

AddonCommissionAmount

string

Addon Commission Amount

AddonCommissionRatio

string

Addon Commission Ratio

AddonProfiles

object

Addon Profiles

AddonSalerCommissionAmount

string

Addon Saler Commission Amount

AddonSalerCommissionRatio

string

Addon Saler Commission Ratio

AdvanceCommissionAmount

string

Advance Commission Amount

AdvanceCommissionRatio

string

Advance Commission Ratio

AdvanceSalerCommissionAmount

string

Advance Saler Commission Amount

AdvanceSalerCommissionRatio

string

Advance Saler Commission Ratio

BaseUnit

string

Base Unit

BaseUnitLabel

string

Base Unit Label

BasicCommissionAmount

string

Basic Commission Amount

BasicCommissionRatio

string

Basic Commission Ratio

BasicSalerCommissionAmount

string

Basic Saler Commission Amount

BasicSalerCommissionRatio

string

Basic Saler Commission Ratio

Business

indexobjects

Business

BusinessOwner

string

Business Owner

BusinessOwnerName

string

Business Owner Name

CommissionAmount

string

Commission Amount

CommissionRatio

string

Commission Ratio

Currency

string

Currency

Description

string

Description

Id

numeric

Id

Image

serialize

Image

IsRelativeToPublisher

boolean

Is Relative To Publisher

Mentor

string

Mentor

MentorLevel

string

Mentor Level

No

numeric

No

Page

string

Page

Price

double

Price

Product

string

Product

ProductUnitIndex

string

Product Unit Index

Publisher

string

Publisher

PublisherName

string

Publisher Name

PublisherRefId

string

Publisher Ref Id

PublisherSupporter

string

Publisher Supporter

PublisherSupporterName

string

Publisher Supporter Name

Quantity

double

Quantity

QuantityConversion

string

Quantity Conversion

RebuyCommissionAmount

string

Rebuy Commission Amount

RebuyCommissionRatio

string

Rebuy Commission Ratio

RelateDetail

string

Relate Detail

SalesManager

string

Sales Manager

SalesManagerName

string

Sales Manager Name

Seller

string

Seller

SellerName

string

Seller Name

SystemUuid

string

System Uuid

Tax

string

Tax

TaxVal

string

Tax Val

ToMoney

string

To Money

Type

string

Type

Unit

string

Unit

UnitConversion

string

Unit Conversion

UnitLabel

string

Unit Label

Voucher

string

Voucher

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/order-details/{Voucher}-{SystemUuid}: for get exacly item

  • GET /v4/collaborator/order-details: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/order-details

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/order-details/{Voucher}-{SystemUuid}: for put exacly item

  • PUT /v4/collaborator/order-details: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/order-details/{Voucher}-{SystemUuid}: for delete exacly item

  • DELETE /v4/collaborator/order-details?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator PriceReports

Primary Key: Code

Schema

Field
Type
Description

Amount

string

Amount

Approved

datetime

Approved

Approver

string

Approver

ApproverName

string

Approver Name

ApproverUser

string

Approver User

AttachImageId

numeric

Attach Image Id

Branch

string

Branch

Code

string

Code

Completed

string

Completed

Completer

string

Completer

CompleteRequested

string

Complete Requested

CompleteRequester

string

Complete Requester

CompleteRequesterName

string

Complete Requester Name

CompleterName

string

Completer Name

Contact

string

Contact

ContactAddress

string

Contact Address

ContactEmail

string

Contact Email

ContactIdentifiedNumber

string

Contact Identified Number

ContactName

string

Contact Name

ContactPhone

string

Contact Phone

Created

datetime

Created

Creator

string

Creator

CreatorId

numeric

Creator Id

CustomerId

numeric

Customer Id

DeliveryAddress

string

Delivery Address

DeliveryLatitude

string

Delivery Latitude

DeliveryLongitude

string

Delivery Longitude

DirectReceiverName

string

Direct Receiver Name

Employee

string

Employee

FileName

string

File Name

Id

numeric

Id

Implemented

string

Implemented

Implementer

string

Implementer

ImplementerName

string

Implementer Name

IncludeTax

boolean

Include Tax

IsApprove

numeric

Is Approve

IsIncludeVat

numeric

Is Include Vat

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectBankCode

string

Object Bank Code

ObjectBankName

string

Object Bank Name

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

PaymentStep

string

Payment Step

Permission

string

Permission

PriceTable

string

Price Table

Recipient

string

Recipient

Reported

datetime

Reported

RequireInvoice

boolean

Require Invoice

SequenceNumber

numeric

Sequence Number

StaffCreatorId

numeric

Staff Creator Id

State

string

State

StoreId

numeric

Store Id

SubNote

string

Sub Note

Tax

string

Tax

Thread

string

Thread

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/price-reports/{Code}: for get exacly item

  • GET /v4/collaborator/price-reports: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/price-reports

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/price-reports/{Code}: for put exacly item

  • PUT /v4/collaborator/price-reports: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/price-reports/{Code}: for delete exacly item

  • DELETE /v4/collaborator/price-reports?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator ProductGroups

Primary Key: Code, Page

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

FindOrder

numeric

Find Order

Id

numeric

Id

Name

string

Name

Page

string

Page

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/product-groups/{Code}-{Page}: for get exacly item

  • GET /v4/collaborator/product-groups: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/product-groups

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/product-groups/{Code}-{Page}: for put exacly item

  • PUT /v4/collaborator/product-groups: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/product-groups/{Code}-{Page}: for delete exacly item

  • DELETE /v4/collaborator/product-groups?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Listen

Primary Key: Publisher

Schema

Field
Type
Description

Address

string

Address

Assigned

datetime

Assigned

Avatar

string

Avatar

AwardMonthlyCheckpoint

string

Award Monthly Checkpoint

AwardQuarterlyCheckpoint

string

Award Quarterly Checkpoint

AwardWeeklyCheckpoint

string

Award Weekly Checkpoint

AwardYearlyCheckpoint

string

Award Yearly Checkpoint

Contact

string

Contact

Created

string

Created

Creator

string

Creator

CreatorName

string

Creator Name

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

LastOnline

string

Last Online

LastOrderDate

string

Last Order Date

Level

string

Level

LevelLabel

string

Level Label

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Publisher

string

Publisher

ReferredCode

string

Referred Code

Saler

string

Saler

SalerName

string

Saler Name

Signature

string

Signature

State

string

State

TokenHash

string

Token Hash

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/listen/{Publisher}: for get exacly item

  • GET /v4/collaborator/listen: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/listen

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/listen/{Publisher}: for put exacly item

  • PUT /v4/collaborator/listen: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/listen/{Publisher}: for delete exacly item

  • DELETE /v4/collaborator/listen?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Statistics

Primary Key: Code

Schema

Field
Type
Description

Account

string

Account

BankAccount

string

Bank Account

Branch

string

Branch

CommissionRatio

string

Commission Ratio

CommissionStrategy

string

Commission Strategy

Construction

string

Construction

ContraAccount

string

Contra Account

Contract

string

Contract

CostClassification

string

Cost Classification

CostObject

string

Cost Object

Credit

number

Credit

CreditQuantity

string

Credit Quantity

DateOfWriting

string

Date Of Writing

Debit

number

Debit

DebitQuantity

string

Debit Quantity

Description

string

Description

Employee

string

Employee

EmployeeCredit

string

Employee Credit

EmployeeCreditAccount

string

Employee Credit Account

EmployeeDebit

string

Employee Debit

EmployeeDebitAccount

string

Employee Debit Account

Id

numeric

Id

MasterBook

string

Master Book

Mentor

string

Mentor

Object

string

Object

ObjectName

string

Object Name

Page

string

Page

Price

string

Price

Product

string

Product

ProductGroupIndex

string

Product Group Index

ProductName

string

Product Name

ProductUnit

string

Product Unit

ProductUnitIndex

string

Product Unit Index

ProductUnitLabel

string

Product Unit Label

Publisher

string

Publisher

Quantity

string

Quantity

SalesOrder

string

Sales Order

Seller

string

Seller

State

string

State

Tags

string

Tags

Thread

string

Thread

Type

string

Type

Voucher

string

Voucher

VoucherDate

datetime

Voucher Date

VoucherDescription

string

Voucher Description

VoucherDetailUuid

string

Voucher Detail Uuid

VoucherPart

string

Voucher Part

VoucherType

string

Voucher Type

WriteNo

numeric

Write No

Writer

string

Writer

WriteType

string

Write Type

SumOfDebit

number

Sum Of Debit

SumOfCredit

number

Sum Of Credit

NumOfVouchers

number

Num Of Vouchers

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/statistics/{Code}: for get exacly item

  • GET /v4/collaborator/statistics: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/statistics

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/statistics/{Code}: for put exacly item

  • PUT /v4/collaborator/statistics: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/statistics/{Code}: for delete exacly item

  • DELETE /v4/collaborator/statistics?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Reports

Primary Key: Code

Schema

Field
Type
Description

Account

string

Account

BankAccount

string

Bank Account

Branch

string

Branch

CommissionRatio

string

Commission Ratio

CommissionStrategy

string

Commission Strategy

Construction

string

Construction

ContraAccount

string

Contra Account

Contract

string

Contract

CostClassification

string

Cost Classification

CostObject

string

Cost Object

Credit

string

Credit

CreditQuantity

string

Credit Quantity

DateOfWriting

datetime

Date Of Writing

Debit

string

Debit

DebitQuantity

string

Debit Quantity

Description

string

Description

Employee

string

Employee

EmployeeCredit

string

Employee Credit

EmployeeCreditAccount

string

Employee Credit Account

EmployeeDebit

string

Employee Debit

EmployeeDebitAccount

string

Employee Debit Account

Id

numeric

Id

MasterBook

string

Master Book

Mentor

string

Mentor

Object

string

Object

ObjectName

string

Object Name

Page

string

Page

Price

double

Price

Product

string

Product

ProductGroupIndex

string

Product Group Index

ProductName

string

Product Name

ProductUnit

string

Product Unit

ProductUnitIndex

string

Product Unit Index

ProductUnitLabel

string

Product Unit Label

Publisher

string

Publisher

Quantity

double

Quantity

SalesOrder

string

Sales Order

Seller

string

Seller

State

string

State

Tags

string

Tags

Thread

string

Thread

Type

string

Type

Voucher

string

Voucher

VoucherDate

datetime

Voucher Date

VoucherDescription

string

Voucher Description

VoucherDetailUuid

string

Voucher Detail Uuid

VoucherPart

string

Voucher Part

VoucherType

string

Voucher Type

WriteNo

numeric

Write No

Writer

string

Writer

WriteType

string

Write Type

HeadDebit

number

Head Debit

HeadCredit

number

Head Credit

GenerateDebit

number

Generate Debit

GenerateCredit

number

Generate Credit

HeadNumOfVouchers

number

Head Num Of Vouchers

GenerateNumOfVouchers

number

Generate Num Of Vouchers

TailNumOfVouchers

number

Tail Num Of Vouchers

ObjectContactGroups

serialize

Object Contact Groups

EmployeeAvatar

serialize

Employee Avatar

ProductFeaturePicture

serialize

Product Feature Picture

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/reports/{Code}: for get exacly item

  • GET /v4/collaborator/reports: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/reports

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/reports/{Code}: for put exacly item

  • PUT /v4/collaborator/reports: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/reports/{Code}: for delete exacly item

  • DELETE /v4/collaborator/reports?id0=123&id1=456&...: for delete multiple items with id0 id1,...

API thao tác Lấy (GET), Thêm (POST), Xóa (DELETE), Sửa (PUT) với phiếu thu/chi phân biệt bằng Loại phiếu (Type) PAYMENT là phiếu chi, RECEIPT là phiếu thu

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

Bank

string

Bank

BankAccount

string

Bank Account

Cashbook

string

Cashbook

Code

string

Code

Creator

string

Creator

CreatorName

string

Creator Name

DateOfVoucher

datetime

Date Of Voucher

Description

string

Description

Object

string

Object

ObjectAddress

string

Object Address

ObjectBankAccount

string

Object Bank Account

ObjectBankName

string

Object Bank Name

ObjectEmail

string

Object Email

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

State

string

State

Thread

string

Thread

Type

string

Type

TypeName

string

Type Name

Details

array

children schema defined in Details Schema below

Details Schema

Field
Type
Description

AccountingBusiness

string

Accounting Business

Amount

double

Amount

CostClassification

string

Cost Classification

CostObject

string

Cost Object

CreditAccount

string

Credit Account

DebitAccount

string

Debit Account

Description

string

Description

No

numeric

No

RelateCode

string

Relate Code

RelativeVoucher

string

Relative Voucher

SalesOrder

string

Sales Order

SystemUuid

string

System Uuid

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/commission-payment-vouchers/{Code}: for get exacly item

  • GET /v4/collaborator/commission-payment-vouchers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/commission-payment-vouchers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/commission-payment-vouchers/{Code}: for put exacly item

  • PUT /v4/collaborator/commission-payment-vouchers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/commission-payment-vouchers/{Code}: for delete exacly item

  • DELETE /v4/collaborator/commission-payment-vouchers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator CommissionVouchers

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

Bank

string

Bank

BankAccount

string

Bank Account

BankName

string

Bank Name

Code

string

Code

CommissionFrom

datetime

Commission From

CommissionTo

datetime

Commission To

Created

datetime

Created

Cycle

string

Cycle

Description

string

Description

DetailsHash

string

Details Hash

Id

numeric

Id

Page

string

Page

Permission

string

Permission

Publisher

string

Publisher

PublisherAddress

string

Publisher Address

PublisherEmail

string

Publisher Email

PublisherIdentifiedNumber

string

Publisher Identified Number

PublisherName

string

Publisher Name

PublisherPhone

string

Publisher Phone

PublisherRefId

string

Publisher Ref Id

RelativeVouchers

string

Relative Vouchers

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/commission-vouchers/{Code}: for get exacly item

  • GET /v4/collaborator/commission-vouchers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/commission-vouchers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/commission-vouchers/{Code}: for put exacly item

  • PUT /v4/collaborator/commission-vouchers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/commission-vouchers/{Code}: for delete exacly item

  • DELETE /v4/collaborator/commission-vouchers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator CommissionVoucherDetails

Primary Key: CommissionVoucher, No

Schema

Field
Type
Description

AccBusiness

string

Acc Business

Business

string

Business

CommissionAmount

double

Commission Amount

CommissionRatio

double

Commission Ratio

CommissionVoucher

string

Commission Voucher

Id

numeric

Id

Image

string

Image

Mentor

string

Mentor

No

numeric

No

Product

string

Product

ProductName

string

Product Name

SumOfNetRevenue

double

Sum Of Net Revenue

SumOfQuantity

double

Sum Of Quantity

SystemUuid

string

System Uuid

Unit

string

Unit

UnitLabel

string

Unit Label

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/commission-voucher-details/{CommissionVoucher}-{No}: for get exacly item

  • GET /v4/collaborator/commission-voucher-details: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/commission-voucher-details

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/commission-voucher-details/{CommissionVoucher}-{No}: for put exacly item

  • PUT /v4/collaborator/commission-voucher-details: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/commission-voucher-details/{CommissionVoucher}-{No}: for delete exacly item

  • DELETE /v4/collaborator/commission-voucher-details?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator CommissionVoucherDetailOrders

Primary Key: CommissionVoucher, DetailNo, No

Schema

Field
Type
Description

BaseUnit

string

Base Unit

BaseUnitLabel

string

Base Unit Label

CommissionAmount

string

Commission Amount

CommissionRatio

string

Commission Ratio

CommissionVoucher

string

Commission Voucher

Description

string

Description

DetailNo

numeric

Detail No

DetailUuid

string

Detail Uuid

Id

numeric

Id

No

numeric

No

Price

double

Price

Product

string

Product

Quantity

double

Quantity

QuantityConversion

double

Quantity Conversion

Strategy

string

Strategy

Tax

string

Tax

TaxLabel

string

Tax Label

TaxValue

double

Tax Value

Unit

string

Unit

UnitConversion

double

Unit Conversion

UnitLabel

string

Unit Label

Voucher

string

Voucher

VoucherDate

datetime

Voucher Date

VoucherDetailNo

numeric

Voucher Detail No

VoucherTitle

string

Voucher Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/commission-voucher-detail-orders/{CommissionVoucher}-{DetailNo}-{No}: for get exacly item

  • GET /v4/collaborator/commission-voucher-detail-orders: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/commission-voucher-detail-orders

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/commission-voucher-detail-orders/{CommissionVoucher}-{DetailNo}-{No}: for put exacly item

  • PUT /v4/collaborator/commission-voucher-detail-orders: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/commission-voucher-detail-orders/{CommissionVoucher}-{DetailNo}-{No}: for delete exacly item

  • DELETE /v4/collaborator/commission-voucher-detail-orders?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AwardVouchers

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

AwardFrom

datetime

Award From

AwardTo

datetime

Award To

Bank

string

Bank

BankAccount

string

Bank Account

BankName

string

Bank Name

Code

string

Code

Created

datetime

Created

Cycle

string

Cycle

Description

string

Description

Id

numeric

Id

Page

string

Page

Publisher

string

Publisher

PublisherAddress

string

Publisher Address

PublisherEmail

string

Publisher Email

PublisherIdentifiedNumber

string

Publisher Identified Number

PublisherName

string

Publisher Name

PublisherPhone

string

Publisher Phone

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/award-vouchers/{Code}: for get exacly item

  • GET /v4/collaborator/award-vouchers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/award-vouchers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/award-vouchers/{Code}: for put exacly item

  • PUT /v4/collaborator/award-vouchers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/award-vouchers/{Code}: for delete exacly item

  • DELETE /v4/collaborator/award-vouchers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AwardVoucherDetails

Primary Key: AwardVoucher, No

Schema

Field
Type
Description

AccBusiness

string

Acc Business

AwardAmount

double

Award Amount

AwardVoucher

string

Award Voucher

Business

string

Business

ExtendTermAmount

double

Extend Term Amount

ExtendTermRatio

double

Extend Term Ratio

ExtSumOfNetRevenue

string

Ext Sum Of Net Revenue

ExtSumOfQuantity

string

Ext Sum Of Quantity

Id

numeric

Id

Image

string

Image

Kpi

string

Kpi

Level1AwardAmount

string

Level1 Award Amount

Level1AwardRatio

string

Level1 Award Ratio

Level1Kpi

string

Level1 Kpi

Level2ExtAwardAmount

string

Level2 Ext Award Amount

Level2ExtAwardRatio

string

Level2 Ext Award Ratio

Level3ExtAwardAmount

string

Level3 Ext Award Amount

Level3ExtAwardRatio

string

Level3 Ext Award Ratio

No

numeric

No

Okr

string

Okr

Product

string

Product

ProductName

string

Product Name

RelativeVouchers

string

Relative Vouchers

SumOfNetRevenue

string

Sum Of Net Revenue

SumOfQuantity

string

Sum Of Quantity

TotalAwardAmount

string

Total Award Amount

Unit

string

Unit

UnitLabel

string

Unit Label

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/award-voucher-details/{AwardVoucher}-{No}: for get exacly item

  • GET /v4/collaborator/award-voucher-details: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/award-voucher-details

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/award-voucher-details/{AwardVoucher}-{No}: for put exacly item

  • PUT /v4/collaborator/award-voucher-details: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/award-voucher-details/{AwardVoucher}-{No}: for delete exacly item

  • DELETE /v4/collaborator/award-voucher-details?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AwardVoucherDetailCommissions

Primary Key: AwardVoucher, DetailNo, No

Schema

Field
Type
Description

AwardVoucher

string

Award Voucher

BaseUnit

string

Base Unit

BaseUnitLabel

string

Base Unit Label

CommissionFrom

string

Commission From

CommissionTo

string

Commission To

ConversionQuantity

string

Conversion Quantity

Description

string

Description

DetailNo

numeric

Detail No

Id

numeric

Id

No

numeric

No

Price

string

Price

Product

string

Product

Quantity

string

Quantity

Tax

string

Tax

TaxLabel

string

Tax Label

TaxValue

string

Tax Value

Unit

string

Unit

UnitConversion

string

Unit Conversion

UnitLabel

string

Unit Label

Voucher

string

Voucher

VoucherDetailNo

numeric

Voucher Detail No

VoucherTitle

string

Voucher Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/award-voucher-detail-commissions/{AwardVoucher}-{DetailNo}-{No}: for get exacly item

  • GET /v4/collaborator/award-voucher-detail-commissions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/award-voucher-detail-commissions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/award-voucher-detail-commissions/{AwardVoucher}-{DetailNo}-{No}: for put exacly item

  • PUT /v4/collaborator/award-voucher-detail-commissions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/award-voucher-detail-commissions/{AwardVoucher}-{DetailNo}-{No}: for delete exacly item

  • DELETE /v4/collaborator/award-voucher-detail-commissions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AwardVoucherDetailExtCommissions

Primary Key: AwardVoucher, DetailNo, No

Schema

Field
Type
Description

AwardVoucher

string

Award Voucher

BaseUnit

string

Base Unit

BaseUnitLabel

string

Base Unit Label

CommissionFrom

string

Commission From

CommissionTo

string

Commission To

ConversionQuantity

string

Conversion Quantity

Description

string

Description

DetailNo

numeric

Detail No

Id

numeric

Id

No

numeric

No

Price

string

Price

Product

string

Product

Quantity

string

Quantity

Tax

string

Tax

TaxLabel

string

Tax Label

TaxValue

string

Tax Value

Unit

string

Unit

UnitConversion

string

Unit Conversion

UnitLabel

string

Unit Label

Voucher

string

Voucher

VoucherDetailNo

numeric

Voucher Detail No

VoucherTitle

string

Voucher Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/award-voucher-detail-ext-commissions/{AwardVoucher}-{DetailNo}-{No}: for get exacly item

  • GET /v4/collaborator/award-voucher-detail-ext-commissions: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/award-voucher-detail-ext-commissions

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/award-voucher-detail-ext-commissions/{AwardVoucher}-{DetailNo}-{No}: for put exacly item

  • PUT /v4/collaborator/award-voucher-detail-ext-commissions: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/award-voucher-detail-ext-commissions/{AwardVoucher}-{DetailNo}-{No}: for delete exacly item

  • DELETE /v4/collaborator/award-voucher-detail-ext-commissions?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator EducationArticles

Primary Key: Code, Page

Schema

Field
Type
Description

Code

string

Code

ContentBlock1

string

Content Block1

ContentBlock2

string

Content Block2

ContentBlock3

string

Content Block3

Creator

string

Creator

DateOfCreated

datetime

Date Of Created

Id

numeric

Id

IsSync

boolean

Is Sync

Page

string

Page

PageName

string

Page Name

Photo

string

Photo

Product

string

Product

ProductName

string

Product Name

State

string

State

Summary

string

Summary

Title

string

Title

VideoEmbed

string

Video Embed

VideoLink

string

Video Link

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/education-articles/{Code}-{Page}: for get exacly item

  • GET /v4/collaborator/education-articles: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/education-articles

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/education-articles/{Code}-{Page}: for put exacly item

  • PUT /v4/collaborator/education-articles: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/education-articles/{Code}-{Page}: for delete exacly item

  • DELETE /v4/collaborator/education-articles?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator BasicStrategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/basic-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/basic-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/basic-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/basic-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/basic-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/basic-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/basic-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AdvanceStrategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/advance-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/advance-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/advance-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/advance-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/advance-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/advance-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/advance-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AddonStrategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/addon-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/addon-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/addon-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/addon-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/addon-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/addon-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/addon-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator RebuyStrategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/rebuy-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/rebuy-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/rebuy-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/rebuy-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/rebuy-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/rebuy-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/rebuy-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Contacts

Primary Key: Code

Schema

Field
Type
Description

Address

string

Address

Address2

string

Address2

Address3

string

Address3

Avatar

serialize

Avatar

AvatarBk

numeric

Avatar Bk

AvatarUrl

string

Avatar Url

BankAcc

string

Bank Acc

BankName

string

Bank Name

Birthday

string

Birthday

Branch

string

Branch

BranchId

numeric

Branch Id

CallcenterNumber

string

Callcenter Number

CanLogin

numeric

Can Login

Code

string

Code

CompanyEmail

string

Company Email

ContactType

string

Contact Type

Created

string

Created

Creator

string

Creator

CreatorName

string

Creator Name

CreditPoints

numeric

Credit Points

CurrentDevice

string

Current Device

DateOfIssueIdNumber

string

Date Of Issue Id Number

Debt

string

Debt

DeleteBy

string

Delete By

DeleteByName

string

Delete By Name

Deleted

string

Deleted

Department

string

Department

District

string

District

DistrictLabel

string

District Label

Email

string

Email

EthnicOrigion

string

Ethnic Origion

Fax

string

Fax

FirstName

string

First Name

FullAddress

string

Full Address

Gender

string

Gender

GlobalPhone

string

Global Phone

Group

string

Group

GtalkId

string

Gtalk Id

Homeland

string

Homeland

HomeTel

string

Home Tel

Id

numeric

Id

IdentifiedNumber

string

Identified Number

IdNumber

string

Id Number

IdNumberSnapshot

string

Id Number Snapshot

IdNumberSnapshot2

string

Id Number Snapshot2

IdNumberSnapshot2Bk

numeric

Id Number Snapshot2 Bk

IdNumberSnapshotBk

numeric

Id Number Snapshot Bk

IsDeleted

boolean

Is Deleted

IsReceiveAllNotifications

numeric

Is Receive All Notifications

JoinedDate

string

Joined Date

Keyword

string

Keyword

LastName

string

Last Name

Latitude

string

Latitude

Location

string

Location

Longitude

string

Longitude

MapLink

string

Map Link

MapUrl

string

Map Url

MaxDebt

string

Max Debt

MemberLevel

string

Member Level

MemberLevelName

string

Member Level Name

MsnId

string

Msn Id

Name

string

Name

Note

string

Note

OtherEmail

string

Other Email

OtherPhone

string

Other Phone

Parent

string

Parent

ParentIdBk

numeric

Parent Id Bk

PermanentAddress

string

Permanent Address

Permission

string

Permission

PersonalEmail

string

Personal Email

Phone

string

Phone

Phone2

string

Phone2

Phone3

string

Phone3

Phone4

string

Phone4

PhoneExt

string

Phone Ext

PlaceOfBirth

string

Place Of Birth

PlaceOfIssueIdNumber

string

Place Of Issue Id Number

Province

string

Province

ProvinceLabel

string

Province Label

Religion

string

Religion

RewardPoints

numeric

Reward Points

SearchRank

numeric

Search Rank

Sex

numeric

Sex

ShortName

string

Short Name

SignatureSnapshot

string

Signature Snapshot

SignsOwn

string

Signs Own

SipDomain

string

Sip Domain

SipPassword

string

Sip Password

SipUser

string

Sip User

SkypeId

string

Skype Id

State

string

State

TaxCode

string

Tax Code

Title

string

Title

Type

string

Type

User

string

User

Ward

string

Ward

WardLabel

string

Ward Label

Website

string

Website

WorkingState

string

Working State

WorkingType

string

Working Type

WorkStatus

string

Work Status

WorkTel

string

Work Tel

YahooId

string

Yahoo Id

Zalo

string

Zalo

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/contacts/{Code}: for get exacly item

  • GET /v4/collaborator/contacts: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/contacts

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/contacts/{Code}: for put exacly item

  • PUT /v4/collaborator/contacts: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/contacts/{Code}: for delete exacly item

  • DELETE /v4/collaborator/contacts?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Sellers

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/sellers/{Id}: for get exacly item

  • GET /v4/collaborator/sellers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/sellers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/sellers/{Id}: for put exacly item

  • PUT /v4/collaborator/sellers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/sellers/{Id}: for delete exacly item

  • DELETE /v4/collaborator/sellers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator HumanResource Directors

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Role

string

Role

RoleName

string

Role Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/human-resource/directors/{Id}: for get exacly item

  • GET /v4/collaborator/human-resource/directors: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/human-resource/directors

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/human-resource/directors/{Id}: for put exacly item

  • PUT /v4/collaborator/human-resource/directors: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/human-resource/directors/{Id}: for delete exacly item

  • DELETE /v4/collaborator/human-resource/directors?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator HumanResource SubDirectors

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Role

string

Role

RoleName

string

Role Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/human-resource/subdirectors/{Id}: for get exacly item

  • GET /v4/collaborator/human-resource/subdirectors: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/human-resource/subdirectors

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/human-resource/subdirectors/{Id}: for put exacly item

  • PUT /v4/collaborator/human-resource/subdirectors: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/human-resource/subdirectors/{Id}: for delete exacly item

  • DELETE /v4/collaborator/human-resource/subdirectors?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator HumanResource SalesLeaders

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Role

string

Role

RoleName

string

Role Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/human-resource/sales-leaders/{Id}: for get exacly item

  • GET /v4/collaborator/human-resource/sales-leaders: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/human-resource/sales-leaders

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/human-resource/sales-leaders/{Id}: for put exacly item

  • PUT /v4/collaborator/human-resource/sales-leaders: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/human-resource/sales-leaders/{Id}: for delete exacly item

  • DELETE /v4/collaborator/human-resource/sales-leaders?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator HumanResource Sellers

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Role

string

Role

RoleName

string

Role Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/human-resource/sellers/{Id}: for get exacly item

  • GET /v4/collaborator/human-resource/sellers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/human-resource/sellers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/human-resource/sellers/{Id}: for put exacly item

  • PUT /v4/collaborator/human-resource/sellers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/human-resource/sellers/{Id}: for delete exacly item

  • DELETE /v4/collaborator/human-resource/sellers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator HumanResources

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Manager

string

Manager

ManagerName

string

Manager Name

Name

string

Name

Page

string

Page

Phone

string

Phone

Role

string

Role

RoleName

string

Role Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/human-resources/{Id}: for get exacly item

  • GET /v4/collaborator/human-resources: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/human-resources

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/human-resources/{Id}: for put exacly item

  • PUT /v4/collaborator/human-resources: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/human-resources/{Id}: for delete exacly item

  • DELETE /v4/collaborator/human-resources?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator SalesManagers

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Name

string

Name

Page

string

Page

Phone

string

Phone

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/sales-managers/{Id}: for get exacly item

  • GET /v4/collaborator/sales-managers: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/sales-managers

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/sales-managers/{Id}: for put exacly item

  • PUT /v4/collaborator/sales-managers: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/sales-managers/{Id}: for delete exacly item

  • DELETE /v4/collaborator/sales-managers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator PublisherSupporters

Primary Key: Id

Schema

Field
Type
Description

Address

string

Address

Assigned

string

Assigned

Avatar

string

Avatar

Contact

string

Contact

Email

string

Email

GlobalPhone

string

Global Phone

Id

numeric

Id

IdentifiedNumber

string

Identified Number

Name

string

Name

Page

string

Page

Phone

string

Phone

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/publisher-supporters/{Id}: for get exacly item

  • GET /v4/collaborator/publisher-supporters: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/publisher-supporters

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/publisher-supporters/{Id}: for put exacly item

  • PUT /v4/collaborator/publisher-supporters: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/publisher-supporters/{Id}: for delete exacly item

  • DELETE /v4/collaborator/publisher-supporters?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator CommisionsIncurred

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

ApprovedDate

string

Approved Date

ApprovedUser

string

Approved User

ApprovedUserName

string

Approved User Name

Code

string

Code

Created

string

Created

Creator

string

Creator

CreatorName

string

Creator Name

Id

numeric

Id

IsRequireInvoice

boolean

Is Require Invoice

IsVatInvoice

string

Is Vat Invoice

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectBank

string

Object Bank

ObjectBankAccount

string

Object Bank Account

ObjectBankName

string

Object Bank Name

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

Page

string

Page

Permission

string

Permission

Publisher

string

Publisher

PublisherAddress

string

Publisher Address

PublisherEmail

string

Publisher Email

PublisherName

string

Publisher Name

PublisherPhone

string

Publisher Phone

PublisherPlatform

string

Publisher Platform

PublisherRefId

string

Publisher Ref Id

ReferralContact

string

Referral Contact

ReferralContactAddress

string

Referral Contact Address

ReferralContactEmail

string

Referral Contact Email

ReferralContactName

string

Referral Contact Name

ReferralContactPhone

string

Referral Contact Phone

State

string

State

SubNote

string

Sub Note

SystemUuid

string

System Uuid

Thread

string

Thread

Title

string

Title

Total

double

Total

VoucherDate

datetime

Voucher Date

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/commissions-incurred/{Code}: for get exacly item

  • GET /v4/collaborator/commissions-incurred: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/commissions-incurred

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/commissions-incurred/{Code}: for put exacly item

  • PUT /v4/collaborator/commissions-incurred: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/commissions-incurred/{Code}: for delete exacly item

  • DELETE /v4/collaborator/commissions-incurred?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator StrategyCompileRules

Primary Key: Code

Schema

Field
Type
Description

CommissionRatio

double

Commission Ratio

Contact

string

Contact

ContactName

string

Contact Name

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Id

numeric

Id

IsAppliedForLevel1Monthly

numeric

Is Applied For Level1 Monthly

IsAppliedForLevel1Quarterly

numeric

Is Applied For Level1 Quarterly

IsAppliedForLevel1Weekly

numeric

Is Applied For Level1 Weekly

IsAppliedForLevel1Yearly

numeric

Is Applied For Level1 Yearly

Level1CommissionRatio

string

Level1 Commission Ratio

Level1MonthlyAwardRatio

string

Level1 Monthly Award Ratio

Level1MonthlyKpi

string

Level1 Monthly Kpi

Level1MonthlyLabel

string

Level1 Monthly Label

Level1MonthlyOkr

string

Level1 Monthly Okr

Level1QuarterlyAwardRatio

string

Level1 Quarterly Award Ratio

Level1QuarterlyKpi

string

Level1 Quarterly Kpi

Level1QuarterlyLabel

string

Level1 Quarterly Label

Level1QuarterlyOkr

string

Level1 Quarterly Okr

Level1WeeklyAwardRatio

string

Level1 Weekly Award Ratio

Level1WeeklyKpi

string

Level1 Weekly Kpi

Level1WeeklyOkr

string

Level1 Weekly Okr

Level1YearlyAwardRatio

string

Level1 Yearly Award Ratio

Level1YearlyKpi

string

Level1 Yearly Kpi

Level1YearlyLabel

string

Level1 Yearly Label

Level1YearlyOkr

string

Level1 Yearly Okr

Level2WeeklyLabel

string

Level2 Weekly Label

Page

string

Page

Product

string

Product

ProductName

string

Product Name

Sku

string

Sku

State

string

State

Strategy

string

Strategy

StrategyTitle

string

Strategy Title

StrategyType

string

Strategy Type

Unit

string

Unit

UnitLabel

string

Unit Label

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/strategy-compile-rules/{Code}: for get exacly item

  • GET /v4/collaborator/strategy-compile-rules: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/strategy-compile-rules

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/strategy-compile-rules/{Code}: for put exacly item

  • PUT /v4/collaborator/strategy-compile-rules: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/strategy-compile-rules/{Code}: for delete exacly item

  • DELETE /v4/collaborator/strategy-compile-rules?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales AwardVouchers

Primary Key: Code

Schema

Field
Type
Description

Approved

string

Approved

Approver

string

Approver

ApproverName

string

Approver Name

AwardContent

serialize

Award Content

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Id

numeric

Id

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Permission

string

Permission

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/awards/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/awards: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/awards

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/awards/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/awards: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/awards/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/awards?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales Groups

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/groups/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/groups: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/groups

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/groups/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/groups: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/groups/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/groups?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales Indicators

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/indicators/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/indicators: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/indicators

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/indicators/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/indicators: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/indicators/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/indicators?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales Statistics

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/statistics/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/statistics: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/statistics

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/statistics/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/statistics: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/statistics/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/statistics?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales Strategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

Description

string

Description

EmployeeGroups

objects

Employee Groups

Formular

string

Formular

HumanResourcesRole

string

Human Resources Role

Id

numeric

Id

LevelDistributedIndicator

string

Level Distributed Indicator

Name

string

Name

Parent

string

Parent

State

string

State

TargetForIndicator

double

Target For Indicator

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/strategies/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Sales DistributedContracts

Primary Key: Code

Schema

Field
Type
Description

Approved

string

Approved

Approver

string

Approver

ApproverName

string

Approver Name

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Id

numeric

Id

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Permission

string

Permission

State

string

State

Title

string

Title

DateOfApproved

datetime

Date Of Approved

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi/sales/distributed-contracts/{Code}: for get exacly item

  • GET /v4/collaborator/kpi/sales/distributed-contracts: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi/sales/distributed-contracts

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi/sales/distributed-contracts/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi/sales/distributed-contracts: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi/sales/distributed-contracts/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi/sales/distributed-contracts?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi AwardVouchers

Primary Key: Code

Schema

Field
Type
Description

Approved

string

Approved

Approver

string

Approver

ApproverName

string

Approver Name

AwardContent

serialize

Award Content

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Id

numeric

Id

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Permission

string

Permission

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-awards/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-awards: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-awards

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-awards/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-awards: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-awards/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-awards?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Groups

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-groups/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-groups: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-groups

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-groups/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-groups: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-groups/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-groups?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Indicators

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-indicators/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-indicators: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-indicators

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-indicators/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-indicators: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-indicators/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-indicators?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Statistics

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-statistics/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-statistics: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-statistics

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-statistics/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-statistics: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-statistics/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-statistics?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi Strategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

Description

string

Description

EmployeeGroups

objects

Employee Groups

Formular

string

Formular

Id

numeric

Id

LevelDistributedIndicator

string

Level Distributed Indicator

Name

string

Name

State

string

State

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Kpi DistributedContracts

Primary Key: Code

Schema

Field
Type
Description

Approved

string

Approved

Approver

string

Approver

ApproverName

string

Approver Name

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Id

numeric

Id

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Permission

string

Permission

State

string

State

Title

string

Title

DateOfApproved

datetime

Date Of Approved

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/kpi-distributed-contracts/{Code}: for get exacly item

  • GET /v4/collaborator/kpi-distributed-contracts: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/kpi-distributed-contracts

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/kpi-distributed-contracts/{Code}: for put exacly item

  • PUT /v4/collaborator/kpi-distributed-contracts: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/kpi-distributed-contracts/{Code}: for delete exacly item

  • DELETE /v4/collaborator/kpi-distributed-contracts?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator EmployeeGroups

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Description

string

Description

Id

numeric

Id

Name

string

Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/employee-groups/{Code}: for get exacly item

  • GET /v4/collaborator/employee-groups: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/employee-groups

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/employee-groups/{Code}: for put exacly item

  • PUT /v4/collaborator/employee-groups: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/employee-groups/{Code}: for delete exacly item

  • DELETE /v4/collaborator/employee-groups?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator BasicSaleCommissionConfigurations

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/basic-sale-commission-configurations/{Code}: for get exacly item

  • GET /v4/collaborator/basic-sale-commission-configurations: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/basic-sale-commission-configurations

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/basic-sale-commission-configurations/{Code}: for put exacly item

  • PUT /v4/collaborator/basic-sale-commission-configurations: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/basic-sale-commission-configurations/{Code}: for delete exacly item

  • DELETE /v4/collaborator/basic-sale-commission-configurations?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AdvancedSaleCommissionConfigurations

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/advanced-sale-commission-configurations/{Code}: for get exacly item

  • GET /v4/collaborator/advanced-sale-commission-configurations: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/advanced-sale-commission-configurations

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/advanced-sale-commission-configurations/{Code}: for put exacly item

  • PUT /v4/collaborator/advanced-sale-commission-configurations: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/advanced-sale-commission-configurations/{Code}: for delete exacly item

  • DELETE /v4/collaborator/advanced-sale-commission-configurations?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AddonSaleCommissionConfigurations

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/addon-sale-commission-configurations/{Code}: for get exacly item

  • GET /v4/collaborator/addon-sale-commission-configurations: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/addon-sale-commission-configurations

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/addon-sale-commission-configurations/{Code}: for put exacly item

  • PUT /v4/collaborator/addon-sale-commission-configurations: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/addon-sale-commission-configurations/{Code}: for delete exacly item

  • DELETE /v4/collaborator/addon-sale-commission-configurations?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator BasicPublisherCareCommissionConfigs

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/basic-publisher-care-commission-configs/{Code}: for get exacly item

  • GET /v4/collaborator/basic-publisher-care-commission-configs: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/basic-publisher-care-commission-configs

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/basic-publisher-care-commission-configs/{Code}: for put exacly item

  • PUT /v4/collaborator/basic-publisher-care-commission-configs: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/basic-publisher-care-commission-configs/{Code}: for delete exacly item

  • DELETE /v4/collaborator/basic-publisher-care-commission-configs?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AdvancedPublisherCareCommissionConfigs

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/advanced-publisher-care-commission-configs/{Code}: for get exacly item

  • GET /v4/collaborator/advanced-publisher-care-commission-configs: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/advanced-publisher-care-commission-configs

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/advanced-publisher-care-commission-configs/{Code}: for put exacly item

  • PUT /v4/collaborator/advanced-publisher-care-commission-configs: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/advanced-publisher-care-commission-configs/{Code}: for delete exacly item

  • DELETE /v4/collaborator/advanced-publisher-care-commission-configs?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator AddonPublisherCareCommissionConfigs

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

Cycle

string

Cycle

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/addon-publisher-care-commission-configs/{Code}: for get exacly item

  • GET /v4/collaborator/addon-publisher-care-commission-configs: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/addon-publisher-care-commission-configs

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/addon-publisher-care-commission-configs/{Code}: for put exacly item

  • PUT /v4/collaborator/addon-publisher-care-commission-configs: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/addon-publisher-care-commission-configs/{Code}: for delete exacly item

  • DELETE /v4/collaborator/addon-publisher-care-commission-configs?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Opportunities

Primary Key: Code

Schema

Field
Type
Description

AddOnCost

double

Add On Cost

AdvanceCost

double

Advance Cost

Amount

string

Amount

BasicCost

double

Basic Cost

Business

string

Business

Code

string

Code

Costs

indexobjects

Costs

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

Customer

string

Customer

CustomerAddress

string

Customer Address

CustomerCallcenterNumber

string

Customer Callcenter Number

CustomerEmail

string

Customer Email

CustomerName

string

Customer Name

CustomerPhone

string

Customer Phone

DateOfOpportunity

datetime

Date Of Opportunity

DeliveryAddress

string

Delivery Address

DeliveryCost

double

Delivery Cost

DeliveryDistrict

string

Delivery District

DeliveryDistrictLabel

string

Delivery District Label

DeliveryMapLink

string

Delivery Map Link

DeliveryProvince

string

Delivery Province

DeliveryProvinceLabel

string

Delivery Province Label

DeliveryWard

string

Delivery Ward

DeliveryWardLabel

string

Delivery Ward Label

DeploymentAddress

string

Deployment Address

DeploymentDistrict

string

Deployment District

DeploymentDistrictLabel

string

Deployment District Label

DeploymentMapLink

string

Deployment Map Link

DeploymentProvince

string

Deployment Province

DeploymentProvinceLabel

string

Deployment Province Label

DeploymentWard

string

Deployment Ward

DeploymentWardLabel

string

Deployment Ward Label

DirectReceiver

string

Direct Receiver

DirectReceiverEmail

string

Direct Receiver Email

DirectReceiverName

string

Direct Receiver Name

DirectReceiverPhone

string

Direct Receiver Phone

Id

numeric

Id

Note

string

Note

Originator

string

Originator

OriginatorName

string

Originator Name

Page

string

Page

Permission

string

Permission

Publisher

string

Publisher

PublisherEmail

string

Publisher Email

PublisherName

string

Publisher Name

PublisherPhone

string

Publisher Phone

PublisherRefId

string

Publisher Ref Id

PublisherSupporter

string

Publisher Supporter

PublisherSupporterEmail

string

Publisher Supporter Email

PublisherSupporterName

string

Publisher Supporter Name

PublisherSupporterPhone

string

Publisher Supporter Phone

SalesManager

string

Sales Manager

SalesManagerName

string

Sales Manager Name

Seller

string

Seller

SellerEmail

string

Seller Email

SellerName

string

Seller Name

SellerPhone

string

Seller Phone

Source

string

Source

SourceCode

string

Source Code

State

string

State

SubNote

string

Sub Note

Target

string

Target

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/opportunities/{Code}: for get exacly item

  • GET /v4/collaborator/opportunities: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/opportunities

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/opportunities/{Code}: for put exacly item

  • PUT /v4/collaborator/opportunities: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/opportunities/{Code}: for delete exacly item

  • DELETE /v4/collaborator/opportunities?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator OpportunityComments

Primary Key: Opportunity, SystemUuid

Schema

Field
Type
Description

Attachments

serialize

Attachments

Content

string

Content

DateOfPost

datetime

Date Of Post

Id

numeric

Id

Opportunity

string

Opportunity

Sender

string

Sender

SenderAvatar

serialize

Sender Avatar

SenderName

string

Sender Name

SystemUuid

string

System Uuid

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/opportunity-comments/{Opportunity}-{SystemUuid}: for get exacly item

  • GET /v4/collaborator/opportunity-comments: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/opportunity-comments

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/opportunity-comments/{Opportunity}-{SystemUuid}: for put exacly item

  • PUT /v4/collaborator/opportunity-comments: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/opportunity-comments/{Opportunity}-{SystemUuid}: for delete exacly item

  • DELETE /v4/collaborator/opportunity-comments?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator OpportunityCostStrategies

Primary Key: Code

Schema

Field
Type
Description

Code

string

Code

DateOfEnd

datetime

Date Of End

DateOfStart

datetime

Date Of Start

Description

string

Description

Id

numeric

Id

Page

string

Page

PageName

string

Page Name

Signature

string

Signature

State

string

State

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/opportunity-cost-strategies/{Code}: for get exacly item

  • GET /v4/collaborator/opportunity-cost-strategies: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/opportunity-cost-strategies

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/opportunity-cost-strategies/{Code}: for put exacly item

  • PUT /v4/collaborator/opportunity-cost-strategies: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/opportunity-cost-strategies/{Code}: for delete exacly item

  • DELETE /v4/collaborator/opportunity-cost-strategies?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator SalarySlips

Primary Key: Code

Schema

Field
Type
Description

Amount

string

Amount

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfVoucher

datetime

Date Of Voucher

Id

numeric

Id

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectIdentifiedNumber

string

Object Identified Number

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

ObjectTaxCode

string

Object Tax Code

Page

string

Page

Permission

string

Permission

PublisherRefId

string

Publisher Ref Id

State

string

State

StateLabel

string

State Label

SubNote

string

Sub Note

Thread

string

Thread

Title

string

Title

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/salary-slips/{Code}: for get exacly item

  • GET /v4/collaborator/salary-slips: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/salary-slips

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/salary-slips/{Code}: for put exacly item

  • PUT /v4/collaborator/salary-slips: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/salary-slips/{Code}: for delete exacly item

  • DELETE /v4/collaborator/salary-slips?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Report Salaries

Primary Key: Code

Schema

Field
Type
Description

Amount

double

Amount

Branch

string

Branch

Code

string

Code

Created

datetime

Created

Creator

string

Creator

CreatorName

string

Creator Name

DateOfBegin

datetime

Date Of Begin

DateOfEnd

datetime

Date Of End

DateOfReport

datetime

Date Of Report

Id

numeric

Id

IsComplete

boolean

Is Complete

MainReportPart

string

Main Report Part

Note

string

Note

Object

string

Object

ObjectAddress

string

Object Address

ObjectEmail

string

Object Email

ObjectName

string

Object Name

ObjectPhone

string

Object Phone

Page

string

Page

Permission

string

Permission

ReportData

string

Report Data

ReportList

string

Report List

State

string

State

StateLabel

string

State Label

SubNote

string

Sub Note

Title

string

Title

Type

string

Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/report-salaries/{Code}: for get exacly item

  • GET /v4/collaborator/report-salaries: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/report-salaries

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/report-salaries/{Code}: for put exacly item

  • PUT /v4/collaborator/report-salaries: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/report-salaries/{Code}: for delete exacly item

  • DELETE /v4/collaborator/report-salaries?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) Collaborator Webhooks

Primary Key: Code

Schema

Field
Type
Description

Description

string

Description

ExtendData

string

Extend Data

Feature

string

Feature

Id

numeric

Id

InputType

string

Input Type

IsApplied

numeric

Is Applied

IsPublic

numeric

Is Public

Module

string

Module

Name

string

Name

Type

string

Type

User

string

User

Value

string

Value

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

  • GET /v4/collaborator/webhooks/{Code}: for get exacly item

  • GET /v4/collaborator/webhooks: for get multiple items

Parameters:

  • token: authentication token (Type: string)

  • offset: get items from offset (Type: int)

  • limit: get number of items (Type: int)

  • id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

  • filter_<Field>: filter items by like value (Type: string)

  • left_<Field>: filter items by like left of value (Type: string)

  • right_<Field>: filter items by like right of value (Type: string)

  • eq_<Field>: filter items by equal value (Type: string)

  • ne_<Field>: filter items by not equal value (Type: string)

  • lt_<Field>: filter items by less than value (Type: string)

  • le_<Field>: filter items by less than or equal value (Type: string)

  • gt_<Field>: filter items by greater then value (Type: string)

  • ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/collaborator/webhooks

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

  • PUT /v4/collaborator/webhooks/{Code}: for put exacly item

  • PUT /v4/collaborator/webhooks: for put multiple items

Payload:

  • Content-Type: application/json

  • Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

  • DELETE /v4/collaborator/webhooks/{Code}: for delete exacly item

  • DELETE /v4/collaborator/webhooks?id0=123&id1=456&...: for delete multiple items with id0 id1,...