contracts

Update a contract

Partially updates a contract and returns it. Any field omitted from the body is left unchanged. When terms is provided, all existing terms and their payments are replaced by the supplied terms. customFields sets only the custom fields it names, keyed by custom field id; a null value clears that field.

PATCH

/v1/contracts/{id}

Update a contract

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/contracts/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customFields": {},
  "description": "<string>",
  "name": "<string>",
  "terms": [
    {
      "amount": 123,
      "endDate": "2023-12-25",
      "note": "<string>",
      "payments": [],
      "purchaseOrder": "<string>",
      "quote": "<string>",
      "startDate": "2023-12-25",
      "status": "planned"
    }
  ],
  "vendor": "<string>"
}
'

{
  "allTerms": [
    {
      "amount": 123,
      "completedAt": "<string>",
      "endDate": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payments": [
        {
          "amount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "paymentDate": "<string>"
        }
      ],
      "startDate": "<string>",
      "status": "<string>",
      "totalPaid": 123
    }
  ],
  "assets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "category": "<string>",
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies": [
    {
      "category": {
        "color": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "description": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "logo": "<string>",
      "name": "<string>"
    }
  ],
  "contractNumber": 123,
  "contractStatus": "pending",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "currentTerm": {
    "amount": 123,
    "completedAt": "<string>",
    "endDate": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "<string>",
    "status": "<string>"
  },
  "description": "<string>",
  "fieldsById": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "nextPayment": {
    "amount": 123,
    "paymentDate": "<string>"
  },
  "previousTerm": {
    "amount": 123,
    "completedAt": "<string>",
    "endDate": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "<string>",
    "status": "<string>"
  },
  "renewalTerm": {
    "amount": 123,
    "completedAt": "<string>",
    "endDate": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "<string>",
    "status": "<string>"
  },
  "tags": [
    {
      "description": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idstringrequired

Body

categoryIdstring | null

companyIdstring | null

customFieldsobject

Custom field values keyed by custom field id, for example { "<customFieldId>": "value" }. An existing value is overwritten (null clears it), and a value is only created when content is non-empty

descriptionstring | null

namestring

Minimum string length: 1

termsobject[]

Required array length: 1 - 100

Show child attributes

vendorstring

Minimum string length: 1

Response

The updated contract

allTermsobject[]required

Show child attributes

assetsobject[]required

Show child attributes

categorystring | nullrequired

categoryIdstring | nullrequired

companiesobject[]required

Show child attributes

contractNumbernumberrequired

contractStatusenum<string>required

Available options: pending, active, renewing_soon, expiring_soon, expired, cancelled, incomplete, planned, not_approved, completed

createdAtstringrequired

createdBystringrequired

currentTermobject | nullrequired

Show child attributes

descriptionstring | nullrequired

fieldsByIdobjectrequired

idstringrequired

namestringrequired

nextPaymentobject | nullrequired

Show child attributes

previousTermobject | nullrequired

Show child attributes

renewalTermobject | nullrequired

Show child attributes

tagsobject[]required

Show child attributes

updatedAtstringrequired

vendorstringrequired

Still need help? Ask the team