{ "openapi": "3.1.0", "info": { "title": "CalcX Loan Calculator API", "version": "Unversioned", "description": "Calculate loan, mortgage and auto payments alongside salary, shift, overtime and fixed-payment schedules.", "x-pricing-model": "payg", "x-free-tier-calls": 0, "x-docs-url": "", "x-dakidarts-contract-status": "published", "x-dakidarts-execution-status": "source-only" }, "servers": [ { "url": "https://api.dakidarts.com/calcx-loan", "description": "Dakidarts direct gateway" } ], "tags": [ { "name": "Operations", "description": "Operations endpoints sourced from the CalcX Loan Calculator API implementation." }, { "name": "Loan and payroll calculators", "description": "Loan and payroll calculators endpoints sourced from the CalcX Loan Calculator API implementation." } ], "paths": { "/status": { "get": { "summary": "Ping", "description": "Returns CalcX Loan service health.", "operationId": "calcx-loan_get_status", "tags": [ "Operations" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "example": { "status": "API is online" } } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true, "x-dakidarts-sample-response": { "status": "API is online" } }, "post": { "summary": "Ping", "description": "Returns CalcX Loan service health.", "operationId": "calcx-loan_post_status", "tags": [ "Operations" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "example": { "status": "API is online" } } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true, "x-dakidarts-sample-response": { "status": "API is online" } } }, "/loan": { "get": { "summary": "Calculate Loan Cost", "description": "Calculates loan payments, interest, and repayment totals.", "operationId": "calcx-loan_get_loan", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "loan", "in": "query", "required": true, "description": "Principal loan amount before interest.", "schema": { "type": "number" } }, { "name": "rate", "in": "query", "required": true, "description": "Annual interest rate as a percentage.", "schema": { "type": "number" } }, { "name": "term", "in": "query", "required": true, "description": "Repayment term in the units expected by this calculator.", "schema": { "type": "integer" } }, { "name": "type", "in": "query", "required": false, "description": "Loan category used to select the repayment calculation.", "schema": { "type": "string", "default": "other", "enum": [ "auto", "personal", "business", "student", "medical", "other" ] } }, { "name": "extra", "in": "query", "required": false, "description": "Optional additional payment amount applied to repayments.", "schema": { "type": "number" } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schedule": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "integer" }, "balance": { "type": "string" }, "payment": { "type": "string" }, "interest": { "type": "string" }, "principal": { "type": "string" } }, "additionalProperties": true } }, "loan_type": { "type": "string" }, "loan_amount": { "type": "string" }, "interest_rate": { "type": "string" }, "loan_interest": { "type": "string" }, "repayment_term": { "type": "string" }, "monthly_payment": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true, "x-dakidarts-sample-response": { "schedule": [ { "period": 1, "balance": "$0.00", "payment": "$1010.00", "interest": "$10.00", "principal": "$1000.00" } ], "loan_type": "personal", "loan_amount": "$1000.00", "interest_rate": "12.00%", "loan_interest": "$10.00", "repayment_term": "1 months", "monthly_payment": "$1010.00" } } }, "/loan/post": { "post": { "summary": "Calculate Loan Cost Post", "description": "Calculates a loan from JSON request data.", "operationId": "calcx-loan_post_loan_post", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schedule": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "integer" }, "balance": { "type": "string" }, "payment": { "type": "string" }, "interest": { "type": "string" }, "principal": { "type": "string" } }, "additionalProperties": true } }, "loan_type": { "type": "string" }, "loan_amount": { "type": "string" }, "interest_rate": { "type": "string" }, "loan_interest": { "type": "string" }, "repayment_term": { "type": "string" }, "monthly_payment": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loan": { "type": "number" }, "rate": { "type": "number" }, "term": { "type": "integer" }, "type": { "type": "string", "default": "other", "enum": [ "auto", "personal", "business", "student", "medical", "other" ] }, "extra": { "type": "number" }, "currency": { "type": "string", "default": "USD" } }, "required": [ "loan", "rate", "term" ], "example": { "loan": 25000, "rate": 7.5, "term": 60, "type": "personal", "currency": "USD" } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/loan/batch": { "post": { "summary": "Calculate Loan Costs", "description": "Calculates multiple loan scenarios from one JSON array request.", "operationId": "calcx-loan_post_loan_batch", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "schedule": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "integer" }, "balance": { "type": "string" }, "payment": { "type": "string" }, "interest": { "type": "string" }, "principal": { "type": "string" } }, "additionalProperties": true } }, "loan_type": { "type": "string" }, "loan_amount": { "type": "string" }, "interest_rate": { "type": "string" }, "loan_interest": { "type": "string" }, "repayment_term": { "type": "string" }, "monthly_payment": { "type": "string" } }, "additionalProperties": true } } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "example": [ { "loan": 10000, "rate": 5, "term": 36 } ] } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/mortgage": { "post": { "summary": "Mortgage Calculator", "description": "Estimates mortgage payments and repayment totals with optional down payment and payment frequency.", "operationId": "calcx-loan_post_mortgage", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "loan_amount": { "type": "string" }, "down_payment": { "type": "string" }, "interest_rate": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "loan_term_months": { "type": "integer" }, "amortization_freq": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "frequency": { "type": "string", "default": "monthly" }, "currency": { "type": "string", "default": "USD" }, "amount": { "type": "number" }, "rate": { "type": "number" }, "term_years": { "type": "integer" }, "down_payment": { "type": "integer", "default": 0 } }, "required": [ "amount", "rate", "term_years" ], "example": { "rate": 7.5, "amount": 25000, "currency": "USD", "frequency": "monthly", "term_years": 20, "down_payment": 0 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "get": { "summary": "Mortgage Calculator", "description": "Estimates mortgage payments and repayment totals with optional down payment and payment frequency.", "operationId": "calcx-loan_get_mortgage", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "frequency", "in": "query", "required": false, "description": "Mortgage payment frequency.", "schema": { "type": "string", "default": "monthly" } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } }, { "name": "amount", "in": "query", "required": true, "description": "Amount financed or borrowed.", "schema": { "type": "number" } }, { "name": "rate", "in": "query", "required": true, "description": "Annual interest rate as a percentage.", "schema": { "type": "number" } }, { "name": "term_years", "in": "query", "required": true, "description": "Repayment term in years.", "schema": { "type": "integer" } }, { "name": "down_payment", "in": "query", "required": false, "description": "Amount paid up front, reducing the financed balance.", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "loan_amount": { "type": "string" }, "down_payment": { "type": "string" }, "interest_rate": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "loan_term_months": { "type": "integer" }, "amortization_freq": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/auto": { "post": { "summary": "Auto Loan Calculator", "description": "Calculates vehicle-financing payments including fees, taxes, trade-in value, and down payment.", "operationId": "calcx-loan_post_auto", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sales_tax": { "type": "string" }, "loan_amount": { "type": "string" }, "term_months": { "type": "integer" }, "upfront_pay": { "type": "string" }, "interest_rate": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "total_loan_cost": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } }, "total_monthly_payments": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "price": { "type": "number" }, "term_months": { "type": "integer" }, "rate": { "type": "number" }, "discount": { "type": "integer", "default": 0 }, "sales_tax_rate": { "type": "integer", "default": 0 }, "down_payment": { "type": "integer", "default": 0 }, "other_fees": { "type": "integer", "default": 0 }, "trade_in_value": { "type": "integer", "default": 0 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "price", "rate", "term_months" ], "example": { "rate": 7.5, "price": 28000, "currency": "USD", "discount": 0, "other_fees": 0, "term_months": 60, "down_payment": 0, "sales_tax_rate": 0, "trade_in_value": 0 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "get": { "summary": "Auto Loan Calculator", "description": "Calculates vehicle-financing payments including fees, taxes, trade-in value, and down payment.", "operationId": "calcx-loan_get_auto", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "price", "in": "query", "required": true, "description": "Vehicle purchase price before incentives and fees.", "schema": { "type": "number" } }, { "name": "term_months", "in": "query", "required": true, "description": "Repayment term in months.", "schema": { "type": "integer" } }, { "name": "rate", "in": "query", "required": true, "description": "Annual interest rate as a percentage.", "schema": { "type": "number" } }, { "name": "discount", "in": "query", "required": false, "description": "Cash incentive or discount deducted from the vehicle price.", "schema": { "type": "integer", "default": 0 } }, { "name": "sales_tax_rate", "in": "query", "required": false, "description": "Sales-tax rate as a percentage.", "schema": { "type": "integer", "default": 0 } }, { "name": "down_payment", "in": "query", "required": false, "description": "Amount paid up front, reducing the financed balance.", "schema": { "type": "integer", "default": 0 } }, { "name": "other_fees", "in": "query", "required": false, "description": "Additional fees included in the financed amount.", "schema": { "type": "integer", "default": 0 } }, { "name": "trade_in_value", "in": "query", "required": false, "description": "Trade-in value deducted from the financed amount.", "schema": { "type": "integer", "default": 0 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sales_tax": { "type": "string" }, "loan_amount": { "type": "string" }, "term_months": { "type": "integer" }, "upfront_pay": { "type": "string" }, "interest_rate": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "total_loan_cost": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } }, "total_monthly_payments": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/fixed-term": { "post": { "summary": "Fix Term Loan Calculator", "description": "Calculates payments and total interest for a fixed-term loan.", "operationId": "calcx-loan_post_fixed-term", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "term_years": { "type": "integer" }, "loan_amount": { "type": "string" }, "interest_rate": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number" }, "term_years": { "type": "integer" }, "rate": { "type": "number" }, "currency": { "type": "string", "default": "USD" } }, "required": [ "amount", "rate", "term_years" ], "example": { "rate": 7.5, "amount": 25000, "currency": "USD", "term_years": 20 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "get": { "summary": "Fix Term Loan Calculator", "description": "Calculates payments and total interest for a fixed-term loan.", "operationId": "calcx-loan_get_fixed-term", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "amount", "in": "query", "required": true, "description": "Amount financed or borrowed.", "schema": { "type": "number" } }, { "name": "term_years", "in": "query", "required": true, "description": "Repayment term in years.", "schema": { "type": "integer" } }, { "name": "rate", "in": "query", "required": true, "description": "Annual interest rate as a percentage.", "schema": { "type": "number" } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "term_years": { "type": "integer" }, "loan_amount": { "type": "string" }, "interest_rate": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/fixed-payment": { "post": { "summary": "Fixed Payment Calculator", "description": "Estimates payoff time and interest for a loan with a fixed monthly payment.", "operationId": "calcx-loan_post_fixed-payment", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "loan_amount": { "type": "string" }, "term_months": { "type": "integer" }, "interest_rate": { "type": "string" }, "loan_duration": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "total_principal": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number" }, "monthly_payment": { "type": "number" }, "rate": { "type": "number" }, "currency": { "type": "string", "default": "USD" } }, "required": [ "amount", "monthly_payment", "rate" ], "example": { "rate": 7.5, "amount": 25000, "currency": "USD", "monthly_payment": 500 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "get": { "summary": "Fixed Payment Calculator", "description": "Estimates payoff time and interest for a loan with a fixed monthly payment.", "operationId": "calcx-loan_get_fixed-payment", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "amount", "in": "query", "required": true, "description": "Amount financed or borrowed.", "schema": { "type": "number" } }, { "name": "monthly_payment", "in": "query", "required": true, "description": "Fixed monthly payment amount.", "schema": { "type": "number" } }, { "name": "rate", "in": "query", "required": true, "description": "Annual interest rate as a percentage.", "schema": { "type": "number" } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "loan_amount": { "type": "string" }, "term_months": { "type": "integer" }, "interest_rate": { "type": "string" }, "loan_duration": { "type": "string" }, "total_payment": { "type": "string" }, "total_interest": { "type": "string" }, "monthly_payment": { "type": "string" }, "total_principal": { "type": "string" }, "amortization_schedule": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "integer" }, "payment": { "type": "string" }, "interest_payment": { "type": "string" }, "principal_payment": { "type": "string" }, "remaining_balance": { "type": "string" } }, "additionalProperties": true } } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/salary": { "get": { "summary": "Salary Calculator", "description": "Converts salary across hourly, daily, weekly, monthly, and annual pay periods.", "operationId": "calcx-loan_get_salary", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Pay period represented by `salary` (for example, hourly, weekly, or annual).", "schema": { "type": "string", "default": "hour" } }, { "name": "salary", "in": "query", "required": false, "description": "Pay amount for the selected pay period.", "schema": { "type": "number", "default": 0 } }, { "name": "hours_per_week", "in": "query", "required": false, "description": "Hours worked per week.", "schema": { "type": "number", "default": 0 } }, { "name": "days_per_week", "in": "query", "required": false, "description": "Days worked per week.", "schema": { "type": "number", "default": 0 } }, { "name": "holidays_per_year", "in": "query", "required": false, "description": "Paid or unpaid holiday days per year used in annualization.", "schema": { "type": "number", "default": 0 } }, { "name": "vacation_per_year", "in": "query", "required": false, "description": "Vacation days per year used in annualization.", "schema": { "type": "number", "default": 0 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Salary": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "hourly": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" }, "bi_weekly": { "type": "string" }, "quarterly": { "type": "string" }, "semi_monthly": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Salary Calculator", "description": "Converts salary across hourly, daily, weekly, monthly, and annual pay periods.", "operationId": "calcx-loan_post_salary", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "Salary": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "hourly": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" }, "bi_weekly": { "type": "string" }, "quarterly": { "type": "string" }, "semi_monthly": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string", "default": "hour" }, "hours_per_week": { "type": "number", "default": 0 }, "days_per_week": { "type": "number", "default": 0 }, "holidays_per_year": { "type": "number", "default": 0 }, "vacation_per_year": { "type": "number", "default": 0 }, "currency": { "type": "string", "default": "USD" }, "salary": { "type": "number", "example": "example" } }, "required": [ "days_per_week", "holidays_per_year", "hours_per_week", "period", "salary", "vacation_per_year" ], "example": { "period": "hour", "salary": 25, "currency": "USD", "days_per_week": 5, "hours_per_week": 40, "holidays_per_year": 10, "vacation_per_year": 15 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/shift-pay": { "get": { "summary": "Pay Calculator", "description": "Estimates shift earnings, including regular and overtime pay.", "operationId": "calcx-loan_get_shift-pay", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "hourly_wage", "in": "query", "required": true, "description": "Base hourly wage.", "schema": { "type": "number" } }, { "name": "overtime_hourly_wage", "in": "query", "required": true, "description": "Hourly wage paid for overtime work.", "schema": { "type": "number" } }, { "name": "hours_worked", "in": "query", "required": false, "description": "Hours worked in the shift or pay period.", "schema": { "type": "number", "default": 8 } }, { "name": "work_weeks_per_year", "in": "query", "required": false, "description": "Number of working weeks per year.", "schema": { "type": "number", "default": 52 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_per_day": { "type": "string" }, "pay_per_week": { "type": "string" }, "pay_per_year": { "type": "string" }, "pay_per_month": { "type": "string" }, "overtime_hours": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" } }, "additionalProperties": true }, "average_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Pay Calculator", "description": "Estimates shift earnings, including regular and overtime pay.", "operationId": "calcx-loan_post_shift-pay", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_per_day": { "type": "string" }, "pay_per_week": { "type": "string" }, "pay_per_year": { "type": "string" }, "pay_per_month": { "type": "string" }, "overtime_hours": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" } }, "additionalProperties": true }, "average_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hourly_wage": { "type": "number" }, "overtime_hourly_wage": { "type": "number" }, "hours_worked": { "type": "number", "default": 8 }, "work_weeks_per_year": { "type": "number", "default": 52 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "hourly_wage", "hours_worked", "overtime_hourly_wage" ], "example": { "currency": "USD", "hourly_wage": 25, "hours_worked": 8, "work_weeks_per_year": 52, "overtime_hourly_wage": 37.5 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/shift-pay/custom": { "get": { "summary": "Custom Shift Pay Calculator", "description": "Estimates shift earnings with configurable shift and work-week assumptions.", "operationId": "calcx-loan_get_shift-pay_custom", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "hourly_wage", "in": "query", "required": true, "description": "Base hourly wage.", "schema": { "type": "number" } }, { "name": "overtime_hourly_wage", "in": "query", "required": true, "description": "Hourly wage paid for overtime work.", "schema": { "type": "number" } }, { "name": "hours_worked", "in": "query", "required": false, "description": "Hours worked in the shift or pay period.", "schema": { "type": "number", "default": 8 } }, { "name": "shift_hours", "in": "query", "required": false, "description": "Scheduled hours in each shift.", "schema": { "type": "number", "default": 12 } }, { "name": "work_days_per_week", "in": "query", "required": false, "description": "Number of work days per week.", "schema": { "type": "number", "default": 5 } }, { "name": "work_weeks_per_year", "in": "query", "required": false, "description": "Number of working weeks per year.", "schema": { "type": "number", "default": 52 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_per_day": { "type": "string" }, "pay_per_week": { "type": "string" }, "pay_per_year": { "type": "string" }, "pay_per_month": { "type": "string" }, "overtime_hours": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" } }, "additionalProperties": true }, "average_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Custom Shift Pay Calculator", "description": "Estimates shift earnings with configurable shift and work-week assumptions.", "operationId": "calcx-loan_post_shift-pay_custom", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_per_day": { "type": "string" }, "pay_per_week": { "type": "string" }, "pay_per_year": { "type": "string" }, "pay_per_month": { "type": "string" }, "overtime_hours": { "type": "object", "properties": { "daily": { "type": "string" }, "annual": { "type": "string" }, "weekly": { "type": "string" }, "monthly": { "type": "string" } }, "additionalProperties": true }, "average_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hourly_wage": { "type": "number" }, "overtime_hourly_wage": { "type": "number" }, "hours_worked": { "type": "number", "default": 8 }, "shift_hours": { "type": "number", "default": 12 }, "work_days_per_week": { "type": "number", "default": 5 }, "work_weeks_per_year": { "type": "number", "default": 52 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "hourly_wage", "hours_worked", "overtime_hourly_wage" ], "example": { "currency": "USD", "hourly_wage": 25, "shift_hours": 12, "hours_worked": 8, "work_days_per_week": 5, "work_weeks_per_year": 52, "overtime_hourly_wage": 37.5 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/shift-finish-time": { "get": { "summary": "Shift Finish Time Calculator", "description": "Calculates shift finish time from start, duration, and break.", "operationId": "calcx-loan_get_shift-finish-time", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "duration", "in": "query", "required": true, "description": "Scheduled shift duration in hours.", "schema": { "type": "number" } }, { "name": "break_duration", "in": "query", "required": true, "description": "Break duration in minutes added after the scheduled shift.", "schema": { "type": "number" } }, { "name": "start_time", "in": "query", "required": true, "description": "Shift start time in the format expected by the endpoint.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "finish_time_12hr": { "type": "string" }, "finish_time_24hr": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Shift Finish Time Calculator", "description": "Calculates shift finish time from start, duration, and break.", "operationId": "calcx-loan_post_shift-finish-time", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "finish_time_12hr": { "type": "string" }, "finish_time_24hr": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "duration": { "type": "number" }, "break_duration": { "type": "number" }, "start_time": { "type": "string" } }, "required": [ "break_duration", "duration", "start_time" ], "example": { "duration": 8, "start_time": "08:00 AM", "break_duration": 30 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/overtime-month": { "get": { "summary": "Overtime Calculator", "description": "Calculates monthly pay including overtime hours.", "operationId": "calcx-loan_get_overtime-month", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "hourly_wage", "in": "query", "required": true, "description": "Base hourly wage.", "schema": { "type": "number" } }, { "name": "regular_hours", "in": "query", "required": true, "description": "Hours paid at the standard rate.", "schema": { "type": "number" } }, { "name": "overtime_multiplier", "in": "query", "required": false, "description": "Multiplier applied to the standard wage for overtime.", "schema": { "type": "number", "default": 1.5 } }, { "name": "overtime_hours", "in": "query", "required": false, "description": "Hours paid at the overtime rate.", "schema": { "type": "number", "default": 0 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_monthly_pay": { "type": "string" }, "monthly_regular_pay": { "type": "string" }, "monthly_overtime_pay": { "type": "string" }, "overtime_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Overtime Calculator", "description": "Calculates monthly pay including overtime hours.", "operationId": "calcx-loan_post_overtime-month", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_monthly_pay": { "type": "string" }, "monthly_regular_pay": { "type": "string" }, "monthly_overtime_pay": { "type": "string" }, "overtime_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hourly_wage": { "type": "number" }, "regular_hours": { "type": "number" }, "overtime_multiplier": { "type": "number", "default": 1.5 }, "overtime_hours": { "type": "number", "default": 0 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "hourly_wage", "regular_hours" ], "example": { "currency": "USD", "hourly_wage": 25, "regular_hours": 160, "overtime_hours": 10, "overtime_multiplier": 1.5 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/overtime-week": { "get": { "summary": "Week Overtime Calculator", "description": "Calculates weekly pay including overtime hours.", "operationId": "calcx-loan_get_overtime-week", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "hourly_wage", "in": "query", "required": true, "description": "Base hourly wage.", "schema": { "type": "number" } }, { "name": "regular_hours", "in": "query", "required": true, "description": "Hours paid at the standard rate.", "schema": { "type": "number" } }, { "name": "overtime_multiplier", "in": "query", "required": false, "description": "Multiplier applied to the standard wage for overtime.", "schema": { "type": "number", "default": 1.5 } }, { "name": "overtime_hours", "in": "query", "required": false, "description": "Hours paid at the overtime rate.", "schema": { "type": "number", "default": 0 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_weekly_pay": { "type": "string" }, "weekly_regular_pay": { "type": "string" }, "weekly_overtime_pay": { "type": "string" }, "overtime_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Week Overtime Calculator", "description": "Calculates weekly pay including overtime hours.", "operationId": "calcx-loan_post_overtime-week", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_weekly_pay": { "type": "string" }, "weekly_regular_pay": { "type": "string" }, "weekly_overtime_pay": { "type": "string" }, "overtime_pay_per_hour": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hourly_wage": { "type": "number" }, "regular_hours": { "type": "number" }, "overtime_multiplier": { "type": "number", "default": 1.5 }, "overtime_hours": { "type": "number", "default": 0 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "hourly_wage", "regular_hours" ], "example": { "currency": "USD", "hourly_wage": 25, "regular_hours": 40, "overtime_hours": 5, "overtime_multiplier": 1.5 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } }, "/time-half": { "get": { "summary": "Time Half Week Overtime Calculator", "description": "Calculates pay across standard, time-and-a-half, double-time, and triple-time hours.", "operationId": "calcx-loan_get_time-half", "tags": [ "Loan and payroll calculators" ], "parameters": [ { "name": "standard_rate", "in": "query", "required": true, "description": "Standard hourly pay rate.", "schema": { "type": "number" } }, { "name": "regular_hours", "in": "query", "required": true, "description": "Hours paid at the standard rate.", "schema": { "type": "number" } }, { "name": "hours_time_half", "in": "query", "required": false, "description": "Hours paid at one-and-a-half times the standard rate.", "schema": { "type": "number", "default": 0 } }, { "name": "hours_double", "in": "query", "required": false, "description": "Hours paid at twice the standard rate.", "schema": { "type": "number", "default": 0 } }, { "name": "hours_triple", "in": "query", "required": false, "description": "Hours paid at three times the standard rate.", "schema": { "type": "number", "default": 0 } }, { "name": "currency", "in": "query", "required": false, "description": "ISO currency code for the amounts in the request and response.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_rates": { "type": "object", "properties": { "double": { "type": "string" }, "triple": { "type": "string" }, "standard": { "type": "string" }, "time_half": { "type": "string" } }, "additionalProperties": true }, "total_double": { "type": "string" }, "total_triple": { "type": "string" }, "total_time_half": { "type": "string" }, "total_regular_pay": { "type": "string" }, "total_amount_earned": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true }, "post": { "summary": "Time Half Week Overtime Calculator", "description": "Calculates pay across standard, time-and-a-half, double-time, and triple-time hours.", "operationId": "calcx-loan_post_time-half", "tags": [ "Loan and payroll calculators" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pay_rates": { "type": "object", "properties": { "double": { "type": "string" }, "triple": { "type": "string" }, "standard": { "type": "string" }, "time_half": { "type": "string" } }, "additionalProperties": true }, "total_double": { "type": "string" }, "total_triple": { "type": "string" }, "total_time_half": { "type": "string" }, "total_regular_pay": { "type": "string" }, "total_amount_earned": { "type": "string" } }, "additionalProperties": true } } } }, "4XX": { "description": "Client error" }, "5XX": { "description": "Upstream or gateway error" }, "503": { "description": "No live upstream is configured. Sample responses are preview-only." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "standard_rate": { "type": "number" }, "regular_hours": { "type": "number" }, "hours_time_half": { "type": "number", "default": 0 }, "hours_double": { "type": "number", "default": 0 }, "hours_triple": { "type": "number", "default": 0 }, "currency": { "type": "string", "default": "USD" } }, "required": [ "hours_time_half", "regular_hours", "standard_rate" ], "example": { "currency": "USD", "hours_double": 0, "hours_triple": 0, "regular_hours": 40, "standard_rate": 25, "hours_time_half": 2 } } } } }, "x-dakidarts-execution-status": "source-only", "x-dakidarts-source-contract": true } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" } } }, "security": [ { "ApiKeyAuth": [] } ] }