POST
/
v1
/
businesses
/
{business_id}
/
customers
/
{customer_id}
/
archive
curl -X POST https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/${customer_id}/archive \
  -H "Authorization: Bearer <access_token>" \

{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ARCHIVED",
   "transaction_tags": []
 }
}
Archiving a customer hides them from the business’s active customer list, returned by the List customers endpoint. Archived customers can still be accessed by ID, but are not returned in list requests by default. Archived customers will have all A/R and Liability balances retained and all invoices will remain.

​
Path Parameters

​
business_id
string
required
ID of the Business the customer is associated with.
​
customer_id
string
required
ID of the Customer to be archived.

​
Response

Returns the archived Customer object 
curl -X POST https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/${customer_id}/archive \
  -H "Authorization: Bearer <access_token>" \

{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ARCHIVED",
   "transaction_tags": []
 }
}