openapi: 3.2.0 info: version: V1 title: Orion Connect Billing/Bills API x-swagger-net-version: 8.4.12.001 servers: - url: https://api.orionadvisor.com/api tags: - name: Billing/Bills paths: /v1/Billing/Bills: get: tags: - Billing/Bills summary: Get a list of bills that the logged in user has access to see. operationId: BillingBill_Get parameters: - name: instanceId in: query required: false schema: type: integer format: int32 - name: isValid in: query required: false schema: type: boolean - name: billType in: query required: false schema: type: string responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array security: - Authorization: [] /v1/Billing/Bills/{key}: get: tags: - Billing/Bills summary: Gets the bills that has the provided key. operationId: BillingBill_GetEntityByKey parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' security: - Authorization: [] /v1/Billing/Bills/{key}/Action/DeleteClientRelatedBills: delete: tags: - Billing/Bills operationId: BillingBill_DeleteClientRelatedBills parameters: - name: key in: path required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: integer format: int32 application/json: schema: type: integer format: int32 text/json: schema: type: integer format: int32 application/xml: schema: type: integer format: int32 text/xml: schema: type: integer format: int32 multipart/form-data: schema: type: integer format: int32 security: - Authorization: [] summary: Billing bill delete client related bills x-summary-source: derived /v1/Billing/Bills/{key}/Action/Hold: put: tags: - Billing/Bills operationId: BillingBill_ActionHoldAsync parameters: - name: key in: path required: true schema: type: integer format: int32 - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true summary: Billing bill action hold async x-summary-source: derived /v1/Billing/Bills/{key}/Action/RemoveHold: put: tags: - Billing/Bills operationId: BillingBill_ActionRemoveHoldAsync parameters: - name: key in: path required: true schema: type: integer format: int32 - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true summary: Billing bill action remove hold async x-summary-source: derived /v1/Billing/Bills/{key}/Log: get: tags: - Billing/Bills summary: Get bill log that has the provided key. operationId: BillingBill_GetBillLogByKey parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillLogDto' security: - Authorization: [] /v1/Billing/Bills/{key}/Simple: get: tags: - Billing/Bills summary: Gets the simple bill that has the provided key. operationId: BillingBill_GetSimpleByKey parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' application/json: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' text/json: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' application/xml: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' text/xml: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' multipart/form-data: schema: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' security: - Authorization: [] /v1/Billing/Bills/Action/Delete: put: tags: - Billing/Bills summary: Delete bill records provided in the list of ids description: 'Sample Request PUT /Billing/Bills/Action/Delete [67567,56637]' operationId: BillingBill_ActionDeleteAsync parameters: - name: ct in: header required: true - name: deleteRelatedHouseholds in: query required: false schema: type: boolean default: false responses: '200': description: OK content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Billing/Bills/List: post: tags: - Billing/Bills summary: Gets a list of bill assets that match one of the keys in the provided list operationId: BillingBill_GetListById responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Billing/Bills/List/Id: post: tags: - Billing/Bills summary: Gets a list of bill assets that match one of the keys in the provided list operationId: BillingBill_PostV1BillingBillsListId responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillDto' xml: name: BillDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Billing/Bills/Simple: get: tags: - Billing/Bills summary: Gets a simple list of bills that the logged in user has access to. operationId: BillingBill_GetSimple parameters: - name: isValid in: query required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] /v1/Billing/Bills/Simple/List: post: tags: - Billing/Bills summary: Gets a simple list of bill that match one of the keys in the provided list operationId: BillingBill_GetSimpleListById responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Billing/Bills/Simple/List/Id: post: tags: - Billing/Bills summary: Gets a simple list of bill that match one of the keys in the provided list operationId: BillingBill_PostV1BillingBillsSimpleListId responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Billing/Bills/ValidateAccPayments: post: tags: - Billing/Bills summary: Returns a list of BillIds for instances where a Household account was making… operationId: BillingBill_ValidatePaysForAccountPaymentAsync parameters: - name: token in: header description: Cancellation Token required: true responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto' xml: name: BillPaysForAccountValidateDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true components: schemas: OAS.WebApi.DTO.Billing.BillDto: properties: id: type: integer format: int32 instanceId: type: integer format: int32 billTransmitMethodId: type: integer format: int32 invoiceNumber: type: string clientId: type: integer format: int32 clientName: type: string firstName: type: string lastName: type: string isValid: type: integer format: int32 billType: type: string initialAmount: type: number format: double adjustments: type: number format: double balanceDue: type: number format: double startDate: type: string format: date-time endDate: type: string format: date-time calcDate: type: string format: date-time createdDate: type: string format: date-time createdBy: type: string asOfDate: type: string format: date-time editedDate: type: string format: date-time editedBy: type: string xml: name: BillDto type: object OAS.WebApi.DTO.Billing.BillLogDto: properties: logText: type: string xml: name: BillLogDto type: object OAS.DataModel.SimpleEntity: properties: id: type: integer format: int32 name: type: string xml: name: SimpleEntity type: object OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto: properties: paidBy: type: integer format: int32 paysTo: type: integer format: int32 billInstance: type: integer format: int32 xml: name: BillPaysForAccountValidateDto type: object securitySchemes: Authorization: type: apiKey description: 'JWT Authorization header using the Session scheme. Example: "Authorization: Session {token}"' name: Authorization in: header