Get a supplier

reference

string

Required (at least one of reference or externalIdentifier must be given)

The internal identifier of the supplier (equivalent to the supplier's Reference/Code in Bloxs).

externalIdentifier

string

Required (at least one of reference or externalIdentifier must be given)

The external API identifier of the supplier.

reference

string, max 100

Optional

The internal identifier (Reference/Code) of the supplier in Bloxs. Null if not assigned.

externalIdentifier

string, max 100

Optional

The external API identifier previously assigned to this supplier, if any.

displayName

string

Optional

The formatted display name of the supplier.

name

string, max 256

Required

The supplier's registered or trading name.

supplierTypeName

string, max 256, nullable

Optional

The supplier type assigned to this supplier. Unlike relationTypeName on Person and Organisation, this is optional. Valid values are managed by the user in the Bloxs admin section and can be retrieved from the Get all supplier types endpoint.

website

string, nullable

Optional

The supplier's website URL.

correspondenceMethod

integer (enum)

Required

How correspondence is delivered to this supplier. Allowed values: 1 = Email, 2 = Post.

languageISOCode

string, max 2, nullable

Optional

ISO 639-1 two-letter language code (for example "nl" or "en") determining the language used in correspondence.

address.street

string, max 200

Conditionally required

Street name of the supplier's main address. Required when correspondenceMethod is set to Post (2).

address.houseNumber

string, max 40, nullable

Optional

House number of the supplier's main address, including any suffix (for example "12A").

address.postalCode

string, max 20

Conditionally required

Postal code of the supplier's main address. Required when correspondenceMethod is set to Post (2).

address.city

string, max 200

Conditionally required

City of the supplier's main address. Required when correspondenceMethod is set to Post (2).

address.countryISOCode

string, max 2

Conditionally required

ISO 3166-1 alpha-2 country code of the supplier's main address, for example "NL". Required when correspondenceMethod is set to Post (2).

invoiceAddress.street

string, max 200

Required (if invoiceAddress is set)

Street name of the address used for invoicing this supplier, if different from the main address.

invoiceAddress.houseNumber

string, max 40, nullable

Optional

House number of the invoice address, including any suffix.

invoiceAddress.postalCode

string, max 20

Required (if invoiceAddress is set)

Postal code of the invoice address.

invoiceAddress.city

string, max 200

Required (if invoiceAddress is set)

City of the invoice address.

invoiceAddress.countryISOCode

string, max 2

Required (if invoiceAddress is set)

ISO 3166-1 alpha-2 country code of the invoice address.

postalAddress.street

string, max 200

Required (if postalAddress is set)

Street name of the postal correspondence address, if different from the main address.

postalAddress.houseNumber

string, max 40, nullable

Optional

House number of the postal address, including any suffix.

postalAddress.postalCode

string, max 20

Required (if postalAddress is set)

Postal code of the postal address.

postalAddress.city

string, max 200

Required (if postalAddress is set)

City of the postal address.

postalAddress.countryISOCode

string, max 2

Required (if postalAddress is set)

ISO 3166-1 alpha-2 country code of the postal address.

phoneNumber

string, nullable

Optional

The supplier's landline phone number.

mobileNumber

string, nullable

Optional

The supplier's mobile phone number.

primaryEmailAddresses

array of string, nullable

Conditionally required

The supplier's primary email address(es), used for general correspondence. Required when correspondenceMethod is set to Email (1).

invoicesEmailAddresses

array of string, nullable

Optional

Email address(es) that receive invoices for this supplier.

paymentRemindersEmailAddresses

array of string, nullable

Optional

Email address(es) that receive payment reminder correspondence.

indexationsEmailAddresses

array of string, nullable

Optional

Email address(es) that receive rent or fee indexation notices.

serviceTicketsEmailAddresses

array of string, nullable

Optional

Email address(es) that receive service or maintenance ticket correspondence.

purchaseOrdersEmailAddresses

array of string, nullable

Optional

Email address(es) that receive purchase order correspondence.

portalsEmailAddresses

array of string, nullable

Optional

Email address(es) used for portal-related notifications.

otherEmailAddresses

array of string, nullable

Optional

Any additional email address(es) not covered by the categories above.

cocNumber

string, max 256, nullable

Optional

Chamber of Commerce (KVK-style) registration number for the supplier.

cocDescription

string, nullable

Optional

Free-text description associated with the Chamber of Commerce registration.

vatNumber

string, max 256, nullable

Optional

The supplier's VAT identification number, used for determining VAT/reverse-charge treatment on purchase invoices where applicable.

defaultPurchaseInvoiceSubject

string, max 512, nullable

Optional

The preferred subject line for purchase invoices from this supplier. When a purchase invoice is created, this value is automatically filled in as the subject and can be overridden. If Scan and Recognize is used, the subject it detects is overwritten by this preferred subject.

paymentMethod

integer (enum), nullable

Optional

The preferred payment method used to pay this supplier. Allowed values: 1 = DirectDebit, 2 = BankTransfer, 3 = Withdrawal, 4 = Cash, 5 = iDEAL. When a purchase invoice is created for this supplier, this value is automatically filled in as the payment method and can be overridden.

defaultPaymentTermName

string, nullable

Optional

The preferred payment term for this supplier (for example a specific number of days). When a purchase invoice is created for this supplier, this value is automatically filled in as the payment term and can be overridden.

defaultLedgerAccountCode

string, nullable

Optional

The preferred general ledger account code for booking purchases from this supplier. When a purchase invoice is created for this supplier, this value is automatically filled in as the ledger account and can be overridden.

remarks

string, nullable

Optional

Free-text internal remarks about the supplier.

archiveDate

string (date), nullable

Optional

The date from which the supplier is archived, formatted as an ISO 8601 date (YYYY-MM-DD). Null if the supplier is not archived.