Przejdź do głównej zawartości

Client

Dla: Programista

Typ obiektowyClient

A client of the print shop — a company, a sole proprietorship or an individual — with its contact persons, addresses, CRM notes and tags. A text field is null when it was not given.

Pola

PoleTypOpis
addresses[ClientAddress!]

Addresses of the client: the default ones first, then the oldest. An empty list (never null) when it has none.

blockModeClientBlockMode!

Whether the print shop takes and releases orders of the client. Only the print shop sets it: an integration cannot place an order for a client blocked with BLOCK_ALL.

blockReasonString

Why the print shop blocked the client; null when not blocked.

blockedAtDateTime

When the current block was set; null when not blocked.

clientNotes[ClientNote!]

The latest CRM notes about the client (calls, meetings, e-mails), the latest contact first: first of them, at most 50. Private notes of the staff never show; an empty list (never null) when there are none.

Argumenty

  • first: Int!

    How many of the latest notes to return: 1 to 50 (25 when not given).

    Domyślnie: 25

contacts[ClientContact!]

Contact persons of the client: the primary one first, then by last and first name. An empty list (never null) when it has none.

createdAtDateTime!

When the client was added.

creditLimitFloat

Credit limit of the client in the print shop's home currency: how much it may owe for unpaid orders. 0 or null: no limit is tracked. Only the print shop sets it.

Wymaga zakresu prices:read.

daysToPayInt

Payment term of the client's orders, in days.

defaultCurrencyIdID

Identifier of the default currency of the client's orders; null for the print shop's home currency.

defaultDeliveryMethodDeliveryMethod

How the client's orders are delivered by default.

defaultInvoiceBillingEntityIdID

Identifier of the print shop's billing entity that invoices the client's orders by default; null while none is chosen.

defaultPaymentMethodPaymentMethod

How the client pays for orders by default.

discountPercentFloat

Default discount of the client in percent (10 = 10%); null when none. Only the print shop sets it.

Wymaga zakresu prices:read.

displayNameString!

Name Prynt shows for the client: the legal name of a company, the first and last name of an individual. Derived from the name fields.

emailString

E-mail address of the client.

euVatNumberString

EU VAT identification number, for supplies within the EU.

externalRefString

Your integration's own identifier of the client (CreateClientInput.externalRef); null until you set one. Each integration sees only its own; in the app it is always null.

firstNameString

First name of an individual or a sole proprietor.

idID!

Identifier of the client (UUID).

isActiveBoolean!

False when the print shop deactivated the client (in Prynt, deleting a client deactivates it). An API key does not change a deactivated client or order for it.

krsString

KRS, the Polish court register number.

lastNameString

Last name of an individual or a sole proprietor.

legalNameString

Legal name of a company or a sole proprietorship, as on invoices.

nameShortString

Short name the print shop uses in lists.

phoneString

Phone number of the client.

regonString

REGON, the Polish statistical business number.

tags[ClientTag!]

Tags of the client, by name. An empty list (never null) when it has none.

taxIdentificationNumberString

Tax identification number (NIP), unique among the print shop's clients.

typeClientType!

Kind of client; it decides which name fields are set.

updatedAtDateTime!

When the client or anything of it (contacts, addresses, notes visible to integrations, tags) last changed. Writing back the same values does not move it. Filter on it with updatedFrom to fetch only what changed since your last sync.

Używane w