Create claim for a plan

POST /api/v1/plans/{plan_uuid}/claim

Headers

Path parameters

plan_uuid string Required

application/json

Body Required

client_uuid string

Client who is claiming this cover. Must be able to access this plan.
claim_amount integer Required

Claim amount in pennies.
claim_start_date date Required

Claim start date
claim_end_date date

Claim end date
claim_notes date

Claim notes

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- claim_amount object
  
  Claim amount
  
  Additional properties are allowed.
- claim_start_date string
  
  Claim start date
- claim_end_date string
  
  Claim end date
- claim_notes string
  
  Claim notes
- client object
  
  Client this claim is for
  
  Additional properties are allowed.

POST /api/v1/plans/{plan_uuid}/claim

curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/claim \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"client_uuid":"ed05b9d6-29a6-4507-9525-136d463167a7","claim_amount":892176,"claim_start_date":"2023-11-20 13:24:03","claim_end_date":"2029-11-20 13:24:03","claim_notes":"Claim notes"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "client_uuid": "ed05b9d6-29a6-4507-9525-136d463167a7",
  "claim_amount": 892176,
  "claim_start_date": "2023-11-20 13:24:03",
  "claim_end_date": "2029-11-20 13:24:03",
  "claim_notes": "Claim notes"
}

Response examples (201)

{
  "uuid": "0f7cf0a6-2bcb-4e13-908e-ba319c931ab1",
  "client": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5b5ddcf9-e2fe-4976-84ce-482a1feef2aa",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-11-20T13:24:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:03+00:00"
  },
  "created_at": "2024-11-20T13:24:03+00:00",
  "updated_at": "2024-11-20T13:24:03+00:00",
  "claim_notes": "Claim notes",
  "claim_amount": {
    "amount": {
      "example": "25000000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£250,000.00",
      "description": "Money amount formatted with currency"
    }
  },
  "claim_end_date": "2029-11-20",
  "claim_start_date": "2023-11-20"
}