POST api/Activity/Crm

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
activity
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Id": 1,
  "SaveId": "sample string 2",
  "TenantId": "sample string 3",
  "UserId": "sample string 4",
  "DocumentId": "sample string 5",
  "DocumentType": "sample string 6",
  "DocumentDate": "sample string 7",
  "DocumentDueDate": "sample string 8",
  "DocumentNumber": "sample string 9",
  "DocumentAmount": "sample string 10",
  "Taxamount": "sample string 11",
  "PreTaxamount": "sample string 12",
  "DocumentSettledAmount": "sample string 13",
  "DocumentCurrency": "sample string 14",
  "DocumentIncoTerms": "sample string 15",
  "DocumentCountry": "sample string 16",
  "DocumentStatus": "sample string 17",
  "CreatedTimeStamp": "sample string 18",
  "UpdatedTimeStamp": "sample string 19",
  "SaleSaveId": "sample string 20",
  "SaleNumber": "sample string 21",
  "XeroInvoiceId": "sample string 22",
  "FreeAgentInvoiceId": "sample string 23",
  "ContactSaveId": "sample string 24",
  "ContactName": "sample string 25",
  "ContactType": "sample string 26",
  "TradingType": "sample string 27",
  "ContactTypeInDocument": "sample string 28",
  "SignatureName": "sample string 29",
  "ContactId": "43201e55-61ed-4881-95fd-e3defa031b56",
  "Contact": {
    "$id": "2",
    "SaveId": "9bf1fec2-0737-4160-b066-6bf1ead02e44",
    "TenantId": "sample string 2",
    "EdgeTenantId": "sample string 3",
    "EdgeCompanyName": "sample string 4",
    "ContactSignature": "sample string 5",
    "UserId": "sample string 6",
    "ContactSource": "sample string 7",
    "UserName": "sample string 8",
    "Status": "sample string 9",
    "PreferredTradeCurrency": "sample string 10",
    "MaxCreditLimit": 11.1,
    "CreditCurrency": "sample string 12",
    "DueTimeTill": 13,
    "KnownSince": "2026-03-21T21:08:53.3971863+00:00",
    "LastActivity": "2026-03-21T21:08:53.3971863+00:00",
    "XeroShortCode": "sample string 14",
    "Image": "sample string 15",
    "Categories": "sample string 16",
    "CreditRating": "sample string 17",
    "Grade": "sample string 18",
    "Phone": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "Id": 1,
          "PhoneNo": "sample string 2",
          "PhoneExt": "sample string 3",
          "PhoneType": "sample string 4",
          "ContactId": "6f2b9cfb-38d1-4da0-8761-bfc7f6573447",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "SocialChannel": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "Id": 1,
          "ContactChannel": "sample string 2",
          "ChannelType": "sample string 3",
          "ContactId": "a932ee65-c286-4781-ac0c-977213e88fdc",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "Website": {
      "$id": "7",
      "$values": [
        {
          "$id": "8",
          "Id": 1,
          "WebName": "sample string 2",
          "WebType": "sample string 3",
          "ContactId": "537ef52d-118d-4cca-b5b9-fbeb778568c8",
          "IsDeleted": true,
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "Email": {
      "$id": "9",
      "$values": [
        {
          "$id": "10",
          "Id": 1,
          "ContactEmail": "sample string 2",
          "EmailType": "sample string 3",
          "ContactId": "f9b61659-aca6-414b-a691-81d3f1cf3f1a",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "10"
        },
        {
          "$ref": "10"
        }
      ]
    },
    "Note": {
      "$id": "11",
      "$values": [
        {
          "$id": "12",
          "Id": 1,
          "UserId": "sample string 2",
          "Activity": "sample string 3",
          "Detail": "sample string 4",
          "CreatdTimestamp": "2026-03-21T21:08:53.3971863+00:00",
          "UserName": "sample string 6",
          "Message": "sample string 7",
          "ContactId": "6279704f-94d4-46ff-9ed7-bed16341e6e8",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "12"
        },
        {
          "$ref": "12"
        }
      ]
    },
    "Address": {
      "$id": "13",
      "$values": [
        {
          "$id": "14",
          "AddressId": 1,
          "CountryName": "sample string 2",
          "AddressType": "sample string 3",
          "AddressLine1": "sample string 4",
          "AddressLine2": "sample string 5",
          "TownLocality": "sample string 6",
          "CityRegion": "sample string 7",
          "PostalZipCode": "sample string 8",
          "State": "sample string 9",
          "INState": "sample string 10",
          "MXState": "sample string 11",
          "BRState": "sample string 12",
          "CAState": "sample string 13",
          "SiteName": "sample string 14",
          "IsMain": true,
          "ContactId": "8d44d841-92e7-4d6c-ba57-e5dd5a3dc1a7",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "Carrier": {
      "$id": "15",
      "$values": [
        {
          "$id": "16",
          "CarrierId": 1,
          "LogisticCompany": "sample string 2",
          "AccountNumber": "sample string 3",
          "TaxNumber": "sample string 4",
          "TaxType": "sample string 5",
          "IsMain": true,
          "ContactId": "771bf8f8-b055-4135-b509-175451678468",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "16"
        },
        {
          "$ref": "16"
        }
      ]
    },
    "BankDetail": {
      "$id": "17",
      "AccountId": "589f0e12-c4ae-4e06-9771-a0b1c9021280",
      "AccountName": "sample string 2",
      "AccountNo": "sample string 3",
      "SortCode": "sample string 4",
      "BankIBAN": "sample string 5",
      "BankSwift": "sample string 6",
      "Contact": {
        "$ref": "2"
      }
    },
    "ControlsLicence": {
      "$id": "18",
      "ControlsLicenceId": "ef9c11bd-0093-4e45-b2dd-3e034baf8de8",
      "IsLicence": true,
      "LicenceNo": "sample string 3",
      "LicenceExpiryDate": "sample string 4",
      "Contact": {
        "$ref": "2"
      },
      "IsDeleted": true
    },
    "FinancialArrangement": {
      "$id": "19",
      "FinancialId": "fc62cfcd-22d9-47d3-9b60-83995dd360d8",
      "PaymentTerm": "sample string 2",
      "PaymentTermValue": "sample string 3",
      "PaymentMethod": "sample string 4",
      "PaymentMethodValue": "sample string 5",
      "Discount": 6.1,
      "Commission": 7.1,
      "BankAccountName": "sample string 8",
      "BankAccountNumber": "sample string 9",
      "BankSortCode": "sample string 10",
      "SaleTaxRegistration": "sample string 11",
      "SaleTax": "sample string 12",
      "CompanyRegistrationNumber": "sample string 13",
      "CustomerAccNo": "sample string 14",
      "EoriNumber": "sample string 15",
      "Contact": {
        "$ref": "2"
      }
    },
    "Supplier": {
      "$id": "20",
      "Id": "29c02974-2e90-4a80-9acc-17ba594a7940",
      "AccountNo": "sample string 2",
      "SupplierId": "sample string 3",
      "NormalLeadTime": 4.0,
      "ActualLeadTime": 5.0,
      "OrderQuantity": 6.0,
      "OrderValue": 7.0,
      "CallOff": 8.0,
      "IsSupplier": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Logistic": {
      "$id": "21",
      "Id": "e111aa71-bf3f-42ba-b3e2-f5c5a4713231",
      "EmailForQuote": "sample string 2",
      "IsLogisticQuote": true,
      "IsLogisticFirm": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Category": {
      "$id": "22",
      "CategoryId": "c067a914-1089-4c78-8786-4ff7e2c8fc8f",
      "IsAgent": true,
      "IsConsultant": true,
      "IsCustomer": true,
      "IsDistributor": true,
      "IsFinancer": true,
      "IsFreightForwarder": true,
      "IsInsurer": true,
      "IsReferrer": true,
      "IsManufacturer": true,
      "IsFriend": true,
      "IsProcessor": true,
      "IsStaff": true,
      "IsOther": true,
      "IsConsignor": true,
      "IsSupplier": true,
      "IsInstaller": true,
      "IsDriver": true,
      "IsSubContractor": true,
      "Miscellaneous": "sample string 20",
      "IsRetailer": true,
      "IsSeller": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "ContactFiles": {
      "$id": "23",
      "$values": [
        {
          "$id": "24",
          "ContactFileId": "12a44fc3-8523-4605-a5a1-33d6ef29ff24",
          "ContactSaveId": "d2fe2049-5e51-49ec-bf2e-069e68429892",
          "SpecificationType": "sample string 3",
          "FileName": "sample string 4",
          "DocType": "sample string 5",
          "WhenAttached": "sample string 6",
          "ValidTillDateTime": "sample string 7",
          "NoOfPages": "sample string 8",
          "FileData": "sample string 9",
          "FilePath": "sample string 10",
          "Comments": "sample string 11",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "24"
        },
        {
          "$ref": "24"
        }
      ]
    },
    "ContactMethod": {
      "$id": "25",
      "ContactMethodId": "3c66d9ac-9514-4cf3-b5c7-3597fc9bfb15",
      "LinkedIn": "sample string 2",
      "Twitter": "sample string 3",
      "FaceBook": "sample string 4",
      "IM": {
        "$id": "26",
        "$values": [
          {
            "$id": "27",
            "Id": 1,
            "Message": "sample string 2",
            "IMType": "sample string 3",
            "ContactMethodId": "71ceb3ac-0681-4f24-8d5e-fb4f804238ca",
            "ContactMethod": {
              "$ref": "25"
            },
            "IsDeleted": true
          },
          {
            "$ref": "27"
          },
          {
            "$ref": "27"
          }
        ]
      },
      "Contact": {
        "$ref": "2"
      }
    },
    "BuyingCriteria": {
      "$id": "28",
      "CriteriaId": "b5e42a82-028d-4d71-98ac-4e42a941c099",
      "AuthoriseToBuy": "sample string 2",
      "Period": "sample string 3",
      "Method": "sample string 4",
      "Power": "sample string 5",
      "Expectation": "sample string 6",
      "Need": "sample string 7",
      "Contact": {
        "$ref": "2"
      }
    },
    "SaleApproach": {
      "$id": "29",
      "Id": "cc541f49-5f28-4154-a0a5-1624d724bf7c",
      "GiveDiscounts": "sample string 2",
      "ContactEvery": "sample string 3",
      "EmailMarketing": "sample string 4",
      "CurrentSupplier": "sample string 5",
      "Competitor": "sample string 6",
      "Competitors": {
        "$id": "30",
        "$values": [
          {
            "$id": "31",
            "Id": 1,
            "CompetitorName": "sample string 2",
            "SaleId": "f5e0f3a7-8633-46a3-979f-a44299718ea3",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "31"
          },
          {
            "$ref": "31"
          }
        ]
      },
      "Suppliers": {
        "$id": "32",
        "$values": [
          {
            "$id": "33",
            "Id": 1,
            "SupplierName": "sample string 2",
            "SaleId": "f196d437-e670-4ca3-a447-cef21738465b",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "33"
          },
          {
            "$ref": "33"
          }
        ]
      },
      "OurRelationship": "sample string 7",
      "RelationshipMgr": "sample string 8",
      "Contact": {
        "$ref": "2"
      }
    },
    "AppendNotes": {
      "$id": "34",
      "$values": [
        {
          "$id": "35",
          "AppendNoteId": 1,
          "CreatedDate": "2026-03-21T21:08:53.4128162+00:00",
          "CreatedBy": "sample string 3",
          "ActivityNote": "sample string 4",
          "AppendNote": "sample string 5",
          "Subject": "sample string 6",
          "ContactName": "sample string 7",
          "ContactMethod": "sample string 8",
          "Location": "sample string 9",
          "ChildAppendNotes": "sample string 10",
          "ContactId": "ce726c95-26f7-4d25-91ee-be73ff21816e",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "35"
        },
        {
          "$ref": "35"
        }
      ]
    },
    "Event": {
      "$id": "36",
      "$values": [
        {
          "$id": "37",
          "EventId": 1,
          "Subject": "sample string 2",
          "EventType": "sample string 3",
          "AssignTo": "sample string 4",
          "StartDate": "2026-03-21T21:08:53.4128162+00:00",
          "EndDate": "2026-03-21T21:08:53.4128162+00:00",
          "IsAllDayEvent": "sample string 7",
          "ContactName": "sample string 8",
          "ContactEmail": "sample string 9",
          "ContactMethod": "sample string 10",
          "Location": "sample string 11",
          "Status": "sample string 12",
          "IsCalendarEvent": "sample string 13",
          "Note": "sample string 14",
          "SenderComapny": "sample string 15",
          "SenderEmail": "sample string 16",
          "MainEventId": 17,
          "ContactId": "1e714974-69c9-4d1b-b416-a7cefec83914",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "37"
        },
        {
          "$ref": "37"
        }
      ]
    },
    "CreatedTimestamp": "2026-03-21T21:08:53.4128162+00:00",
    "IsClient": true,
    "RpsStatus": "sample string 21",
    "RpsUpdatedDate": "2026-03-21T21:08:53.4128162+00:00",
    "PersonalInformation": {
      "$id": "38",
      "PersonalId": "3bc2aecf-3fa4-46c4-ad1a-f6a7d73ebdf1",
      "Gender": "sample string 1",
      "DateOfBirth": "2026-03-21T21:08:53.4128162+00:00",
      "NotifyBirthday": "sample string 2",
      "Occupation": "sample string 3",
      "MaritalStatus": "sample string 4",
      "PersonalStatus": "sample string 5",
      "Interests": "sample string 6",
      "NationalInsuranceNo": "sample string 7",
      "Contact": {
        "$ref": "2"
      }
    },
    "MinExpiryDays": 22,
    "CountryList": {
      "$id": "39",
      "$values": [
        {
          "$id": "40",
          "Id": 1,
          "CountryCode": "sample string 2",
          "Name": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "$ref": "40"
        },
        {
          "$ref": "40"
        }
      ]
    },
    "XeroId": "2277a05f-7645-4bf1-a1d1-825b3a7772da",
    "OwingAmount": 24.1,
    "OwingCcy": "sample string 25",
    "FreeAgentId": "sample string 26",
    "QuickBookId": "sample string 27",
    "QuickBookSupplierId": "sample string 28",
    "SageOneId": "sample string 29",
    "ShopifyId": "sample string 30",
    "BigCommerceId": "sample string 31",
    "FaireId": "sample string 32",
    "WooCommerceId": "sample string 33",
    "UpdatedDateTimeStamp": "2026-03-21T21:08:53.4128162+00:00",
    "OrganisationId": "sample string 35",
    "Main": true,
    "WBSBookingId": "0dd5166b-4c48-4681-a049-842090b3945b",
    "WBSFirmSaveId": "9116a319-6ca1-4212-8983-6f88eb532f7e",
    "WBSDriverSaveId": "4bd48784-e38e-4d42-8524-f45035e378e3",
    "WBSUserId": "0efc9dae-8539-4556-9af3-3e03856cb635",
    "WBSUserSaveId": "d212f97d-c8cc-40ed-8af2-b2b67fe26deb"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Activity'.