contracts

Get a contract

Returns a single contract by id, including all of its terms.

GET

/v1/contracts/{id}

Get a contract

curl --request GET \
  --url https://api.beamdynamics.io/v1/contracts/{id} \
  --header 'beam-api-key: <api-key>'

{
  "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

Response

The 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