PATCH api/BusinessPartners
Request Information
URI Parameters
None.
Body Parameters
BusinessPartners| Name | Description | Type | Additional information |
|---|---|---|---|
| CardCode | string |
None. |
|
| GroupCode | integer |
None. |
|
| CardName | string |
None. |
|
| CardType | string |
None. |
|
| Phone1 | string |
None. |
|
| PayTermsGrpCode | integer |
None. |
|
| DiscountPercent | decimal number |
None. |
|
| MaxCommitment | decimal number |
None. |
|
| FederalTaxID | string |
None. |
|
| PriceListNum | integer |
None. |
|
| SalesPersonCode | integer |
None. |
|
| Currency | string |
None. |
|
| EmailAddress | string |
None. |
|
| Series | integer |
None. |
|
| CashCustomer | boolean |
None. |
|
| TypeAheadFormat | string |
None. |
|
| TypeIdentification | string |
None. |
|
| Provincia | string |
None. |
|
| Canton | string |
None. |
|
| Distrito | string |
None. |
|
| Barrio | string |
None. |
|
| Direccion | string |
None. |
|
| Frozen | string |
None. |
|
| Valid | string |
None. |
|
| FatherType | string |
None. |
|
| FatherCard | string |
None. |
|
| ConfigurableFields | Collection of ConfigurableFields |
None. |
|
| BPAddresses | Collection of BPAddresses |
None. |
|
| Udfs | Collection of Udf |
None. |
|
| IsCompanyDirection | boolean |
None. |
|
| ShipToDefault | string |
None. |
|
| BilltoDefault | string |
None. |
|
| AttachmentEntry | integer |
None. |
|
| Device | string |
None. |
|
| CreateDate | date |
None. |
|
| CreditLine | decimal number |
None. |
|
| Address | string |
None. |
|
| Balance | decimal number |
None. |
|
| CardForeignName | string |
None. |
|
| Industry | integer |
None. |
|
| ContactEmployees | Collection of BusinessPartnerContactPerson |
None. |
|
| ContactPerson | string |
None. |
|
| Cellular | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CardCode": "sample string 1",
"GroupCode": 2,
"CardName": "sample string 3",
"CardType": "sample string 4",
"Phone1": "sample string 5",
"PayTermsGrpCode": 6,
"DiscountPercent": 7.0,
"MaxCommitment": 8.0,
"FederalTaxID": "sample string 9",
"PriceListNum": 10,
"SalesPersonCode": 11,
"Currency": "sample string 12",
"EmailAddress": "sample string 13",
"Series": 14,
"CashCustomer": true,
"TypeAheadFormat": "sample string 16",
"TypeIdentification": "sample string 17",
"Provincia": "sample string 18",
"Canton": "sample string 19",
"Distrito": "sample string 20",
"Barrio": "sample string 21",
"Direccion": "sample string 22",
"Frozen": "sample string 23",
"Valid": "sample string 24",
"FatherType": "sample string 25",
"FatherCard": "sample string 26",
"ConfigurableFields": [
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
},
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
}
],
"BPAddresses": [
{
"AddressName": "sample string 1",
"Street": "sample string 2",
"Block": "sample string 3",
"ZipCode": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"Country": "sample string 7",
"State": "sample string 8",
"AddressType": "sample string 9",
"AddressName2": "sample string 10",
"AddressName3": "sample string 11",
"BPCode": "sample string 12",
"GlobalLocationNumber": "sample string 13",
"StreetNo": "sample string 14",
"BuildingFloorRoom": "sample string 15",
"RowNum": 16,
"ConfigurableFields": [
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
},
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
}
]
},
{
"AddressName": "sample string 1",
"Street": "sample string 2",
"Block": "sample string 3",
"ZipCode": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"Country": "sample string 7",
"State": "sample string 8",
"AddressType": "sample string 9",
"AddressName2": "sample string 10",
"AddressName3": "sample string 11",
"BPCode": "sample string 12",
"GlobalLocationNumber": "sample string 13",
"StreetNo": "sample string 14",
"BuildingFloorRoom": "sample string 15",
"RowNum": 16,
"ConfigurableFields": [
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
},
{
"Description": "sample string 1",
"NameSL": "sample string 2",
"Id": "sample string 3",
"Value": "sample string 4",
"IsObjDirection": true,
"FieldType": "sample string 6"
}
]
}
],
"Udfs": [
{
"Name": "sample string 1",
"FieldType": "sample string 2",
"Value": "sample string 3"
},
{
"Name": "sample string 1",
"FieldType": "sample string 2",
"Value": "sample string 3"
}
],
"IsCompanyDirection": true,
"ShipToDefault": "sample string 28",
"BilltoDefault": "sample string 29",
"AttachmentEntry": 1,
"Device": "sample string 30",
"CreateDate": "2025-12-05T22:42:04.9518919-06:00",
"CreditLine": 32.0,
"Address": "sample string 33",
"Balance": 34.0,
"CardForeignName": "sample string 35",
"Industry": 36,
"ContactEmployees": [
{
"CardCode": "sample string 1",
"Name": "sample string 2",
"FirstName": "sample string 3",
"Position": "sample string 4",
"Address": "sample string 5",
"Phone1": "sample string 6",
"MobilePhone": "sample string 7",
"E_Mail": "sample string 8",
"Active": "sample string 9",
"InternalCode": 10
},
{
"CardCode": "sample string 1",
"Name": "sample string 2",
"FirstName": "sample string 3",
"Position": "sample string 4",
"Address": "sample string 5",
"Phone1": "sample string 6",
"MobilePhone": "sample string 7",
"E_Mail": "sample string 8",
"Active": "sample string 9",
"InternalCode": 10
}
],
"ContactPerson": "sample string 37",
"Cellular": "sample string 38"
}
application/xml, text/xml
Sample:
<BusinessPartners xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS.SAP">
<Address>sample string 33</Address>
<AttachmentEntry>1</AttachmentEntry>
<BPAddresses>
<BPAddresses>
<AddressName>sample string 1</AddressName>
<AddressName2>sample string 10</AddressName2>
<AddressName3>sample string 11</AddressName3>
<AddressType>sample string 9</AddressType>
<BPCode>sample string 12</BPCode>
<Block>sample string 3</Block>
<BuildingFloorRoom>sample string 15</BuildingFloorRoom>
<City>sample string 5</City>
<ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
</ConfigurableFields>
<Country>sample string 7</Country>
<County>sample string 6</County>
<GlobalLocationNumber>sample string 13</GlobalLocationNumber>
<RowNum>16</RowNum>
<State>sample string 8</State>
<Street>sample string 2</Street>
<StreetNo>sample string 14</StreetNo>
<ZipCode>sample string 4</ZipCode>
</BPAddresses>
<BPAddresses>
<AddressName>sample string 1</AddressName>
<AddressName2>sample string 10</AddressName2>
<AddressName3>sample string 11</AddressName3>
<AddressType>sample string 9</AddressType>
<BPCode>sample string 12</BPCode>
<Block>sample string 3</Block>
<BuildingFloorRoom>sample string 15</BuildingFloorRoom>
<City>sample string 5</City>
<ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
</ConfigurableFields>
<Country>sample string 7</Country>
<County>sample string 6</County>
<GlobalLocationNumber>sample string 13</GlobalLocationNumber>
<RowNum>16</RowNum>
<State>sample string 8</State>
<Street>sample string 2</Street>
<StreetNo>sample string 14</StreetNo>
<ZipCode>sample string 4</ZipCode>
</BPAddresses>
</BPAddresses>
<Balance>34</Balance>
<Barrio>sample string 21</Barrio>
<BilltoDefault>sample string 29</BilltoDefault>
<Canton>sample string 19</Canton>
<CardCode>sample string 1</CardCode>
<CardForeignName>sample string 35</CardForeignName>
<CardName>sample string 3</CardName>
<CardType>sample string 4</CardType>
<CashCustomer>true</CashCustomer>
<Cellular>sample string 38</Cellular>
<ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
<ConfigurableFields>
<Description>sample string 1</Description>
<FieldType>sample string 6</FieldType>
<Id>sample string 3</Id>
<IsObjDirection>true</IsObjDirection>
<NameSL>sample string 2</NameSL>
<Value>sample string 4</Value>
</ConfigurableFields>
</ConfigurableFields>
<ContactEmployees>
<BusinessPartnerContactPerson>
<Active>sample string 9</Active>
<Address>sample string 5</Address>
<CardCode>sample string 1</CardCode>
<E_Mail>sample string 8</E_Mail>
<FirstName>sample string 3</FirstName>
<InternalCode>10</InternalCode>
<MobilePhone>sample string 7</MobilePhone>
<Name>sample string 2</Name>
<Phone1>sample string 6</Phone1>
<Position>sample string 4</Position>
</BusinessPartnerContactPerson>
<BusinessPartnerContactPerson>
<Active>sample string 9</Active>
<Address>sample string 5</Address>
<CardCode>sample string 1</CardCode>
<E_Mail>sample string 8</E_Mail>
<FirstName>sample string 3</FirstName>
<InternalCode>10</InternalCode>
<MobilePhone>sample string 7</MobilePhone>
<Name>sample string 2</Name>
<Phone1>sample string 6</Phone1>
<Position>sample string 4</Position>
</BusinessPartnerContactPerson>
</ContactEmployees>
<ContactPerson>sample string 37</ContactPerson>
<CreateDate>2025-12-05T22:42:04.9518919-06:00</CreateDate>
<CreditLine>32</CreditLine>
<Currency>sample string 12</Currency>
<Device>sample string 30</Device>
<Direccion>sample string 22</Direccion>
<DiscountPercent>7</DiscountPercent>
<Distrito>sample string 20</Distrito>
<EmailAddress>sample string 13</EmailAddress>
<FatherCard>sample string 26</FatherCard>
<FatherType>sample string 25</FatherType>
<FederalTaxID>sample string 9</FederalTaxID>
<Frozen>sample string 23</Frozen>
<GroupCode>2</GroupCode>
<Industry>36</Industry>
<IsCompanyDirection>true</IsCompanyDirection>
<MaxCommitment>8</MaxCommitment>
<PayTermsGrpCode>6</PayTermsGrpCode>
<Phone1>sample string 5</Phone1>
<PriceListNum>10</PriceListNum>
<Provincia>sample string 18</Provincia>
<SalesPersonCode>11</SalesPersonCode>
<Series>14</Series>
<ShipToDefault>sample string 28</ShipToDefault>
<TypeAheadFormat>sample string 16</TypeAheadFormat>
<TypeIdentification>sample string 17</TypeIdentification>
<Udfs xmlns:d2p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
<d2p1:Udf>
<d2p1:FieldType>sample string 2</d2p1:FieldType>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 3</d2p1:Value>
</d2p1:Udf>
<d2p1:Udf>
<d2p1:FieldType>sample string 2</d2p1:FieldType>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 3</d2p1:Value>
</d2p1:Udf>
</Udfs>
<Valid>sample string 24</Valid>
</BusinessPartners>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |