Noyo Reconcilation Issues API
The Reconcilation Issues API from Noyo — 2 operation(s) for reconcilation issues.
OpenAPI Specification
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Reconcilation Issues API
version: 1.0.0
servers: []
tags:
- name: Reconcilation Issues
paths:
/api/v1/reconciliation_issues:
get:
description: Returns a list of all reconciliation issues matching the given query
operationId: getReconciliationIssuesList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: Status of the reconciliation issues
in: query
name: status
required: false
schema:
type: string
- description: Status grouping of the reconciliation issues
in: query
name: status_grouping
required: false
schema:
type: string
- description: Type grouping of the reconciliation issues
in: query
name: type_grouping
required: false
schema:
type: string
- description: The unique identifier of the carrier for which you would like to view reconciliation issues
in: query
name: carrier_id
required: false
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: The unique identifier of the group for which you would like to view reconciliation issues
in: query
name: group_id
required: false
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: Unique identifier of the model that is the subject of the reconciliation issue
in: query
name: subject_id
required: false
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: The type of the model that is the subject of the reconciliation issue
in: query
name: subject_type
required: false
schema:
type: string
- description: The categorization of the reconciliation issue
in: query
name: reconciliation_issue_type
required: false
schema:
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 1
response:
- body:
carrier_value: '2020-01-01'
distributor_value: '2020-02-01'
carrier_id: 8fac0992-933a-4743-8dab-0d606ef2569e
context: ''
created: 1557862286
group_id: 436fb487-bb75-42d4-9651-7b1471a8940e
id: dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1
modified: 1557862286
reconciliation_issue_type: individual_enrollment_effective_start_date_mismatch
status: pending_resolution
subject_id: 7027d416-3bed-43e8-b824-508d9c0d323e
subject_type: IndividualEnrollment
version: ea38e798-cd61-4fa2-b485-d1c5b87a61af
schema:
$ref: '#/components/schemas/PaginatedReconciliationIssuePublicResult'
description: Successful Response - Returns all matching Reconciliation Issues
summary: List Reconciliation Issues
tags:
- Reconcilation Issues
/api/v1/reconciliation_issues/{reconciliation_issue_id}:
get:
description: Returns the latest version of a single reconciliation issue based on the ID provided
operationId: getReconciliationIssue
parameters:
- description: The unique identifier of the reconciliation issue you would like to retrieve
in: path
name: reconciliation_issue_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
body:
carrier_value: '2020-01-01'
distributor_value: '2020-02-01'
carrier_id: 8fac0992-933a-4743-8dab-0d606ef2569e
context: ''
created: 1557862286
group_id: 436fb487-bb75-42d4-9651-7b1471a8940e
id: dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1
modified: 1557862286
reconciliation_issue_type: individual_enrollment_effective_start_date_mismatch
status: pending_resolution
subject_id: 7027d416-3bed-43e8-b824-508d9c0d323e
subject_type: IndividualEnrollment
version: ea38e798-cd61-4fa2-b485-d1c5b87a61af
schema:
$ref: '#/components/schemas/ReconciliationIssuePublicResult'
description: Successful Response - Returns a single Reconciliation Issue
summary: Get Reconciliation Issue
tags:
- Reconcilation Issues
components:
schemas:
ReconciliationIssuePublicResult:
properties:
body:
description: Details of what values are in contention with each other
readOnly: true
type: object
carrier_id:
description: Unique identifier of the associated carrier in Noyo
format: uuid
readOnly: true
type: string
context:
description: Context for the processing of the reconciliation issue
readOnly: true
type: string
created:
description: The date the record was created
type: integer
group_id:
description: Unique identifier of the group in Noyo
format: uuid
readOnly: true
type: string
id:
description: Unique identifier of the record in Noyo
format: uuid
type: string
modified:
description: The date the record was last updated
type: integer
reconciliation_issue_type:
description: Categorization of the reconciliation issue
readOnly: true
type: string
status:
description: Status of the reconciliation issue
enum:
- needs_review
- processing
- resolved
- dismissed
- failed
readOnly: true
type: string
subject_id:
description: Unique identifier of the model that is the subject of the reconciliation issue
format: uuid
readOnly: true
type: string
subject_type:
description: The type of the model that is the subject of the reconciliation issue
readOnly: true
type: string
version:
description: Current version of the record
format: uuid
type: string
required:
- body
- carrier_id
- created
- group_id
- id
- modified
- reconciliation_issue_type
- status
- subject_id
- subject_type
- version
type: object
x-field_order:
- id
- version
- group_id
- carrier_id
- status
- reconciliation_issue_type
- subject_id
- subject_type
- context
- body
- created
- modified
PaginatedReconciliationIssuePublicResult:
properties:
meta:
allOf:
- $ref: '#/components/schemas/Meta'
description: Metadata associated with the response data
response:
description: List of reconciliation issue results
items:
$ref: '#/components/schemas/ReconciliationIssuePublicResult'
type: array
required:
- meta
- response
type: object
x-field_order:
- meta
- response
Meta:
properties:
offset:
description: The offset of the first response record within the matching data set
format: int32
minimum: 0
readOnly: true
type: integer
page_num:
description: The page number of the response records within the overall data set (1-based integer)
format: int32
minimum: 1
readOnly: true
type: integer
page_size:
description: The maximum number of response records on each page of results
format: int32
minimum: 1
readOnly: true
type: integer
total_records:
description: The total number of records in the entire matching data set
format: int32
minimum: 0
readOnly: true
type: integer
required:
- offset
- page_num
- page_size
type: object