PATCH api/SyncDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserAssignId	integer	None.
OfflineDate	date	None.
BackupsRequestAmount	integer	None.
TransactionType	string	None.
TransactionStatus	string	None.
TransactionDetail	string	None.
DocEntry	integer	None.
DocNum	integer	None.
DocumentKey	string	None.
DocumentType	string	None.
RawDocument	string	None.
UserAssign	UserAssign	None.
Id	integer	None.
CreatedDate	date	None.
CreatedBy	string	None.
UpdateDate	date	None.
UpdatedBy	string	None.
IsActive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "UserAssignId": 1,
  "OfflineDate": "2025-09-12T16:03:29.0492938-06:00",
  "BackupsRequestAmount": 3,
  "TransactionType": "sample string 4",
  "TransactionStatus": "sample string 5",
  "TransactionDetail": "sample string 6",
  "DocEntry": 7,
  "DocNum": 8,
  "DocumentKey": "sample string 9",
  "DocumentType": "sample string 10",
  "RawDocument": "sample string 11",
  "UserAssign": {
    "CompanyId": 1,
    "UserId": 2,
    "LicenseId": 3,
    "User": {
      "UseScheduling": true,
      "EmailType": 2,
      "EmailPassword": "sample string 3",
      "SchedulingEmail": "sample string 4",
      "TokenRecovery": "sample string 5",
      "TokenRecoveryEndDate": "2025-09-12T16:03:29.0492938-06:00",
      "Name": "sample string 7",
      "LastName": "sample string 8",
      "Email": "sample string 9",
      "Password": "sample string 10",
      "Id": 11,
      "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
      "CreatedBy": "sample string 13",
      "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
      "UpdatedBy": "sample string 14",
      "IsActive": true
    },
    "Company": {
      "ConnectionId": 1,
      "Connection": {
        "Name": "sample string 1",
        "Odbctype": "sample string 2",
        "Server": "sample string 3",
        "User": "sample string 4",
        "Pass": "sample string 5",
        "ServerType": "sample string 6",
        "SLUrl": "sample string 7",
        "Id": 8,
        "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
        "CreatedBy": "sample string 10",
        "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
        "UpdatedBy": "sample string 11",
        "IsActive": true
      },
      "Name": "sample string 2",
      "DatabaseCode": "sample string 3",
      "Id": 4,
      "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
      "CreatedBy": "sample string 6",
      "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
      "UpdatedBy": "sample string 7",
      "IsActive": true
    },
    "License": {
      "CompanyId": 1,
      "Company": {
        "ConnectionId": 1,
        "Connection": {
          "Name": "sample string 1",
          "Odbctype": "sample string 2",
          "Server": "sample string 3",
          "User": "sample string 4",
          "Pass": "sample string 5",
          "ServerType": "sample string 6",
          "SLUrl": "sample string 7",
          "Id": 8,
          "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
          "CreatedBy": "sample string 10",
          "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
          "UpdatedBy": "sample string 11",
          "IsActive": true
        },
        "Name": "sample string 2",
        "DatabaseCode": "sample string 3",
        "Id": 4,
        "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
        "CreatedBy": "sample string 6",
        "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
        "UpdatedBy": "sample string 7",
        "IsActive": true
      },
      "User": "sample string 2",
      "Password": "sample string 3",
      "Id": 4,
      "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
      "CreatedBy": "sample string 6",
      "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
      "UpdatedBy": "sample string 7",
      "IsActive": true
    },
    "SlpCode": "sample string 4",
    "CenterCost": "sample string 5",
    "WhsCode": "sample string 6",
    "Discount": 7.1,
    "Id": 8,
    "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
    "CreatedBy": "sample string 10",
    "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
    "UpdatedBy": "sample string 11",
    "IsActive": true
  },
  "Id": 12,
  "CreatedDate": "2025-09-12T16:03:29.0492938-06:00",
  "CreatedBy": "sample string 14",
  "UpdateDate": "2025-09-12T16:03:29.0492938-06:00",
  "UpdatedBy": "sample string 15",
  "IsActive": true
}

application/xml, text/xml

Sample:

<SyncDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 14</CreatedBy>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">12</Id>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
  <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 15</UpdatedBy>
  <BackupsRequestAmount>3</BackupsRequestAmount>
  <DocEntry>7</DocEntry>
  <DocNum>8</DocNum>
  <DocumentKey>sample string 9</DocumentKey>
  <DocumentType>sample string 10</DocumentType>
  <OfflineDate>2025-09-12T16:03:29.0492938-06:00</OfflineDate>
  <RawDocument>sample string 11</RawDocument>
  <TransactionDetail>sample string 6</TransactionDetail>
  <TransactionStatus>sample string 5</TransactionStatus>
  <TransactionType>sample string 4</TransactionType>
  <UserAssign>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
    <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
    <CenterCost xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</CenterCost>
    <Discount xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">7.1</Discount>
    <SlpCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</SlpCode>
    <WhsCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</WhsCode>
    <Company>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
      <DatabaseCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</DatabaseCode>
      <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Name>
      <Connection>
        <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
        <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
        <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
        <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
        <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
        <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
        <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 1</Name>
        <Odbctype xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Odbctype>
        <Pass xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</Pass>
        <SLUrl xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</SLUrl>
        <Server xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Server>
        <ServerType xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</ServerType>
        <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</User>
      </Connection>
      <ConnectionId>1</ConnectionId>
    </Company>
    <CompanyId>1</CompanyId>
    <License>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
      <Password xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Password>
      <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</User>
      <Company>
        <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
        <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
        <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
        <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
        <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
        <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
        <DatabaseCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</DatabaseCode>
        <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Name>
        <Connection>
          <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
          <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
          <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
          <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
          <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
          <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
          <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 1</Name>
          <Odbctype xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Odbctype>
          <Pass xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</Pass>
          <SLUrl xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</SLUrl>
          <Server xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Server>
          <ServerType xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</ServerType>
          <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</User>
        </Connection>
        <ConnectionId>1</ConnectionId>
      </Company>
      <CompanyId>1</CompanyId>
    </License>
    <LicenseId>3</LicenseId>
    <User>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 13</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">11</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-09-12T16:03:29.0492938-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 14</UpdatedBy>
      <Email xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 9</Email>
      <LastName xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 8</LastName>
      <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</Name>
      <Password xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 10</Password>
      <EmailPassword>sample string 3</EmailPassword>
      <EmailType>2</EmailType>
      <SchedulingEmail>sample string 4</SchedulingEmail>
      <TokenRecovery>sample string 5</TokenRecovery>
      <TokenRecoveryEndDate>2025-09-12T16:03:29.0492938-06:00</TokenRecoveryEndDate>
      <UseScheduling>true</UseScheduling>
    </User>
    <UserId>2</UserId>
  </UserAssign>
  <UserAssignId>1</UserAssignId>
</SyncDocument>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.