POST api/clients/delete

Request Information

URI Parameters

None.

Body Parameters

ClientData
NameDescriptionTypeAdditional information
Code

string

None.

Name

string

None.

CommercialName

string

None.

Description

string

None.

ResponsibleTypeID

integer

None.

ResponsibleTypeName

string

None.

IdentificationDocumentTypeID

integer

None.

IdentificationDocumentName

string

None.

IdentificationDocumentValue

string

None.

Email

string

None.

CityID

integer

None.

CityName

string

None.

DepartmentID

integer

None.

DepartmentName

string

None.

ProvinceID

integer

None.

ProvinceName

string

None.

CountryID

integer

None.

CountryName

string

None.

StreetNameAndNumber

string

None.

CityShipmentID

integer

None.

CityShipmentName

string

None.

DepartmentShipmentID

integer

None.

DepartmentShipmentName

string

None.

ProvinceShipmentID

integer

None.

ProvinceShipmentName

string

None.

CountryShipmentID

integer

None.

CountryShipmentName

string

None.

StreetNameAndNumberShipment

string

None.

Phone1

string

None.

Phone2

string

None.

ZoneID

integer

None.

ZoneName

string

None.

IsEnableCheckingAccount

boolean

None.

CheckingAccountID

integer

None.

IIBBAlicuota

decimal number

None.

Documents

Collection of FileData

None.

ExpirationDate

date

None.

ExtraData

Dictionary of string [key] and PropertyData [value]

None.

ZoneNameToGroup

string

None.

CheckingAccountBalance

decimal number

None.

IIBBAlicuotaToDecimal

decimal number

None.

IIBBAlicuotaToStr

string

None.

CheckingAccountBalanceToStr

string

None.

Phones

string

None.

CheckingAccountStatus

string

None.

DisplayCompleteName

string

None.

DisplayNameAndCommercialName

string

None.

CompleteAddress

string

None.

ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Code": "sample string 1",
  "Name": "sample string 2",
  "CommercialName": "sample string 3",
  "Description": "sample string 4",
  "ResponsibleTypeID": 1,
  "ResponsibleTypeName": "sample string 5",
  "IdentificationDocumentTypeID": 1,
  "IdentificationDocumentName": "sample string 6",
  "IdentificationDocumentValue": "sample string 7",
  "Email": "sample string 8",
  "CityID": 1,
  "CityName": "sample string 9",
  "DepartmentID": 1,
  "DepartmentName": "sample string 10",
  "ProvinceID": 1,
  "ProvinceName": "sample string 11",
  "CountryID": 1,
  "CountryName": "sample string 12",
  "StreetNameAndNumber": "sample string 13",
  "CityShipmentID": 1,
  "CityShipmentName": "sample string 14",
  "DepartmentShipmentID": 1,
  "DepartmentShipmentName": "sample string 15",
  "ProvinceShipmentID": 1,
  "ProvinceShipmentName": "sample string 16",
  "CountryShipmentID": 1,
  "CountryShipmentName": "sample string 17",
  "StreetNameAndNumberShipment": "sample string 18",
  "Phone1": "sample string 19",
  "Phone2": "sample string 20",
  "ZoneID": 1,
  "ZoneName": "sample string 21",
  "IsEnableCheckingAccount": true,
  "CheckingAccountID": 1,
  "IIBBAlicuota": 1.0,
  "Documents": [
    {
      "Description": "sample string 1",
      "FileName": "sample string 2",
      "Url": "sample string 3",
      "SizeInMB": 1.0,
      "Data": "QEA=",
      "ID": 1
    },
    {
      "Description": "sample string 1",
      "FileName": "sample string 2",
      "Url": "sample string 3",
      "SizeInMB": 1.0,
      "Data": "QEA=",
      "ID": 1
    }
  ],
  "ExpirationDate": "2025-08-02T19:12:58.3378578+00:00",
  "ExtraData": {
    "sample string 1": {
      "Type": 0,
      "Name": "sample string 1",
      "Value": "sample string 2",
      "Required": true
    },
    "sample string 2": {
      "Type": 0,
      "Name": "sample string 1",
      "Value": "sample string 2",
      "Required": true
    }
  },
  "ZoneNameToGroup": "Zona: sample string 21",
  "CheckingAccountBalance": 1.0,
  "IIBBAlicuotaToDecimal": 1.0,
  "IIBBAlicuotaToStr": "1,00",
  "CheckingAccountBalanceToStr": "1,00",
  "Phones": "sample string 19 / sample string 20",
  "CheckingAccountStatus": "1,00",
  "DisplayCompleteName": "sample string 1 - sample string 2 (sample string 3) - sample string 6 sample string 7 - sample string 5",
  "DisplayNameAndCommercialName": "sample string 2 (sample string 3)",
  "CompleteAddress": "sample string 13, sample string 9 (sample string 11)",
  "ID": 1
}

text/xml

Sample:
<ClientData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">
  <ID>1</ID>
  <CheckingAccountBalance>1</CheckingAccountBalance>
  <CheckingAccountID>1</CheckingAccountID>
  <CityID>1</CityID>
  <CityName>sample string 9</CityName>
  <CityShipmentID>1</CityShipmentID>
  <CityShipmentName>sample string 14</CityShipmentName>
  <Code>sample string 1</Code>
  <CommercialName>sample string 3</CommercialName>
  <CountryID>1</CountryID>
  <CountryName>sample string 12</CountryName>
  <CountryShipmentID>1</CountryShipmentID>
  <CountryShipmentName>sample string 17</CountryShipmentName>
  <DepartmentID>1</DepartmentID>
  <DepartmentName>sample string 10</DepartmentName>
  <DepartmentShipmentID>1</DepartmentShipmentID>
  <DepartmentShipmentName>sample string 15</DepartmentShipmentName>
  <Description>sample string 4</Description>
  <Documents>
    <FileData>
      <ID>1</ID>
      <Data>QEA=</Data>
      <Description>sample string 1</Description>
      <FileName>sample string 2</FileName>
      <SizeInMB>1</SizeInMB>
      <Url>sample string 3</Url>
    </FileData>
    <FileData>
      <ID>1</ID>
      <Data>QEA=</Data>
      <Description>sample string 1</Description>
      <FileName>sample string 2</FileName>
      <SizeInMB>1</SizeInMB>
      <Url>sample string 3</Url>
    </FileData>
  </Documents>
  <Email>sample string 8</Email>
  <ExpirationDate>2025-08-02T19:12:58.3378578+00:00</ExpirationDate>
  <ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringPropertyDatal3xPxu36>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <Name>sample string 1</Name>
        <Required>true</Required>
        <Type>INT</Type>
        <Value>sample string 2</Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringPropertyDatal3xPxu36>
    <d2p1:KeyValueOfstringPropertyDatal3xPxu36>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <Name>sample string 1</Name>
        <Required>true</Required>
        <Type>INT</Type>
        <Value>sample string 2</Value>
      </d2p1:Value>
    </d2p1:KeyValueOfstringPropertyDatal3xPxu36>
  </ExtraData>
  <IIBBAlicuota>1</IIBBAlicuota>
  <IdentificationDocumentName>sample string 6</IdentificationDocumentName>
  <IdentificationDocumentTypeID>1</IdentificationDocumentTypeID>
  <IdentificationDocumentValue>sample string 7</IdentificationDocumentValue>
  <IsEnableCheckingAccount>true</IsEnableCheckingAccount>
  <Name>sample string 2</Name>
  <Phone1>sample string 19</Phone1>
  <Phone2>sample string 20</Phone2>
  <ProvinceID>1</ProvinceID>
  <ProvinceName>sample string 11</ProvinceName>
  <ProvinceShipmentID>1</ProvinceShipmentID>
  <ProvinceShipmentName>sample string 16</ProvinceShipmentName>
  <ResponsibleTypeID>1</ResponsibleTypeID>
  <ResponsibleTypeName>sample string 5</ResponsibleTypeName>
  <StreetNameAndNumber>sample string 13</StreetNameAndNumber>
  <StreetNameAndNumberShipment>sample string 18</StreetNameAndNumberShipment>
  <ZoneID>1</ZoneID>
  <ZoneName>sample string 21</ZoneName>
</ClientData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.