--- updatedAt: 2026-07-13T07:05:39.000Z agentTools: projectIndex: https://docs.getsmileapi.com/llms.txt --- # View Income View the user's income by ID. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Smile API", "version": "1.14.0", "description": "The Smile API provides employment and income data from a single API. ", "contact": { "name": "Smile Technology Pte Ltd", "url": "https://www.getsmileapi.com", "email": "info@getsmileapi.com" }, "termsOfService": "https://www.getsmileapi.com/terms-and-conditions" }, "servers": [ { "url": "https://sandbox.smileapi.io/v1", "description": "Sandbox" }, { "url": "https://open.smileapi.io/v1", "description": "Production" } ], "paths": { "/incomes/{id}": { "get": { "summary": "View Income", "tags": [ "Incomes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomeGetResponse" }, "examples": { "Example": { "value": { "code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": { "id": "inc-17bbf36498de4d68a0d4f86c7b62f69f", "workItem": null, "employer": "ABC Corporation", "startDate": "2021-06-01", "endDate": "2021-06-15", "paymentMethod": "Cash", "currency": "PHP", "frequency": "Monthly", "baseAmount": 8500, "grossAmount": 10000, "netAmount": 7820.25, "metadata": { "createdAt": "2021-06-14T09:30:24Z", "sourceId": "a-17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp" } } } } } } } } }, "operationId": "get-income", "description": "View the user's income by ID.", "parameters": [] }, "parameters": [ { "$ref": "#/components/parameters/id" } ] } }, "components": { "schemas": { "ObjectMetadataRefCode": { "type": "string", "title": "ObjectMetadataRefCode", "description": "Request status code", "enum": [ "OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED" ], "example": "OK", "x-internal": false }, "ObjectMetadataRefMessage": { "type": "string", "title": "ObjectMetadataRefMessage", "description": "Message response to the request", "example": "Success", "x-internal": false }, "ObjectMetadataRefRequestID": { "type": "string", "title": "ObjectMetadataRefRequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false, "example": "5b79399a-6852-4234-bb0e-ad472648282d" }, "RefObjectID": { "type": "string", "title": "Object ID", "description": "Unique ID of this object", "example": "17bbf36498de4d68a0d4f86c7b62f69f" }, "RefDateTime": { "type": "string", "title": "Date and Time string", "format": "date-time", "example": "2021-04-14T09:30:24Z", "description": "Date and time" }, "RefEmployer": { "type": "string", "title": "Employer", "nullable": true, "description": "Employer name", "example": "ABC Corporation" }, "RefCurrency": { "type": "string", "title": "Currency ISO Codes", "description": "Currency in 3 character alpha ISO 4217", "enum": [ "AFN", "DZD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "THB", "PAB", "BBD", "BYN", "BZD", "BMD", "VES", "BOB", "BRL", "BND", "BGN", "BIF", "CAD", "CVE", "KYD", "GHS", "XOF", "XAF", "XPF", "CLP", "COP", "KMF", "CDF", "BAM", "NIO", "CRC", "HRK", "CZK", "GMD", "DKK", "MKD", "DJF", "STD", "DOP", "VND", "XCD", "EGP", "SVC", "ETB", "EUR", "FKP", "FJD", "HUF", "GIP", "HTG", "PYG", "GNF", "GYD", "HKD", "UAH", "ISK", "INR", "IRR", "IQD", "JMD", "JOD", "KES", "PGK", "LAK", "EEK", "KWD", "MWK", "AOA", "MMK", "GEL", "LVL", "LBP", "ALL", "HNL", "SLL", "LRD", "LYD", "SZL", "LTL", "LSL", "MGA", "MYR", "TMT", "MUR", "MZN", "MXN", "MDL", "MAD", "NGN", "ERN", "NAD", "NPR", "ANG", "ILS", "RON", "TWD", "NZD", "BTN", "KPW", "NOK", "PEN", "MRO", "TOP", "PKR", "MOP", "UYU", "PHP", "GBP", "BWP", "QAR", "GTQ", "ZAR", "OMR", "KHR", "MVR", "IDR", "RUB", "RWF", "SHP", "SAR", "RSD", "SCR", "SGD", "SBD", "KGS", "SOS", "TJS", "LKR", "SDG", "SRD", "SEK", "CHF", "SYP", "BDT", "WST", "TZS", "KZT", "TTD", "MNT", "TND", "TRY", "AED", "UGX", "CLF", "USD", "UZS", "VUV", "KRW", "YER", "JPY", "CNY", "ZMW", "ZWL", "PLN" ], "example": "PHP" }, "RefPayPeriod": { "type": "string", "nullable": true, "title": "Pay Period", "description": "Pay period", "enum": [ "Hourly", "Daily", "Weekly", "Semimonthly", "Monthly", "Bimonthly", "Quarterly", "Annually", "Variable", "Unspecified", null ], "example": "Annually" }, "IncomePayload": { "type": "object", "required": [ "id", "startDate", "currency" ], "properties": { "id": { "$ref": "#/components/schemas/RefObjectID" }, "workItem": { "type": "string", "description": "Work performed (specially in the case of contract or freelance jobs)", "nullable": true }, "employer": { "$ref": "#/components/schemas/RefEmployer" }, "startDate": { "type": "string", "description": "Start date", "format": "date", "example": "2021-06-01" }, "endDate": { "type": "string", "example": "2021-06-15", "format": "date", "description": "End date", "nullable": true }, "currency": { "$ref": "#/components/schemas/RefCurrency" }, "frequency": { "$ref": "#/components/schemas/RefPayPeriod" }, "baseAmount": { "type": "number", "description": "Base amount", "nullable": true }, "grossAmount": { "type": "number", "description": "Gross amount", "nullable": true }, "netAmount": { "type": "number", "description": "Net amount", "nullable": true } } }, "RefSourceType": { "type": "string", "nullable": true, "title": "Ref-Source-Type", "example": "Account", "enum": [ "ACCOUNT", "UPLOAD", "ARCHIVE", "SOCIAL_SECURITY" ], "description": "Source Type" }, "ObjectReferenceMetadata": { "title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "properties": { "itemCreatedAt": { "$ref": "#/components/schemas/RefDateTime" }, "createdAt": { "$ref": "#/components/schemas/RefDateTime" }, "accountId": { "type": "string", "deprecated": true, "description": "The accountId of this object" }, "sourceId": { "type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object" }, "sourceType": { "$ref": "#/components/schemas/RefSourceType" }, "userId": { "type": "string", "description": "The user ID associated with this object" }, "providerId": { "type": "string", "description": "The provider ID associated with this object" } }, "required": [ "createdAt", "itemCreatedAt", "sourceId", "sourceType", "userId", "providerId" ] }, "Income": { "title": "Income", "type": "object", "description": "The stored income information of the user from an employment data provider.", "x-examples": { "Example": { "id": "inc-17bbf36498de4d68a0d4f86c7b62f69f", "workItem": null, "employer": "ABC Corporation", "startDate": "2021-06-01", "endDate": "2021-06-15", "currency": "PHP", "frequency": "Monthly", "baseAmount": 8500, "grossAmount": 10000, "netAmount": 7820.25, "metadata": { "createdAt": "2021-06-14T09:30:24Z", "sourceId": "a-17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "user-provided" } } }, "x-internal": false, "x-tags": [ "Incomes" ], "allOf": [ { "$ref": "#/components/schemas/IncomePayload" }, { "properties": { "metadata": { "$ref": "#/components/schemas/ObjectReferenceMetadata" } } } ], "required": [ "id", "startDate", "currency", "metadata" ] }, "IncomeGetResponse": { "title": "Income Get Response", "type": "object", "properties": { "code": { "$ref": "#/components/schemas/ObjectMetadataRefCode" }, "message": { "$ref": "#/components/schemas/ObjectMetadataRefMessage" }, "requestId": { "$ref": "#/components/schemas/ObjectMetadataRefRequestID" }, "data": { "$ref": "#/components/schemas/Income" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "parameters": { "id": { "name": "id", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "ID of the specific object in the collection.", "required": true } } }, "security": [ { "basicAuth": [] } ] } ```