GET api/Partner
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "9ff4808a-b787-4c97-b98d-4a8b76f8ca18",
"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": "07bacdc2-9abb-4aad-aca1-6edc342cdb8c",
"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": "ad67763e-32b5-4dbb-84e6-c9214182789d"
},
{
"contactID": "07bacdc2-9abb-4aad-aca1-6edc342cdb8c",
"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": "ad67763e-32b5-4dbb-84e6-c9214182789d"
}
],
"incharges": [
{
"inchargeID": "5829fd91-5d6c-4e6a-910d-c7f179f2aee6",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "d4edb31f-faad-4e08-83a6-e77e540feb49"
},
{
"inchargeID": "5829fd91-5d6c-4e6a-910d-c7f179f2aee6",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "d4edb31f-faad-4e08-83a6-e77e540feb49"
}
],
"locationAddresses": [
{
"locationAddressID": "0df66d03-79c2-44f4-9d9b-5bdf683fd6c9",
"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": "4e07c10d-6e63-4a98-aca5-99bf98598806"
},
{
"locationAddressID": "0df66d03-79c2-44f4-9d9b-5bdf683fd6c9",
"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": "4e07c10d-6e63-4a98-aca5-99bf98598806"
}
]
},
{
"isNew": true,
"isDeleted": true,
"partnerID": "9ff4808a-b787-4c97-b98d-4a8b76f8ca18",
"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": "07bacdc2-9abb-4aad-aca1-6edc342cdb8c",
"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": "ad67763e-32b5-4dbb-84e6-c9214182789d"
},
{
"contactID": "07bacdc2-9abb-4aad-aca1-6edc342cdb8c",
"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": "ad67763e-32b5-4dbb-84e6-c9214182789d"
}
],
"incharges": [
{
"inchargeID": "5829fd91-5d6c-4e6a-910d-c7f179f2aee6",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "d4edb31f-faad-4e08-83a6-e77e540feb49"
},
{
"inchargeID": "5829fd91-5d6c-4e6a-910d-c7f179f2aee6",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "d4edb31f-faad-4e08-83a6-e77e540feb49"
}
],
"locationAddresses": [
{
"locationAddressID": "0df66d03-79c2-44f4-9d9b-5bdf683fd6c9",
"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": "4e07c10d-6e63-4a98-aca5-99bf98598806"
},
{
"locationAddressID": "0df66d03-79c2-44f4-9d9b-5bdf683fd6c9",
"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": "4e07c10d-6e63-4a98-aca5-99bf98598806"
}
]
}
]
application/xml, text/xml
Sample:
XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.