> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Archive a supplier > Archives an existing supplier from the given date. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the supplier. ## OpenAPI ````json POST /api/v1/relations/suppliers/archive { "openapi": "3.0.4", "info": { "title": "Relations V1", "description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Common" }, { "name": "CommunicationFormAPI" }, { "name": "EstateAgentAPI" }, { "name": "Metadata" }, { "name": "OrganisationAPI" }, { "name": "OwnerAPI" }, { "name": "PersonAPI" }, { "name": "RelationTypeAPI" }, { "name": "SupplierAPI" }, { "name": "SupplierTypeAPI" } ], "paths": { "/api/v1/relations/suppliers/archive": { "post": { "tags": [ "Relations" ], "summary": "Archive a supplier", "description": "Archives an existing supplier from the given date. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the supplier.", "operationId": "ArchiveSupplier", "parameters": [ { "name": "archiveDate", "in": "query", "description": "The date on which it is archived.", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "The external API identifier of the model.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The supplier was archived", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierDetails" } } } }, "400": { "description": "The archiving has validation issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } }, "404": { "description": "The requested supplier was not found." } }, "x-d360-narrative-url": "

Archive a Supplier

Archives an existing supplier relation as of a given date.

A developer calls this endpoint when a supplier relation is no longer active but should be retained in Bloxs for historical and audit purposes rather than deleted.

The supplier to archive is located via reference or externalIdentifier.

Request Fields

Field

Type

Required

Description

archiveDate

string (date)

Required

The date from which the supplier is considered archived, formatted as ISO 8601 (YYYY-MM-DD), for example \"2026-06-30\".

reference

string

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

The internal identifier (Reference/Code) of the supplier to archive.

externalIdentifier

string

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

The external API identifier of the supplier to archive.

Response Fields

Field

Type

Required

Description

reference

string, max 100

Optional

The internal identifier (Reference/Code) of the archived supplier.

externalIdentifier

string, max 100

Optional

The external API identifier of the archived 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.

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 determining the correspondence language.

address.street

string, max 200

Conditionally required

Street name of the supplier's main address.

address.houseNumber

string, max 40, nullable

Optional

House number of the supplier's main address, including any suffix.

address.postalCode

string, max 20

Conditionally required

Postal code of the supplier's main address.

address.city

string, max 200

Conditionally required

City of the supplier's main address.

address.countryISOCode

string, max 2

Conditionally required

ISO 3166-1 alpha-2 country code of the supplier's main address.

invoiceAddress.street

string, max 200

Required (if invoiceAddress is set)

Street name of the invoice address.

invoiceAddress.houseNumber

string, max 40, nullable

Optional

House number of the invoice address.

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 address.

postalAddress.houseNumber

string, max 40, nullable

Optional

House number of the postal address.

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).

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, where applicable.

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.

defaultPurchaseInvoiceSubject

string, max 512, nullable

Optional

The preferred subject line for purchase invoices from this supplier.

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.

defaultPaymentTermName

string, nullable

Optional

The preferred payment term for this supplier.

defaultLedgerAccountCode

string, nullable

Optional

The preferred general ledger account code for booking purchases from this supplier.

remarks

string, nullable

Optional

Free-text internal remarks about the supplier.

archiveDate

string (date), nullable

Optional

The date from which the supplier is now archived, formatted as an ISO 8601 date (YYYY-MM-DD). Reflects the value submitted in the request.

" } } }, "components": { "schemas": { "SupplierDetails": { "required": [ "correspondenceMethod", "name" ], "type": "object", "properties": { "languageISOCode": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "invoiceAddress": { "$ref": "#/components/schemas/Address" }, "postalAddress": { "$ref": "#/components/schemas/Address" }, "primaryEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "invoicesEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "paymentRemindersEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "indexationsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serviceTicketsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "purchaseOrdersEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "portalsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "otherEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "mobileNumber": { "type": "string", "nullable": true }, "cocNumber": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "cocDescription": { "type": "string", "nullable": true }, "vatNumber": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "correspondenceMethod": { "type": "integer", "description": "Email = 1\nPost = 2", "format": "int32", "x-enumNames": [ "Email", "Post" ] }, "remarks": { "type": "string", "nullable": true }, "supplierTypeName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 256, "minLength": 0, "type": "string" }, "website": { "type": "string", "nullable": true }, "defaultPurchaseInvoiceSubject": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "paymentMethod": { "type": "integer", "description": "DirectDebit = 1\nBankTransfer = 2\nWithdrawal = 3\nCash = 4\niDEAL = 5", "format": "int32", "nullable": true, "x-enumNames": [ "DirectDebit", "BankTransfer", "Withdrawal", "Cash", "iDEAL" ] }, "defaultPaymentTermName": { "type": "string", "nullable": true }, "defaultLedgerAccountCode": { "type": "string", "nullable": true }, "reference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "archiveDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "APIErrorMessageModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Address": { "required": [ "city", "countryISOCode", "postalCode", "street" ], "type": "object", "properties": { "street": { "maxLength": 200, "minLength": 0, "type": "string" }, "houseNumber": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "postalCode": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 200, "minLength": 0, "type": "string" }, "countryISOCode": { "maxLength": 2, "minLength": 0, "type": "string" } }, "additionalProperties": false } } } } ````