Archive

API Reference

V1

Contracts

Archive a contract

client.v1.contracts.archive(ContractArchiveParamsbody, RequestOptionsoptions?): dataIDContractArchiveResponse

post/v1/contracts/archive

Archive a contract

Parameters

bodycontract_idstringcustomer_idstringvoid_invoicesbooleanContractArchiveParams

Hide ParametersShow Parameters

contract_idstring

ID of the contract to archive

formatuuid

customer_idstring

ID of the customer whose contract is to be archived

formatuuid

void_invoicesboolean

If false, the existing finalized invoices will remain after the contract is archived.

Returns

ContractArchiveResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.contracts.archive({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  void_invoices: true,
});

console.log(response.data);

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}