AlayaCare · Schema
AlayaCare Accounting API Schemas
Home CareCommunity CareHealthcareSchedulingClinicalBillingClient ManagementCare ManagementAged CareWorkforce Management
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AlayaCare Accounting API Schemas",
"definitions": {
"InvoicingModelField": {
"type": "string",
"description": "Invoicing Model used by the Funder\n\n* batched -> All Client Visits roll up to 1 Invoice for the Payor\n* funder_individual -> One Invoice per Client is sent to the Payor\n* individual_invoices -> One Invoice per Client is sent to the Client or Billing Contact\n* hcp -> invoicing_model specific for Australian Home Care Packages program\n* mecicaid -> Each Date of Service or Visit creates 1 Invoice\n* ccac -> CHRIS/HPG/LHIN invoicing model - Each Visit creates 1 Invoice.\n All Invoices for 1 payor are batched into 1 submission to the payor\n",
"enum": [
"batched",
"funder_individual",
"individual_invoices",
"ccac",
"medicaid",
"hcp",
"ndis"
]
},
"FunderTypeField": {
"type": "string",
"description": "Provided for backwards compatibility, equivalent to `invoicing_model`\nbut mapping different values\n\nThe following three mappings are different:\n* client_individual -> individual_invoices\n* electronic_billing -> medicaid\n* funder_batched -> batched\n\nThe following mappings remain the same:\n* funder_individual\n* ccac\n* hcp\n",
"enum": [
"funder_individual",
"client_individual",
"electronic_billing",
"funder_batched",
"ccac",
"hcp"
]
},
"FunderCreateSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/FunderCommonCreateSchema"
},
{
"$ref": "#/components/schemas/FunderElectronicBillingCreateSchema"
},
{
"$ref": "#/components/schemas/FunderHcpCreateSchema"
},
{
"$ref": "#/components/schemas/FunderCcacCreateSchema"
}
]
},
"FunderUpdateSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/FunderCommonUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderElectronicBillingUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderHcpUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderCcacUpdateSchema"
}
]
},
"FunderBaseCreateSchema": {
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseUpdateSchema"
},
{
"type": "object",
"properties": {
"branch_id": {
"type": "integer",
"description": "The ID of the branch to which this funder belongs",
"example": 1,
"minimum": 1
}
}
}
]
},
"FunderBaseUpdateSchema": {
"type": "object",
"description": "Fields shared by create requests for all invoicing_model types",
"properties": {
"code": {
"type": "string",
"example": "Code"
},
"description": {
"type": "string",
"example": "Description"
},
"gl_asset": {
"$ref": "#/components/schemas/LinkedEntitySchema"
},
"gl_bank": {
"$ref": "#/components/schemas/LinkedEntitySchema"
},
"holiday_multiplier": {
"type": "number",
"example": "1.00"
},
"invoicing_model": {
"$ref": "#/components/schemas/InvoicingModelField"
},
"name": {
"type": "string",
"example": "Name"
},
"profile": {
"$ref": "#/components/schemas/ProfileSchema"
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunderTaxesItemSchema"
}
},
"gl_receivables_cost_centre": {
"$ref": "#/components/schemas/CostCentreSchema"
},
"gl_bank_cost_centre": {
"$ref": "#/components/schemas/CostCentreSchema"
},
"line_item_limit": {
"type": "number",
"example": 76
}
}
},
"FunderCommonUpdateFieldsSchema": {
"type": "object",
"properties": {
"allow_paypal_payment": {
"type": "boolean",
"example": false
},
"agency_profile": {
"type": "string",
"example": "Agency profile"
},
"billing_contact": {
"type": "string",
"example": "Billing contact"
},
"billing_adjustment_period": {
"type": "integer",
"example": 30
},
"organization_name": {
"type": "string",
"example": "Organization name"
},
"organization_code": {
"type": "string",
"example": "Organization code"
},
"billing_frequency": {
"type": "string",
"example": "weekly",
"enum": [
"no_frequency",
"weekly",
"calendar_month"
]
}
}
},
"FunderCommonCreateSchema": {
"description": "Update requests for 'batched', 'funder_individual' and 'individual_invoices' invoicing model types",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseCreateSchema"
},
{
"$ref": "#/components/schemas/FunderCommonUpdateFieldsSchema"
}
]
},
"FunderCommonUpdateSchema": {
"description": "Update requests for 'batched', 'funder_individual' and 'individual_invoices' invoicing model types",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderCommonUpdateFieldsSchema"
}
]
},
"FunderCcacUpdateFieldsSchema": {
"type": "object",
"properties": {
"ccac_code": {
"type": "string",
"example": "GT"
},
"ccac_name": {
"type": "string",
"example": "Central CCAC"
},
"organization_code": {
"type": "string",
"example": "org_code"
},
"organization_name": {
"type": "string",
"example": "Green Cross Inc."
},
"billing_frequency": {
"type": "string",
"example": "weekly",
"enum": [
"none",
"weekly",
"calendar_month"
]
},
"file_name_prefix": {
"type": "string",
"example": "GT"
}
}
},
"FunderCcacCreateSchema": {
"description": "Create requests for Funders with 'ccac' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseCreateSchema"
},
{
"$ref": "#/components/schemas/FunderCcacUpdateFieldsSchema"
}
]
},
"FunderCcacUpdateSchema": {
"description": "Create requests for Funders with 'ccac' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderCcacUpdateFieldsSchema"
}
]
},
"FunderElectronicBillingCreateSchema": {
"description": "Create request for Funder with 'medicaid' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseCreateSchema"
},
{
"$ref": "#/components/schemas/FunderElectronicBillingUpdateFieldsSchema"
}
]
},
"FunderElectronicBillingUpdateSchema": {
"description": "Create request for Funder with 'medicaid' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderElectronicBillingUpdateFieldsSchema"
}
]
},
"FunderElectronicBillingUpdateFieldsSchema": {
"type": "object",
"required": [
"payer_code",
"payer_name",
"provider_name",
"payer_electronic_transmitter_id",
"provider_electronic_transmitter_id",
"provider_tax_id"
],
"properties": {
"organization_code": {
"type": "string",
"example": 23678
},
"organization_name": {
"type": "string",
"example": "Green Cross Inc."
},
"payer_code": {
"type": "string",
"example": "PYRCD"
},
"payer_name": {
"type": "string",
"example": "Senior Whole Health"
},
"provider_code": {
"type": "string",
"example": 1425636511
},
"provider_code_api": {
"type": "string",
"example": 123456789
},
"send_provider_code_as": {
"type": "string",
"example": "npi",
"enum": [
"npi",
"api"
]
},
"provider_name": {
"type": "string",
"example": "Care provider"
},
"payer_electronic_transmitter_id": {
"type": "string",
"example": 238561
},
"provider_electronic_transmitter_id": {
"type": "string",
"example": 841263
},
"provider_tax_id": {
"type": "string",
"example": 231424221
},
"provider_taxonomy_code": {
"type": "string",
"example": "251E00000X"
},
"business_entity_id": {
"type": "string",
"example": "211312312LL"
},
"uses_bank": {
"type": "boolean",
"example": true
},
"send_bill_code_description": {
"type": "string",
"example": "bill_code_description",
"enum": [
"bill_code_description",
"visit_start_and_end_time",
"do_not_send"
]
},
"supervising_provider_secondary": {
"type": "boolean",
"example": true
},
"claim_type": {
"type": "string",
"example": "institutional",
"enum": [
"institutional",
"professional"
]
},
"claim_breakdown_frequency": {
"type": "string",
"example": "weekly",
"enum": [
"lifetime",
"daily",
"weekly",
"calendar_month"
]
},
"end_of_week": {
"type": "string",
"example": "Monday",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"clearing_house": {
"description": "Claim destination system for initial billing",
"type": "string",
"example": "waystar",
"enum": [
"waystar",
"tellus",
"hhax",
"tellus_rs"
]
},
"rebill_clearing_house": {
"description": "Claim destination system for re-billing",
"type": "string",
"example": "waystar",
"enum": [
"waystar",
"tellus",
"hhax",
"tellus_rs"
]
},
"evv_destination_system": {
"description": "EVV destination system",
"type": "string",
"example": "sandata",
"enum": [
"None",
"sandata",
"emed_ny",
"vesta",
"tellus_rs",
"hhax"
]
},
"export_type": {
"description": "Export type for initial billing",
"type": "string",
"example": "manual",
"enum": [
"manual",
"electronic",
"claim_pdf"
]
},
"rebill_export_type": {
"description": "Export type for re-billing",
"type": "string",
"example": "manual",
"enum": [
"manual",
"electronic",
"claim_pdf"
]
},
"export_template": {
"description": "Export template for initial billing",
"type": "string",
"example": "cms_1500_no_background",
"enum": [
"cms_1500_no_background",
"cms_1500_with_background"
]
},
"rebill_export_template": {
"description": "Export template for re-billing",
"type": "string",
"example": "cms_1500_no_background",
"enum": [
"cms_1500_no_background",
"cms_1500_with_background"
]
},
"referring_provider": {
"type": "string",
"example": "agency_at_claim_level",
"enum": [
"agency_at_claim_level",
"agency_at_service_line_level",
"contact_at_claim_level",
"contact_at_service_line_level",
"do_not_send"
]
},
"rendering_provider": {
"type": "string",
"example": "agency_at_service_line_level",
"enum": [
"agency_at_claim_level",
"agency_at_service_line_level",
"contact_at_claim_level",
"contact_at_service_line_level",
"employee_at_service_line_level",
"do_not_send"
]
},
"supervising_provider": {
"type": "string",
"example": "agency_at_claim_level",
"enum": [
"agency_at_claim_level",
"contact_at_claim_level",
"contact_at_service_line_level",
"do_not_send"
]
},
"operating_provider": {
"type": "string",
"example": "do_not_send",
"enum": [
"agency_at_claim_level",
"agency_at_service_line_level",
"contact_at_claim_level",
"contact_at_service_line_level",
"do_not_send"
]
},
"ordering_provider": {
"type": "string",
"example": "contact_at_service_line_level",
"enum": [
"agency_at_service_line_level",
"contact_at_service_line_level",
"do_not_send"
]
},
"attending_provider": {
"type": "string",
"example": "contact_at_claim_level",
"enum": [
"agency_at_claim_level",
"contact_at_claim_level",
"do_not_send"
]
},
"service_facility": {
"type": "string",
"example": "agency_at_claim_level",
"enum": [
"agency_at_claim_level",
"agency_at_service_line_level",
"client_at_claim_level",
"client_at_service_line_level",
"do_not_send"
]
},
"ambulance_location": {
"type": "boolean",
"example": true
},
"attach_claim_documentation": {
"type": "boolean",
"example": true
},
"attachment_report_type": {
"type": "string",
"enum": [
"IR",
"LA",
"M1",
"MT",
"NN",
"OB",
"OC",
"OD",
"OE",
"OX",
"OZ",
"P4",
"P5",
"PE",
"PN",
"PO",
"PQ",
"PY",
"PZ",
"RB",
"RR",
"RT",
"RX",
"SG",
"V5",
"XP"
],
"example": "IR"
},
"transmission_method": {
"type": "string",
"enum": [
"AA",
"BM",
"EL",
"EM",
"FT",
"FX"
],
"example": "FX"
},
"send_patient_injury_info": {
"type": "boolean",
"example": true
},
"plan_id": {
"type": "string",
"enum": [
"10",
"18",
"19",
"1A",
"1E",
"1P",
"2Q",
"31",
"33",
"34",
"36",
"37",
"3G",
"3H",
"40",
"42",
"43",
"44",
"45",
"46",
"47",
"4F",
"4G",
"4H",
"50",
"52",
"53",
"5A",
"5B",
"63",
"66",
"67",
"69",
"6C",
"6F",
"6G",
"71",
"72",
"79",
"7G",
"7H",
"7P",
"7Q",
"7R",
"7S",
"7V",
"7Z",
"82",
"83",
"85",
"86",
"8G",
"8H",
"8J",
"8K",
"8L",
"8R",
"8S",
"8T",
"90",
"93",
"95",
"9F",
"9H",
"9J",
"9K",
"C1",
"C2",
"C3",
"C4",
"C5",
"CCCP",
"FMSP",
"H1",
"H2",
"H3",
"H4",
"H5",
"H6",
"H7",
"H8",
"H9",
"HA",
"K1",
"K2",
"K3",
"K4",
"K5",
"K6",
"K7",
"K8",
"K9",
"KA",
"KB",
"KC",
"KD",
"KE",
"KF",
"KG",
"KH",
"KJ",
"KL",
"KM",
"KN",
"KP",
"KQ",
"KR",
"KS",
"KT",
"KU",
"KV",
"MEDA",
"MEDF",
"N1",
"N2",
"N3",
"N4",
"NONE",
"SLTC",
"SMMA",
"W2",
"W3",
"W4",
"W5",
"W6"
],
"example": "MEDA"
},
"program_id": {
"type": "string",
"enum": [
"590-CCSP",
"660-ICWP",
"680-NOW",
"681-COMP",
"930-SOURCE",
"971-GAPP",
"AD",
"CDD",
"DDAD",
"DDAID",
"F",
"FLCF",
"FLFD",
"FLIB",
"FLLC",
"FLLT",
"FLME",
"FLMF",
"FLMM",
"FLMW",
"FLPA",
"FLTB",
"I",
"J",
"L",
"M",
"N",
"PA67",
"PAAA",
"PAAC",
"PAAG",
"PAAI",
"PACE",
"PACH",
"PACL",
"PACO",
"PACW",
"PAFD",
"PAIN",
"PAMC",
"PAOB",
"PASS",
"PAWI"
],
"example": "PACL"
},
"delivery_system": {
"type": "string",
"enum": [
"FFFS",
"MCOR"
],
"example": "FFFS"
},
"timely_filing_window": {
"type": "string",
"enum": [
"10",
"30",
"60",
"90",
"120",
"180",
"365",
"none"
],
"example": "30"
},
"tenant_qualifier": {
"type": "string",
"example": "ZZ"
},
"tenant_id": {
"type": "string",
"example": 702765200
},
"clearing_house_qualifier": {
"type": "string",
"example": "ZZ"
},
"rebill_clearing_house_qualifier": {
"type": "string",
"example": "ZZ"
},
"clearing_house_id": {
"type": "string",
"example": "ZIRMED"
},
"rebill_clearing_house_id": {
"type": "string",
"example": "ZIRMED"
},
"claim_grouping_methodology": {
"type": "string",
"example": "details_with_modifier",
"enum": [
"details_no_modifier",
"details_with_modifier",
"group_by_date"
]
},
"referring_provider_code": {
"type": "string",
"example": 123456789
},
"referring_provider_qualifier": {
"type": "string",
"example": "XX"
},
"ordering_provider_code": {
"type": "string",
"example": 123456789
},
"ordering_provider_qualifier": {
"type": "string",
"example": "XX"
},
"rendering_provider_code": {
"type": "string",
"example": 123456789
},
"rendering_provider_qualifier": {
"type": "string",
"example": "XX"
},
"operating_provider_code": {
"type": "string",
"example": 123456789
},
"operating_provider_qualifier": {
"type": "string",
"example": "XX"
},
"attending_provider_code": {
"type": "string",
"example": 123456789
},
"attending_provider_qualifier": {
"type": "string",
"example": "XX"
},
"relase_of_information_code": {
"type": "string",
"enum": [
"Y",
"I"
]
}
}
},
"FunderHcpCreateSchema": {
"description": "Create request for Funder with 'hcp' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseCreateSchema"
},
{
"$ref": "#/components/schemas/FunderHcpUpdateFieldsSchema"
}
]
},
"FunderHcpUpdateSchema": {
"description": "Create request for Funder with 'hcp' invoicing_model type",
"allOf": [
{
"$ref": "#/components/schemas/FunderBaseUpdateSchema"
},
{
"$ref": "#/components/schemas/FunderHcpUpdateFieldsSchema"
}
]
},
"FunderHcpUpdateFieldsSchema": {
"type": "object",
"required": [
"organization_code",
"organization_name",
"unearned_revenue_account_id"
],
"properties": {
"organization_code": {
"type": "integer",
"example": 1
},
"organization_name": {
"type": "integer",
"example": 1
},
"recognized_revenue_account_id": {
"type": "integer",
"example": 1
},
"unearned_revenue_account_id": {
"type": "integer",
"example": 1
}
}
},
"CostCentre": {
"description": "Details of a cost centre",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Cost centre description",
"example": "Montreal"
},
"id": {
"type": "integer",
"description": "Cost centre ID",
"example": 2,
"minimum": 1
},
"number": {
"type": "string",
"description": "Cost centre number for display in-app",
"example": "5555"
},
"status": {
"type": "string",
"description": "Cost centre status",
"example": "enabled"
}
},
"nullable": true
},
"ActivityCode": {
"description": "Details of a cost centre",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Activity Code description",
"example": "Some description"
},
"id": {
"type": "integer",
"description": "Activity Code ID",
"example": 2
},
"code": {
"type": "string",
"description": "Activity Code code field",
"example": "5555"
},
"branch": {
"$ref": "#/components/schemas/BranchSummary"
}
},
"nullable": true
},
"ActivityCodeList": {
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
}
],
"description": "Paginated list of activity codes",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityCode"
}
}
}
},
"CostCentreList": {
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
}
],
"description": "Paginated list of cost centres",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostCentre"
}
}
}
},
"CostCentreClientCreate": {
"type": "object",
"properties": {
"client_id": {
"type": "integer",
"description": "client ID",
"example": 1010,
"minimum": 1
},
"client_external_id": {
"type": "string",
"description": "client external ID",
"example": "john.1010"
}
}
},
"CostCentreClientResponse": {
"description": "Client to cost centre link",
"type": "object",
"properties": {
"client_id": {
"type": "integer",
"description": "client ID",
"example": 1010,
"minimum": 1
},
"cost_centre_id": {
"type": "integer",
"description": "Cost centre ID",
"example": 10,
"minimum": 1
}
}
},
"CostCentreEmployeeCreateSchema": {
"type": "object",
"properties": {
"employee_id": {
"type": "integer",
"description": "Employee ID",
"example": 1010,
"minimum": 1
},
"employee_external_id": {
"type": "string",
"description": "Employee external ID",
"example": "john.1010"
}
}
},
"CostCentreEmployeeResponse": {
"description": "Employee to cost centre link",
"type": "object",
"properties": {
"employee_id": {
"type": "integer",
"description": "Employee ID",
"example": 1010,
"minimum": 1
},
"cost_centre_id": {
"type": "integer",
"description": "Cost centre ID",
"example": 10,
"minimum": 1
}
}
},
"StatusReasonsList": {
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
}
],
"description": "Paginated list of status reasons",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusReasonDetail"
}
}
}
},
"StatusReasonDetail": {
"description": "Client status reason.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "AlayaCare status reason ID.",
"example": 1
},
"status": {
"type": "string",
"description": "Alayacare client status",
"example": "on_hold",
"enum": [
"on_hold",
"discharged"
]
},
"name": {
"type": "string",
"description": "AlayaCare status reason name.",
"example": "Vacation"
},
"description": {
"type": "string",
"description": "AlayaCare status reason description",
"example": "Yearly summer vacation."
},
"branch": {
"type": "object",
"description": "AlayaCare branch",
"properties": {
"id": {
"type": "integer",
"description": "Branch ID",
"example": 1000,
"minimum": 1
},
"name": {
"type": "string",
"description": "Branch name",
"example": "Toronto branch"
}
}
}
}
},
"Premium": {
"description": "A premium configured in AlayaCare Accounting Settings",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "AlayaCare premium code name",
"example": "MILEAGE"
},
"premium_id": {
"type": "integer",
"description": "AlayaCare premium ID",
"example": 643,
"minimum": 1
},
"pay_code": {
"$ref": "#/components/schemas/PayCode"
},
"bill_codes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillCode"
}
},
"rule": {
"type": "string",
"description": "AlayaCare premium rule name",
"example": "Weekends"
},
"branch": {
"$ref": "#/components/schemas/Branch"
}
},
"required": [
"code",
"premium_id"
]
},
"VisitPremiumDetails": {
"description": "A visit premium",
"type": "object",
"properties": {
"visit_premium_id": {
"type": "integer",
"description": "AlayaCare visit premium ID",
"example": 345,
"minimum": 1
},
"description": {
"type": "string",
"description": "Description of the visit premium",
"example": "Reported travel KMs"
},
"quantity": {
"type": "integer",
"description": "Quantity of premiums applied to the visit",
"example": 2
},
"premium": {
"$ref": "#/components/schemas/Premium"
}
},
"required": [
"visit_premium_id",
"quantity",
"premium"
]
},
"VisitPremiumsList": {
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
}
],
"type": "object",
"description": "Paginated list of premiums",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VisitPremiumDetails"
}
}
}
},
"PremiumsList": {
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
}
],
"type": "object",
"description": "Paginated list of premiums",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Premium"
}
}
}
},
"Branch": {
"description": "AlayaCare branch",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Branch ID",
"example": 1000,
"minimum": 1
},
"name": {
"type": "string",
"description": "Branch name",
"example": "AlayaCare Health"
}
}
},
"BillCode": {
"description": "AlayaCare bill code",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "AlayCare bill code ID",
"example": 783,
"minimum": 1
},
"code": {
"type": "string",
"description": "AlayCare bill code name",
"example": "MEDIBILL"
}
},
"required": [
"id",
"code"
]
},
"PayCode": {
"description": "AlayaCare pay code",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "AlayCare pay code ID",
"example": 3,
"minimum": 1
},
"code": {
"type": "string",
"description": "AlayCare pay code name",
# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/api-evangelist-alayacare/refs/heads/main/json-schema/alayacare-accounting-schema.json