GET api/Partner/{id}/{option}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
option		string	Default value is

Body Parameters

None.

Response Information

Resource Description

partner

Name	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": "741829bb-1415-4cfc-8a6f-558f91f3cf2e",
  "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": "44ed8281-fa48-4ddc-8a83-99d05f8331e9",
      "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": "79eedb39-3f85-4978-a1fe-c432032b379b"
    },
    {
      "contactID": "44ed8281-fa48-4ddc-8a83-99d05f8331e9",
      "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": "79eedb39-3f85-4978-a1fe-c432032b379b"
    }
  ],
  "incharges": [
    {
      "inchargeID": "f74f6441-4e06-43f0-9442-77445c6b3236",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "435297f1-2289-4560-9d2f-995b83c4cabb"
    },
    {
      "inchargeID": "f74f6441-4e06-43f0-9442-77445c6b3236",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "435297f1-2289-4560-9d2f-995b83c4cabb"
    }
  ],
  "locationAddresses": [
    {
      "locationAddressID": "92822f5c-7610-43e7-8d8b-d1119c762042",
      "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": "74fdb9f8-8ff6-47e0-800c-2e258d3be61e"
    },
    {
      "locationAddressID": "92822f5c-7610-43e7-8d8b-d1119c762042",
      "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": "74fdb9f8-8ff6-47e0-800c-2e258d3be61e"
    }
  ]
}

application/xml, text/xml

Sample:

XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.