POST api/Partner
Request Information
URI Parameters
None.
Body Parameters
partner| Name | Description | Type | Additional information |
|---|---|---|---|
| isNew | boolean |
None. |
|
| isDeleted | boolean |
None. |
|
| partnerID | globally unique identifier |
None. |
|
| companyName | string |
None. |
|
| isVendor | boolean |
None. |
|
| isBuyer | boolean |
None. |
|
| isConsignee | boolean |
None. |
|
| companyCode | string |
None. |
|
| ein | string |
None. |
|
| terms | string |
None. |
|
| memo | string |
None. |
|
| isAutoPo | boolean |
None. |
|
| consigneeNumber | string |
None. |
|
| isStock | boolean |
None. |
|
| apiServer | string |
None. |
|
| bills | Collection of bill |
None. |
|
| contacts | Collection of contact |
None. |
|
| incharges | Collection of incharge |
None. |
|
| inventoryMovements | Collection of inventoryMovement |
None. |
|
| inventoryMovementCosts | Collection of inventoryMovementCost |
None. |
|
| invoices | Collection of invoice |
None. |
|
| locationAddresses | Collection of locationAddress |
None. |
|
| masterOrders | Collection of masterOrder |
None. |
|
| materialReceivings | Collection of materialReceiving |
None. |
|
| purchaseOrders | Collection of purchaseOrder |
None. |
|
| salesOrders | Collection of salesOrder |
None. |
Request Formats
application/json, text/json
Sample:
{
"isNew": true,
"isDeleted": true,
"partnerID": "7404df36-0426-436e-b1b9-a37b73beb8fb",
"companyName": "sample string 4",
"isVendor": true,
"isBuyer": true,
"isConsignee": true,
"companyCode": "sample string 5",
"ein": "sample string 6",
"terms": "sample string 7",
"memo": "sample string 8",
"isAutoPo": true,
"consigneeNumber": "sample string 9",
"isStock": true,
"apiServer": "sample string 10",
"contacts": [
{
"contactID": "d5413663-aff0-4e1f-b4e0-3f1700b3f445",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "15963012-9f48-4730-8658-441c5aec1784"
},
{
"contactID": "d5413663-aff0-4e1f-b4e0-3f1700b3f445",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "15963012-9f48-4730-8658-441c5aec1784"
}
],
"incharges": [
{
"inchargeID": "d3bde22f-c142-42fc-93a6-d712c81e7c4e",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "7fb4d038-273a-4fbd-bd91-cc5c71a4c7c3"
},
{
"inchargeID": "d3bde22f-c142-42fc-93a6-d712c81e7c4e",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "7fb4d038-273a-4fbd-bd91-cc5c71a4c7c3"
}
],
"locationAddresses": [
{
"locationAddressID": "fa876cb0-56ac-4ddc-9b47-830ae92c67cb",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "2628a018-2761-45f3-82ca-fe357be084e8"
},
{
"locationAddressID": "fa876cb0-56ac-4ddc-9b47-830ae92c67cb",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "2628a018-2761-45f3-82ca-fe357be084e8"
}
]
}
application/xml, text/xml
Sample:
XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
partner| Name | Description | Type | Additional information |
|---|---|---|---|
| isNew | boolean |
None. |
|
| isDeleted | boolean |
None. |
|
| partnerID | globally unique identifier |
None. |
|
| companyName | string |
None. |
|
| isVendor | boolean |
None. |
|
| isBuyer | boolean |
None. |
|
| isConsignee | boolean |
None. |
|
| companyCode | string |
None. |
|
| ein | string |
None. |
|
| terms | string |
None. |
|
| memo | string |
None. |
|
| isAutoPo | boolean |
None. |
|
| consigneeNumber | string |
None. |
|
| isStock | boolean |
None. |
|
| apiServer | string |
None. |
|
| bills | Collection of bill |
None. |
|
| contacts | Collection of contact |
None. |
|
| incharges | Collection of incharge |
None. |
|
| inventoryMovements | Collection of inventoryMovement |
None. |
|
| inventoryMovementCosts | Collection of inventoryMovementCost |
None. |
|
| invoices | Collection of invoice |
None. |
|
| locationAddresses | Collection of locationAddress |
None. |
|
| masterOrders | Collection of masterOrder |
None. |
|
| materialReceivings | Collection of materialReceiving |
None. |
|
| purchaseOrders | Collection of purchaseOrder |
None. |
|
| salesOrders | Collection of salesOrder |
None. |
Response Formats
application/json, text/json
Sample:
{
"isNew": true,
"isDeleted": true,
"partnerID": "028c3b57-7983-4857-80ac-c8808743ea36",
"companyName": "sample string 4",
"isVendor": true,
"isBuyer": true,
"isConsignee": true,
"companyCode": "sample string 5",
"ein": "sample string 6",
"terms": "sample string 7",
"memo": "sample string 8",
"isAutoPo": true,
"consigneeNumber": "sample string 9",
"isStock": true,
"apiServer": "sample string 10",
"contacts": [
{
"contactID": "1b78ae33-8199-441f-9e8d-c38036c8b6d7",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "3d334e7e-3268-42d1-9244-b54d140fc7c3"
},
{
"contactID": "1b78ae33-8199-441f-9e8d-c38036c8b6d7",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "3d334e7e-3268-42d1-9244-b54d140fc7c3"
}
],
"incharges": [
{
"inchargeID": "9bb3f217-ea08-425b-ac69-7e7e882f78a9",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "178e7bc6-d3d7-4895-ae45-d735c757615c"
},
{
"inchargeID": "9bb3f217-ea08-425b-ac69-7e7e882f78a9",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "178e7bc6-d3d7-4895-ae45-d735c757615c"
}
],
"locationAddresses": [
{
"locationAddressID": "00333e1a-ee27-4b32-80b5-e939f3bb50ee",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "1b5203f1-129a-44c6-85cb-13f256b75f7b"
},
{
"locationAddressID": "00333e1a-ee27-4b32-80b5-e939f3bb50ee",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "1b5203f1-129a-44c6-85cb-13f256b75f7b"
}
]
}
application/xml, text/xml
Sample:
XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.