Help Page Home

POST api/legal-persons

Request Information

URI Parameters

None.

Body Parameters

LegalPersonModel
NameDescriptionTypeAdditional information
Id

integer

None.
BusinessLine

BusinessLineModel

None.
HeadOffice

LegalPersonModel

None.
CompanyFancyName

string

None.
CompanyName

string

None.
CNPJ

string

None.
WebSite

string

None.
Branch

boolean

None.
CorporateEmail

string

None.
PhoneNumbers

string

None.
Comments

string

None.
Phones

Collection of PhoneModel

None.
Addresses

Collection of AddressModel

None.
Branches

Collection of LegalPersonModel

None.
History

Collection of ContactHistoryModel

None.
AuthorId

integer

None.
Author

string

None.
Created

date

None.
EditorId

integer

None.
Editor

string

None.
Modified

date

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "BusinessLine": {
    "Id": 1,
    "Description": "sample string 2",
    "AuthorId": 3,
    "Author": "sample string 4",
    "Created": "2026-03-09T17:07:07.1465543-03:00",
    "EditorId": 5,
    "Editor": "sample string 6",
    "Modified": "2026-03-09T17:07:07.1465543-03:00"
  },
  "CompanyFancyName": "sample string 2",
  "CompanyName": "sample string 3",
  "CNPJ": "sample string 4",
  "WebSite": "sample string 5",
  "Branch": true,
  "CorporateEmail": "sample string 7",
  "PhoneNumbers": "sample string 8",
  "Comments": "sample string 9",
  "Phones": [
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Description": "sample string 2",
        "LegalPerson": true,
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "City": {
        "Id": 1,
        "Name": "sample string 2",
        "State": {
          "Id": 1,
          "Name": "sample string 2",
          "Country": {
            "Id": 1,
            "Name": "sample string 2",
            "AuthorId": 3,
            "Author": "sample string 4",
            "Created": "2026-03-09T17:07:07.1465543-03:00",
            "EditorId": 5,
            "Editor": "sample string 6",
            "Modified": "2026-03-09T17:07:07.1465543-03:00"
          },
          "AuthorId": 3,
          "Author": "sample string 4",
          "Created": "2026-03-09T17:07:07.1465543-03:00",
          "EditorId": 5,
          "Editor": "sample string 6",
          "Modified": "2026-03-09T17:07:07.1465543-03:00"
        },
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "Number": "sample string 2",
      "Interlocutor": "sample string 3",
      "Note": "sample string 4",
      "Primary": true,
      "Extension": 1,
      "Order": 1,
      "Status": 0,
      "AuthorId": 6,
      "Author": "sample string 7",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 8,
      "Editor": "sample string 9",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    },
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Description": "sample string 2",
        "LegalPerson": true,
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "City": {
        "Id": 1,
        "Name": "sample string 2",
        "State": {
          "Id": 1,
          "Name": "sample string 2",
          "Country": {
            "Id": 1,
            "Name": "sample string 2",
            "AuthorId": 3,
            "Author": "sample string 4",
            "Created": "2026-03-09T17:07:07.1465543-03:00",
            "EditorId": 5,
            "Editor": "sample string 6",
            "Modified": "2026-03-09T17:07:07.1465543-03:00"
          },
          "AuthorId": 3,
          "Author": "sample string 4",
          "Created": "2026-03-09T17:07:07.1465543-03:00",
          "EditorId": 5,
          "Editor": "sample string 6",
          "Modified": "2026-03-09T17:07:07.1465543-03:00"
        },
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "Number": "sample string 2",
      "Interlocutor": "sample string 3",
      "Note": "sample string 4",
      "Primary": true,
      "Extension": 1,
      "Order": 1,
      "Status": 0,
      "AuthorId": 6,
      "Author": "sample string 7",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 8,
      "Editor": "sample string 9",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    }
  ],
  "Addresses": [
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Description": "sample string 2",
        "LegalPerson": true,
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "City": {
        "Id": 1,
        "Name": "sample string 2",
        "State": {
          "Id": 1,
          "Name": "sample string 2",
          "Country": {
            "Id": 1,
            "Name": "sample string 2",
            "AuthorId": 3,
            "Author": "sample string 4",
            "Created": "2026-03-09T17:07:07.1465543-03:00",
            "EditorId": 5,
            "Editor": "sample string 6",
            "Modified": "2026-03-09T17:07:07.1465543-03:00"
          },
          "AuthorId": 3,
          "Author": "sample string 4",
          "Created": "2026-03-09T17:07:07.1465543-03:00",
          "EditorId": 5,
          "Editor": "sample string 6",
          "Modified": "2026-03-09T17:07:07.1465543-03:00"
        },
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "Address": "sample string 2",
      "AddressComplement": "sample string 3",
      "District": "sample string 4",
      "ZipCode": "sample string 5",
      "OpeningHours": "2026-03-09T17:07:07.1465543-03:00",
      "ClosingHours": "2026-03-09T17:07:07.1465543-03:00",
      "ServiceDays": [
        1,
        2
      ],
      "Primary": true,
      "Order": 1,
      "Country": "sample string 7",
      "Note": "sample string 8",
      "Status": 0,
      "AuthorId": 9,
      "Author": "sample string 10",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 11,
      "Editor": "sample string 12",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    },
    {
      "Id": 1,
      "Type": {
        "Id": 1,
        "Description": "sample string 2",
        "LegalPerson": true,
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "City": {
        "Id": 1,
        "Name": "sample string 2",
        "State": {
          "Id": 1,
          "Name": "sample string 2",
          "Country": {
            "Id": 1,
            "Name": "sample string 2",
            "AuthorId": 3,
            "Author": "sample string 4",
            "Created": "2026-03-09T17:07:07.1465543-03:00",
            "EditorId": 5,
            "Editor": "sample string 6",
            "Modified": "2026-03-09T17:07:07.1465543-03:00"
          },
          "AuthorId": 3,
          "Author": "sample string 4",
          "Created": "2026-03-09T17:07:07.1465543-03:00",
          "EditorId": 5,
          "Editor": "sample string 6",
          "Modified": "2026-03-09T17:07:07.1465543-03:00"
        },
        "AuthorId": 3,
        "Author": "sample string 4",
        "Created": "2026-03-09T17:07:07.1465543-03:00",
        "EditorId": 5,
        "Editor": "sample string 6",
        "Modified": "2026-03-09T17:07:07.1465543-03:00"
      },
      "Address": "sample string 2",
      "AddressComplement": "sample string 3",
      "District": "sample string 4",
      "ZipCode": "sample string 5",
      "OpeningHours": "2026-03-09T17:07:07.1465543-03:00",
      "ClosingHours": "2026-03-09T17:07:07.1465543-03:00",
      "ServiceDays": [
        1,
        2
      ],
      "Primary": true,
      "Order": 1,
      "Country": "sample string 7",
      "Note": "sample string 8",
      "Status": 0,
      "AuthorId": 9,
      "Author": "sample string 10",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 11,
      "Editor": "sample string 12",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    }
  ],
  "Branches": [],
  "History": [
    {
      "Id": 1,
      "Operation": "sample string 2",
      "AuthorId": 3,
      "Author": "sample string 4",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 5,
      "Editor": "sample string 6",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    },
    {
      "Id": 1,
      "Operation": "sample string 2",
      "AuthorId": 3,
      "Author": "sample string 4",
      "Created": "2026-03-09T17:07:07.1465543-03:00",
      "EditorId": 5,
      "Editor": "sample string 6",
      "Modified": "2026-03-09T17:07:07.1465543-03:00"
    }
  ],
  "AuthorId": 10,
  "Author": "sample string 11",
  "Created": "2026-03-09T17:07:07.1465543-03:00",
  "EditorId": 12,
  "Editor": "sample string 13",
  "Modified": "2026-03-09T17:07:07.1465543-03:00"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.