POST api/Partner

Request Information

URI Parameters

None.

Body Parameters

partner
NameDescriptionTypeAdditional 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": "2de19f04-b6b0-4da1-9156-6f3ef2485042",
  "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": "04593035-13f1-479c-b255-ad9d52665698",
      "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": "d2479047-af39-4d27-906c-bfce8239e13c"
    },
    {
      "contactID": "04593035-13f1-479c-b255-ad9d52665698",
      "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": "d2479047-af39-4d27-906c-bfce8239e13c"
    }
  ],
  "incharges": [
    {
      "inchargeID": "14dbaee7-4b6a-4011-9f24-a28907019008",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "da35c8a1-349c-431c-b633-fd1df481afbf"
    },
    {
      "inchargeID": "14dbaee7-4b6a-4011-9f24-a28907019008",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "da35c8a1-349c-431c-b633-fd1df481afbf"
    }
  ],
  "locationAddresses": [
    {
      "locationAddressID": "9ba3e0bf-d6a9-46f4-8673-d96cf0129523",
      "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": "80b443e0-557d-47eb-964c-29c943d08133"
    },
    {
      "locationAddressID": "9ba3e0bf-d6a9-46f4-8673-d96cf0129523",
      "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": "80b443e0-557d-47eb-964c-29c943d08133"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

partner
NameDescriptionTypeAdditional 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": "0f1355db-a68c-4f55-885c-32f247ca8b44",
  "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": "32a571c0-7820-4f65-b147-49a860e81724",
      "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": "8ba464ba-f69d-4307-8063-6fd66a960257"
    },
    {
      "contactID": "32a571c0-7820-4f65-b147-49a860e81724",
      "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": "8ba464ba-f69d-4307-8063-6fd66a960257"
    }
  ],
  "incharges": [
    {
      "inchargeID": "d9579dc5-0271-469d-a710-bc5249990019",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "f290da0d-fa27-4523-b11d-3222e8039049"
    },
    {
      "inchargeID": "d9579dc5-0271-469d-a710-bc5249990019",
      "inchargeEmail": "sample string 2",
      "confirmEmail": "sample string 3",
      "partnerID": "f290da0d-fa27-4523-b11d-3222e8039049"
    }
  ],
  "locationAddresses": [
    {
      "locationAddressID": "12fbb06f-3c05-41f3-80a0-a06ce26d8ad0",
      "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": "885e76d0-2e7a-46ed-b3b2-e3362c41e638"
    },
    {
      "locationAddressID": "12fbb06f-3c05-41f3-80a0-a06ce26d8ad0",
      "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": "885e76d0-2e7a-46ed-b3b2-e3362c41e638"
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.