---
title: "Archive a supplier"
slug: "archive-a-supplier"
updated: 2024-09-04T11:14:03Z
published: 2026-02-10T10:27:20Z
---
> ## 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
Post/api/v1/relations/suppliers/archive
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.
**Description**
Archives an existing Supplier from the given date. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. By using this operation the selected Owner will not be available anymore as an option to choose from lists.
A supplier encompasses all entities from which you receive invoices. For example, the tax authorities or a cleaning company. Also, for instance, the company from which you purchase office supplies.
**Use Case**
The Bloxs user terminates the cooperation with a Supplier. Therefore the Supplier should not be shown in lists anymore.
| Field | Description |
| --- | --- |
| reference | The relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| archiveDate | Date on which the supplier was archived and is no longer active. |
SecurityHTTPType Bearer
Please enter a valid token
Query parametersarchiveDatestring (date) Required
The date on which it is archived.
referencestring
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
externalIdentifierstring
The external API identifier of the model.
Responses200
The supplier was archived
Expand Allobject languageISOCodestring | null Min length0Max length2
addressobject (Address) streetstring Min length0Max length200
houseNumberstring | null Min length0Max length40
postalCodestring Min length0Max length20
citystring Min length0Max length200
countryISOCodestring Min length0Max length2
invoiceAddressobject (Address) streetstring Min length0Max length200
houseNumberstring | null Min length0Max length40
postalCodestring Min length0Max length20
citystring Min length0Max length200
countryISOCodestring Min length0Max length2
postalAddressobject (Address) streetstring Min length0Max length200
houseNumberstring | null Min length0Max length40
postalCodestring Min length0Max length20
citystring Min length0Max length200
countryISOCodestring Min length0Max length2
primaryEmailAddresses Array of string | null string
invoicesEmailAddresses Array of string | null string
paymentRemindersEmailAddresses Array of string | null string
indexationsEmailAddresses Array of string | null string
serviceTicketsEmailAddresses Array of string | null string
purchaseOrdersEmailAddresses Array of string | null string
portalsEmailAddresses Array of string | null string
otherEmailAddresses Array of string | null string
externalIdentifierstring | null Min length0Max length100
phoneNumberstring | null
mobileNumberstring | null
cocNumberstring | null Min length0Max length256
cocDescriptionstring | null
vatNumberstring | null Min length0Max length256
correspondenceMethodinteger (int32) Valid values[
1,
2
]
remarksstring | null
supplierTypeNamestring | null Min length0Max length256
namestring Min length0Max length256
websitestring | null
defaultPurchaseInvoiceSubjectstring | null Min length0Max length512
paymentMethodinteger (int32) | null Valid values[
1,
2,
3,
4,
5
]
defaultPaymentTermNamestring | null
defaultLedgerAccountCodestring | null
referencestring | null Min length0Max length100
displayNamestring | null
archiveDatestring (date) | null
400
The archiving has validation issues
Expand Allobject typestring | null
titlestring | null
traceIdstring | null
statusinteger (int32)
errorsobject | null property* Array of string | null additionalPropertiesstring
404
The requested supplier was not found.