Partners

Business partners — suppliers and customers used in Stock In and Stock Out transactions.

O objeto Partner

Partner — a supplier or customer used as the counterparty on Stock In and Stock Out transactions.

idintegerminimum 0, maximum 2147483647obrigatório

Partner id.

typenumberobrigatório

Partner classification. 0 = supplier (used in Stock In transactions), 1 = customer (used in Stock Out transactions).

Valores possíveis01

namestringobrigatório

Partner display name.

phonestringobrigatório

Phone number. Empty string when not set.

emailstringobrigatório

Email address. Empty string when not set.

addressstringobrigatório

Postal address. Empty string when not set.

memostringobrigatório

Free-text memo. Empty string when not set.

Exemplo

{
  "id": 431485,
  "type": 0,
  "name": "Acme Supply Co.",
  "phone": "+1-415-555-0101",
  "email": "orders@acme-supply.example.com",
  "address": "123 Market St, San Francisco, CA 94103",
  "memo": ""
}

Endpoints

List partners GET /v1/partners
Create a partner POST /v1/partners
Get a partner GET /v1/partners/{partner_id}
Update a partner PUT /v1/partners/{partner_id}
Delete a partner DELETE /v1/partners/{partner_id}