Get an income

GET /api/v2/income/{uuid}

Headers

Path parameters

uuid integer Required

Responses

200 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.
- name string
  
  The name of the income.
- type string
  
  The type of income.
- amount object
  
  The amount of the income.
  
  Additional properties are allowed.
- amount_type string
  
  The type of the amount.
- start_date string
  
  The start date of the income.
- end_date string
  
  The end date of the income.
- frequency string
  
  The frequency of the income.
- is_taxable boolean
  
  Denotes if the income is taxable or not.
- employment object
  
  Employment of this income.
  
  Additional properties are allowed.
- account object
  
  Account that owns this income.
  
  Additional properties are allowed.

GET /api/v2/income/{uuid}

curl \
 -X GET https://api.plannrcrm.com/api/v2/income/uuid \
 -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}"

Response examples (200)

{
  "name": "My Salary",
  "type": "salary",
  "uuid": "54b089e2-e7d1-4151-8dfd-a1cfe6c97329",
  "amount": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    }
  },
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "38836925-c2db-4d0e-a1e3-d742b678f6e4",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-01-17T11:18:33+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:33+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "end_date": "2025-01-17",
  "frequency": "annually",
  "created_at": "2025-01-17T11:18:33+00:00",
  "employment": {
    "uuid": "d987c090-0326-4d1a-b38f-e5ea62979670",
    "income": "App\\Http\\Resources\\IncomeResource",
    "profit": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "status": "employed",
    "address": "App\\Http\\Resources\\AddressResource",
    "employer": "Plannr Technologies Ltd",
    "ended_at": "2021-01-17T11:18:33+00:00",
    "directors": "Susan F. Lancaster",
    "job_title": "Senior financial adviser",
    "created_at": "2025-01-17T11:18:33+00:00",
    "occupation": "Financial Adviser",
    "started_at": "2020-01-17T11:18:33+00:00",
    "updated_at": "2025-01-17T11:18:33+00:00",
    "phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "shared_owner": "App\\Http\\Resources\\AccountResource",
    "business_name": "My Business",
    "email_address": "App\\Http\\Resources\\ContactDetailResource",
    "business_value": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "occupation_code": "FAC02774",
    "accountant_email": "accountant@email.com",
    "turnover_history": "App\\Http\\Resources\\TurnoverHistoryResource",
    "business_year_end": "2020-12-31",
    "is_business_owner": true,
    "shared_owner_type": "individual",
    "accountant_address": "23 Chollerton, Hexham, Northumberland, NE46 4TF",
    "last_salary_increase": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "accountant_company_name": "My Accountant",
    "shareholding_in_business": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "accountant_telephone_number": "+441234567890",
    "percentage_of_business_shared": 50
  },
  "is_taxable": true,
  "start_date": "2024-01-17",
  "updated_at": "2025-01-17T11:18:33+00:00",
  "amount_type": "net"
}