POST Collection/Collection_Insert

Request Information

URI Parameters

None.

Body Parameters

Collectors
NameDescriptionTypeAdditional information
CollectionId

integer

None.

UserID

integer

None.

FromDate

date

None.

ToDate

date

None.

Target

decimal number

None.

TargetType

integer

None.

Commission

decimal number

None.

CommissionType

integer

None.

CompanyId

integer

None.

BranchId

integer

None.

User

Collection of User

None.

CreatedBy

integer

None.

CreatedAt

date

None.

ModifyBy

integer

None.

ModifyAt

date

None.

Request Formats

application/json, text/json

Sample:
{
  "CollectionId": 1,
  "UserID": 2,
  "FromDate": "2025-10-29T05:45:23.6456297+03:00",
  "ToDate": "2025-10-29T05:45:23.6456297+03:00",
  "Target": 5.0,
  "TargetType": 6,
  "Commission": 7.0,
  "CommissionType": 8,
  "CompanyId": 9,
  "BranchId": 10,
  "User": [
    {
      "UserID": 1,
      "CompanyId": 2,
      "CompanyBranchId": 3,
      "Username": "sample string 4",
      "OldPassword": "sample string 5",
      "NewPassword": "sample string 6",
      "FirstName": "sample string 7",
      "MidName": "sample string 8",
      "LastName": "sample string 9",
      "Email": "sample string 10",
      "Address": "sample string 11",
      "PhoneNo": "sample string 12",
      "UserPermission": "sample string 13",
      "IsPasswordReset": true,
      "GroupOfUserID": 15,
      "IsActive": true,
      "DateOfBirth": "2025-10-29T05:45:23.6456297+03:00",
      "DepartmentId": 17,
      "JobTitle": "sample string 18",
      "Gender": 19,
      "ProfilePicture": "sample string 20",
      "JobDescription": "sample string 21",
      "ConfirmPassword": "sample string 22",
      "PasswordLastModifyDate": "2025-10-29T05:45:23.6456297+03:00",
      "ColGroupsOfPermission": [
        {
          "GroupID": 1,
          "GroupName": "sample string 2",
          "GroupPermission": "sample string 3"
        },
        {
          "GroupID": 1,
          "GroupName": "sample string 2",
          "GroupPermission": "sample string 3"
        }
      ],
      "ColDepartment": [
        {
          "Id": 1,
          "DepartmentPrimaryName": "sample string 2",
          "DepartmentSecondaryName": "sample string 3"
        },
        {
          "Id": 1,
          "DepartmentPrimaryName": "sample string 2",
          "DepartmentSecondaryName": "sample string 3"
        }
      ],
      "RefDepartment": {
        "Id": 1,
        "DepartmentPrimaryName": "sample string 2",
        "DepartmentSecondaryName": "sample string 3"
      },
      "Name": "sample string 24",
      "Type": 25,
      "BPassword": "QEA=",
      "Salt": "sample string 26",
      "Role_Id": 27,
      "UserGroupId": 28,
      "OperatorId": 29,
      "AccountId": 1,
      "KeyId": "sample string 30"
    },
    {
      "UserID": 1,
      "CompanyId": 2,
      "CompanyBranchId": 3,
      "Username": "sample string 4",
      "OldPassword": "sample string 5",
      "NewPassword": "sample string 6",
      "FirstName": "sample string 7",
      "MidName": "sample string 8",
      "LastName": "sample string 9",
      "Email": "sample string 10",
      "Address": "sample string 11",
      "PhoneNo": "sample string 12",
      "UserPermission": "sample string 13",
      "IsPasswordReset": true,
      "GroupOfUserID": 15,
      "IsActive": true,
      "DateOfBirth": "2025-10-29T05:45:23.6456297+03:00",
      "DepartmentId": 17,
      "JobTitle": "sample string 18",
      "Gender": 19,
      "ProfilePicture": "sample string 20",
      "JobDescription": "sample string 21",
      "ConfirmPassword": "sample string 22",
      "PasswordLastModifyDate": "2025-10-29T05:45:23.6456297+03:00",
      "ColGroupsOfPermission": [
        {
          "GroupID": 1,
          "GroupName": "sample string 2",
          "GroupPermission": "sample string 3"
        },
        {
          "GroupID": 1,
          "GroupName": "sample string 2",
          "GroupPermission": "sample string 3"
        }
      ],
      "ColDepartment": [
        {
          "Id": 1,
          "DepartmentPrimaryName": "sample string 2",
          "DepartmentSecondaryName": "sample string 3"
        },
        {
          "Id": 1,
          "DepartmentPrimaryName": "sample string 2",
          "DepartmentSecondaryName": "sample string 3"
        }
      ],
      "RefDepartment": {
        "Id": 1,
        "DepartmentPrimaryName": "sample string 2",
        "DepartmentSecondaryName": "sample string 3"
      },
      "Name": "sample string 24",
      "Type": 25,
      "BPassword": "QEA=",
      "Salt": "sample string 26",
      "Role_Id": 27,
      "UserGroupId": 28,
      "OperatorId": 29,
      "AccountId": 1,
      "KeyId": "sample string 30"
    }
  ],
  "CreatedBy": 11,
  "CreatedAt": "2025-10-29T05:45:23.6476373+03:00",
  "ModifyBy": 13,
  "ModifyAt": "2025-10-29T05:45:23.6476373+03:00"
}

application/xml, text/xml

Sample:
<Collectors xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POCO">
  <BranchId>10</BranchId>
  <CollectionId>1</CollectionId>
  <Commission>7</Commission>
  <CommissionType>8</CommissionType>
  <CompanyId>9</CompanyId>
  <CreatedAt>2025-10-29T05:45:23.6476373+03:00</CreatedAt>
  <CreatedBy>11</CreatedBy>
  <FromDate>2025-10-29T05:45:23.6456297+03:00</FromDate>
  <ModifyAt>2025-10-29T05:45:23.6476373+03:00</ModifyAt>
  <ModifyBy>13</ModifyBy>
  <Target>5</Target>
  <TargetType>6</TargetType>
  <ToDate>2025-10-29T05:45:23.6456297+03:00</ToDate>
  <User>
    <User>
      <AccountId>1</AccountId>
      <Address>sample string 11</Address>
      <BPassword>QEA=</BPassword>
      <ColDepartment>
        <Department>
          <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
          <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
          <Id>1</Id>
        </Department>
        <Department>
          <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
          <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
          <Id>1</Id>
        </Department>
      </ColDepartment>
      <ColGroupsOfPermission>
        <GroupOfUserPermission>
          <GroupID>1</GroupID>
          <GroupName>sample string 2</GroupName>
          <GroupPermission>sample string 3</GroupPermission>
        </GroupOfUserPermission>
        <GroupOfUserPermission>
          <GroupID>1</GroupID>
          <GroupName>sample string 2</GroupName>
          <GroupPermission>sample string 3</GroupPermission>
        </GroupOfUserPermission>
      </ColGroupsOfPermission>
      <CompanyBranchId>3</CompanyBranchId>
      <CompanyId>2</CompanyId>
      <ConfirmPassword>sample string 22</ConfirmPassword>
      <DateOfBirth>2025-10-29T05:45:23.6456297+03:00</DateOfBirth>
      <DepartmentId>17</DepartmentId>
      <Email>sample string 10</Email>
      <FirstName>sample string 7</FirstName>
      <Gender>19</Gender>
      <GroupOfUserID>15</GroupOfUserID>
      <IsActive>true</IsActive>
      <IsPasswordReset>true</IsPasswordReset>
      <JobDescription>sample string 21</JobDescription>
      <JobTitle>sample string 18</JobTitle>
      <KeyId>sample string 30</KeyId>
      <LastName>sample string 9</LastName>
      <MidName>sample string 8</MidName>
      <Name>sample string 24</Name>
      <NewPassword>sample string 6</NewPassword>
      <OldPassword>sample string 5</OldPassword>
      <OperatorId>29</OperatorId>
      <PasswordLastModifyDate>2025-10-29T05:45:23.6456297+03:00</PasswordLastModifyDate>
      <PhoneNo>sample string 12</PhoneNo>
      <ProfilePicture>sample string 20</ProfilePicture>
      <RefDepartment>
        <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
        <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
        <Id>1</Id>
      </RefDepartment>
      <Role_Id>27</Role_Id>
      <Salt>sample string 26</Salt>
      <Type>25</Type>
      <UserGroupId>28</UserGroupId>
      <UserID>1</UserID>
      <UserPermission>sample string 13</UserPermission>
      <Username>sample string 4</Username>
    </User>
    <User>
      <AccountId>1</AccountId>
      <Address>sample string 11</Address>
      <BPassword>QEA=</BPassword>
      <ColDepartment>
        <Department>
          <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
          <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
          <Id>1</Id>
        </Department>
        <Department>
          <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
          <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
          <Id>1</Id>
        </Department>
      </ColDepartment>
      <ColGroupsOfPermission>
        <GroupOfUserPermission>
          <GroupID>1</GroupID>
          <GroupName>sample string 2</GroupName>
          <GroupPermission>sample string 3</GroupPermission>
        </GroupOfUserPermission>
        <GroupOfUserPermission>
          <GroupID>1</GroupID>
          <GroupName>sample string 2</GroupName>
          <GroupPermission>sample string 3</GroupPermission>
        </GroupOfUserPermission>
      </ColGroupsOfPermission>
      <CompanyBranchId>3</CompanyBranchId>
      <CompanyId>2</CompanyId>
      <ConfirmPassword>sample string 22</ConfirmPassword>
      <DateOfBirth>2025-10-29T05:45:23.6456297+03:00</DateOfBirth>
      <DepartmentId>17</DepartmentId>
      <Email>sample string 10</Email>
      <FirstName>sample string 7</FirstName>
      <Gender>19</Gender>
      <GroupOfUserID>15</GroupOfUserID>
      <IsActive>true</IsActive>
      <IsPasswordReset>true</IsPasswordReset>
      <JobDescription>sample string 21</JobDescription>
      <JobTitle>sample string 18</JobTitle>
      <KeyId>sample string 30</KeyId>
      <LastName>sample string 9</LastName>
      <MidName>sample string 8</MidName>
      <Name>sample string 24</Name>
      <NewPassword>sample string 6</NewPassword>
      <OldPassword>sample string 5</OldPassword>
      <OperatorId>29</OperatorId>
      <PasswordLastModifyDate>2025-10-29T05:45:23.6456297+03:00</PasswordLastModifyDate>
      <PhoneNo>sample string 12</PhoneNo>
      <ProfilePicture>sample string 20</ProfilePicture>
      <RefDepartment>
        <DepartmentPrimaryName>sample string 2</DepartmentPrimaryName>
        <DepartmentSecondaryName>sample string 3</DepartmentSecondaryName>
        <Id>1</Id>
      </RefDepartment>
      <Role_Id>27</Role_Id>
      <Salt>sample string 26</Salt>
      <Type>25</Type>
      <UserGroupId>28</UserGroupId>
      <UserID>1</UserID>
      <UserPermission>sample string 13</UserPermission>
      <Username>sample string 4</Username>
    </User>
  </User>
  <UserID>2</UserID>
</Collectors>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
ErrorCode

integer

None.

ErrorMessage

string

None.

IsScusses

boolean

None.

ResponseDetails

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "ErrorMessage": "sample string 2",
  "IsScusses": true,
  "ResponseDetails": {}
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accounting.API.Models">
  <ErrorCode>1</ErrorCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsScusses>true</IsScusses>
  <ResponseDetails />
</Response>