{ "swagger": "2.0", "info": { "version": "v1", "title": "Revenue - Catalog HTTP API", "description": "The Revenue Microservice HTTP API. This is a Data-Driven/CRUD microservice", "termsOfService": "Terms Of Service" }, "paths": { "/api/{api-version}/account/balance/statistics/{customerType}/{customerId}": { "post": { "tags": [ "account/balance" ], "operationId": "account/balance-GetStatistics", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "string", "enum": [ "Person", "Organization" ] }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RevenueMetricsFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel" } } }, "deprecated": true } }, "/api/{api-version}/account/balance/statisticsByItemType/{itemType}/{itemId}": { "get": { "tags": [ "account/balance" ], "operationId": "account/balance-GetStatisticsByItemType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "itemType", "in": "path", "required": true, "type": "string", "enum": [ "Subscription", "Event", "Endorsement", "Class", "Product", "EventSession", "EventBundle", "Manual", "Modification", "CancellationFee", "Exhibitor", "AdditionalExhibitor", "Tenant" ] }, { "name": "itemId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel" } } }, "deprecated": true } }, "/api/{api-version}/account/balance/statisticsByItemTypeWithFilter/{itemType}/{itemId}": { "post": { "tags": [ "account/balance" ], "operationId": "account/balance-GetStatisticsByItemTypeWithFilter", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "itemType", "in": "path", "required": true, "type": "string", "enum": [ "Subscription", "Event", "Endorsement", "Class", "Product", "EventSession", "EventBundle", "Manual", "Modification", "CancellationFee", "Exhibitor", "AdditionalExhibitor", "Tenant" ] }, { "name": "itemId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RevenueMetricsFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel" } } }, "deprecated": true } }, "/api/{api-version}/account/balance/statisticsForAllTransactions": { "post": { "tags": [ "account/balance" ], "operationId": "account/balance-GetAllTransactionsRevenueMetrics", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionsListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.AllTransactionStatisticsViewModel" } } }, "deprecated": true } }, "/api/{api-version}/AccountCode/GetEventItemCode/{id}": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetEventItemCode", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.EventItemsViewModel" } } } } }, "/api/{api-version}/AccountCode/GetItemCode/{id}/{type}": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetItemCodes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "type", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } } } } }, "/api/{api-version}/AccountCode/save": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-CreateOrUpdateAccountCodeMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeUpdateModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeUpdateModel" } } } } } }, "/api/{api-version}/AccountCode/SaveTenantDefault": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-saveTenantDefault", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeUpdateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeUpdateModel" } } } } }, "/api/{api-version}/AccountCode/GetTenantDefault": { "get": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetTenantDefault", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountCodeModel" } } } } }, "/api/{api-version}/AccountCode/GetAccountCodeMaster": { "get": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetAccountCodeMaster", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeMasterModel" } } } } } }, "/api/{api-version}/AccountCode/SaveAccountCodeMaster": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-SaveAccountCodeMaster", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeCreateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeCreateModel" } } } } }, "/api/{api-version}/AccountCode/GetDepartmentCodes": { "get": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetDepartmentCodes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.DepartmentCodeMasterModel" } } } } } }, "/api/{api-version}/AccountCode/SaveDepartmentCodeMaster": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-SaveDepartmentCodeMaster", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.DepartmentCodeMasterCreateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.DepartmentCodeMasterCreateModel" } } } } }, "/api/{api-version}/AccountCode/GetAccountCodesByEntityType/{type}": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetAccountCodesByEntityType", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "entityIds", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } } } } } }, "/api/{api-version}/AccountCode/GetAccountCodeTypes": { "get": { "tags": [ "AccountCode" ], "operationId": "AccountCode-GetAccountCodeTypes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeTypeModel" } } } } } }, "/api/{api-version}/AccountCode/SaveAccountTypes": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-SaveAccountTypes", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeTypeCreateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeTypeCreateModel" } } } } }, "/api/{api-version}/AccountCode/DeleteAccountTypes/{id}": { "post": { "tags": [ "AccountCode" ], "operationId": "AccountCode-DeleteAccountTypes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Address/check/billingaddresss/{customerType}/{customerId}": { "get": { "tags": [ "Address" ], "operationId": "Address-CheckBillingAddressAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "deprecated": true } }, "/api/{api-version}/Address/get/billing-address/{customerType}/{customerId}": { "get": { "tags": [ "Address" ], "operationId": "Address-GetBillingAddressAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Address/create/billingAddress": { "post": { "tags": [ "Address" ], "operationId": "Address-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AddressCreationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/creditNote/create": { "post": { "tags": [ "creditNote" ], "summary": "This is for create/update credit note", "operationId": "creditNote-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteModel", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteCreationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } }, "deprecated": true } }, "/api/{api-version}/creditNote/issue": { "post": { "tags": [ "creditNote" ], "operationId": "creditNote-IssueAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteCreationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/creditNote/use": { "post": { "tags": [ "creditNote" ], "operationId": "creditNote-UseAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteUseModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/creditNote/list": { "post": { "tags": [ "creditNote" ], "summary": "This is for listing of credit notes with or without apply any filter", "operationId": "creditNote-GetCreditNoteListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteListViewModel" } } } } } }, "/api/{api-version}/creditNote/list/count": { "post": { "tags": [ "creditNote" ], "summary": "This is for listing of credit notes with or without apply any filter", "operationId": "creditNote-GetCreditNoteListCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/creditNote/item/{id}": { "post": { "tags": [ "creditNote" ], "summary": "This is for list of invoices against which we create credit note", "operationId": "creditNote-CreditNoteInvoiceListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNotesInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceViewModel" } } } } }, "/api/{api-version}/creditNote/favorite": { "post": { "tags": [ "creditNote" ], "summary": "This is for marking a credit note favorite or remove from favorite", "operationId": "creditNote-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/creditNote/number": { "get": { "tags": [ "creditNote" ], "summary": "This is for getting list of existing credit note number", "operationId": "creditNote-GetExistingCreditNoteNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } } } } } }, "/api/{api-version}/creditNote/CreditNoteNumberNext": { "get": { "tags": [ "creditNote" ], "operationId": "creditNote-GetNextCreditNoteNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/creditNote/detail/{creditNoteId}": { "get": { "tags": [ "creditNote" ], "summary": "This is for detail of Credit note against a particular credit Note Id", "operationId": "creditNote-CreditNoteDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteDetailViewModel" } } } } }, "/api/{api-version}/creditNote/paymentsGroupByInvoices/{customerType}/{customerId}": { "get": { "tags": [ "creditNote" ], "operationId": "creditNote-GetpaymentsGroupByInvoicesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.PaymentsGroupByInvoices" } } } } } }, "/api/{api-version}/creditNote/unsettledCreditNote/{customerType}/{customerId}": { "get": { "tags": [ "creditNote" ], "operationId": "creditNote-UnsettledCreditNote", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.PaymentsForCreditNoteIssue" } } } } } }, "/api/{api-version}/creditNote/edit/manual/{creditNoteId}": { "get": { "tags": [ "creditNote" ], "summary": "This is for detail of Credit note for mapping in edit model", "operationId": "creditNote-GetCreditNoteDetailForEditAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteCreationModel" } } } } }, "/api/{api-version}/creditNote/export": { "post": { "tags": [ "creditNote" ], "operationId": "creditNote-ExportCreditNoteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/creditNote/delete/{creditnoteId}": { "delete": { "tags": [ "creditNote" ], "operationId": "creditNote-MarkTrash", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "creditnoteId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/creditNote/getpaymentitemuseddetail/{paymentId}": { "get": { "tags": [ "creditNote" ], "operationId": "creditNote-GetPaymentItemUsedDetaiAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/creditNote/getcreditnoteitemuseddetail/{creditNoteId}": { "get": { "tags": [ "creditNote" ], "operationId": "creditNote-GetCreditNoteItemUsedDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "creditNoteId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CreditNotItemUsedDetailViewModel" } } } } } }, "/api/{api-version}/creditRequestCreditNote/create": { "post": { "tags": [ "creditRequestCreditNote" ], "operationId": "creditRequestCreditNote-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "creditRequestCreditNoteModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditRequestCreditNoteCreationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/dropdown/gettags/{tagType}/{text}": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetTagsAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tagType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "text", "in": "path", "required": true, "type": "string", "default": "" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } }, "400": { "description": "Bad Request", "schema": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } } } }, "/api/{api-version}/dropdown/gettemplatemacro": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetTemplateMacroAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.TemplateMacro" } } } } } }, "/api/{api-version}/dropdown/subscription/type/cost": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetCostType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/subscriber": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriberType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/frequency": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriptionFrequencyType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/expiry": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriptionExpiryType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/subscription": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriptionType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/buyer": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetBuyerType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/type/tag": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetTagType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/status/payment": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetPaymentStatus", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/status": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriptionStatusType", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/type/laststatus": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetLastSubscriptionStatus", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EnumModel" } } } } } }, "/api/{api-version}/dropdown/subscription/types": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriptionTypes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.DropdownItemModel" } } } } } }, "/api/{api-version}/dropdown/getposition": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetPositionAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.DropdownItemModel" } } } } } }, "/api/{api-version}/dropdown/subscriber/getsubscriberorganization": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetSubscriberOrganizationAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.DropdownItemModel" } } } } } }, "/api/{api-version}/dropdown/customer/bytype/{typeId}": { "get": { "tags": [ "dropdown" ], "operationId": "dropdown-GetCustomerById", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CustomerDropdownItemModel" } } } } } }, "/api/{api-version}/invoice/detail": { "post": { "tags": [ "invoice" ], "summary": "invoice/detail", "description": "This API will help to get the Invoice detail", "operationId": "invoice-InvoiceDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceRevisionModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceViewModel" } } } } }, "/api/{api-version}/invoice/detail/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-InvoiceDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceViewModel" } } } } }, "/api/{api-version}/invoice/invoicePaidDetail/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-InvoicePaidDetail", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePaymentDetail" } } } } } }, "/api/{api-version}/invoice/item/{id}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceItemAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPurchasedViewModel" } } } } }, "/api/{api-version}/invoice/refreshitem": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetRefreshItemAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "itemModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.DomainModels.ConsolidatedInvoiceRefreshDetails" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.DomainModels.ConsolidatedInvoiceRefreshDetails" } } } } }, "/api/{api-version}/invoice/deleterefreshitem/{id}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-DeleteRefreshItem", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/consolidateditem/{id}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetConsolidatedInvoiceItemAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ConsolidatedInvoiceListModel" } } } } }, "/api/{api-version}/invoice/revisedInvoices/{id}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetRevisedInvoicesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ConsolidatedInvoiceListModel" } } } } }, "/api/{api-version}/invoice/list/unpaid/{customerType}/{customerId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetUnPaidOrPartialPaidInvoiceListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePartialViewModel" } } } } }, "/api/{api-version}/invoice/list/unpaidCount/{customerType}/{customerId}/{requestType}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetUnPaidOrPartialPaidInvoiceCountAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "requestType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.OrgDependenciesModel" } } } } } }, "/api/{api-version}/invoice/create": { "post": { "tags": [ "invoice" ], "operationId": "invoice-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ManualInvoiceCreationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/invoice/sendInvoice": { "post": { "tags": [ "invoice" ], "operationId": "invoice-SendInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SendInvoiceModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/invoiceNumberNext": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetNextInvoiceNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/invoice/copy/{invoiceId}": { "get": { "tags": [ "invoice" ], "summary": "used to get items to copy", "operationId": "invoice-GetInvoiceCopyAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceCopyModel" } } } } }, "/api/{api-version}/invoice/copy": { "post": { "tags": [ "invoice" ], "summary": "used to create copy of invoice", "operationId": "invoice-CopyInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "copyModel", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceCopyModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ManualInvoiceCreationModel" } } } } }, "/api/{api-version}/invoice/edit/manual": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceRevisionModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ManualInvoiceCreationModel" } } } } }, "/api/{api-version}/invoice/delete/{invoiceId}": { "delete": { "tags": [ "invoice" ], "operationId": "invoice-MarkTrash", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/mark/void": { "post": { "tags": [ "invoice" ], "operationId": "invoice-MarkVoid", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkVoidItemModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/list/all/{customerType}/{customerId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetAllInvoiceListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AllInvoiceListiViewModel" } } } } }, "/api/{api-version}/invoice/favorite": { "post": { "tags": [ "invoice" ], "operationId": "invoice-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/number": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetExistingInvoiceNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } } } } } }, "/api/{api-version}/invoice/list/item": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceItemListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "payload", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentItemsPayload" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemByPaymentViewModel" } } } } }, "/api/{api-version}/invoice/info-by-invoice/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceCustomPaymentDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.InvoiceCustomPaymentViewModel" } } } } }, "/api/{api-version}/invoice/invoice-payment/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-InvoicePaymentDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceViewModel" } } } } }, "/api/{api-version}/invoice/generate": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GenerateInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "invoicesModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceGenerationModels" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceGeneratedModel" } } } } } }, "/api/{api-version}/invoice/recognize": { "post": { "tags": [ "invoice" ], "operationId": "invoice-RecognizeInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "invoicesModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RevenueRecognitionViewModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/invoice/getInvoiceItemPaidDetail/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceItemPaidDetail", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPaidDetailListModel" } } } } } }, "/api/{api-version}/invoice/getInvoiceItemPaidDetail/{batchId}/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceItemPaidDetailForBatches", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "batchId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPaidDetailListModel" } } } } } }, "/api/{api-version}/invoice/billingDetailsById/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetBillingDetailsById", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceBillingContacts" } } } } } }, "/api/{api-version}/invoice/eventItem/{id}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetInvoiceItemforEventAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPurchasedViewModel" } } } } }, "/api/{api-version}/invoice/GetRegModifiedInvoiceHistory/{invoiceId}": { "get": { "tags": [ "invoice" ], "operationId": "invoice-GetRegModifiedInvoiceHistory", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegModifiedInvoiceHistoryViewModel" } } } } } }, "/api/{api-version}/invoice/GetAllRevenueDetails": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetAllRevenueDetails", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Request", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.GetRevebueDetailsModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.GetRevebueDetailsViewModel" } } } } } }, "/api/{api-version}/invoice/GetAllCreditnotesForPaymentDetails/{InvoiceId}": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetPaymentCreditNotes", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "InvoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteModel" } } } } } }, "/api/{api-version}/invoice/InvoiceUpdateByRegistration": { "post": { "tags": [ "invoice" ], "operationId": "invoice-GetRegistrationForInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "request", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceUpdateRequest" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success" } } } }, "/api/{api-version}/invoice/details/{invoiceId}": { "get": { "tags": [ "invoice" ], "summary": "Get Invoice Details Summary", "description": "Get summary details for a specific invoice.", "operationId": "invoice-GetInvoiceDetailsSummary", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSummaryViewModel" } } } } }, "/api/{api-version}/invoice/SaveInvoiceReminder": { "post": { "tags": [ "invoice" ], "summary": "Save Invoice Reminder", "description": "Save a reminder for a specific invoice.", "operationId": "invoice-SaveInvoiceReminder", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceReminderRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceReminderViewModel" } } } } }, "/api/{api-version}/membership/list/{subscriptionId}": { "post": { "tags": [ "membership" ], "operationId": "membership-GetSubscribersListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "status", "in": "body", "required": false, "schema": { "enum": [ "Active", "Cancelled", "Reactivated", "Paused" ], "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Membership.SubscribersListModel" } } } } } }, "/api/{api-version}/membership/status/change/{subscriptionId}/{membershipStatusId}": { "post": { "tags": [ "membership" ], "operationId": "membership-MembershipStatusChange", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "membershipStatusTypeId", "in": "body", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "membershipStatusId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/membership/subscriber/save": { "post": { "tags": [ "membership" ], "operationId": "membership-SaveSubscriberAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionSubscriberModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/membership/individual/save": { "post": { "tags": [ "membership" ], "operationId": "membership-SaveSubscriptionForIndividualAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionSubscriberModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/membership/organization/save": { "post": { "tags": [ "membership" ], "operationId": "membership-SaveSubscriptionForOrganizationAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionSubscriberModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/membership/subscriber/list": { "post": { "tags": [ "membership" ], "operationId": "membership-GetSubscriptionSubscribers", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionSubscriberListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionSubscribersViewModel" } } } } }, "/api/{api-version}/membership/subscriber/count": { "post": { "tags": [ "membership" ], "operationId": "membership-GetSubscriberCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionSubscriberListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/membership/batch/{id}": { "get": { "tags": [ "membership" ], "operationId": "membership-GetBatchDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MembershipBatchViewModel" } } } } }, "/api/{api-version}/membership/batch": { "post": { "tags": [ "membership" ], "operationId": "membership-CreateBatchAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionSubscriberModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/membership/subscribers/organization/list/{subscriptionId}": { "post": { "tags": [ "membership" ], "operationId": "membership-SelectOrganizationConsumersAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.OrganisationListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionListViewModel" } } } } }, "/api/{api-version}/membership/subscribers/individual/list/{subscriptionId}": { "post": { "tags": [ "membership" ], "operationId": "membership-SelectIndividualConsumersAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.IndividualListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionListViewModel" } } } } }, "/api/{api-version}/notification/email/template/custom/list": { "get": { "tags": [ "notification" ], "operationId": "notification-GetCustomEmailTemplateList", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationEmailTemplateModel" } } } } } }, "/api/{api-version}/notification/email/template/personalised/list": { "get": { "tags": [ "notification" ], "operationId": "notification-GetPersonalisedEmailTemplateList", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/EngagifiiMessageCenter.sdk.Models.EmailTemplate" } } } } } }, "/api/{api-version}/notification/email/template/macro/list/{categoryId}": { "get": { "tags": [ "notification" ], "operationId": "notification-GetEmailTemplateMacroList", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.EmailTemplateMacrosViewModel" } } } } } }, "/api/{api-version}/notification/email/template/{notificationTemplateId}": { "get": { "tags": [ "notification" ], "operationId": "notification-GetEmailTemplate", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "notificationTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationEmailTemplateModel" } } } } }, "/api/{api-version}/notification/email/template/email/{templateId}": { "get": { "tags": [ "notification" ], "operationId": "notification-GetSpecificEmailTemplate", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EngagifiiMessageCenter.sdk.Models.EmailTemplate" } } } } }, "/api/{api-version}/notification/email/template/save": { "post": { "tags": [ "notification" ], "operationId": "notification-SaveEmailTemplateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationEmailTemplateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/notification/email/template/saveList": { "post": { "tags": [ "notification" ], "operationId": "notification-SaveEmailTemplates", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "list", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationEmailTemplateModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/notification/getAllNotificationCategory": { "get": { "tags": [ "notification" ], "operationId": "notification-GetAllNotificationCategory", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "enum": [ "Custom", "SubscriptionReminder", "SubscriptionAddonReminder", "PayLaterEmail", "PaidLaterEmail", "BillingContactEmailPayNow", "MOLBillingContactEmailPayLater", "MOLBillingContactEmailPayNow", "MemberBillingContactEmailPayLater", "MemberBillingContactEmailPayNow", "ManualInvoiceGenerated", "ConsolidatedInvoiceGenerated", "ConsolidatedInvoiceItemsGenerated", "ConsolidatedInvoiceVoidedGenerated", "ConsolidatedInvoiceForOrganization", "ConsolidatedInvoiceItemAmount", "ConsolidatedInvoiceOrgBiller", "ConsolidatedInvoiceBuyer", "ConsolidatedInvoiceForChildOrg", "RegistrationCancellationEmail", "RegistrationModificationEmailModifiedRegistrants", "RegistrationModificationEmailRequestedby", "RegistrationModificationEmailNotifyMe", "RegistrationModificationEmailEventContact", "RegistrationModificationEmailCancelled", "RegistrationModificationEmailBillingContact", "RegistrationModificationEmailFinanceContact", "RefundEmailNotification", "NotificationForPayment", "ExhibitorRegistrationEmailRegistrants", "ExhibitorRegistrationEmailBoothStaff", "ExhibitorRegistrationEmailEventContact", "ExhibitorRegistrationEmailBillingContact", "ExhibitorRegistrationEmailFinanceContact", "PeopleProfileUpdateReminder", "OrganizationProfileUpdateReminder", "OnlyOrganizationLeadProfileUpdateReminder", "RegistrationCancellationClassForRegistrant", "RegistrationCancellationClassForAdmin", "RegistrationCancellationClassForClassContacts", "RegistrationCancellationClassForBillingContact", "BoothPreferenceByExhibitors", "BoothAssignmentByAdmin", "BoothPreferenceEmailBillingContact", "BoothAssignmentEmailBillingContact", "BoothPreferenceEmailExhibitorContact", "BoothAssignmentEmailExhibitorContact" ], "type": "string" } } }, "404": { "description": "Not Found" } } } }, "/api/{api-version}/notification/tenant/settings/list": { "get": { "tags": [ "notification" ], "operationId": "notification-GetClientNotificationAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationCategorySettingModel" } } } } } }, "/api/{api-version}/notification/tenant/settings/save": { "post": { "tags": [ "notification" ], "operationId": "notification-SaveClientNotificationAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "list", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.NotificationCategorySettingModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/notification/email/personalized/send": { "post": { "tags": [ "notification" ], "operationId": "notification-SendPersonalizedEmailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.PersonalizedEmailNotificationModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/notification/email/template/mapping": { "post": { "tags": [ "notification" ], "operationId": "notification-SaveEmailTemplateMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "emailTemplateMapping", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.EmailTemplateMapping" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/notification/email/template/clearmapping": { "post": { "tags": [ "notification" ], "operationId": "notification-ClearEmailTemplateMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "emailTemplateMapping", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Notification.EmailTemplateMapping" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/payment/create": { "post": { "tags": [ "payment" ], "operationId": "payment-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePaymentPayloadModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/payment/charge": { "post": { "tags": [ "payment" ], "operationId": "payment-ChargePaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/payment/authorizenet/charge": { "post": { "tags": [ "payment" ], "operationId": "payment-AuthorizenetChargePaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AuthorizePaymentReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AuthorizePaymentResModel" } } } } }, "/api/{api-version}/payment/list": { "post": { "tags": [ "payment" ], "operationId": "payment-GetListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentListViewModel" } } } } }, "/api/{api-version}/payment/transaction/detail/{paymentId}": { "post": { "tags": [ "payment" ], "operationId": "payment-GetPaymentTransactionDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentTransactionDetailViewModel" } } } } }, "/api/{api-version}/payment/detail/{paymentId}": { "get": { "tags": [ "payment" ], "operationId": "payment-GetPaymentDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentDetailViewModel" } } } } }, "/api/{api-version}/payment/itemwise/detail": { "post": { "tags": [ "payment" ], "operationId": "payment-GetPaymentItemwiseDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "req", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PaymentItemWiseReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentDetailViewModel" } } } } }, "/api/{api-version}/payment/manual/record": { "post": { "tags": [ "payment" ], "operationId": "payment-RecordManualPaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ManualPaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/payment/manual/create": { "post": { "tags": [ "payment" ], "operationId": "payment-CreateManualPaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ExtraPaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/payment/edit/manual/{paymentId}": { "get": { "tags": [ "payment" ], "operationId": "payment-GetManualPaymentDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ManualPaymentModel" } } } } }, "/api/{api-version}/payment/list/succeed/payment/{customerType}/{customerId}": { "get": { "tags": [ "payment" ], "operationId": "payment-GetSuccedPaymentListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.InvoiceWisePaymentForRefundViewModel" } } } } }, "/api/{api-version}/payment/mark/void": { "post": { "tags": [ "payment" ], "operationId": "payment-MarkVoid", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkVoidItemModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.VoidModel" } } } } }, "/api/{api-version}/payment/updateclearingdate": { "post": { "tags": [ "payment" ], "operationId": "payment-UpdateClearingDate", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.UpdateClearingDateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/payment/favorite": { "post": { "tags": [ "payment" ], "operationId": "payment-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/payment/delete/{paymentId}": { "delete": { "tags": [ "payment" ], "operationId": "payment-MarkTrash", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/payment/copy/{paymentId}": { "get": { "tags": [ "payment" ], "operationId": "payment-GetPaymentCopyAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentCopyModel" } } } } }, "/api/{api-version}/payment/copy": { "post": { "tags": [ "payment" ], "operationId": "payment-CopyInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "copyModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentCopyModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ManualPaymentModel" } } } } }, "/api/{api-version}/payment/number": { "get": { "tags": [ "payment" ], "operationId": "payment-GetExistingPaymentNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } } } } } }, "/api/{api-version}/payment/PaymentNumberNext": { "get": { "tags": [ "payment" ], "operationId": "payment-GetNextPaymentNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/payment/PaypalCreateOrder": { "post": { "tags": [ "payment" ], "operationId": "payment-PaypalCreateOrder", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaypalOrderModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/payment/term/add": { "post": { "tags": [ "payment/term" ], "operationId": "payment/term-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AddPaymentTermModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/payment/term/getallpaymentterm": { "get": { "tags": [ "payment/term" ], "operationId": "payment/term-GetAllPaymentTermAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentTermSettingModel" } } } } } }, "/api/{api-version}/PaymentBatches/List": { "post": { "tags": [ "PaymentBatches" ], "summary": "PaymentBatches/List", "description": "This API will help to get the Payment Batches List", "operationId": "PaymentBatches-PaymentBatchesAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesViewModel" } } } } }, "/api/{api-version}/PaymentBatches/ListCount": { "post": { "tags": [ "PaymentBatches" ], "summary": "PaymentBatches/ListCount", "description": "This API will help to get the Payment Batches List", "operationId": "PaymentBatches-PaymentBatchesCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesViewModel" } } } } }, "/api/{api-version}/PaymentBatches/DetailById/{id}": { "get": { "tags": [ "PaymentBatches" ], "summary": "PaymentBatches/DetailById", "description": "This API will help to get the Payment Batch Detail", "operationId": "PaymentBatches-PaymentBatchesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchDetail" } } } } }, "/api/{api-version}/PaymentBatches/DraftDetailById/{id}/{invoiceId}": { "get": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-DraftPaymentBatchesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.DraftPaymentBatchDetail" } } } } }, "/api/{api-version}/PaymentBatches/upsert": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-UpsertPaymentBatchesAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatch" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/PaymentBatches/favorite": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesList/{customerId}": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListCount/{customerId}": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListCount", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/PaymentBatches/GetBatchInvoicesList/{batchId}": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBatchInvoicesAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "string" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/GetBatchInvoicesList/export": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-ExportMonthEndDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel+ExportPaymentBatchInvoice" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByBuyer": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByBuyer", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesByBuyerQueryViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByBuyerCount": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByBuyerCount", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByOrganization": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByOrganization", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesByOrganizationQueryViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByOrganizationCount": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByOrganizationCount", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByEvent": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByEvent", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesByEventQueryViewModel" } } } } }, "/api/{api-version}/PaymentBatches/GetBalanceInvoicesListByEventCount": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetBalanceInvoicesListByEventCount", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/PaymentBatches/GetInvoicesForBatchPayment": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-GetInvoicesForBatchPayment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicesForBatchPaymentQueryViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/VerifyInvoicesForBatchPayment": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-VerifyInvoicesForBatchPayment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "RequestModel", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatches.VerifyInvoicesForBatchPaymentModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatches.VerifyInvoicesForBatchPaymenViewModel" } } } } } }, "/api/{api-version}/PaymentBatches/RecordPaymentBatches": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-RecordPaymentBatches", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatches.RecordPaymentBatchesModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/PaymentBatches/Delete/{PaymentBatchesId}": { "delete": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-DeletePaymentBatches", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "PaymentBatchesId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/PaymentBatches/GetPaymentBatchesFilterOptions": { "post": { "tags": [ "PaymentBatches" ], "operationId": "PaymentBatches-PaymentBatchesFilterOptions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentBatchesFilterOptionsReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentBatchesFilterOptions" } } } } }, "/api/{api-version}/Permissions/GetPermissions": { "post": { "tags": [ "Permissions" ], "operationId": "Permissions-GetPermissions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "request", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Authorization.PermissionRequests" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Authorization.PermissionResponse" } } }, "400": { "description": "Bad Request" } } } }, "/api/{api-version}/Permissions/GetRolesPermissions": { "get": { "tags": [ "Permissions" ], "summary": "get permission based on roles", "operationId": "Permissions-GetRolesPermissions", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.Impl.ViewModels.UserContextModel" } }, "400": { "description": "Bad Request" } } } }, "/api/{api-version}/Public/get/billing-address/{customerType}/{customerId}": { "get": { "tags": [ "Public" ], "operationId": "Public-GetBillingAddressAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Public/detail/{invoiceId}/{personId}/{tenantCode}": { "get": { "tags": [ "Public" ], "operationId": "Public-InvoiceDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "personId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceViewModel" } } } } }, "/api/{api-version}/Public/GetSimpleInvoiceDetail/{invoiceId}": { "get": { "tags": [ "Public" ], "operationId": "Public-getInvoiceSimpleDetail", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSimpleView" } } } } }, "/api/{api-version}/Public/paymentoptions/{tenantCode}": { "get": { "tags": [ "Public" ], "operationId": "Public-GetPaymentOptions", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tenantcode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.TenantPaymentOptionPackage" } } } } }, "/api/{api-version}/Public/charge/{personId}/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-ChargePaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "personId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/Public/get/{tenantCode}": { "get": { "tags": [ "Public" ], "operationId": "Public-GetDateTime", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "date-time", "type": "string" } } } } }, "/api/{api-version}/Public/stripe/paymentintent/create/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-CreatePaymentIntent", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "createPaymentIntentRequestOptions", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentRequest" } }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentResponse" } } } } }, "/api/{api-version}/Public/paymentintentach/create/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-CreatePaymentIntentACH", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "createPaymentIntentRequestOptions", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreateACHPaymentIntentRequest" } }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentACHIntentResponse" } } } } }, "/api/{api-version}/Public/initiatePayment/{personId}/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-InitiateRegistrationPaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "personId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/Public/mapPaymentWithPaymentGatewayResponse/{personId}/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-MapPaymentWithPaymentGatewayResponseAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "personId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/Public/Authcharge/{personId}/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-AuthorizenetChargePaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AuthorizePaymentReqModel" } }, { "name": "personId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AuthorizePaymentResModel" } } } } }, "/api/{api-version}/Public/validateVoidPayment/{tenantCode}": { "post": { "tags": [ "Public" ], "operationId": "Public-validateVoidPayment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/Public/DeleteRegistrants": { "post": { "tags": [ "Public" ], "operationId": "Public-DeleteRegistrantsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.DeleteRegistrantsReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/Public/RestoreInvoiceToOriginalState": { "post": { "tags": [ "Public" ], "operationId": "Public-RestoreInvoiceToOriginalStateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RestoreInvoiceReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/Public/sendInvoice": { "post": { "tags": [ "Public" ], "operationId": "Public-SendInvoice", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SendInvoiceModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Public/RegCancelCreditNote": { "post": { "tags": [ "Public" ], "operationId": "Public-RegCancelCreditNote", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNoteRegCancelReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/Public/RegCancelParticipants": { "post": { "tags": [ "Public" ], "operationId": "Public-CancelParticipantsfromRevenue", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CancelParticipantsfromRevenueModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelCreditNoteResModel" } } } } }, "/api/{api-version}/Public/RemoveParticipantFromEventClassByInvoiceDetails": { "post": { "tags": [ "Public" ], "operationId": "Public-RemoveParticipantFromEventClassByInvoiceDetails", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceDetailViewModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Public/GetPaymentFormFields/{tenantCode}": { "get": { "tags": [ "Public" ], "operationId": "Public-GetPaymentFormFields", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tenantcode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentFormFieldsViewModel" } } } } }, "/api/{api-version}/Public/GetPaypalCred/{tenantCode}": { "get": { "tags": [ "Public" ], "operationId": "Public-GetPaypalCred", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tenantcode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentResponse" } } } } }, "/api/{api-version}/Public/SendModificationRegistrationMain": { "post": { "tags": [ "Public" ], "operationId": "Public-SendModificationRegistrationMain", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationModificationViewModels" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelCreditNoteResModelForEvent" } } } } }, "/api/{api-version}/Public/SendExhibitorRegistrationMain": { "post": { "tags": [ "Public" ], "operationId": "Public-SendExhibitorRegistrationMain", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ExhibitorRegistrationViewModels" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelCreditNoteResModelForEvent" } } } } }, "/api/{api-version}/Public/UpdateStripeMetaData": { "get": { "tags": [ "Public" ], "operationId": "Public-UpdateStripeMetaData", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "eventId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "tenantCode", "in": "query", "required": false, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/connection/create": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-CreateConnection", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnectModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnectViewModel" } } } } }, "/api/{api-version}/qb/integration/connection/all": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetConnectionRecords", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.ConnectionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnectViewModel" } } } } } }, "/api/{api-version}/qb/integration/token/generate": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GenerateToken", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookGenerateTokenModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookIntegrationToken" } } } } }, "/api/{api-version}/qb/integration/token/validate": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetConnection", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnect" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.ValidateTokenModel" } } } } }, "/api/{api-version}/qb/integration/webhook/master/import": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-ImportQBMasters", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBMasterImportModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnectViewModel" } } } } }, "/api/{api-version}/qb/integration/coa/list": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListViewModel" } } } } } }, "/api/{api-version}/qb/integration/coa/edit": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpdateCOAName", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "editModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/coa/delete": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-DeleteCOARecord", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Id", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COADeleteModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/coa/list/count": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAListCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/qb/integration/categories/enum": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCategoryEnumAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COACategoryEnum" } } } } } }, "/api/{api-version}/qb/integration/coa/filter": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAFilterOptionsAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListFilterOption" } } } } } }, "/api/{api-version}/qb/integration/coa/ddl": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListDdlOption" } } } } } }, "/api/{api-version}/qb/integration/coa/bycompany/ddl/{companyId}": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAByCompanyIdAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListDdlOption" } } } } } }, "/api/{api-version}/qb/integration/typesBycategory/{categoryId}": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCategoryTypesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CategoryTypesModel" } } } } } }, "/api/{api-version}/qb/integration/get/qbcompany/list": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetQbCompanyMasterListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QbCompanyModel" } } } } } }, "/api/{api-version}/qb/integration/objectsByCategoryType/{categoryId}/{typeId}": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCategoryTypesAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QbObjectNameModel" } } } } } }, "/api/{api-version}/qb/integration/create/coa/mapping/default": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-DefaultCOAMappingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingListViewModel" } } } } }, "/api/{api-version}/qb/integration/create/coa/mapping/itemwise": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-ItemWiseCOAMappingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingResponseModel" } } } } }, "/api/{api-version}/qb/integration/create/coa/mapping/manual": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-ManualCOAMappingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAManualTrxMappingReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingResponseModel" } } } } }, "/api/{api-version}/qb/integration/get/coa/mapping/itemwise": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetItemWiseCOAMappingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingListFilterOption" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAItemWiseResponse" } } } } }, "/api/{api-version}/qb/integration/get/coa/mapping/itemwise/count": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetItemWiseCOAMappingCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAItemLevelMappingFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/qb/integration/get/coa/mapping": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOADefaultMappingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingListViewModel" } } } } } }, "/api/{api-version}/qb/integration/coa/filter/list": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAFilterOptionsListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAFilterListOption" } } } } } }, "/api/{api-version}/qb/integration/webhook/syncinvoiceRequest": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncInvoices", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SyncRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/syncinvoiceRequestCount": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncInvoicesCount", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SyncRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/syncinvoiceResponse": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncInvoicesResponse", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "responseModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBInvoiceSyncResponse" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/syncpaymentRequest": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncPayments", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SyncRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/synccreditnoteRequest": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncCreditNotes", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SyncRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/syncPaymentResponse": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-SyncPaymentResponse", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "responseModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBPaymentSyncResponse" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/logging": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-Logging", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.LogRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookConnectViewModel" } } } } }, "/api/{api-version}/qb/integration/coamapping/filter": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAMappingFilterOptionsAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListFilterOption" } } } } } }, "/api/{api-version}/qb/integration/coamapping/list": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCOAMappingListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAItemLevelMappingFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAItemWiseResponse" } } } } }, "/api/{api-version}/qb/integration/webhook/companylist": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetCompanyListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CompanyWiseMasterSyncTime" } } } } } }, "/api/{api-version}/qb/integration/upsert/fiscalyear": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpsertFiscalYears", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "fiscalYear", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.FiscalYearViewModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/get/fiscalyearlist": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetFiscalYearListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.FiscalYearModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.FiscalYearModel" } } } } } }, "/api/{api-version}/qb/integration/delete/fiscalyear": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-DeleteFiscalYear", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "Id", "in": "query", "required": false, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/webhook/companystatus": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpdateCompanyStatusAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "data", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QbCompanyStatusModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/creditsettings/update": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpdateCreditSettingAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "data", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBCreditSettingsModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/coa/list/export": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-ExportCOAListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.COAExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/qb/integration/customermapping/peoplelist": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetPeopleListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeopleFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.PeopleListPagingModel" } } } } } }, "/api/{api-version}/qb/integration/customermapping/peoplelist/count": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetPeopleListCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeopleFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/qb/integration/customermapping/peoplemappingedit": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpdatePeopleMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "editModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.EditPeopleMappingModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/customermapping/peoplemappingdelete": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-DeletePeopleMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "deletePeopleMappings", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.DeletePeopleMappingModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/customermapping/getqbpeoplelist": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetQBPeopleListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBPeopleListViewModel" } } } } } }, "/api/{api-version}/qb/integration/invoice/getsyncstatusdata/{invoiceId}": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetInvoiceSyncDataAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBInvoiceMappingFailedModel" } } } } }, "/api/{api-version}/qb/integration/get/qbcustomerdata": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetQbcustomerDataAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBCustomerDataModel" } } } } } }, "/api/{api-version}/qb/integration/get/qbtermdata": { "get": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetQbTermDataAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBCustomerDataModel" } } } } } }, "/api/{api-version}/qb/integration/invoice/savemappings": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetInvoiceSyncDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "mappingModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBInvoiceMappingFailedModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/customermapping/organizationlist": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetOrganizationListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.OrgFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.PeopleListPagingModel" } } } } } }, "/api/{api-version}/qb/integration/customermapping/organizationlist/count": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-GetOrganizationListCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.OrgFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/qb/integration/customermapping/organizationmappingedit": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-UpdateOrganizationMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "editModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.QB.EditPeopleMappingModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/qb/integration/customermapping/organizationmappingdelete": { "post": { "tags": [ "qb/integration" ], "operationId": "qb/integration-DeleteOrganizationMapping", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "deletePeopleMappings", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.DeletePeopleMappingModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/refund/manual/record": { "post": { "tags": [ "refund" ], "summary": "method for saving and updating refund", "operationId": "refund-RecordManualRefundAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "description": "class having refund related properties", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.ManualRefundModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/{api-version}/refund/transaction/detail/{refundId}": { "post": { "tags": [ "refund" ], "operationId": "refund-GetRefundTransactionDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "refundId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RefundInvoicesListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundTransactionDetailViewModel" } } } } }, "/api/{api-version}/refund/detail/{refundId}": { "get": { "tags": [ "refund" ], "summary": "gets detail of Rufund by Id", "operationId": "refund-GetRefundDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "refundId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundDetailViewModel" } } } } }, "/api/{api-version}/refund/edit/manual/{refundId}": { "get": { "tags": [ "refund" ], "summary": "get details of refund by Id for editing", "operationId": "refund-GetManualRefundDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "refundId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.ManualRefundModel" } } } } }, "/api/{api-version}/refund/favorite": { "post": { "tags": [ "refund" ], "operationId": "refund-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/refund/custom/refund/{paymentId}": { "get": { "tags": [ "refund" ], "summary": "get refund initail data", "operationId": "refund-GetCustomRefundDataAgainstPaymentAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "paymentId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CustomRefundViewModel" } } } } }, "/api/{api-version}/refund/number": { "get": { "tags": [ "refund" ], "operationId": "refund-GetExistingRefundNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } } } } } }, "/api/{api-version}/refund/RefundNumberNext": { "get": { "tags": [ "refund" ], "operationId": "refund-GetNextRefundNumberAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/refund/record/refund": { "post": { "tags": [ "refund" ], "summary": "method for saving and updating refund", "operationId": "refund-RecordRefundAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "description": "class having refund related properties", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.CreditNotePaymentRefundModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RecordRefundViewModel" } } } } }, "/api/{api-version}/refund/record/MultipleRefundCreditNote": { "post": { "tags": [ "refund" ], "operationId": "refund-RecordMultipleCrediteNoteRefundAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "modellist", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.CreditNotePaymentRefundModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RecordRefundViewModel" } } } } } }, "/api/{api-version}/refund/updateclearingdate": { "post": { "tags": [ "refund" ], "operationId": "refund-UpdateClearingDate", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.UpdateRefundClearingDateModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/refund/SendRefundNotification": { "post": { "tags": [ "refund" ], "operationId": "refund-SendModificationRegistrationMain", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RefundNotificationViewModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelCreditNoteResModelForEvent" } } } } }, "/api/{api-version}/registration/checkPayment": { "post": { "tags": [ "registration" ], "operationId": "registration-CheckRegitrationPayment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/validateVoidPayment": { "post": { "tags": [ "registration" ], "operationId": "registration-validateVoidPayment", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/invoice": { "post": { "tags": [ "registration" ], "operationId": "registration-RegistrationInvoiceAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/RegModifiedInvoiceChange": { "post": { "tags": [ "registration" ], "operationId": "registration-RegModifiedInvoiceChange", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "ModifyRegistration", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ModifyRegistration" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.RegModifiedInvoiceChangeViewModel" } } } } }, "/api/{api-version}/registration/initiatePayment": { "post": { "tags": [ "registration" ], "operationId": "registration-InitiateRegistrationPaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/mapPaymentWithPaymentGatewayResponse": { "post": { "tags": [ "registration" ], "operationId": "registration-MapPaymentWithPaymentGatewayResponseAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/cancelUnprocessedPayment": { "post": { "tags": [ "registration" ], "operationId": "registration-CancelUnprocessedPaymentAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentResponseModel" } } } } }, "/api/{api-version}/registration/canModifyRegistration/{InvoiceId}": { "post": { "tags": [ "registration" ], "operationId": "registration-CanModifyTheRegistration", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "InvoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/registration/RegCancelParticipantsForEvent": { "post": { "tags": [ "registration" ], "operationId": "registration-CancelParticipantsfromRevenueForEvent", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "requestModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CancelParticipantsRevenueViewModels" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelCreditNoteResModelForEvent" } } } } }, "/api/{api-version}/registration/canModifyRegistration/{InvoiceId}/{type}": { "post": { "tags": [ "registration" ], "operationId": "registration-CanModifyTheRegistration", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "InvoiceId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "type", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/Get": { "post": { "tags": [ "Report" ], "operationId": "Report-GetReportsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.ReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportListViewModel" } } } } } }, "/api/{api-version}/Report/Count": { "post": { "tags": [ "Report" ], "operationId": "Report-GetReportCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.ReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportListViewModel" } } } } } }, "/api/{api-version}/Report/GetById/{id}": { "get": { "tags": [ "Report" ], "operationId": "Report-GetReportByIdAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportListViewModel" } } } } }, "/api/{api-version}/Report/UpdateReportViewer": { "post": { "tags": [ "Report" ], "operationId": "Report-UpdateReportViewerAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportViewerModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportListViewModel" } } } } } }, "/api/{api-version}/Report/MarkFavorite": { "post": { "tags": [ "Report" ], "operationId": "Report-UpdateReportFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportViewerModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportListViewModel" } } } } } }, "/api/{api-version}/Report/GetTrialReportByOrganization": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialReportByOrganizationsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialOrgGroupListViewModel" } } } } } }, "/api/{api-version}/Report/GetTrialReportByOrganization/Count": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialReportByOrganizationCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Report/GetTrialReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialReportAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialGroupListViewModel" } } } } } }, "/api/{api-version}/Report/GetTrialReport/Count": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialReportCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Report/ExportTrialReport": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportTrialReport", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "exportModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportExportModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/Report/GetTrialDetail/{customerId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailListModel" } } } } } }, "/api/{api-version}/Report/GetOrgTrialDetail/{organizationId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetOrgTrialDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailListModel" } } } } } }, "/api/{api-version}/Report/GetTrialDetail/Count/{customerId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialDetailCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Report/GetOrgTrialDetail/Count/{organizationId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialOrgDetailCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Report/GetTrialReportFilterOptions": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialReportFilterOptions", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterOptionsReqModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterOptions" } } } } }, "/api/{api-version}/Report/GetMonthEndReportData": { "post": { "tags": [ "Report" ], "operationId": "Report-GetMonthEndReportDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportResponseModel" } } } } }, "/api/{api-version}/Report/GetEventDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetEventMonthEndReportDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndEventReportResponseModel" } } } } }, "/api/{api-version}/Report/GetInvoiceDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetInvoiceDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndInvoiceReportResponseModel" } } } } }, "/api/{api-version}/Report/GetItemRevenueDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetItemRevenueDataReportAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndInvoiceReportResponseModel" } } } } }, "/api/{api-version}/Report/GetItemRevenueGrandTotalDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetItemRevenueGrandTotalDataReport", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.GrantTotalItemRevenueDataReportModel" } } } } }, "/api/{api-version}/Report/GetEventInvoiceItemsDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetEventInvoiceItemsDataReport", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndInvoiceReportResponseModel" } } } } }, "/api/{api-version}/Report/GetEventInvoiceItemsGrandTotalDataReport": { "post": { "tags": [ "Report" ], "operationId": "Report-GetEventInvoiceItemsGrandTotalDataReport", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndInvoiceReportResponseModel" } } } } }, "/api/{api-version}/Report/ItemRevenueDataReport/export": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportItemRevenueDataReportAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/EventInvoiceItemsDataReport/export": { "post": { "tags": [ "Report" ], "operationId": "Report-EventInvoiceItemsDataReport", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/monthlyrevenuereport/export": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportMonthEndDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/MonthlyrevenuereportInvoice/export": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportMonthEndInvoiceDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndReportInvoiceExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/SyncEventClass": { "get": { "tags": [ "Report" ], "operationId": "Report-SyncEventClass", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EventClasses.EventClassModel" } } } } } }, "/api/{api-version}/Report/SyncEventSession": { "get": { "tags": [ "Report" ], "operationId": "Report-SyncEventSession", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Event.EventSessionModel" } } } } } }, "/api/{api-version}/Report/SyncEventBundle": { "get": { "tags": [ "Report" ], "operationId": "Report-SyncEventBundle", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/CreditNoteReport/Export": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportCreditNoteBalanceAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "exportModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNoteFilterBody" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/Report/GetCreditNoteReport": { "post": { "tags": [ "Report" ], "operationId": "Report-CreditNoteReportAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNoteReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteGroupListViewModel" } } } } } }, "/api/{api-version}/Report/GetCreditNoteDetail/{customerId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetCreditNoteDetailAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNoteReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteReportDetailListModel" } } } } } }, "/api/{api-version}/Report/CreditNoteDetailsExportReport/Export": { "post": { "tags": [ "Report" ], "operationId": "Report-CreditNoteExportReportDataAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNoteReportExportModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/AgedTrialReport/export": { "post": { "tags": [ "Report" ], "operationId": "Report-ExportAgedTrialReportAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "exportModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportExportModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/SendNowUpdatedProfileReminder": { "get": { "tags": [ "Report" ], "operationId": "Report-SendNowUpdatedProfileReminder", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "Id", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Report/GetTrialInvoiceList/{customerId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetTrialInvoiceListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportInvoiceListModel" } } } } } }, "/api/{api-version}/Report/GetOrgTrialInvoiceList/{organizationId}": { "post": { "tags": [ "Report" ], "operationId": "Report-GetOrgTrialInvoiceListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailListModel" } } } } } }, "/api/{api-version}/Report/get/exportFieldList": { "post": { "tags": [ "Report" ], "operationId": "Report-GetExportFieldList", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "categoryIds", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.ExportReportField" } } } } } }, "/api/{api-version}/revenue/payment/customerprofile": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-CreateCustomerProfileAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CreateCustomerProfileRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/charge/creditcard": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-ChargeCreditCardAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ChargeCreditCardRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/refund/transaction": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-RefundTransactionAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.RefundTransactionRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/void/transaction": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-VoidTransactionAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.VoidTransactionRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/debit/bankaccount": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-DebitBankAccountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.DebitBankAccountRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/credit/bankaccount": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-CreditBankAccountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CreditBankAccountRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/payment/charge/customerprofile": { "post": { "tags": [ "revenue/payment" ], "operationId": "revenue/payment-ChargeCustomerProfileAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ChargeCustomerProfileRequestModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/revenue/service/save": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-SaveAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonPostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonListView" } } } } }, "/api/{api-version}/revenue/service/update": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-UpdateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonEditModel" } } } } }, "/api/{api-version}/revenue/service/copy/{subscriptionAddonId}": { "get": { "tags": [ "revenue/service" ], "operationId": "revenue/service-GetSubscriptionAddonCopyAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionAddonId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CopySubscriptionAddonEditModel" } } } } }, "/api/{api-version}/revenue/service/copy": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-CopySubscriptionAddonAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CopySubscriptionAddonEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonEditModel" } } } } }, "/api/{api-version}/revenue/service/tag/save": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-SaveTagsAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tags", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "uniqueItems": false }, { "name": "subscriptionAddonId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/revenue/service/list": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-GetListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionAddonFilterList" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonListViewModel" } } } } }, "/api/{api-version}/revenue/service/count": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-GetSubscriptionAddonCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionAddonFilterList" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/revenue/service/detail/{subscriptionId}": { "get": { "tags": [ "revenue/service" ], "operationId": "revenue/service-GetSubscriptionGeneralDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/revenue/service/mark/favorite": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-MarkFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/revenue/service/export": { "post": { "tags": [ "revenue/service" ], "operationId": "revenue/service-ExportSubscriptionAddonListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionAddonExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/revenue/service/subscribe/information": { "get": { "tags": [ "revenue/service/subscribe" ], "operationId": "revenue/service/subscribe-GetSubscriptionAddonSubscribeInfoAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "SubscriptionAddonId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonSubscribeInfoView" } } } } }, "/api/{api-version}/revenue/service/subscribe/keystatistics/netgrossactivation": { "get": { "tags": [ "revenue/service/subscribe/keystatistics" ], "operationId": "revenue/service/subscribe/keystatistics-GetNetVsGrossActivations", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.NetGrossActivationView" } } } } }, "/api/{api-version}/revenue/service/subscribe/keystatistics/totalservicesrevenue": { "get": { "tags": [ "revenue/service/subscribe/keystatistics" ], "operationId": "revenue/service/subscribe/keystatistics-GetTotalServicesRevenue", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.TotalMembershipSubscriptionView" } } } } }, "/api/{api-version}/revenue/service/subscribe/keystatistics/financeaccounting": { "get": { "tags": [ "revenue/service/subscribe/keystatistics" ], "operationId": "revenue/service/subscribe/keystatistics-GetFinanceAccounting", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.FinanceAccountingView" } } } } }, "/api/{api-version}/revenue/service/subscribe/keystatistics/recurringrevenuelist": { "get": { "tags": [ "revenue/service/subscribe/keystatistics" ], "operationId": "revenue/service/subscribe/keystatistics-GetRecurringRevenueList", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.MonthlyRevenueView" } } } } } }, "/api/{api-version}/revenue/service/subscribe/keystatistics/totalrevenuelist": { "get": { "tags": [ "revenue/service/subscribe/keystatistics" ], "operationId": "revenue/service/subscribe/keystatistics-GetTotalRevenueList", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.MonthlyRevenueView" } } } } } }, "/api/{api-version}/revenue/service/subscribe/memberconsumers/list": { "post": { "tags": [ "revenue/service/subscribe/memberconsumers" ], "operationId": "revenue/service/subscribe/memberconsumers-GetListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionAddonConsumersFilterList" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonMemberConsumerViewModel" } } } } }, "/api/{api-version}/revenue/service/subscribe/organizationconsumers/list": { "post": { "tags": [ "revenue/service/subscribe/organizationconsumers" ], "operationId": "revenue/service/subscribe/organizationconsumers-GetListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionAddonConsumersFilterList" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonOrganizationConsumerViewModel" } } } } }, "/api/{api-version}/revenue/subscription/individualsubscribers/list": { "post": { "tags": [ "revenue/subscription/individualsubscribers" ], "operationId": "revenue/subscription/individualsubscribers-GetListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionConsumersFilterList" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.IndividualSubscriberViewModel" } } } } }, "/api/{api-version}/Settings/list": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetTemplateListAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.RevenueTemplateViewModel" } } } } } }, "/api/{api-version}/Settings/create": { "post": { "tags": [ "Settings" ], "operationId": "Settings-CreateInvoiceTemplate", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.SettingModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.CreateRevenueTemplateResponseModel" } } } } }, "/api/{api-version}/Settings/getSettings": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetTenantSettings", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.SettingModel" } } } } }, "/api/{api-version}/Settings/seedSettings": { "get": { "tags": [ "Settings" ], "operationId": "Settings-SeedSettings", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success" } } } }, "/api/{api-version}/Settings/paymentoptions": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetPaymentOptions", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.TenantPaymentOptionPackage" } } } } }, "/api/{api-version}/Settings/PeopleNameSetting": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetPeopleNameConfigSetting", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Engagifii.common.GlobalHelpers.Domain.ConfigurationSettings.PeopleDisplayNameView" } } } } }, "/api/{api-version}/Settings/UpdatePeopleNameSetting": { "post": { "tags": [ "Settings" ], "operationId": "Settings-UpdatePeopleNameSetting", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "item", "in": "body", "required": false, "schema": { "$ref": "#/definitions/Engagifii.common.GlobalHelpers.Domain.ConfigurationSettings.PeopleDisplayNameView" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Engagifii.common.GlobalHelpers.Domain.ConfigurationSettings.PeopleDisplayNameView" } } } } }, "/api/{api-version}/Settings/paymentoptionsredacted": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetPaymentOptionsRedacted", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.TenantPaymentOptionPackage" } } } } }, "/api/{api-version}/Settings/GetPaymentFormFields": { "get": { "tags": [ "Settings" ], "operationId": "Settings-GetPaymentFormFields", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentFormFieldsViewModel" } } } } }, "/api/{api-version}/Settings/SavePaymentFormFields": { "post": { "tags": [ "Settings" ], "operationId": "Settings-SavePaymentFormFieldsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentFormFieldsPostViewModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Settings/SavePaymentGateway": { "post": { "tags": [ "Settings" ], "operationId": "Settings-SavePaymentGateway", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentGatewaySettingModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Settings/GetPaymentGateway": { "post": { "tags": [ "Settings" ], "operationId": "Settings-GetPaymentGateway", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/stripe/paymentintent/create": { "post": { "tags": [ "stripe" ], "operationId": "stripe-CreatePaymentIntent", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "createPaymentIntentRequestOptions", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentRequest" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentResponse" } } } } }, "/api/{api-version}/subscribe/steps/list/{subscriptionId}": { "get": { "tags": [ "subscribe/steps" ], "operationId": "subscribe/steps-GetSubcriptionStepsAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionStepsModel" } } } } } }, "/api/{api-version}/subscription/create": { "post": { "tags": [ "subscription" ], "operationId": "subscription-CreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionInlineEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionListView" } } } } }, "/api/{api-version}/subscription/update": { "post": { "tags": [ "subscription" ], "operationId": "subscription-UpdateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/count": { "post": { "tags": [ "subscription" ], "operationId": "subscription-GetSubscriptionCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/subscription/list": { "post": { "tags": [ "subscription" ], "operationId": "subscription-GetSubscriptionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionListViewModel" } } } } }, "/api/{api-version}/subscription/detail/{subscriptionId}": { "get": { "tags": [ "subscription" ], "operationId": "subscription-GetSubscriptionGeneralDetailAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/favorite": { "post": { "tags": [ "subscription" ], "operationId": "subscription-MarkIsFavoriteAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.MarkFavoritePostModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/subscription/copy/{subscriptionId}": { "get": { "tags": [ "subscription" ], "operationId": "subscription-GetSubscriptionCopyAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CopySubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/copy": { "post": { "tags": [ "subscription" ], "operationId": "subscription-CopySubscription", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.CopySubscriptionEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/export": { "post": { "tags": [ "subscription" ], "operationId": "subscription-ExportSubscriptionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.SubscriptionExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/subscription/tag/save": { "post": { "tags": [ "subscription" ], "operationId": "subscription-SaveTagsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionTagEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/subscription/subscriptionType/create": { "post": { "tags": [ "subscription" ], "operationId": "subscription-SubscriptionTypeCreateAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionTypeEditModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success" } } } }, "/api/{api-version}/subscription/discontinue/{id}": { "post": { "tags": [ "subscription" ], "operationId": "subscription-DiscontinueSubscriptionSync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/delete/{id}": { "post": { "tags": [ "subscription" ], "operationId": "subscription-DeleteSubscriptionSync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionEditModel" } } } } }, "/api/{api-version}/subscription/item/name/{customerType}/{customerId}": { "get": { "tags": [ "subscription" ], "operationId": "subscription-GetItemNameListCategoryWiseAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "customerType", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customerId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ManualInvoiceItemViewModel" } } } } } }, "/api/{api-version}/timezone/get": { "get": { "tags": [ "timezone" ], "operationId": "timezone-GetDateTime", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "date-time", "type": "string" } } } } }, "/api/{api-version}/Transaction/list/all": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAllTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionsListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/list/filters": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAllFilterListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionFilterOptionDataModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/webhook/{tenantCode}": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAccountMatricsAsyncAll", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "tenantCode", "in": "path", "required": true, "type": "string" }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel" } } } } }, "/api/{api-version}/Transaction/stripe/customer/create": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-CreateStripeCustomer", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "data", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.StripeCustomer" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } } } }, "/api/{api-version}/Transaction/list/all/matrics": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAccountMatricsAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionsListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel" } } } } }, "/api/{api-version}/Transaction/list/export": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-ExportAllTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/Transaction/export": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-ExportInvoiceListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceListExportFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/Transaction/Paymentexport": { "post": { "tags": [ "Transaction" ], "summary": "action method for getting result of data to be export", "operationId": "Transaction-ExportTransationPaymentListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentTransactionExportFilter" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/Transaction/refundexport": { "post": { "tags": [ "Transaction" ], "summary": "action method for getting result of data to be export", "operationId": "Transaction-ExportTransationRefundListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RefundTransactionExportFilter" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileStreamResult" } } } } }, "/api/{api-version}/Transaction/filterItems/all": { "get": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAllListFilterData", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ListFilterDataViewModel" } } } } }, "/api/{api-version}/Transaction/count/all": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAllTransactionCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionsListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Transaction/consumerlist/all": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetConsumerAllTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.ConsumerTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/consumercount/all": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetConsumerTransactionCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.ConsumerTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Transaction/list/invoice": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetInvoiceTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.InvoiceTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.InvoiceTransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/count/invoice": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetInvoiceTransactionListCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.InvoiceTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int64", "type": "integer" } } } } }, "/api/{api-version}/Transaction/count/payment": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetPaymentTransactionCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/Transaction/list/payment": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetPaymentTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PaymentTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.PaymentTransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/count/refund": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetRefundTransactionCountAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RefundTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/{api-version}/Transaction/list/refund": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-GetRefundTransactionListAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.RefundTransactionListFilterModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.RefundTransactionListViewModel" } } } } } }, "/api/{api-version}/Transaction/transactionSerial/all": { "get": { "tags": [ "Transaction" ], "operationId": "Transaction-GetAllTransactionStartingSerialValues", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionSerialStartValueModel" } } } } }, "/api/{api-version}/Transaction/validateinvoice": { "post": { "tags": [ "Transaction" ], "operationId": "Transaction-ValidateInvoices", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "filterModel", "in": "body", "required": false, "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ValidateModel" } } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.ValidateInvoiceModel" } } } } }, "/api/{api-version}/transaction/activity/list/{activityItemId}": { "get": { "tags": [ "transaction/activity" ], "operationId": "transaction/activity-List", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "activityItemId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "transactionEntityType", "in": "query", "required": false, "type": "string", "enum": [ "invoice", "payment", "creditNote", "refund" ] }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionActivityLogViewModel" } } } } } }, "/api/{api-version}/transaction/activity/list-by-date/{invoiceOrPaymentId}": { "get": { "tags": [ "transaction/activity" ], "summary": "Pass invoice id to get the activity of inovice\r\nPass payment id to get the activity of payment", "operationId": "transaction/activity-ListByDate", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "invoiceOrPaymentId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "transactionEntityType", "in": "query", "description": "", "required": false, "type": "string", "enum": [ "invoice", "payment", "creditNote", "refund" ] }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionActivityLogViewModel" } } } } } }, "/api/{api-version}/transaction/activity/save": { "post": { "tags": [ "transaction/activity" ], "operationId": "transaction/activity-ActivityList", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "saveActivityModel", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.SaveActivityModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/user/preference": { "get": { "tags": [ "user" ], "operationId": "user-GetPreferenceAsync", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/api.revenue.ApiModels.UserUiPreferenceModel" } } } } }, "/api/{api-version}/user/preference/save": { "post": { "tags": [ "user" ], "operationId": "user-SaveAsync", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "application/json" ], "parameters": [ { "name": "model", "in": "body", "required": false, "schema": { "$ref": "#/definitions/api.revenue.ApiModels.UserUiPreferenceModel" } }, { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } } } }, "/api/{api-version}/user/cards": { "get": { "tags": [ "user" ], "operationId": "user-GetSavedCards", "consumes": [], "produces": [ "application/json" ], "parameters": [ { "name": "api-version", "in": "path", "required": true, "type": "string" }, { "name": "tenant-code", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CustomerPaymentProfileViewMOdel" } } } } } } }, "definitions": { "api.revenue.ApiModels.Filters.RevenueMetricsFilterModel": { "type": "object", "properties": { "transactionType": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "paymentStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "refundStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "paymentMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "itemType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "invoicePaidInFullDate": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "creationDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "originalDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "itemName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumber": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "isPersonSpecific": { "type": "boolean" }, "buyerOrganization": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "text": { "type": "string" }, "invoiceId": { "type": "string" }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "invoiceType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "api.revenue.ApiModels.Filters.DateFilterModel": { "type": "object", "properties": { "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "isEmpty": { "type": "boolean", "readOnly": true } } }, "api.revenue.ApiModels.AccountBalance.ConsumerStatisticsViewModel": { "type": "object", "properties": { "totalInvoices": { "format": "double", "type": "number" }, "totalPayments": { "format": "double", "type": "number" }, "totalCredits": { "format": "double", "type": "number" }, "totalRefunds": { "format": "double", "type": "number" }, "totalDue": { "format": "double", "type": "number" }, "totalOverDue": { "format": "double", "type": "number" }, "invoiced": { "format": "double", "type": "number" }, "invoicedThisYear": { "format": "double", "type": "number" }, "paymentsReceived": { "format": "double", "type": "number" }, "paymentsReceivedThisYear": { "format": "double", "type": "number" }, "due": { "format": "double", "type": "number" }, "overDue": { "format": "double", "type": "number" }, "credits": { "format": "double", "type": "number" }, "appliedCredits": { "format": "double", "type": "number" }, "unAppliedCredits": { "format": "double", "type": "number" }, "refunds": { "format": "double", "type": "number" }, "refundThisYear": { "format": "double", "type": "number" }, "balance": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Filters.TransactionsListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "invoiceId": { "type": "string" }, "invoiceType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "paymentStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "acctSysSync": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "refundStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "creditNoteStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "itemType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumber": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "creationDate": { "format": "date-time", "type": "string" }, "consumerType": { "enum": [ "Item", "Individual", "Organization" ], "type": "string" }, "consumerId": { "type": "string" }, "cnStatus": { "type": "boolean" }, "isPersonSpecific": { "type": "boolean" }, "viewHoldInvoices": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "showUniqueTransactions": { "type": "boolean" }, "uniqueLastState": { "type": "boolean" }, "paymentMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "refundMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "invoicePaidInFullDate": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "exportDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "clearingDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "originalDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "itemName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerOrganization": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "viewMyTransactions": { "type": "boolean" }, "viewMyOrganizationTransactions": { "type": "boolean" }, "permisionType": { "format": "int32", "type": "integer" }, "tenantUserId": { "format": "uuid", "type": "string" }, "consolidatedInvoiceId": { "format": "uuid", "type": "string" }, "paymentGateway": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "revisionStatus": { "format": "int32", "type": "integer" }, "localDateTime": { "format": "date-time", "type": "string" }, "pmtGatewayTrxId": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "showPayments": { "type": "boolean" }, "showInvoices": { "type": "boolean" }, "showRefunds": { "type": "boolean" }, "showCreditNotes": { "type": "boolean" }, "showFailedPayments": { "type": "boolean" }, "exportType": { "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "isLineItemExport": { "type": "boolean" }, "isEmpty": { "type": "boolean", "readOnly": true }, "includePayments": { "type": "boolean", "readOnly": true }, "includeInvoices": { "type": "boolean", "readOnly": true }, "includeRefunds": { "type": "boolean", "readOnly": true }, "includeCreditNotes": { "type": "boolean", "readOnly": true }, "dataFilterType": { "format": "int32", "type": "integer" }, "dataFilter": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DataFilterModel" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.DataFilterModel": { "type": "object", "properties": { "dayFilter": { "format": "int32", "type": "integer" }, "createDateRangeFilter": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" } } }, "api.revenue.ApiModels.AccountBalance.AllTransactionStatisticsViewModel": { "type": "object", "properties": { "totalInvoices": { "format": "double", "type": "number" }, "totalPayments": { "format": "double", "type": "number" }, "totalCredits": { "format": "double", "type": "number" }, "totalRefunds": { "format": "double", "type": "number" }, "totalDue": { "format": "double", "type": "number" }, "totalOverDue": { "format": "double", "type": "number" }, "invoiced": { "format": "double", "type": "number" }, "invoicedThisYear": { "format": "double", "type": "number" }, "paymentsReceived": { "format": "double", "type": "number" }, "paymentsReceivedThisYear": { "format": "double", "type": "number" }, "due": { "format": "double", "type": "number" }, "overDue": { "format": "double", "type": "number" }, "credits": { "format": "double", "type": "number" }, "appliedCredits": { "format": "double", "type": "number" }, "unAppliedCredits": { "format": "double", "type": "number" }, "refunds": { "format": "double", "type": "number" }, "refundThisYear": { "format": "double", "type": "number" }, "balance": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.EventItemsViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "revenueAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "cancellationAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "modificationAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "departmentCode": { "$ref": "#/definitions/api.revenue.ApiModels.EntityDepartmentCodeBaseModel" }, "eventClass": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } }, "eventSession": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } }, "exhibitor": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } }, "eventBundle": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } }, "exhibitorStaff": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.EntityItemViewModel" } } } }, "api.revenue.ApiModels.EntityAccountBaseModel": { "type": "object", "properties": { "accountCode": { "type": "string" }, "accountCodeDisplayName": { "type": "string" }, "accountCodeId": { "format": "uuid", "type": "string" }, "accountTypeName": { "type": "string" } } }, "api.revenue.ApiModels.EntityDepartmentCodeBaseModel": { "type": "object", "properties": { "departmentCode": { "type": "string" }, "departmentDisplayName": { "type": "string" }, "departmentName": { "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.EntityItemViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "entityType": { "format": "int32", "type": "integer" }, "revenueAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "cancellationAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "modificationAccount": { "$ref": "#/definitions/api.revenue.ApiModels.EntityAccountBaseModel" }, "departmentCode": { "$ref": "#/definitions/api.revenue.ApiModels.EntityDepartmentCodeBaseModel" } } }, "api.revenue.ApiModels.AccountCodeUpdateModel": { "type": "object", "properties": { "entityId": { "type": "string" }, "entityType": { "format": "int32", "type": "integer" }, "dirtyFlag": { "type": "string" }, "accountCodeId": { "format": "uuid", "type": "string" }, "cancellationAccountCodeId": { "format": "uuid", "type": "string" }, "modificationAccountCodeId": { "format": "uuid", "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.EntityAccountCodeModel": { "type": "object", "properties": { "entityId": { "type": "string" }, "entityType": { "format": "int32", "type": "integer" }, "displayName": { "type": "string" }, "accountCode": { "type": "string" }, "accountCodeId": { "format": "uuid", "type": "string" }, "accountCodeTypeName": { "type": "string" }, "cancellationAccountCode": { "type": "string" }, "cancellationAccountCodeDisplayName": { "type": "string" }, "cancellationAccountCodeId": { "format": "uuid", "type": "string" }, "cancellationAccountTypeName": { "type": "string" }, "modificationAccountCode": { "type": "string" }, "modificationAccountCodeDisplayName": { "type": "string" }, "modificationAccountCodeId": { "format": "uuid", "type": "string" }, "modificationAccountTypeName": { "type": "string" }, "departmentCode": { "type": "string" }, "departmentName": { "type": "string" }, "departmentDisplayName": { "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.AccountCodeMasterModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "accountCode": { "type": "string" }, "displayName": { "type": "string" }, "accountTypeName": { "type": "string" }, "displayNameWithType": { "type": "string" }, "subAccountCode": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AccountCodeMasterModel" } } } }, "api.revenue.ApiModels.AccountCodeCreateModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "accountCode": { "type": "string" }, "displayName": { "type": "string" }, "parentId": { "format": "uuid", "type": "string" }, "accountCodeTypeId": { "format": "uuid", "type": "string" }, "engagifiiAlias": { "type": "string" }, "description": { "type": "string" } } }, "api.revenue.ApiModels.DepartmentCodeMasterModel": { "type": "object", "properties": { "departmentCodeId": { "format": "uuid", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" } } }, "api.revenue.ApiModels.DepartmentCodeMasterCreateModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" } } }, "api.revenue.ApiModels.AccountCodeTypeModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "count": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.AccountCodeTypeCreateModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.AddressCreationModel": { "type": "object", "properties": { "customerType": { "format": "int32", "type": "integer" }, "customerId": { "format": "uuid", "type": "string" }, "addressType": { "format": "int32", "type": "integer" }, "location": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteCreationModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "creditNoteDate": { "format": "date-time", "type": "string" }, "creditNoteTime": { "format": "date-time", "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "remainingCreditAmount": { "format": "double", "type": "number" }, "totalAppliedAmount": { "format": "double", "type": "number" }, "reason": { "type": "string" }, "note": { "type": "string" }, "creditNoteFor": { "format": "int32", "type": "integer" }, "customerId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "customCreditNoteNumber": { "type": "string" }, "creditNoteNumber": { "format": "int64", "type": "integer" }, "isFavorite": { "type": "boolean" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerIcon": { "type": "string" }, "status": { "type": "string" }, "cnSourceId": { "format": "int32", "type": "integer" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceModel" } }, "payments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNotePaymentModel" } } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "dueDate": { "format": "date-time", "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNoteUseItemWiseModel" } }, "usedDate": { "format": "date-time", "type": "string" }, "type": { "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.CreditNotePaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "type": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "invoiceNumber": { "type": "string" }, "paymentAmount": { "format": "double", "type": "number" }, "invoiceAmount": { "format": "double", "type": "number" }, "paymentDate": { "format": "date-time", "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "note": { "type": "string" }, "creditNoteIssuedAmount": { "format": "double", "type": "number" }, "remainingAmountForIssuingCreditNote": { "format": "double", "type": "number" }, "invoices": { "type": "string" }, "paymentInvoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSimpleModel" } } } }, "api.revenue.ApiModels.CreditNoteUseItemWiseModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "itemId": { "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "itemUsedAmount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" }, "creditNoteinvoiceId": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.InvoiceSimpleModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "issuedAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.GetPaymentItemUsedDetailModel" } } } }, "api.revenue.ApiModels.QB.GetPaymentItemUsedDetailModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "itemId": { "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "itemPaidAmount": { "format": "double", "type": "number" }, "itemIssuedAmount": { "format": "double", "type": "number" }, "itemAppliedAmount": { "format": "double", "type": "number" }, "invoicePaidAmount": { "format": "double", "type": "number" }, "invoiceIssuedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteUseModel": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "creditBalanceUsedAmount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "invoice": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSimpleModel" }, "paymentId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "creditNoteId": { "type": "string" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteListViewModel": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteViewModel" } } } }, "api.revenue.ApiModels.PagingModel": { "type": "object", "properties": { "pageSize": { "format": "int32", "type": "integer" }, "totalRecords": { "format": "int64", "type": "integer" }, "currentPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "creditNoteNumber": { "type": "string" }, "customerType": { "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "customerIcon": { "type": "string" }, "createdBy": { "type": "string" }, "icon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "activityCount": { "format": "int32", "type": "integer" }, "isItemSelected": { "type": "boolean" }, "isExpanded": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.CreditNotesInvoiceFilterModel": { "type": "object", "properties": { "invoiceNumber": { "type": "string" }, "text": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceItemViewModel" } }, "date": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceItemViewModel": { "type": "object", "properties": { "icon": { "type": "string" }, "item": { "type": "string" } } }, "api.revenue.ApiModels.MarkFavoritePostModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteDetailViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "creditNoteDate": { "format": "date-time", "type": "string" }, "creditNoteTime": { "format": "date-time", "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "remainingCreditAmount": { "format": "double", "type": "number" }, "totalAppliedAmount": { "format": "double", "type": "number" }, "totalRefundAmount": { "format": "double", "type": "number" }, "reason": { "type": "string" }, "note": { "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "creditNoteNumber": { "type": "string" }, "isFavorite": { "type": "boolean" }, "customerType": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerName": { "type": "string" }, "customerIcon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "status": { "type": "string" }, "tenantIcon": { "type": "string" }, "tenantAddress": { "type": "string" }, "creditType": { "format": "int32", "type": "integer" }, "isOverPayment": { "type": "boolean" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceModel" } }, "payments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNotePaymentModel" } }, "refunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteRefundsViewModel" } } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteRefundsViewModel": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "refundNote": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "clearingDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "reason": { "type": "string" }, "refundNumber": { "type": "string" }, "referenceNo": { "type": "string" }, "mode": { "format": "int32", "type": "integer" }, "modeText": { "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.PaymentsGroupByInvoices": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "payments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.PaymentsForCreditNoteIssue" } } } }, "api.revenue.ApiModels.CreditNotes.PaymentsForCreditNoteIssue": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "paymentAmount": { "format": "double", "type": "number" }, "amount": { "format": "double", "type": "number" }, "status": { "type": "string" }, "mode": { "type": "string" }, "statusId": { "format": "int32", "type": "integer" }, "modeId": { "format": "int32", "type": "integer" }, "orignalModeId": { "format": "int32", "type": "integer" }, "note": { "type": "string" }, "creditIssuedAmount": { "format": "double", "type": "number" }, "remainingPaymentAmount": { "format": "double", "type": "number" }, "creditNotes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.UnsettledCreditNote" } } } }, "api.revenue.ApiModels.CreditNotes.UnsettledCreditNote": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "creditNoteBalanceAmount": { "format": "double", "type": "number" }, "status": { "type": "string" }, "createdon": { "format": "date-time", "type": "string" }, "statusId": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "creditNoteId": { "type": "string" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "Microsoft.AspNetCore.Mvc.FileStreamResult": { "type": "object", "properties": { "fileStream": { "$ref": "#/definitions/System.IO.Stream" }, "contentType": { "type": "string", "readOnly": true }, "fileDownloadName": { "type": "string" }, "lastModified": { "format": "date-time", "type": "string" }, "entityTag": { "$ref": "#/definitions/Microsoft.Net.Http.Headers.EntityTagHeaderValue" }, "enableRangeProcessing": { "type": "boolean" } } }, "System.IO.Stream": { "type": "object", "properties": { "canRead": { "type": "boolean", "readOnly": true }, "canSeek": { "type": "boolean", "readOnly": true }, "canTimeout": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "length": { "format": "int64", "type": "integer", "readOnly": true }, "position": { "format": "int64", "type": "integer" }, "readTimeout": { "format": "int32", "type": "integer" }, "writeTimeout": { "format": "int32", "type": "integer" } } }, "Microsoft.Net.Http.Headers.EntityTagHeaderValue": { "type": "object", "properties": { "tag": { "$ref": "#/definitions/Microsoft.Extensions.Primitives.StringSegment", "readOnly": true }, "isWeak": { "type": "boolean", "readOnly": true } } }, "Microsoft.Extensions.Primitives.StringSegment": { "type": "object", "properties": { "buffer": { "type": "string", "readOnly": true }, "offset": { "format": "int32", "type": "integer", "readOnly": true }, "length": { "format": "int32", "type": "integer", "readOnly": true }, "value": { "type": "string", "readOnly": true }, "hasValue": { "type": "boolean", "readOnly": true } } }, "api.revenue.ApiModels.QB.CreditNotItemUsedDetailViewModel": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "mode": { "type": "string" }, "modeId": { "format": "int32", "type": "integer" }, "orignalModeId": { "format": "int32", "type": "integer" }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteAmount": { "format": "double", "type": "number" }, "creditNoteStatusId": { "format": "int32", "type": "integer" }, "creditNoteStatus": { "type": "string" }, "creditNoteNumber": { "type": "string" }, "creditNoteCreated": { "format": "date-time", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "remainingAmount": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CreditNotInvoiceItems" } } } }, "api.revenue.ApiModels.QB.CreditNotInvoiceItems": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "itemId": { "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "itemIssuedAmount": { "format": "double", "type": "number" }, "itemUsedAmount": { "format": "double", "type": "number" }, "itemRemainingAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.CreditRequestCreditNoteCreationModel": { "type": "object", "properties": { "amountToCredit": { "format": "double", "type": "number" }, "reason": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerIcon": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "creditRequestId": { "type": "string" }, "requestId": { "type": "string" } } }, "api.revenue.DomainModels.TemplateMacro": { "type": "object", "properties": { "identifierName": { "type": "string" }, "codeString": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.EnumModel": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "text": { "type": "string" } } }, "api.revenue.ApiModels.ViewModel.DropdownItemModel": { "type": "object", "properties": { "text": { "type": "string" }, "value": { "type": "string" }, "icon": { "type": "string" } } }, "api.revenue.ApiModels.CustomerDropdownItemModel": { "type": "object", "properties": { "text": { "type": "string" }, "value": { "type": "string" }, "icon": { "type": "string" }, "organizationName": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceRevisionModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "isRevision": { "type": "boolean" } } }, "api.revenue.ApiModels.InvoiceViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "eventRegistrationType": { "enum": [ "None", "Member", "Exhibitor" ], "type": "string" }, "invoiceNumber": { "type": "string" }, "status": { "type": "string" }, "billerName": { "type": "string" }, "isPersonActive": { "type": "boolean" }, "isPersonDeleted": { "type": "boolean" }, "buyerStatus": { "type": "boolean" }, "billerId": { "format": "uuid", "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "invoiceFor": { "format": "int32", "type": "integer" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceTime": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "total": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemViewModel" } }, "billTo": { "type": "string" }, "customerType": { "type": "string" }, "customerName": { "type": "string" }, "discountType": { "type": "string" }, "discountTypeId": { "format": "int32", "type": "integer" }, "discount": { "format": "double", "type": "number" }, "paymentTerm": { "type": "string" }, "paymentTermId": { "format": "uuid", "type": "string" }, "subTotal": { "format": "double", "type": "number" }, "totalPrice": { "format": "double", "type": "number" }, "customerIcon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "note": { "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "isFavorite": { "type": "boolean" }, "isOverdue": { "type": "boolean" }, "tax": { "format": "double", "type": "number" }, "balanceAmount": { "format": "double", "type": "number" }, "tenantIcon": { "type": "string" }, "tenantAddress": { "type": "string" }, "billedOn": { "format": "date-time", "type": "string" }, "paidAmount": { "format": "double", "type": "number" }, "isLatePaymentApply": { "type": "boolean" }, "lateAmount": { "format": "double", "type": "number" }, "latePaymentType": { "enum": [ "PercentageOfTransaction", "FixedCharge" ], "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "fullPaymentDate": { "format": "date-time", "type": "string" }, "remittanceId": { "format": "uuid", "type": "string" }, "invoiceDeliveryAddress": { "format": "uuid", "type": "string" }, "invoiceRemittanceAddressId": { "format": "uuid", "type": "string" }, "remittanceContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "isMarkVoidAllowed": { "type": "boolean" }, "voidInvoiceDetail": { "$ref": "#/definitions/api.revenue.ApiModels.VoidModel" }, "requestedBy": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "invoicePaidDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePaidDetail" } }, "consolidatedInvoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ConsolidatedListModel" } }, "previousCreationDate": { "format": "date-time", "type": "string" }, "previousInvoiceNumber": { "type": "string" }, "previousInvoiceId": { "type": "string" }, "previousStatus": { "format": "int32", "type": "integer" }, "auditRemarks": { "type": "string" }, "paymentAuditRemarks": { "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "gatewayStatus": { "type": "boolean" }, "paymentMode": { "format": "int32", "type": "integer" }, "paymentStatus": { "format": "int32", "type": "integer" }, "invoiceAllowPay": { "type": "boolean" }, "syncStatus": { "type": "string" }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "billingContactsDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" } }, "email": { "type": "string" }, "invoiceLink": { "type": "string" }, "paymentBatchesDetails": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesDetails" } }, "sourceColumnName": { "type": "string" }, "sourceItemName": { "type": "string" }, "sourceItemType": { "format": "int32", "type": "integer" }, "itemName": { "type": "string" }, "registrationNumber": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationInfo" } }, "groupNumber": { "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "paymentApplied": { "format": "double", "type": "number" }, "dueBalance": { "format": "double", "type": "number" }, "lastReminderSent": { "$ref": "#/definitions/api.revenue.ApiModels.LastReminderSentViewModel" }, "statusId": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.InvoiceItemViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemType": { "format": "int32", "type": "integer" }, "itemTypeName": { "type": "string" }, "itemCategoryId": { "format": "int32", "type": "integer" }, "itemCategory": { "type": "string" }, "accountNumber": { "type": "string" }, "accountCodeId": { "format": "uuid", "type": "string" }, "departmentCode": { "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" }, "description": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "itemId": { "type": "string" }, "createdDate": { "format": "date-time", "type": "string" }, "cost": { "format": "double", "type": "number" }, "sku": { "format": "int32", "type": "integer" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "quantity": { "format": "double", "type": "number" }, "tax": { "format": "double", "type": "number" }, "sequence": { "format": "int32", "type": "integer" }, "total": { "format": "double", "type": "number", "readOnly": true }, "itemName": { "type": "string" }, "discount": { "format": "double", "type": "number" }, "iconUrl": { "type": "string" }, "whoIsThisFor": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "balanceDue": { "format": "double", "type": "number" }, "isCancelled": { "type": "boolean" } } }, "api.revenue.ApiModels.VoidModel": { "type": "object", "properties": { "reason": { "type": "string" }, "markedVoidById": { "format": "uuid", "type": "string" }, "markedVoidByName": { "type": "string" }, "imageUrl": { "type": "string" }, "markedVoidDateTime": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.InvoicePersonInfo": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "iconUrl": { "type": "string" }, "email": { "type": "string" }, "isGuest": { "type": "boolean" }, "guestCount": { "format": "int32", "type": "integer" }, "invoicePersonType": { "enum": [ "Person", "Organization" ], "type": "string" }, "guestOf": { "$ref": "#/definitions/api.revenue.ApiModels.GuestRegistrantClientView" } } }, "api.revenue.ApiModels.InvoicePaidDetail": { "type": "object", "properties": { "trxDateTime": { "format": "date-time", "type": "string" }, "trxType": { "type": "string" }, "trxNumber": { "type": "string" }, "trxId": { "format": "uuid", "type": "string" }, "paymentMethod": { "type": "string" }, "totalAmount": { "format": "double", "type": "number" }, "amountApplied": { "format": "double", "type": "number" }, "trxById": { "format": "uuid", "type": "string" }, "trxByName": { "type": "string" }, "trxByImageUrl": { "type": "string" } } }, "api.revenue.ApiModels.ConsolidatedListModel": { "type": "object", "properties": { "buyerType": { "type": "string" }, "buyerName": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "buyerImageUrl": { "type": "string" }, "requestedBy": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "poNumber": { "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemViewModel" } }, "billedOn": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "invoiceName": { "type": "string" }, "createdDate": { "format": "date-time", "type": "string" }, "amount": { "type": "string" } } }, "api.revenue.ApiModels.PaymentBatchesDetails": { "type": "object", "properties": { "paymentBatchesID": { "format": "uuid", "type": "string" }, "paymentBatchesName": { "type": "string" }, "paymentBatchStatus": { "format": "int32", "type": "integer" }, "controlAmount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.RegistrationInfo": { "type": "object", "properties": { "registrationNumber": { "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "whoIsThisFor": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" } } }, "api.revenue.ApiModels.LastReminderSentViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "lastReminderSentDate": { "format": "date-time", "type": "string" }, "lastReminderSentByName": { "type": "string" }, "lastReminderSentById": { "format": "uuid", "type": "string" }, "lastReminderSentByImageUrl": { "type": "string" } } }, "api.revenue.ApiModels.GuestRegistrantClientView": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.InvoicePaymentDetail": { "type": "object", "properties": { "paymentDate": { "format": "date-time", "type": "string" }, "trxType": { "type": "string" }, "txnNumber": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentMethod": { "type": "string" }, "totalAmount": { "format": "double", "type": "number" }, "amountPaid": { "format": "double", "type": "number" }, "trxById": { "format": "uuid", "type": "string" }, "trxByName": { "type": "string" }, "trxByImageUrl": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceItemFilterModel": { "type": "object", "properties": { "item": { "type": "string" }, "invoiceItemFilterType": { "enum": [ "Event", "Class" ], "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.InvoiceItemPurchasedViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemCategory": { "type": "string" }, "itemCategoryIcon": { "type": "string" }, "itemType": { "type": "string" }, "total": { "format": "double", "type": "number" }, "quantity": { "format": "double", "type": "number" }, "tag": { "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPurchasedModel" } } } }, "api.revenue.ApiModels.InvoiceItemPurchasedModel": { "type": "object", "properties": { "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "itemType": { "type": "string" }, "itemId": { "type": "string" }, "whoIsThisFor": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "customerName": { "type": "string" }, "quantity": { "format": "double", "type": "number" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "refundAmount": { "format": "double", "type": "number" } } }, "api.revenue.DomainModels.ConsolidatedInvoiceRefreshDetails": { "type": "object", "properties": { "invoiceJson": { "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.ConsolidatedInvoiceListModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceName": { "type": "string" }, "createdDate": { "format": "date-time", "type": "string" }, "amount": { "type": "string" } } }, "api.revenue.ApiModels.InvoicePartialViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "balanceAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "creditedAmount": { "format": "double", "type": "number" }, "invoiceDate": { "format": "date-time", "type": "string" }, "amount": { "format": "double", "type": "number" }, "itemCount": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.ViewModel.OrgDependenciesModel": { "type": "object", "properties": { "openCount": { "format": "int32", "type": "integer" }, "totalCount": { "format": "int32", "type": "integer" }, "openLineItem": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.LineItem" } }, "totalLineItem": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ViewModel.LineItem" } } } }, "api.revenue.ApiModels.ViewModel.LineItem": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" } } }, "api.revenue.ApiModels.ManualInvoiceCreationModel": { "type": "object", "properties": { "invoiceType": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "eventRegistrationType": { "enum": [ "None", "Member", "Exhibitor" ], "type": "string" }, "customerType": { "type": "string" }, "customerName": { "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "isPersonActive": { "type": "boolean" }, "isHold": { "type": "boolean" }, "isPersonDeleted": { "type": "boolean" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceTime": { "format": "date-time", "type": "string" }, "sendDate": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "discountType": { "type": "string" }, "discountTypeId": { "format": "int32", "type": "integer" }, "discount": { "format": "double", "type": "number" }, "balanceDue": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "paymentTerm": { "type": "string" }, "paymentTermId": { "format": "uuid", "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ManualInvoiceItemCreationModel" } }, "customerIcon": { "type": "string" }, "note": { "type": "string" }, "customInvoiceNumber": { "type": "string" }, "invoiceNumber": { "format": "int64", "type": "integer" }, "isFavorite": { "type": "boolean" }, "isOverdue": { "type": "boolean" }, "isFavoriteChanged": { "type": "boolean" }, "tax": { "format": "double", "type": "number" }, "tenantIcon": { "type": "string" }, "tenantAddress": { "type": "string" }, "isRecognized": { "type": "boolean" }, "invoiceDeliveryAddressId": { "format": "uuid", "type": "string" }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "purchaseOrderNumber": { "type": "string" }, "remittanceId": { "format": "uuid", "type": "string" }, "invoiceRemittanceAddressId": { "format": "uuid", "type": "string" }, "remittanceContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "isMarkVoidAllowed": { "type": "boolean" }, "voidInvoiceDetail": { "$ref": "#/definitions/api.revenue.ApiModels.VoidModel" }, "requestedBy": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "requestedById": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "auditRemarks": { "type": "string" }, "invoicePaidDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePaidDetail" } }, "consolidatedInvoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ConsolidatedListModel" } }, "cnRefreshId": { "format": "uuid", "type": "string" }, "chartOfAccountId": { "format": "uuid", "type": "string" }, "subTotal": { "format": "double", "type": "number" }, "total": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.ManualInvoiceItemCreationModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisFor": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicePersonInfo" }, "itemType": { "format": "int32", "type": "integer" }, "itemTypeName": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "accountCodeId": { "format": "uuid", "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemId": { "type": "string" }, "sku": { "format": "int32", "type": "integer" }, "quantity": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "sequence": { "format": "int32", "type": "integer" }, "tax": { "format": "double", "type": "number" }, "description": { "type": "string" }, "discount": { "format": "double", "type": "number" }, "iconUrl": { "type": "string" }, "itemCategoryName": { "type": "string" }, "total": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.SendInvoiceModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "sendDate": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.InvoiceCopyModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "format": "int64", "type": "integer" }, "invoiceDate": { "type": "boolean" }, "dueDate": { "type": "boolean" }, "items": { "type": "boolean" }, "customerType": { "type": "boolean" }, "customerName": { "type": "boolean" }, "paymentTerm": { "type": "boolean" }, "memo": { "type": "boolean" }, "discount": { "type": "boolean" } } }, "api.revenue.ApiModels.MarkVoidItemModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "remark": { "type": "string" } } }, "api.revenue.ApiModels.AllInvoiceListiViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceAmount": { "format": "double", "type": "number" }, "itemCount": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.PaymentItemsPayload": { "type": "object", "properties": { "paymentIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "itemType": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceItemByPaymentViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "itemCategory": { "type": "string" }, "itemCategoryId": { "format": "int32", "type": "integer" }, "itemName": { "type": "string" }, "remarks": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" } } }, "api.revenue.ApiModels.Payment.InvoiceCustomPaymentViewModel": { "type": "object", "properties": { "customerName": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "invoiceNumber": { "type": "string" }, "note": { "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "originalAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "customerId": { "format": "uuid", "type": "string" }, "customerIcon": { "type": "string" }, "customerType": { "type": "string" }, "balanceAmount": { "format": "double", "type": "number", "readOnly": true } } }, "api.revenue.ApiModels.InvoiceGenerationModels": { "type": "object", "properties": { "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceModel" } } } }, "api.revenue.ApiModels.InvoiceModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceFor": { "enum": [ "Person", "Organization" ], "type": "string" }, "eventRegistrationType": { "enum": [ "None", "Member", "Exhibitor" ], "type": "string" }, "invoiceForId": { "format": "uuid", "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemModel" } }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "invoiceGeneratedForId": { "format": "uuid", "type": "string" }, "clientId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "invoiceDeliveryAddress": { "format": "uuid", "type": "string" }, "remittanceId": { "format": "uuid", "type": "string" }, "invoiceRemittanceAddressId": { "format": "uuid", "type": "string" }, "remittanceContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "api.revenue.ApiModels.InvoiceItemModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "whoIsThisFor": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "itemId": { "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "itemType": { "type": "string" }, "itemTypeName": { "type": "string" }, "itemCategory": { "enum": [ "Subscription", "Event", "Endorsement", "Class", "Product", "EventSession", "EventBundle", "Manual", "Modification", "CancellationFee", "Exhibitor", "AdditionalExhibitor", "Tenant" ], "type": "string" }, "orignalItemCategory": { "format": "int32", "type": "integer" }, "accountCodeId": { "format": "uuid", "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" }, "itemCategoryName": { "type": "string" }, "itemCategoryIcon": { "type": "string" }, "invoiceItemType": { "enum": [ "Membership", "Service", "General", "Conference", "Merchandise", "Manual", "Modification", "CancellationFee" ], "type": "string" }, "cost": { "format": "double", "type": "number" }, "quantity": { "format": "double", "type": "number" }, "note": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceGeneratedModel": { "type": "object", "properties": { "registrationId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.RevenueRecognitionViewModel": { "type": "object", "properties": { "invoiceIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "api.revenue.ApiModels.InvoiceItemPaidDetailListModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "itemId": { "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "whoIsThisForImgUrl": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" }, "itemCategoryName": { "type": "string" }, "itemCategoryId": { "format": "int32", "type": "integer" }, "paymentMethod": { "format": "int32", "type": "integer" }, "createdOn": { "format": "date-time", "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceBillingContacts": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.RegModifiedInvoiceHistoryViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "amount": { "format": "double", "type": "number" }, "createdOn": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.GetRevebueDetailsModel": { "type": "object", "properties": { "originInvoiceId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.GetRevebueDetailsViewModel": { "type": "object", "properties": { "originInvoiceId": { "format": "uuid", "type": "string" }, "newInvoiceId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "type": { "type": "string" }, "transactionNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "status": { "type": "string" }, "paidAmount": { "format": "double", "type": "number" }, "creditNoteAmount": { "format": "double", "type": "number" }, "dueBalance": { "format": "double", "type": "number" }, "statusaAfterModification": { "type": "string" }, "remark": { "type": "string" } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteModel": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "itemId": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "amount": { "format": "double", "type": "number" }, "status": { "format": "int32", "type": "integer" }, "createdById": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.InvoiceUpdateRequest": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "groupNumber": { "type": "string" }, "iconUrl": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemRequest" } } } }, "api.revenue.ApiModels.InvoiceItemRequest": { "type": "object", "properties": { "peopleId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "registrationNumber": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "iconUrl": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.InvoiceSummaryViewModel": { "type": "object", "properties": { "totalCount": { "format": "int32", "type": "integer" }, "peopleCount": { "format": "int32", "type": "integer" }, "personDetailsJson": { "type": "string" }, "personDetails": { "$ref": "#/definitions/api.revenue.ApiModels.PersonInfo", "readOnly": true }, "invoiceAmount": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSummaryItemViewModel" } }, "transactionDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionSummaryViewModel" } }, "paymentApplied": { "format": "double", "type": "number" }, "dueBalance": { "format": "double", "type": "number" }, "peopleCancellationCount": { "format": "int32", "type": "integer" }, "itemsCancellationCount": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.PersonInfo": { "type": "object", "properties": { "fullName": { "type": "string" }, "imageUrl": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isCancelled": { "type": "boolean" } } }, "api.revenue.ApiModels.InvoiceSummaryItemViewModel": { "type": "object", "properties": { "itemName": { "type": "string" }, "itemId": { "type": "string" }, "iconUrl": { "type": "string" }, "whoIsThisFor": { "$ref": "#/definitions/api.revenue.ApiModels.WhoIsThisFor" }, "itemCategory": { "type": "string" }, "itemCategoryId": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "sku": { "format": "int32", "type": "integer" }, "qty": { "format": "double", "type": "number" }, "due": { "format": "double", "type": "number" }, "isCancel": { "type": "boolean" }, "unitPrice": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" }, "subtotal": { "format": "double", "type": "number" }, "accountNumber": { "type": "string" }, "accountCodeId": { "format": "uuid", "type": "string" }, "departmentCode": { "type": "string" }, "departmentCodeId": { "format": "uuid", "type": "string" }, "transactionDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionSummaryViewModel" } } } }, "api.revenue.ApiModels.TransactionSummaryViewModel": { "type": "object", "properties": { "transactionNumber": { "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "appliedAmout": { "format": "double", "type": "number" }, "transactionType": { "format": "int32", "type": "integer" }, "transactionDate": { "type": "string" }, "paymentMode": { "type": "string" }, "cardNumber": { "type": "string" }, "cardType": { "type": "string" }, "paymentModeNumber": { "format": "int32", "type": "integer" }, "referenceNumber": { "type": "string" } } }, "api.revenue.ApiModels.WhoIsThisFor": { "type": "object", "properties": { "name": { "type": "string" }, "iconUrl": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "email": { "type": "string" }, "invoicePersonType": { "enum": [ "Person", "Organization" ], "type": "string" } } }, "api.revenue.ApiModels.InvoiceReminderRequestModel": { "type": "object", "properties": { "fromEmailAddress": { "type": "string" }, "subject": { "type": "string" }, "buyerId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "recipients": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceReminderRecipientModel" } }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceReminderDetailModel" } } } }, "api.revenue.ApiModels.InvoiceReminderRecipientModel": { "type": "object", "properties": { "emailAddress": { "type": "string" }, "recipientTypeId": { "format": "int32", "type": "integer" }, "peopleId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.InvoiceReminderDetailModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceReminderViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "buyerId": { "format": "uuid", "type": "string" }, "organizatioId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Membership.SubscribersListModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "icon": { "type": "string" }, "name": { "type": "string" }, "subscribedOn": { "format": "date-time", "type": "string" }, "actionDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.SubscriptionSubscriberModel": { "type": "object", "properties": { "subscriptionId": { "format": "uuid", "type": "string" }, "subscriberType": { "format": "int32", "type": "integer" }, "subscribers": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "batchId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Filters.SubscriptionSubscriberListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "name": { "type": "string" }, "type": { "format": "int32", "type": "integer" }, "subscriptionId": { "format": "uuid", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "organization": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionSubscribersViewModel": { "type": "object", "properties": { "subscriberId": { "format": "uuid", "type": "string" }, "subscriberTypeId": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "primaryOrganizationName": { "type": "string" }, "position": { "type": "string" }, "personType": { "type": "string" }, "status": { "type": "string" } } }, "api.revenue.ApiModels.MembershipBatchViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "createdByOn": { "format": "date-time", "type": "string" }, "subscribers": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.MembershipBatchItemViewModel" } } } }, "api.revenue.ApiModels.MembershipBatchItemViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "subscriberName": { "type": "string" }, "subscriberIcon": { "type": "string" }, "subscriberId": { "format": "uuid", "type": "string" }, "subscriberType": { "format": "int32", "type": "integer" }, "invoiceId": { "format": "uuid", "type": "string" }, "email": { "type": "string" } } }, "api.revenue.ApiModels.Filters.OrganisationListFilterModel": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "phone": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "organizationType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "lastPaymentStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "lastSubscriptionStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "paymentMethod": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "mainContact": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionListView" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.SubscriptionListView": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "isFavourite": { "type": "boolean" }, "icon": { "type": "string" }, "name": { "type": "string" }, "nameColor": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "buyer": { "type": "string" }, "buyerTypeId": { "format": "int32", "type": "integer" }, "activeCount": { "format": "int32", "type": "integer" }, "cancelledCount": { "format": "int32", "type": "integer" }, "reactivatedCount": { "format": "int32", "type": "integer" }, "pausedCount": { "format": "int32", "type": "integer" }, "addedDate": { "format": "date-time", "type": "string" }, "lastSubscribedUser": { "type": "string" }, "lastSubscribedUserIcon": { "type": "string" }, "lastSubscribedOn": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "isSubscribed": { "type": "boolean" }, "isBillMeLater": { "type": "boolean" }, "isBillPaidByOrganisation": { "type": "boolean" }, "isBillPaidByParentOrganisation": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "membershipStatusTypeId": { "format": "int32", "type": "integer" }, "membershipStatusId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Filters.IndividualListFilterModel": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "phone": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "organization": { "type": "string" }, "invoice": { "type": "string" }, "lastBilled": { "format": "date-time", "type": "string" }, "nextBillingOn": { "format": "date-time", "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Notification.NotificationEmailTemplateModel": { "type": "object", "properties": { "notificationCategoryTemplateId": { "type": "string" }, "notificationCategory": { "type": "string" }, "notificationCategoryId": { "type": "string" }, "tenantCode": { "type": "string" }, "template": { "$ref": "#/definitions/EngagifiiMessageCenter.sdk.Models.EmailTemplate" } } }, "EngagifiiMessageCenter.sdk.Models.EmailTemplate": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "emailSubject": { "type": "string" }, "dateCreated": { "format": "date-time", "type": "string" }, "body": { "type": "string" }, "category": { "type": "string" } } }, "api.revenue.ApiModels.Notification.EmailTemplateMacrosViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" } } }, "api.revenue.ApiModels.Notification.NotificationCategorySettingModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "notificationCategoryId": { "format": "uuid", "type": "string" }, "notificationCategory": { "type": "string" }, "allowEmail": { "type": "boolean" }, "allowPhone": { "type": "boolean" }, "allowTextMessage": { "type": "boolean" }, "isActive": { "type": "boolean" }, "notificationTemplateId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Notification.PersonalizedEmailNotificationModel": { "type": "object", "properties": { "templateId": { "type": "string" }, "receiverList": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "senderType": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Notification.EmailTemplateMapping": { "type": "object", "properties": { "tenantCode": { "type": "string" }, "templateList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/EngagifiiMessageCenter.sdk.Models.EmailTemplate" } } } }, "api.revenue.ApiModels.InvoicePaymentPayloadModel": { "type": "object", "properties": { "membershipBatchId": { "format": "uuid", "type": "string" }, "mode": { "format": "int32", "type": "integer" }, "note": { "type": "string" }, "cardNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "cardCode": { "type": "string" }, "nameOnCard": { "type": "string" }, "isCardSave": { "type": "boolean" }, "paymentProfileId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.PaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "CreditCard", "Check", "Cash", "CreditCardProcessedOutsideEngagifii", "AccountTransfer", "ACH", "ACHRecord", "CreditNote" ], "type": "string" }, "note": { "type": "string" }, "paymentProfileId": { "format": "uuid", "type": "string" }, "payLater": { "type": "boolean" }, "card": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CardModel" }, "invoiceId": { "format": "uuid", "type": "string" }, "refTransId": { "type": "string" }, "invoice": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceModel" }, "paymentIdAuto": { "format": "int64", "type": "integer" }, "paymentNumber": { "type": "string" }, "paymentAmount": { "format": "double", "type": "number" }, "paymentDate": { "format": "date-time", "type": "string" }, "clientSideResponseModel": { "type": "object" }, "isClientSidePayment": { "type": "boolean" }, "isHold": { "type": "boolean" }, "paymentAttempt": { "format": "int32", "type": "integer" }, "paymentResponse": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentTransactionResponse" }, "stripePaymentTransactionResponse": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.StripePaymentTransactionResponse" }, "paymentIntentId": { "type": "string" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ManualPaymentInvoiceModel" } }, "registrationId": { "format": "uuid", "type": "string" }, "eventIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "modifyRegistration": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ModifyRegistration" } } }, "api.revenue.ApiModels.Payment.CardModel": { "type": "object", "properties": { "cardNumber": { "type": "string" }, "expiryMonth": { "format": "int32", "type": "integer" }, "expiryYear": { "format": "int32", "type": "integer" }, "expirationDate": { "type": "string" }, "cardCode": { "type": "string" }, "nameOnCard": { "type": "string" }, "isCardSave": { "type": "boolean" } } }, "api.revenue.ApiModels.PaymentTransactionResponse": { "type": "object", "properties": { "responseId": { "type": "string" }, "response": { "type": "string" }, "isSuccess": { "type": "boolean" }, "paymentGatewayId": { "format": "uuid", "type": "string" }, "cardNo": { "type": "string" }, "cardType": { "type": "string" }, "customerProfileId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.StripePaymentTransactionResponse": { "type": "object", "properties": { "clientSideResponseModel": { "type": "object" } } }, "api.revenue.ApiModels.Payment.ManualPaymentInvoiceModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "paidAmount": { "format": "double", "type": "number" }, "originalAmount": { "format": "double", "type": "number" }, "balanceAmount": { "format": "double", "type": "number" }, "dueDate": { "format": "date-time", "type": "string" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.InvoiceLineItem" } } } }, "api.revenue.ApiModels.Payment.ModifyRegistration": { "type": "object", "properties": { "isModifiedRegistration": { "type": "boolean" }, "regModificationType": { "enum": [ "No", "ChargeForEveryChange", "OverallModificationFee" ], "type": "string" }, "modifiedAmount": { "format": "double", "type": "number" }, "groupId": { "format": "uuid", "type": "string" }, "registraionId": { "format": "uuid", "type": "string" }, "originalInvoiceId": { "format": "uuid", "type": "string" }, "newInvoiceId": { "format": "uuid", "type": "string" }, "groupNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.InvoiceLineItem": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemNameIcon": { "type": "string" }, "whoIsThisForId": { "format": "uuid", "type": "string" }, "whoIsThisForName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Payment.PaymentResponseModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceStatus": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "paymentStatus": { "type": "string" }, "isSuccess": { "type": "boolean" }, "message": { "type": "string" }, "paymentAmount": { "format": "double", "type": "number" }, "refTransId": { "type": "string" }, "isChargeProcessed": { "type": "boolean" }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "creditNoteAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.AuthorizePaymentReqModel": { "type": "object", "properties": { "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "card": { "$ref": "#/definitions/api.revenue.ApiModels.AuthCardDetail" }, "billingAddress": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.AddressDetail" }, "paymentAmount": { "format": "double", "type": "number" }, "isProcessingPayment": { "type": "boolean" }, "refTransId": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "shippingAddress": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.AddressDetail" }, "orderInformation": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.OrderInformation" } } }, "api.revenue.DomainModels.Invoice": { "type": "object", "properties": { "invoiceType": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "tenantId": { "format": "uuid", "type": "string" }, "invoiceFor": { "format": "int32", "type": "integer" }, "organizationId": { "format": "uuid", "type": "string" }, "individualId": { "format": "uuid", "type": "string" }, "date": { "format": "date-time", "type": "string" }, "sendDate": { "format": "date-time", "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "invoicePrefix": { "type": "string" }, "invoiceId": { "format": "int64", "type": "integer" }, "invoiceSuffix": { "type": "string" }, "isActive": { "type": "boolean" }, "discountType": { "format": "int32", "type": "integer" }, "discount": { "format": "double", "type": "number" }, "paymentTermId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "remarkForVoid": { "type": "string" }, "note": { "type": "string" }, "tax": { "format": "double", "type": "number" }, "purchaseOrderNumber": { "type": "string" }, "isRecognized": { "type": "boolean" }, "isAutoGeneratedNumber": { "type": "boolean" }, "invoiceDeliveryAddressId": { "format": "uuid", "type": "string" }, "remittanceId": { "format": "uuid", "type": "string" }, "requestedById": { "format": "uuid", "type": "string" }, "invoiceRemittanceAddressId": { "format": "uuid", "type": "string" }, "consolidatedInvoiceId": { "format": "uuid", "type": "string" }, "previousCreationDate": { "format": "date-time", "type": "string" }, "previousInvoiceNumber": { "type": "string" }, "previousInvoiceId": { "type": "string" }, "previousStatus": { "format": "int32", "type": "integer" }, "auditRemarks": { "type": "string" }, "initialTransactionId": { "format": "uuid", "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "addressSynced": { "type": "boolean" }, "isHold": { "type": "boolean" }, "syncQueued": { "type": "boolean" }, "registrationId": { "format": "uuid", "type": "string" }, "invoiceAmount": { "format": "double", "type": "number" }, "balanceDue": { "format": "double", "type": "number" }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "readOnly": true }, "invoicePayments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoicePayment" }, "readOnly": true }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "tenantUser": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "paymentTerm": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentTerm" }, "requestedBy": { "$ref": "#/definitions/api.revenue.DomainModels.Person" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "invoiceDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceDetail" }, "readOnly": true }, "creditNoteInvoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNoteInvoice" }, "readOnly": true }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.AuthCardDetail": { "type": "object", "properties": { "nameOnCard": { "type": "string" }, "cardNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "cardCode": { "type": "string" }, "zipCode": { "type": "string" }, "expiryMonth": { "type": "string" }, "expiryYear": { "type": "string" }, "isCardSave": { "type": "boolean" } } }, "api.revenue.ApiModels.Payment.AddressDetail": { "type": "object", "properties": { "addressType": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zipCode": { "type": "string" }, "poNumber": { "type": "string" }, "phone": { "type": "string" }, "fax": { "type": "string" } } }, "api.revenue.ApiModels.Payment.OrderInformation": { "type": "object", "properties": { "description": { "type": "string" }, "invoiceNumber": { "type": "string" } } }, "api.revenue.DomainModels.InvoiceItem": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "itemId": { "type": "string" }, "itemType": { "format": "int32", "type": "integer" }, "itemTypeName": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "accountCodeMaster": { "$ref": "#/definitions/api.revenue.DomainModels.AccountCodeMaster" }, "accountCodeId": { "format": "uuid", "type": "string" }, "departmentCodeMaster": { "$ref": "#/definitions/api.revenue.DomainModels.DepartmentCodeMaster" }, "departmentCodeId": { "format": "uuid", "type": "string" }, "itemCategoryName": { "type": "string" }, "cost": { "format": "double", "type": "number" }, "quantityDecimal": { "format": "double", "type": "number" }, "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "person": { "$ref": "#/definitions/api.revenue.DomainModels.Person" }, "itemName": { "type": "string" }, "iconUrl": { "type": "string" }, "description": { "type": "string" }, "note": { "type": "string" }, "sku": { "format": "int32", "type": "integer" }, "tax": { "format": "double", "type": "number" }, "sequence": { "format": "int32", "type": "integer" }, "discount": { "format": "double", "type": "number" }, "chartOfAccountId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "registrationNumber": { "type": "string" }, "groupNumber": { "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "isCancelled": { "type": "boolean" }, "paidAmount": { "format": "double", "type": "number" }, "refundAmount": { "format": "double", "type": "number" }, "amountDecimal": { "format": "double", "type": "number", "readOnly": true }, "refunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.RefundInvoiceItem" }, "readOnly": true }, "creditNotePaymentDetails": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNotePaymentDetail" }, "readOnly": true }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.InvoicePayment": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.Organization": { "type": "object", "properties": { "name": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "imageThumbUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "website": { "type": "string" }, "email": { "type": "string" }, "isParent": { "type": "boolean" }, "isChild": { "type": "boolean" }, "isTenantDefault": { "type": "boolean" }, "timeZone": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "organizationTypes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.OrganizationType" }, "readOnly": true }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "readOnly": true }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.TenantUser": { "type": "object", "properties": { "tenantId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "primaryOrganizationId": { "format": "uuid", "type": "string" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "person": { "$ref": "#/definitions/api.revenue.DomainModels.Person" }, "primaryOrganization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "tags": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUserTag" } }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentTerm": { "type": "object", "properties": { "paymentTermName": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "isDefault": { "type": "boolean" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "isPaymentTermActive": { "type": "boolean" }, "paymentDueDate": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentDueDate" }, "isLatePaymentActive": { "type": "boolean" }, "latePayment": { "$ref": "#/definitions/api.revenue.DomainModels.LatePayment" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.Person": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "email": { "type": "string" }, "imageUrl": { "type": "string" }, "phone": { "type": "string" }, "timeZone": { "type": "string" }, "identityId": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "readOnly": true }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.Tenant": { "type": "object", "properties": { "name": { "type": "string" }, "tenantCode": { "type": "string" }, "sourceId": { "format": "uuid", "type": "string" }, "moduleName": { "type": "string" }, "logo": { "type": "string" }, "timezone": { "type": "string" }, "primaryContactId": { "format": "uuid", "type": "string" }, "primaryContact": { "$ref": "#/definitions/api.revenue.DomainModels.Person" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.InvoiceDetail": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "iconUrl": { "type": "string" }, "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "originalInvoiceId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "eventRegistrationDate": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.CreditNoteInvoice": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "creditNote": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNote" }, "creditNoteInvoiceDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNoteInvoiceDetail" }, "readOnly": true }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.AccountCodeMaster": { "type": "object", "properties": { "accountCode": { "type": "string" }, "displayName": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "parentId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "parent": { "$ref": "#/definitions/api.revenue.DomainModels.AccountCodeMaster" }, "accountCodeTypeId": { "format": "uuid", "type": "string" }, "engagifiiAlias": { "type": "string" }, "eventClass": { "type": "string" }, "description": { "type": "string" }, "accountCodeType": { "$ref": "#/definitions/api.revenue.DomainModels.AccountCodeType" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.DepartmentCodeMaster": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.RefundInvoiceItem": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "remarks": { "type": "string" }, "sequence": { "format": "int32", "type": "integer" }, "refund": { "$ref": "#/definitions/api.revenue.DomainModels.Refund" }, "invoiceItem": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.CreditNotePaymentDetail": { "type": "object", "properties": { "creditNotePaymentId": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "invoiceItem": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "creditNotePayment": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNotePayment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.Payment": { "type": "object", "properties": { "amount": { "format": "double", "type": "number" }, "tenantId": { "format": "uuid", "type": "string" }, "customerType": { "format": "int32", "type": "integer" }, "individualId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "mode": { "format": "int32", "type": "integer" }, "isSuccess": { "type": "boolean" }, "note": { "type": "string" }, "paymentId": { "format": "int64", "type": "integer" }, "initiatedById": { "format": "uuid", "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "paymentNumber": { "type": "string" }, "isAutoGeneratedNumber": { "type": "boolean" }, "status": { "format": "int32", "type": "integer" }, "gatewayStatus": { "type": "boolean" }, "remarkForVoid": { "type": "string" }, "auditRemarks": { "type": "string" }, "paymentCreditCard": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentCreditCard" }, "paymentCash": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentCash" }, "paymentACH": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentACH" }, "paymentECheque": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentECheque" }, "paymentCreditNote": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentCreditNote" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "individual": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "payLater": { "type": "boolean" }, "invoicePayments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.InvoicePayment" }, "readOnly": true }, "paymentRefunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentRefund" }, "readOnly": true }, "creditNotePayments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNotePayment" }, "readOnly": true }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.OrganizationType": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "order": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "tenantOrganizationTypeId": { "format": "uuid", "type": "string" }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "tenantOrganizationType": { "$ref": "#/definitions/api.revenue.DomainModels.TenantOrganizationType" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.TenantUserTag": { "type": "object", "properties": { "name": { "type": "string" }, "tenantUserId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "tenantUser": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentDueDate": { "type": "object", "properties": { "dueAfter": { "format": "int32", "type": "integer" }, "currentMonthDay": { "format": "int32", "type": "integer" }, "daysOut": { "format": "int32", "type": "integer" }, "paymentTermId": { "format": "uuid", "type": "string" }, "paymentTermType": { "format": "int32", "type": "integer" }, "paymentTerm": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentTerm" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.LatePayment": { "type": "object", "properties": { "percentageOfTransaction": { "format": "double", "type": "number" }, "fixedCharge": { "format": "double", "type": "number" }, "paymentTermId": { "format": "uuid", "type": "string" }, "latePaymentType": { "format": "int32", "type": "integer" }, "paymentTerm": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentTerm" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.CreditNote": { "type": "object", "properties": { "creditNoteNumber": { "type": "string" }, "isAutoGeneratedNumber": { "type": "boolean" }, "tenantId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "int64", "type": "integer" }, "date": { "format": "date-time", "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "reason": { "type": "string" }, "note": { "type": "string" }, "creditNoteFor": { "format": "int32", "type": "integer" }, "organizationId": { "format": "uuid", "type": "string" }, "individualId": { "format": "uuid", "type": "string" }, "initialTransactionId": { "format": "uuid", "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "previousId": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "isOverPayment": { "type": "boolean" }, "creditType": { "format": "int32", "type": "integer" }, "cnSourceId": { "format": "int32", "type": "integer" }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "tenantUser": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "creditNoteInvoice": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNoteInvoice" }, "readOnly": true }, "creditNotePayment": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNotePayment" }, "readOnly": true }, "paymentRefunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentRefund" }, "readOnly": true }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.CreditNoteInvoiceDetail": { "type": "object", "properties": { "creditnoteInvoiceid": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "invoiceItem": { "$ref": "#/definitions/api.revenue.DomainModels.InvoiceItem" }, "creditNoteInvoice": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNoteInvoice" }, "paymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.AccountCodeType": { "type": "object", "properties": { "name": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.Refund": { "type": "object", "properties": { "amount": { "format": "double", "type": "number" }, "tenantId": { "format": "uuid", "type": "string" }, "customerType": { "format": "int32", "type": "integer" }, "individualId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "mode": { "format": "int32", "type": "integer" }, "isSuccess": { "type": "boolean" }, "note": { "type": "string" }, "reason": { "type": "string" }, "refundId": { "format": "int64", "type": "integer" }, "initiatedById": { "format": "uuid", "type": "string" }, "refundDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "refundNumber": { "type": "string" }, "isAutoGeneratedNumber": { "type": "boolean" }, "refundDeliveryAddressId": { "format": "uuid", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "initialTransactionId": { "format": "uuid", "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "individual": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "organization": { "$ref": "#/definitions/api.revenue.DomainModels.Organization" }, "clearingDate": { "format": "date-time", "type": "string" }, "referenceNo": { "type": "string" }, "paymentRefunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.PaymentRefund" }, "readOnly": true }, "refundCreditCards": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.RefundCreditCard" }, "readOnly": true }, "refunds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.RefundInvoiceItem" }, "readOnly": true }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.CreditNotePayment": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "note": { "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "invoice": { "$ref": "#/definitions/api.revenue.DomainModels.Invoice" }, "creditNote": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNote" }, "creditNotePaymentDetail": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNotePaymentDetail" }, "readOnly": true }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentCreditCard": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "customerProfileId": { "format": "uuid", "type": "string" }, "cardNumber": { "type": "string" }, "cardType": { "type": "string" }, "paymentInitialId": { "type": "string" }, "paymentIntentId": { "type": "string" }, "paymentMethodId": { "type": "string" }, "response": { "type": "string" }, "isSuccess": { "type": "boolean" }, "paymentGatewayId": { "format": "uuid", "type": "string" }, "paymentAttempt": { "format": "int32", "type": "integer" }, "chargeId": { "type": "string" }, "refundId": { "type": "string" }, "refundResponse": { "type": "string" }, "voidTransactionId": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "paymentGateway": { "$ref": "#/definitions/api.revenue.DomainModels.TenantPaymentGatewaySetting" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentCash": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentACH": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "isDeleted": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentECheque": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentCreditNote": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.PaymentRefund": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "refundId": { "format": "uuid", "type": "string" }, "refundType": { "format": "int32", "type": "integer" }, "transactionId": { "format": "uuid", "type": "string" }, "payment": { "$ref": "#/definitions/api.revenue.DomainModels.Payment" }, "refund": { "$ref": "#/definitions/api.revenue.DomainModels.Refund" }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNote": { "$ref": "#/definitions/api.revenue.DomainModels.CreditNote" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.TenantOrganizationType": { "type": "object", "properties": { "name": { "type": "string" }, "imageUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "order": { "format": "int32", "type": "integer" }, "tenantId": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.RefundCreditCard": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "transactionId": { "type": "string" }, "response": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "isSucess": { "type": "boolean" }, "attempt": { "format": "int32", "type": "integer" }, "cardNo": { "type": "string" }, "cardType": { "type": "string" }, "pgTrxId": { "type": "string" }, "isDeleted": { "type": "boolean" }, "refund": { "$ref": "#/definitions/api.revenue.DomainModels.Refund" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.DomainModels.TenantPaymentGatewaySetting": { "type": "object", "properties": { "tenantId": { "format": "uuid", "type": "string" }, "gatewayName": { "type": "string" }, "settingJson": { "type": "string" }, "paymentGatewayType": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "isVisible": { "type": "boolean" }, "maxAttempts": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.AuthorizePaymentResModel": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "paymentId": { "type": "string" }, "paymentAmount": { "type": "string" }, "isSuccess": { "type": "boolean" }, "message": { "type": "string" }, "messageCode": { "type": "string" }, "refTransId": { "type": "string" }, "paymentTransactionResponseId": { "type": "string" }, "response": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentTransactionResponse" } } }, "api.revenue.ApiModels.Filters.PaymentListFilterModel": { "type": "object", "properties": { "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Payment.PaymentListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Payment.PaymentViewModel": { "type": "object", "properties": { "amount": { "format": "double", "type": "number" }, "mode": { "type": "string" }, "status": { "type": "boolean" }, "paymentDate": { "format": "date-time", "type": "string" }, "note": { "type": "string" }, "paymentGateway": { "type": "string" } } }, "api.revenue.ApiModels.Filters.PaymentInvoiceFilterModel": { "type": "object", "properties": { "invoiceNumber": { "type": "string" }, "text": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Payment.PaymentTransactionDetailViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "dateOfCreation": { "format": "date-time", "type": "string" }, "buyerType": { "type": "string" }, "invoiceNumber": { "type": "string" }, "buyerName": { "type": "string" }, "buyerIcon": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentInvoiceItemViewModel" } }, "createdBy": { "type": "string" } } }, "api.revenue.ApiModels.PaymentInvoiceItemViewModel": { "type": "object", "properties": { "icon": { "type": "string" }, "item": { "type": "string" } } }, "api.revenue.ApiModels.Payment.PaymentDetailViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "modeId": { "format": "int32", "type": "integer" }, "mode": { "type": "string" }, "note": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "paymentTime": { "format": "date-time", "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "totalAppliedAmount": { "format": "double", "type": "number" }, "referenceNumber": { "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "customerIcon": { "type": "string" }, "isFavorite": { "type": "boolean" }, "tenantIcon": { "type": "string" }, "tenantAddress": { "type": "string" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentInvoiceDetailViewModel" } }, "remaningAmountToCredit": { "format": "double", "type": "number" }, "paymentResponse": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentTransactionResponse" }, "voidDetail": { "$ref": "#/definitions/api.revenue.ApiModels.VoidModel" }, "isMarkVoidAllowed": { "type": "boolean" }, "creditNotes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteSimpleModel" } }, "paymentCreditNotes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.PaymentCreditNoteViewModel" } }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" } } }, "api.revenue.ApiModels.Payment.PaymentInvoiceDetailViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceId": { "type": "string" }, "invoiceAmount": { "format": "double", "type": "number" }, "paymentNote": { "type": "string" }, "paidAmount": { "format": "double", "type": "number" }, "dueDate": { "format": "date-time", "type": "string" }, "itemCount": { "format": "int32", "type": "integer" }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemPaidDetailListModel" } } } }, "api.revenue.ApiModels.CreditNotes.CreditNoteSimpleModel": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "amountIssuedAgainstPayment": { "format": "double", "type": "number" }, "status": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CreditNotes.PaymentCreditNoteViewModel": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "itemId": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "amount": { "format": "double", "type": "number" }, "status": { "format": "int32", "type": "integer" }, "statusText": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": "string" } } }, "PaymentItemWiseReqModel": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.ManualPaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "CreditCard", "Check", "Cash", "CreditCardProcessedOutsideEngagifii", "AccountTransfer", "ACH", "ACHRecord", "CreditNote" ], "type": "string" }, "note": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "paymentTime": { "format": "date-time", "type": "string" }, "customerType": { "enum": [ "Person", "Organization" ], "type": "string" }, "customerTypeText": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "remaningAmountToCredit": { "format": "double", "type": "number" }, "totalAppliedAmount": { "format": "double", "type": "number" }, "referenceNumber": { "type": "string" }, "paymentId": { "format": "int64", "type": "integer" }, "paymentNumber": { "type": "string" }, "modeId": { "format": "int32", "type": "integer" }, "modeText": { "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerName": { "type": "string" }, "status": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerIcon": { "type": "string" }, "isfavorite": { "type": "boolean" }, "isPaymentIdExists": { "type": "boolean" }, "isRecognized": { "type": "boolean" }, "clearingDate": { "format": "date-time", "type": "string" }, "createdOnDate": { "format": "date-time", "type": "string" }, "auditRemarks": { "type": "string" }, "paymentIntentId": { "type": "string" }, "refTransId": { "type": "string" }, "paymentAttempt": { "format": "int32", "type": "integer" }, "payLater": { "type": "boolean" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.ManualPaymentInvoiceModel" } }, "paymentResponse": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentTransactionResponse" }, "voidDetail": { "$ref": "#/definitions/api.revenue.ApiModels.VoidModel" }, "stripePaymentTransactionResponse": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.StripePaymentTransactionResponse" }, "creditNotes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteSimpleModel" } } } }, "api.revenue.ApiModels.Payment.ExtraPaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "paymentMethods": { "enum": [ "CreditCard", "Check", "Cash", "CreditCardProcessedOutsideEngagifii", "AccountTransfer", "ACH", "ACHRecord", "CreditNote" ], "type": "string" }, "amount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" }, "referenceNumber": { "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "paymentIntentId": { "type": "string" }, "refTransId": { "type": "string" }, "paymentAttempt": { "format": "int32", "type": "integer" }, "stripePaymentTransactionResponse": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.StripePaymentTransactionResponse" }, "paymentResponse": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentTransactionResponse" } } }, "api.revenue.ApiModels.Payment.InvoiceWisePaymentForRefundViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "status": { "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "amount": { "format": "double", "type": "number" }, "payments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentForRefundViewModel" } } } }, "api.revenue.ApiModels.Payment.PaymentForRefundViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentId": { "type": "string" }, "mode": { "type": "string" }, "paymentNumber": { "type": "string" }, "status": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "paymentAmount": { "format": "float", "type": "number" }, "amount": { "format": "float", "type": "number" }, "amountRefunded": { "format": "float", "type": "number" } } }, "api.revenue.ApiModels.Payment.UpdateClearingDateModel": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "referenceNumber": { "type": "string" } } }, "api.revenue.ApiModels.PaymentCopyModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "referenceNumber": { "type": "boolean" }, "date": { "type": "boolean" }, "amount": { "type": "boolean" }, "memo": { "type": "boolean" }, "customer": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "invoices": { "type": "boolean" }, "paymentNumber": { "format": "int64", "type": "integer" }, "isChecked": { "type": "boolean" } } }, "api.revenue.ApiModels.Payment.PaypalOrderModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "amount": { "type": "string" } } }, "api.revenue.ApiModels.AddPaymentTermModel": { "type": "object", "properties": { "paymentTermName": { "type": "string" }, "description": { "type": "string" }, "dueDays": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Settings.PaymentTermSettingModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentTermName": { "type": "string" }, "isPaymentTermActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "paymentDueDateModel": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentDueDateModel" }, "latePaymentModel": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.LatePaymentModel" }, "isLatePayment": { "type": "boolean" }, "isAbleToDelete": { "type": "boolean" } } }, "api.revenue.ApiModels.Settings.PaymentDueDateModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentTermType": { "enum": [ "DueAfter", "DueOn" ], "type": "string" }, "dueDays": { "format": "int32", "type": "integer" }, "dayOfMonth": { "format": "int32", "type": "integer" }, "numberOfDaysBefore": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Settings.LatePaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "latePaymentType": { "enum": [ "PercentageOfTransaction", "FixedCharge" ], "type": "string" }, "percentageOfTransaction": { "format": "double", "type": "number" }, "fixedCharge": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.PaymentBatchesFilterModel": { "type": "object", "properties": { "totalAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "controlAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "createdDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "updatedDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "searchBatches": { "type": "string" }, "batchStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.AmountFilterBody": { "type": "object", "properties": { "minAmount": { "format": "double", "type": "number" }, "maxAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.PaymentBatchesViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatchesModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.PaymentBatchesModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "iconUrl": { "type": "string" }, "description": { "type": "string" }, "controlAmount": { "format": "double", "type": "number" }, "totalAmount": { "format": "double", "type": "number" }, "transactionCount": { "format": "int32", "type": "integer" }, "batchStatus": { "type": "string" }, "syncStatus": { "format": "int32", "type": "integer" }, "isFavorite": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdByImgUrl": { "type": "string" }, "modifiedByImgUrl": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedBy": { "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.PaymentBatchDetail": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" }, "iconUrl": { "type": "string" }, "description": { "type": "string" }, "controlAmount": { "format": "double", "type": "number" }, "totalAmount": { "format": "double", "type": "number" }, "batchStatus": { "format": "int32", "type": "integer" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.DraftPaymentBatchDetail": { "type": "object", "properties": { "referenceId": { "type": "string" }, "paymentMethod": { "format": "int32", "type": "integer" }, "memo": { "type": "string" } } }, "api.revenue.ApiModels.PaymentBatch": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" }, "controlAmount": { "format": "double", "type": "number" }, "description": { "type": "string" } } }, "api.revenue.ApiModels.BalanceInvoiceFilterModel": { "type": "object", "properties": { "period": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeriodFilterBody" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerName": { "type": "string" }, "consumerType": { "format": "int32", "type": "integer" }, "invoiceAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "outStandingAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "paidAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "buyerOrganizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "people": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "text": { "type": "string" }, "itemName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "invoice": { "type": "string" }, "itemId": { "type": "string" }, "nameFormat": { "type": "string" }, "consumerIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.PeriodFilterBody": { "type": "object", "properties": { "periodFilterType": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.BalanceInvoicesViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoicesDetailModel" } }, "totalDraftCount": { "format": "int64", "type": "integer" }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.BalanceInvoicesDetailModel": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "invoiceNumber": { "type": "string" }, "invoiceCreatedOn": { "format": "date-time", "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceDueDate": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "createdByName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "outstandingAmount": { "format": "double", "type": "number" }, "invoiceStatus": { "type": "string" }, "buyerType": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "buyerId": { "type": "string" }, "buyerName": { "type": "string" }, "icon": { "type": "string" }, "itemsCount": { "format": "int32", "type": "integer" }, "newInvoiceBalance": { "format": "double", "type": "number" }, "batchPayment": { "format": "double", "type": "number" }, "inDraftBatches": { "type": "boolean" }, "draftBatchName": { "type": "string" }, "organizationName": { "type": "string" }, "paymentId": { "type": "string" }, "paymentNumber": { "type": "string" }, "paymentAmount": { "format": "double", "type": "number" }, "paymentMethod": { "type": "string" }, "referenceNumber": { "type": "string" } } }, "api.revenue.ApiModels.BalanceInvoiceFilterModel+ExportPaymentBatchInvoice": { "type": "object", "properties": { "batchId": { "format": "uuid", "type": "string" }, "nameFormat": { "type": "string" }, "nameSortBy": { "type": "string" }, "invoice": { "type": "string" }, "buyerName": { "type": "string" }, "fileName": { "type": "string" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.BalanceInvoicesByBuyerQueryViewModel": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceByBuyerDetailModel" } } } }, "api.revenue.ApiModels.BalanceInvoiceByBuyerDetailModel": { "type": "object", "properties": { "invoiceCount": { "format": "int32", "type": "integer" }, "draftCount": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "customerStatus": { "format": "int32", "type": "integer" }, "personId": { "format": "uuid", "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "imageUrl": { "type": "string" }, "totalAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftInvoiceAmount": { "format": "double", "type": "number" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.OrganizationViewModel" } } } }, "api.revenue.ApiModels.Transaction.OrganizationViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "imageThumbUrl": { "type": "string" }, "isPrimary": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "api.revenue.ApiModels.BalanceInvoicesByOrganizationQueryViewModel": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceByOrganizationDetailModel" } } } }, "api.revenue.ApiModels.BalanceInvoiceByOrganizationDetailModel": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "organizationName": { "type": "string" }, "organizationStatus": { "type": "boolean" }, "imageUrl": { "type": "string" }, "invoiceCount": { "format": "int32", "type": "integer" }, "draftCount": { "format": "int32", "type": "integer" }, "totalAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftInvoiceAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.BalanceInvoicesByEventQueryViewModel": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.BalanceInvoiceByEventDetailsModel" } } } }, "api.revenue.ApiModels.BalanceInvoiceByEventDetailsModel": { "type": "object", "properties": { "itemId": { "type": "string" }, "itemName": { "type": "string" }, "imageUrl": { "type": "string" }, "invoiceCount": { "format": "int32", "type": "integer" }, "draftCount": { "format": "int32", "type": "integer" }, "totalAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftOutstandingAmount": { "format": "double", "type": "number" }, "totalDraftInvoiceAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.InvoicesForBatchPaymentQueryViewModel": { "type": "object", "properties": { "totalRecordCount": { "format": "int64", "type": "integer" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoicesForBatchPaymentDetailsModel" } } } }, "api.revenue.ApiModels.InvoicesForBatchPaymentDetailsModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "organizationId": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "invoiceNumber": { "type": "string" }, "invoiceStatus": { "format": "int32", "type": "integer" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceCreatedOn": { "format": "date-time", "type": "string" }, "invoiceDueDate": { "format": "date-time", "type": "string" }, "createdByName": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "buyerType": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "buyerName": { "type": "string" }, "organizationName": { "type": "string" }, "icon": { "type": "string" }, "buyerId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "outstandingAmount": { "format": "double", "type": "number" }, "itemsCount": { "format": "int32", "type": "integer" }, "inDraftBatches": { "type": "boolean" } } }, "api.revenue.ApiModels.PaymentBatches.VerifyInvoicesForBatchPaymentModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "balanceAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.PaymentBatches.VerifyInvoicesForBatchPaymenViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "isValid": { "type": "boolean" } } }, "api.revenue.ApiModels.PaymentBatches.RecordPaymentBatchesModel": { "type": "object", "properties": { "paymentBatchId": { "format": "uuid", "type": "string" }, "isDraft": { "type": "boolean" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatches.RecordPaymentInvoices" } } } }, "api.revenue.ApiModels.PaymentBatches.RecordPaymentInvoices": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" }, "paymentMethod": { "format": "int32", "type": "integer" }, "referanceId": { "type": "string" }, "memo": { "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "invoiceItem": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentBatches.RecordPaymentInvoiceItem" } } } }, "api.revenue.ApiModels.PaymentBatches.RecordPaymentInvoiceItem": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" }, "appliedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Filters.PaymentBatchesFilterOptionsReqModel": { "type": "object", "properties": { "reportName": { "type": "string" } } }, "api.revenue.ApiModels.Filters.PaymentBatchesFilterOptions": { "type": "object", "properties": { "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "controlAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "totalAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "batchStatus": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "people": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } } } }, "api.revenue.ApiModels.Filters.KeyValModel": { "type": "object", "properties": { "value": { "type": "string" }, "text": { "type": "string" } } }, "api.revenue.ApiModels.Authorization.PermissionRequests": { "type": "object", "properties": { "requests": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Authorization.PermissionRequest" } } } }, "api.revenue.ApiModels.Authorization.PermissionRequest": { "required": [ "type" ], "type": "object", "properties": { "entityId": { "type": "string" }, "type": { "type": "string" } } }, "api.revenue.ApiModels.Authorization.PermissionResponse": { "type": "object", "properties": { "entityId": { "type": "string" }, "type": { "type": "string" }, "permissions": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/EngagifiiPolicy.Common.Models.Permission" } } } }, "EngagifiiPolicy.Common.Models.Permission": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "module": { "type": "string" }, "entityType": { "type": "string" } } }, "api.revenue.Impl.ViewModels.UserContextModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "tenantUserId": { "format": "uuid", "type": "string" }, "primaryOrganizationId": { "format": "uuid", "type": "string" }, "permissions": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "hasTenantOrganization": { "type": "boolean" }, "token": { "type": "string" }, "userTimeZone": { "type": "string" } } }, "api.revenue.ApiModels.InvoiceSimpleView": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNo": { "type": "string" }, "invoiceAmt": { "format": "double", "type": "number" }, "dueDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "paymentStatus": { "type": "string" } } }, "api.revenue.ApiModels.Settings.TenantPaymentOptionPackage": { "type": "object", "properties": { "tenantId": { "format": "uuid", "type": "string" }, "tenantCode": { "type": "string" }, "paymentOptionList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.TenantPaymentOption" } }, "primaryPaymentGateway": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentGatewaySettingModel" } } }, "api.revenue.ApiModels.Settings.TenantPaymentOption": { "type": "object", "properties": { "mode": { "format": "int32", "type": "integer" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.Settings.PaymentGatewaySettingModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "clientId": { "type": "string" }, "apiSettingKey": { "type": "string" }, "paymentGatewayName": { "type": "string" }, "paymentGatewayType": { "format": "int32", "type": "integer" }, "isPrimary": { "type": "boolean" }, "maxAttempts": { "format": "int32", "type": "integer" }, "isValid": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean" }, "isExists": { "type": "boolean" } } }, "api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentRequest": { "type": "object", "properties": { "amountInSmallestUnit": { "format": "int64", "description": "In USD this will be pennies", "type": "integer" }, "sessionIdentifier": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "description": { "type": "string" } } }, "api.revenue.ApiModels.Payment.Stripe.CreatePaymentIntentResponse": { "type": "object", "properties": { "clientSecret": { "type": "string" }, "publicApiKey": { "type": "string" }, "paymentIntentId": { "type": "string" }, "refTransId": { "type": "string" } } }, "api.revenue.ApiModels.Payment.Stripe.CreateACHPaymentIntentRequest": { "type": "object", "properties": { "amountInSmallestUnit": { "format": "int64", "description": "In USD this will be pennies", "type": "integer" }, "sessionIdentifier": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "tenantUserId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.Stripe.CreatePaymentACHIntentResponse": { "type": "object", "properties": { "clientSecret": { "type": "string" }, "publicApiKey": { "type": "string" }, "paymentIntentId": { "type": "string" }, "refTransId": { "type": "string" }, "userName": { "type": "string" }, "userEmail": { "type": "string" } } }, "api.revenue.ApiModels.DeleteRegistrantsReqModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "personIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "api.revenue.ApiModels.RestoreInvoiceReqModel": { "type": "object", "properties": { "tenantCode": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.CreditNoteRegCancelReqModel": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "paymentIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "invoiceId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "registrantItemdetails": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrantItemdetail" } }, "creditType": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.RegistrantItemdetail": { "type": "object", "properties": { "peopleId": { "format": "uuid", "type": "string" }, "itemId": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "remainingFundsType": { "enum": [ "None", "RefundableCredit", "RetainFunds" ], "type": "string" }, "totalCreditAmount": { "format": "double", "type": "number" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CancelParticipantsfromRevenueModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "cancellationfee": { "format": "double", "type": "number" }, "ticketNumber": { "type": "string" } } }, "api.revenue.ApiModels.RegCancelCreditNoteResModel": { "type": "object", "properties": { "originalinvoiceid": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "unPaidInvoiceId": { "format": "uuid", "type": "string" }, "originalInvoiceNumber": { "type": "string" }, "paymentNumber": { "type": "string" }, "registrantName": { "type": "string" }, "itemName": { "type": "string" }, "creditNote": { "type": "string" }, "creditNoteNumber": { "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "cancellationInvoiceAndFees": { "type": "string" }, "cancellationInvoiceFees": { "format": "double", "type": "number" }, "cancellationInvoiceNumber": { "type": "string" }, "invoiceStatus": { "format": "int32", "type": "integer" }, "ticketNumber": { "type": "string" }, "registrantItemdetailsCount": { "format": "int32", "type": "integer" }, "isFullRefundPayment": { "type": "boolean" } } }, "api.revenue.ApiModels.InvoiceDetailViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Settings.PaymentFormFieldsViewModel": { "type": "object", "properties": { "fieldTypeName": { "type": "string" }, "fieldTypeItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.FieldTypeItems" } } } }, "api.revenue.ApiModels.Settings.FieldTypeItems": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "fieldName": { "type": "string" }, "isRequired": { "type": "boolean" } } }, "api.revenue.ApiModels.RegistrationModificationViewModels": { "type": "object", "properties": { "registrationId": { "format": "uuid", "type": "string" }, "registrationName": { "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "groupName": { "type": "string" }, "originalInvoiceId": { "format": "uuid", "type": "string" }, "newInvoiceId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "modifiedRegistrants": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "cancelledRegistrants": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "requestedBy": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "notifyMe": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "eventContanct": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "financeContacts": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "additionalPeople": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AdditionalPeopleViewModel" } }, "removedItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RemovedItemsViewModel" } }, "addedItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RemovedItemsViewModel" } } } }, "api.revenue.ApiModels.ModifiedRequestViewModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isEmailSend": { "type": "boolean" } } }, "api.revenue.ApiModels.AdditionalPeopleViewModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } } }, "api.revenue.ApiModels.RemovedItemsViewModel": { "type": "object", "properties": { "itemId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemType": { "enum": [ "Activities", "Classes", "Products", "Bundles", "Booths", "BoothStaff" ], "type": "string" } } }, "api.revenue.ApiModels.RegCancelCreditNoteResModelForEvent": { "type": "object", "properties": { "originalinvoiceid": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteVoucherId": { "format": "uuid", "type": "string" }, "unPaidInvoiceId": { "format": "uuid", "type": "string" }, "originalInvoiceNumber": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "registrantName": { "type": "string" }, "itemName": { "type": "string" }, "itemNameLinks": { "type": "string" }, "creditNote": { "type": "string" }, "creditNoteNumber": { "type": "string" }, "amountToCredit": { "format": "double", "type": "number" }, "cancellationInvoiceAndFees": { "type": "string" }, "cancellationInvoiceFees": { "format": "double", "type": "number" }, "cancellationInvoiceNumber": { "type": "string" }, "invoiceStatus": { "format": "int32", "type": "integer" }, "ticketNumber": { "type": "string" }, "registrantItemdetailsCount": { "format": "int32", "type": "integer" }, "isFullRefundPayment": { "type": "boolean" }, "retainAmount": { "format": "double", "type": "number" }, "newCreditNoteBalance": { "format": "double", "type": "number" }, "regCancelLineItemResModel": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegCancelLineItemResModel" } }, "cancellationRefundViewDetails": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CancelllationRefundViewDetails" } } } }, "api.revenue.ApiModels.RegCancelLineItemResModel": { "type": "object", "properties": { "registrationId": { "type": "string" }, "eventName": { "type": "string" }, "cancellationReason": { "type": "string" }, "cancellationComment": { "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "personName": { "type": "string" }, "icon": { "type": "string" }, "email": { "type": "string" }, "cancellationFees": { "format": "double", "type": "number" }, "refundFees": { "format": "double", "type": "number" }, "regId": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "groupNumber": { "type": "string" }, "regNumber": { "type": "string" }, "iconUrl": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "itemCategoryName": { "type": "string" }, "retainAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.CancelllationRefundViewDetails": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "refundNumber": { "type": "string" }, "totalRefundAmount": { "format": "double", "type": "number" }, "refundNumberWithAmount": { "type": "string" }, "refundStatus": { "format": "int32", "type": "integer" }, "refundErrorMessage": { "type": "string" } } }, "api.revenue.ApiModels.ExhibitorRegistrationViewModels": { "type": "object", "properties": { "registrationId": { "format": "uuid", "type": "string" }, "registrationName": { "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "groupName": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "exhibitorId": { "format": "uuid", "type": "string" }, "boothAssignmentType": { "format": "int32", "type": "integer" }, "isAssignedBooth": { "type": "boolean" }, "exhibitorOrganizationName": { "type": "string" }, "exhibitorRegistrant": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } }, "molRegistrantsView": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } }, "eventContanct": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } }, "financeContacts": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } }, "additionalPeople": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AdditionalPeopleViewModel" } }, "removedItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationItemsViewModel" } }, "addedItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationItemsViewModel" } }, "boothStaffRegistrant": { "$ref": "#/definitions/api.revenue.ApiModels.RegistrationRequestViewModel" } } }, "api.revenue.ApiModels.RegistrationRequestViewModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isEmailSend": { "type": "boolean" } } }, "api.revenue.ApiModels.RegistrationItemsViewModel": { "type": "object", "properties": { "itemId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "length": { "format": "int32", "type": "integer" }, "breadth": { "format": "int32", "type": "integer" }, "preference": { "format": "int32", "type": "integer" }, "itemType": { "enum": [ "Activities", "Classes", "Products", "Bundles", "Booths", "BoothStaff" ], "type": "string" } } }, "api.revenue.ApiModels.QB.AccBookConnectModel": { "type": "object", "properties": { "financialYear": { "type": "string" }, "accountingSystemType": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.AccBookConnectViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "tenantCode": { "type": "string" }, "tennatLogo": { "type": "string" }, "financialYear": { "type": "string" }, "accountingSystemType": { "type": "string" }, "isConnectionActive": { "type": "boolean" }, "createdById": { "format": "uuid", "type": "string" }, "createdByName": { "type": "string" }, "createdByImage": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "downloadUrl": { "type": "string" }, "userTokenKeys": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookIntegrationToken" } } } }, "api.revenue.ApiModels.QB.AccBookIntegrationToken": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "personName": { "type": "string" }, "personImage": { "type": "string" }, "token": { "type": "string" }, "expiryDateTime": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "createdByName": { "type": "string" }, "createdByImage": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.Filters.ConnectionListFilterModel": { "type": "object", "properties": { "accountingSystemType": { "format": "int32", "type": "integer" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.AccBookGenerateTokenModel": { "type": "object", "properties": { "externalAcBookIntegrationId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.QB.AccBookConnect": { "type": "object", "properties": { "token": { "type": "string" } } }, "api.revenue.ApiModels.QB.ValidateTokenModel": { "type": "object", "properties": { "isTokenValid": { "type": "boolean" }, "response": { "type": "string" }, "mappingURL": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "tenantCode": { "type": "string" }, "tennatLogo": { "type": "string" }, "financialYear": { "type": "string" }, "accountingSystemType": { "type": "string" }, "isConnectionActive": { "type": "boolean" }, "createdById": { "format": "uuid", "type": "string" }, "createdByName": { "type": "string" }, "createdByImage": { "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "downloadUrl": { "type": "string" }, "userTokenKeys": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccBookIntegrationToken" } } } }, "api.revenue.ApiModels.QB.QBMasterImportModel": { "type": "object", "properties": { "qbMasterType": { "format": "int32", "type": "integer" }, "qbCompany": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CompanyRequestModel" }, "pagination": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBPagination" }, "data": { "type": "object" } } }, "api.revenue.ApiModels.QB.CompanyRequestModel": { "type": "object", "properties": { "qbCompanyID": { "type": "string" }, "qbCompanyName": { "type": "string" }, "qbCompanyFilePath": { "type": "string" }, "tokenReferanceID": { "type": "string" }, "isConnected": { "type": "boolean" } } }, "api.revenue.ApiModels.QB.QBPagination": { "type": "object", "properties": { "pageNo": { "format": "int64", "type": "integer" }, "pageSize": { "format": "int64", "type": "integer" }, "totalPage": { "format": "int64", "type": "integer" } } }, "api.revenue.ApiModels.Filters.COAFilterModel": { "type": "object", "properties": { "nameText": { "type": "string" }, "numberText": { "type": "string" }, "companyNameText": { "type": "string" }, "companies": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "lastUpdatedBy": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "syncDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "nameFormat": { "type": "string" }, "categoryId": { "format": "int32", "type": "integer" }, "isEmpty": { "type": "boolean", "readOnly": true }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.COAListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAListQueryViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.QB.COAListQueryViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "qbListId": { "type": "string" }, "companyId": { "type": "string" }, "companyName": { "type": "string" }, "lastUpdatedById": { "format": "uuid", "type": "string" }, "lastUpdatedByName": { "type": "string" }, "lastUpdatedByImage": { "type": "string" }, "lastUpdatedDate": { "format": "date-time", "type": "string" }, "isAlreadyMapped": { "type": "boolean" }, "lastSyncedOn": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.QB.COAEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.QB.COADeleteModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.QB.COACategoryEnum": { "type": "object", "properties": { "categoryId": { "format": "int32", "type": "integer" }, "categoryName": { "type": "string" } } }, "api.revenue.ApiModels.QB.COAListFilterOption": { "type": "object", "properties": { "companyNames": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAFilterObject" } }, "lastUpdatedBy": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAFilterObject" } }, "types": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAFilterObject" } }, "syncDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" } } }, "api.revenue.ApiModels.QB.COAFilterObject": { "type": "object", "properties": { "text": { "type": "string" }, "value": { "type": "string" } } }, "api.revenue.ApiModels.QB.COAListDdlOption": { "type": "object", "properties": { "chartOfAccountId": { "format": "uuid", "type": "string" }, "number": { "type": "string" }, "account": { "type": "string" }, "qbListId": { "type": "string" } } }, "api.revenue.ApiModels.QB.CategoryTypesModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "typeId": { "format": "int32", "type": "integer" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.QB.QbCompanyModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "qbCompanyId": { "type": "string" }, "qbCompanyName": { "type": "string" }, "qbCompanyPath": { "type": "string" } } }, "api.revenue.ApiModels.QB.QbObjectNameModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.QB.COAMappingReqModel": { "type": "object", "properties": { "qbCompanyId": { "type": "string" }, "invoiceCOAId": { "format": "uuid", "type": "string" }, "paymentCOAId": { "format": "uuid", "type": "string" }, "creditNoteCOAId": { "format": "uuid", "type": "string" }, "refundCOAId": { "format": "uuid", "type": "string" }, "itemId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.QB.COAMappingListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.QB.COAMappingViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "qbListId": { "type": "string" }, "lastSyncedOn": { "format": "date-time", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "personName": { "type": "string" }, "imageUrl": { "type": "string" }, "email": { "type": "string" }, "position": { "type": "string" }, "payment": { "type": "string" }, "invoice": { "type": "string" }, "refund": { "type": "string" }, "creditNote": { "type": "string" } } }, "api.revenue.ApiModels.QB.COAMappingResponseModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "qbCompanyId": { "type": "string" }, "qbCompanyName": { "type": "string" }, "invoiceCOAId": { "type": "string" }, "invoiceCOA": { "type": "string" }, "paymentCOAId": { "type": "string" }, "paymentCOA": { "type": "string" }, "creditNoteCOAId": { "type": "string" }, "creditNoteCOA": { "type": "string" }, "refundCOAId": { "type": "string" }, "refundCOA": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "objectType": { "type": "string" }, "objectCategory": { "type": "string" } } }, "api.revenue.ApiModels.QB.COAManualTrxMappingReqModel": { "type": "object", "properties": { "invoiceCOAId": { "format": "uuid", "type": "string" }, "paymentCOAId": { "format": "uuid", "type": "string" }, "creditNoteCOAId": { "format": "uuid", "type": "string" }, "refundCOAId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.QB.COAMappingListFilterOption": { "type": "object", "properties": { "qbCompanyId": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "invoiceCOAId": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "paymentCOAId": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "creditNoteCOAId": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "refundCOAId": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "itemCount": { "format": "int32", "type": "integer" }, "pageNumber": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.COAItemWiseResponse": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.COAMappingListModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.QB.COAMappingListModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "qbCompanyId": { "type": "string" }, "qbCompanyName": { "type": "string" }, "invoiceCOAId": { "type": "string" }, "invoiceCOA": { "type": "string" }, "paymentCOAId": { "type": "string" }, "paymentCOA": { "type": "string" }, "creditNoteCOAId": { "type": "string" }, "creditNoteCOA": { "type": "string" }, "refundCOAId": { "type": "string" }, "refundCOA": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "typeId": { "format": "int32", "type": "integer" }, "objectType": { "type": "string" }, "objectCategory": { "type": "string" }, "categoryId": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.COAItemLevelMappingFilterModel": { "type": "object", "properties": { "companies": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "objectCategory": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "isEmpty": { "type": "boolean", "readOnly": true }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.COAFilterListOption": { "type": "object", "properties": { "companyIds": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "masterTypes": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "coaTypes": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.Filters.SyncRequestModel": { "type": "object", "properties": { "companyId": { "type": "string" }, "tokenReferanceID": { "type": "string" }, "pageSize": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.QBInvoiceSyncResponse": { "type": "object", "properties": { "qbCompanyID": { "type": "string" }, "tokenReferenceID": { "type": "string" }, "success": { "$ref": "#/definitions/api.revenue.ApiModels.QB.SuccessRes" }, "failure": { "$ref": "#/definitions/api.revenue.ApiModels.QB.FailureRes" } } }, "api.revenue.ApiModels.QB.SuccessRes": { "type": "object", "properties": { "invoice": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.InvoiceSyncRes" } }, "customer": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CustomerRes" } }, "account": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccountRes" } }, "term": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.TermRes" } }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.ItemRes" } } } }, "api.revenue.ApiModels.QB.FailureRes": { "type": "object", "properties": { "invoice": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.InvoiceSyncRes" } }, "customer": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CustomerRes" } }, "account": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccountRes" } }, "term": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.TermRes" } }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.ItemRes" } } } }, "api.revenue.ApiModels.QB.InvoiceSyncRes": { "type": "object", "properties": { "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" }, "qbTransactionID": { "type": "string" }, "engagifiiID": { "type": "string" }, "qbRefNumber": { "type": "string" }, "qbVoidTransactionID": { "type": "string" } } }, "api.revenue.ApiModels.QB.CustomerRes": { "type": "object", "properties": { "name": { "type": "string" }, "qbid": { "type": "string" }, "engagifiiID": { "type": "string" }, "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" } } }, "api.revenue.ApiModels.QB.AccountRes": { "type": "object", "properties": { "name": { "type": "string" }, "qbid": { "type": "string" }, "engagifiiID": { "type": "string" }, "accountType": { "type": "string" }, "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" } } }, "api.revenue.ApiModels.QB.TermRes": { "type": "object", "properties": { "name": { "type": "string" }, "qbid": { "type": "string" }, "engagifiiID": { "type": "string" }, "noOfDays": { "format": "int32", "type": "integer" }, "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" } } }, "api.revenue.ApiModels.QB.ItemRes": { "type": "object", "properties": { "itemName": { "type": "string" }, "qbItemID": { "type": "string" }, "engagifiiItemID": { "type": "string" }, "account": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccountRes" } } }, "api.revenue.ApiModels.QB.QBPaymentSyncResponse": { "type": "object", "properties": { "qbCompanyID": { "type": "string" }, "tokenReferenceID": { "type": "string" }, "success": { "$ref": "#/definitions/api.revenue.ApiModels.QB.SuccessPay" }, "failure": { "$ref": "#/definitions/api.revenue.ApiModels.QB.FailurePay" } } }, "api.revenue.ApiModels.QB.SuccessPay": { "type": "object", "properties": { "invoicePayment": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.InvoicePaymentSycRes" } } } }, "api.revenue.ApiModels.QB.FailurePay": { "type": "object", "properties": { "invoicePayment": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.InvoicePaymentSycRes" } } } }, "api.revenue.ApiModels.QB.InvoicePaymentSycRes": { "type": "object", "properties": { "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" }, "qbTransactionID": { "type": "string" }, "engagifiiID": { "type": "string" }, "qbRefNumber": { "type": "string" }, "creditMemo": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CreditMemo" }, "qbDeletedTransactionID": { "type": "string" } } }, "api.revenue.ApiModels.QB.CreditMemo": { "type": "object", "properties": { "qbStatusCode": { "type": "string" }, "qbMessage": { "type": "string" }, "qbTransactionID": { "type": "string" }, "qbRefNumber": { "type": "string" } } }, "api.revenue.ApiModels.QB.LogRequestModel": { "type": "object", "properties": { "logType": { "format": "int32", "type": "integer" }, "message": { "type": "string" } } }, "api.revenue.ApiModels.QB.CompanyWiseMasterSyncTime": { "type": "object", "properties": { "qbCompanyID": { "type": "string" }, "qbCompanyName": { "type": "string" }, "qbCompanyFilePath": { "type": "string" }, "masterSyncTime": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.QBSyncMasterDataModel" } } } }, "api.revenue.ApiModels.QB.QBSyncMasterDataModel": { "type": "object", "properties": { "syncDate": { "format": "date-time", "type": "string" }, "qbMasterType": { "format": "int32", "type": "integer" }, "qbMasterTypeName": { "type": "string" }, "qbCompanyId": { "type": "string" } } }, "api.revenue.ApiModels.QB.FiscalYearViewModel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.QB.FiscalYearModel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.QbCompanyStatusModel": { "type": "object", "properties": { "qbCompanyId": { "type": "string" }, "isConnected": { "type": "boolean" } } }, "api.revenue.ApiModels.QB.QBCreditSettingsModel": { "type": "object", "properties": { "creditType": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.COAExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "nameText": { "type": "string" }, "numberText": { "type": "string" }, "companyNameText": { "type": "string" }, "companies": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "lastUpdatedBy": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "syncDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "nameFormat": { "type": "string" }, "categoryId": { "format": "int32", "type": "integer" }, "isEmpty": { "type": "boolean", "readOnly": true }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.PeopleFilterModel": { "type": "object", "properties": { "peopleNameText": { "type": "string" }, "qbdPeopleNameText": { "type": "string" }, "organizationNameText": { "type": "string" }, "syncStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.PeopleListPagingModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.PeopleListViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.QB.PeopleListViewModel": { "type": "object", "properties": { "engagifiiCustomerId": { "format": "uuid", "type": "string" }, "engagifiiCustomerFirstName": { "type": "string" }, "engagifiiCustomerMiddleName": { "type": "string" }, "engagifiiCustomerLastName": { "type": "string" }, "engagifiiCustomerEmail": { "type": "string" }, "engagifiiCustomerStatus": { "type": "boolean" }, "engagifiiCustomerImageUrl": { "type": "string" }, "primaryOrganizationId": { "format": "uuid", "type": "string" }, "primaryOrganizationName": { "type": "string" }, "primaryOrganizationImageUrl": { "type": "string" }, "qbCompanyId": { "type": "string" }, "qbListId": { "type": "string" }, "qbFulllName": { "type": "string" }, "qbFirstName": { "type": "string" }, "qbMiddleName": { "type": "string" }, "qbLastName": { "type": "string" }, "qbEmail": { "type": "string" }, "comment": { "type": "string" }, "syncStatus": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.QB.EditPeopleMappingModel": { "type": "object", "properties": { "engagifiiCustomerId": { "format": "uuid", "type": "string" }, "qbListId": { "type": "string" } } }, "api.revenue.ApiModels.QB.DeletePeopleMappingModel": { "type": "object", "properties": { "engagifiiCustomerId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.QB.QBPeopleListViewModel": { "type": "object", "properties": { "qbCompanyId": { "type": "string" }, "qbListId": { "type": "string" }, "qbFulllName": { "type": "string" }, "qbFirstName": { "type": "string" }, "qbMiddleName": { "type": "string" }, "qbLastName": { "type": "string" }, "qbEmail": { "type": "string" }, "isAlreadyMapped": { "type": "boolean" } } }, "api.revenue.ApiModels.QB.QBInvoiceMappingFailedModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "termMapping": { "$ref": "#/definitions/api.revenue.ApiModels.QB.TermMapping" }, "customerMapping": { "$ref": "#/definitions/api.revenue.ApiModels.QB.CustomerMapping" }, "accountMapping": { "$ref": "#/definitions/api.revenue.ApiModels.QB.AccountMapping" } } }, "api.revenue.ApiModels.QB.TermMapping": { "type": "object", "properties": { "syncStatus": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "paymentTermName": { "type": "string" }, "qbTermId": { "type": "string" } } }, "api.revenue.ApiModels.QB.CustomerMapping": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "customerType": { "type": "string" }, "syncStatus": { "type": "boolean" }, "qbCustomerId": { "type": "string" } } }, "api.revenue.ApiModels.QB.AccountMapping": { "type": "object", "properties": { "syncStatus": { "type": "boolean" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QB.Item" } } } }, "api.revenue.ApiModels.QB.Item": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemTypeName": { "type": "string" }, "qbCoaId": { "type": "string" } } }, "api.revenue.ApiModels.QB.QBCustomerDataModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "qbCompanyId": { "type": "string" } } }, "api.revenue.ApiModels.Filters.OrgFilterModel": { "type": "object", "properties": { "organizationNameText": { "type": "string" }, "qbOrganizationNameText": { "type": "string" }, "syncStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Refund.ManualRefundModel": { "description": "manual refund model class", "type": "object", "properties": { "id": { "format": "uuid", "description": "unique identifier", "type": "string" }, "mode": { "description": "refund method", "enum": [ "CreditCard", "Check", "Cash", "CreditCardProcessedOutsideEngagifii", "AccountTransfer", "ACH", "ACHRecord", "CreditNote" ], "type": "string" }, "note": { "description": "refund description", "type": "string" }, "reason": { "description": "refund reason", "type": "string" }, "refundDate": { "format": "date-time", "description": "refund date", "type": "string" }, "refundTime": { "format": "date-time", "description": "refund time", "type": "string" }, "customerType": { "description": "it's for customer type", "enum": [ "Person", "Organization" ], "type": "string" }, "customerTypeText": { "description": "for setting customer type text value", "type": "string" }, "customerId": { "format": "uuid", "description": "for customer type", "type": "string" }, "amount": { "format": "double", "description": "for refund amount", "type": "number" }, "refundId": { "format": "int64", "description": "forign key for refund table", "type": "integer" }, "refundNumber": { "description": "automatic generated refund number", "type": "string" }, "modeId": { "format": "int32", "description": "payment method enum value", "type": "integer" }, "modeText": { "description": "payment method text value", "type": "string" }, "customerTypeId": { "format": "int32", "description": "customer type enum value", "type": "integer" }, "customerName": { "description": "customer name", "type": "string" }, "status": { "description": "refund status", "type": "string" }, "isFavorite": { "description": "marking refund as favorate", "type": "boolean" }, "customerIcon": { "description": "customer image icon", "type": "string" }, "payments": { "description": "foreign key table", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.ManualPaymentRefundModel" } }, "invoiceItems": { "description": "foreign key table", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.InvoiceItembyPaymentModel" } }, "refundDeliveryAddressId": { "format": "uuid", "type": "string" }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } } } }, "api.revenue.ApiModels.Refund.ManualPaymentRefundModel": { "description": "class will be used for saving or updating the refund manually", "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "id": { "format": "uuid", "description": "unique identifier of refund", "type": "string" }, "paymentId": { "format": "uuid", "description": "it will be payment id", "type": "string" }, "paymentNumber": { "description": "it will be payment number", "type": "string" }, "paymentMethod": { "description": "it wil be payment method", "type": "string" }, "paymentDate": { "format": "date-time", "description": "it will be payment date", "type": "string" }, "amount": { "format": "double", "description": "it will be paid amount", "type": "number" }, "amountToRefund": { "format": "float", "description": "it will be amount to be paid", "type": "number" }, "note": { "description": "Note about refund", "type": "string" }, "remarks": { "description": "it will be remarks about refund", "type": "string" }, "status": { "description": "field for status", "type": "string" } } }, "api.revenue.ApiModels.Refund.InvoiceItembyPaymentModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "itemCategory": { "type": "string" }, "itemName": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "remarks": { "type": "string" } } }, "api.revenue.ApiModels.Filters.RefundInvoicesListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "invoiceNumber": { "type": "string" }, "creditNoteSearchText": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Refund.RefundTransactionDetailViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "dateOfCreation": { "format": "date-time", "type": "string" }, "number": { "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "amount": { "format": "float", "type": "number" }, "createdBy": { "type": "string" }, "refundTypeID": { "format": "int32", "type": "integer" }, "refundType": { "type": "string" } } }, "api.revenue.ApiModels.Refund.RefundDetailViewModel": { "description": "class having properties of refund detail by id", "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "refundNumber": { "type": "string" }, "modeId": { "format": "int32", "type": "integer" }, "refundTypeId": { "format": "int32", "type": "integer" }, "mode": { "type": "string" }, "note": { "type": "string" }, "refundDate": { "format": "date-time", "type": "string" }, "refundTime": { "format": "date-time", "type": "string" }, "customerTypeId": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "amountToRefund": { "format": "double", "type": "number" }, "reason": { "type": "string" }, "isSuccess": { "type": "boolean" }, "customerIcon": { "type": "string" }, "isFavorite": { "type": "boolean" }, "status": { "type": "string" }, "tenantIcon": { "type": "string" }, "tenantAddress": { "type": "string" }, "payments": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundPaymentDetailViewModel" } }, "creditNotes": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundCreditNoteDetailViewModel" } }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundItemDetailViewModel" } }, "refundItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.RefundItemLevelViewModel" } }, "refundDeliveryAddressId": { "format": "uuid", "type": "string" }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "refundReferenceNo": { "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.Refund.RefundPaymentDetailViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "paymentDate": { "format": "date-time", "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "amount": { "format": "float", "type": "number" }, "amountToRefund": { "format": "float", "type": "number" } } }, "api.revenue.ApiModels.Refund.RefundCreditNoteDetailViewModel": { "type": "object", "properties": { "paymentId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "paymentNumber": { "type": "string" }, "creditNoteDate": { "format": "date-time", "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "amount": { "format": "float", "type": "number" }, "amountToRefund": { "format": "float", "type": "number" }, "clearingDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.Refund.RefundItemDetailViewModel": { "description": "class for having item detail accordingly refund is done", "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "itemCategory": { "type": "string" }, "itemName": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "remarks": { "type": "string" } } }, "api.revenue.ApiModels.Refund.RefundItemLevelViewModel": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "amount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Payment.CustomRefundViewModel": { "type": "object", "properties": { "customerType": { "description": "it's for customer type", "enum": [ "Person", "Organization" ], "type": "string" }, "customerTypeText": { "description": "for setting customer type text value", "type": "string" }, "customerId": { "format": "uuid", "description": "for customer type", "type": "string" }, "customerTypeId": { "format": "int32", "description": "for refund amount", "type": "integer" }, "customerName": { "description": "customer name", "type": "string" }, "status": { "description": "refund status", "type": "string" }, "customerIcon": { "description": "marking refund as favorate", "type": "string" }, "payments": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.ManualPaymentRefundModel", "description": "foreign key table" }, "invoiceItems": { "description": "foreign key table", "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Refund.InvoiceItembyPaymentModel" } } } }, "api.revenue.ApiModels.Refund.CreditNotePaymentRefundModel": { "description": "manual refund model class", "type": "object", "properties": { "mode": { "description": "unique identifier", "enum": [ "CreditCard", "Check", "Cash", "CreditCardProcessedOutsideEngagifii", "AccountTransfer", "ACH", "ACHRecord", "CreditNote" ], "type": "string" }, "note": { "description": "refund description", "type": "string" }, "reason": { "description": "refund reason", "type": "string" }, "refundDate": { "format": "date-time", "description": "refund date", "type": "string" }, "refundTime": { "format": "date-time", "description": "refund time", "type": "string" }, "customerType": { "description": "it's for customer type", "enum": [ "Person", "Organization" ], "type": "string" }, "customerTypeText": { "description": "for setting customer type text value", "type": "string" }, "customerId": { "format": "uuid", "description": "for customer type", "type": "string" }, "amount": { "format": "double", "description": "for refund amount", "type": "number" }, "refundNumber": { "description": "forign key for refund table", "type": "string" }, "modeId": { "format": "int32", "description": "payment method enum value", "type": "integer" }, "modeText": { "description": "payment method text value", "type": "string" }, "customerTypeId": { "format": "int32", "description": "customer type enum value", "type": "integer" }, "customerName": { "description": "customer name", "type": "string" }, "status": { "description": "refund status", "type": "string" }, "creditNoteId": { "format": "uuid", "description": "marking refund as favorate", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "refundType": { "format": "int32", "type": "integer" }, "clearingDate": { "format": "date-time", "type": "string" }, "refeReferenceNo": { "type": "string" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CreditNotes.CreditNoteInvoiceModel" } }, "intentId": { "type": "string" }, "isRefundFromCancellationRegistration": { "type": "boolean" } } }, "api.revenue.ApiModels.Refund.RecordRefundViewModel": { "type": "object", "properties": { "status": { "format": "int32", "type": "integer" }, "errorMessage": { "type": "string" }, "refundId": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Refund.UpdateRefundClearingDateModel": { "type": "object", "properties": { "refundId": { "format": "uuid", "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "referenceNumber": { "type": "string" } } }, "api.revenue.ApiModels.RefundNotificationViewModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "paymentId": { "format": "uuid", "type": "string" }, "refundId": { "format": "uuid", "type": "string" }, "isPaymentRefund": { "type": "boolean" }, "billingContacts": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "loggedinUser": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ModifiedRequestViewModel" } }, "additionalPeople": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.AdditionalPeopleViewModel" } } } }, "api.revenue.ApiModels.Payment.RegModifiedInvoiceChangeViewModel": { "type": "object", "properties": { "originalInvoiceId": { "format": "uuid", "type": "string" }, "newInvoiceId": { "format": "uuid", "type": "string" }, "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "creditNoteAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.CancelParticipantsRevenueViewModels": { "type": "object", "properties": { "regCancellationType": { "enum": [ "Subscription", "Event", "Endorsement", "Class", "Product", "EventSession", "EventBundle", "Manual", "Modification", "CancellationFee", "Exhibitor", "AdditionalExhibitor", "Tenant" ], "type": "string" }, "cancelParticipantsfromRevenueModellist": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.CancelParticipantsfromRevenueModelForEvent" } }, "listOfNotifyPersonList": { "$ref": "#/definitions/api.revenue.ApiModels.ListOfNotifyPersonList" } } }, "api.revenue.ApiModels.CancelParticipantsfromRevenueModelForEvent": { "type": "object", "properties": { "registrationId": { "type": "string" }, "eventName": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "cancellationReason": { "type": "string" }, "cancellationComment": { "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceItemId": { "format": "uuid", "type": "string" }, "cancellationfee": { "format": "double", "type": "number" }, "ticketNumber": { "type": "string" }, "refundAmount": { "format": "double", "type": "number" }, "creditNoteAmount": { "format": "double", "type": "number" }, "retainedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.ListOfNotifyPersonList": { "type": "object", "properties": { "cancellledRegPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "adminPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "classPersonContactList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "eventPersonContactList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "eventSpeakerPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "eventApproverPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "billingContactPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "financeContactsPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "additionalPeopleToNotify": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } }, "classInstructorPersonList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.NotifyPersonListModel" } } } }, "api.revenue.ApiModels.NotifyPersonListModel": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "isEmailSend": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.ReportFilterModel": { "type": "object", "properties": { "reportName": { "type": "string" }, "viewedBy": { "type": "string" }, "viewedOn": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateRangeFilterBody" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.DateRangeFilterBody": { "type": "object", "properties": { "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.Transaction.ReportListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.ReportViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Transaction.ReportViewModel": { "type": "object", "properties": { "reportId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "lastViewedBy": { "$ref": "#/definitions/api.revenue.ApiModels.PersonSimpleView" }, "lastViewedDttm": { "format": "date-time", "type": "string" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.PersonSimpleView": { "type": "object", "properties": { "personId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.ReportViewerModel": { "type": "object", "properties": { "reportId": { "format": "uuid", "type": "string" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.TrialReportFilterModel": { "type": "object", "properties": { "customerType": { "type": "string" }, "period": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeriodFilterBody" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerName": { "type": "string" }, "invoiceAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "outStandingAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "paidAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "openCreditNotebalance": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "itemCategory": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "organizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "buyerOrganizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "people": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "text": { "type": "string" }, "invoice": { "type": "string" }, "item": { "type": "string" }, "amt30": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt30_60": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt60_90": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt90": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "nameFormat": { "type": "string" }, "consumerIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "aging": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.MinMaxModel": { "type": "object", "properties": { "minText": { "type": "string" }, "maxText": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.TrialOrgGroupListViewModel": { "type": "object", "properties": { "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportHeadersData" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportOrgGroupModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Transaction.TrialReportHeadersData": { "type": "object", "properties": { "totalInvoiceAmount": { "format": "double", "type": "number" }, "totalPaidAmount": { "format": "double", "type": "number" }, "totalOpenCreditNoteBalanceAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount30Days": { "format": "double", "type": "number" }, "totalOutstandingAmount60Days": { "format": "double", "type": "number" }, "totalOutstandingAmount90Days": { "format": "double", "type": "number" }, "totalOutstandingAmount30to60Days": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Transaction.TrialReportOrgGroupModel": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "organizationName": { "type": "string" }, "organizationStatus": { "type": "boolean" }, "imageUrl": { "type": "string" }, "invoiceCount": { "format": "int32", "type": "integer" }, "totalAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "openCreditNotebalance": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "amt30": { "format": "double", "type": "number" }, "amt30_60": { "format": "double", "type": "number" }, "amt60_90": { "format": "double", "type": "number" }, "amt90": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Transaction.TrialGroupListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportGroupModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportHeadersData" } } }, "api.revenue.ApiModels.Transaction.TrialReportGroupModel": { "type": "object", "properties": { "invoiceCount": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "customerStatus": { "type": "boolean" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "imageUrl": { "type": "string" }, "totalAmount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "openCreditNotebalance": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "amt30": { "format": "double", "type": "number" }, "amt30_60": { "format": "double", "type": "number" }, "amt60_90": { "format": "double", "type": "number" }, "amt90": { "format": "double", "type": "number" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.OrganizationViewModel" } } } }, "api.revenue.ApiModels.Filters.TrialReportExportModel": { "type": "object", "properties": { "filterModel": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TrialReportFilterModel" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "tableName": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.TrialReportDetailListModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailsHeadersData" } } }, "api.revenue.ApiModels.Transaction.TrialReportDetailModel": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "invoiceNumber": { "type": "string" }, "invoiceCreatedOn": { "format": "date-time", "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceDueDate": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "createdByName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "outstandingAmount": { "format": "double", "type": "number" }, "invoiceStatus": { "type": "string" }, "buyerType": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "buyerId": { "type": "string" }, "buyerName": { "type": "string" }, "icon": { "type": "string" }, "invoiceItemsDetail": { "type": "string" }, "openCreditNotebalance": { "format": "double", "type": "number" }, "amt30": { "format": "double", "type": "number" }, "amt30_60": { "format": "double", "type": "number" }, "amt60_90": { "format": "double", "type": "number" }, "amt90": { "format": "double", "type": "number" }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemModel" } }, "lastReminderSent": { "$ref": "#/definitions/api.revenue.ApiModels.LastReminderSentViewModel" } } }, "api.revenue.ApiModels.Transaction.TrialReportDetailsHeadersData": { "type": "object", "properties": { "totalInvoiceAmount": { "format": "double", "type": "number" }, "totalPaidAmount": { "format": "double", "type": "number" }, "totalOutstandingAmount": { "format": "double", "type": "number" }, "payAllPaymentLink": { "type": "string" } } }, "api.revenue.ApiModels.Filters.TrialReportFilterOptionsReqModel": { "type": "object", "properties": { "reportName": { "type": "string" } } }, "api.revenue.ApiModels.Filters.TrialReportFilterOptions": { "type": "object", "properties": { "period": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeriodFilterBody" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "itemCategory": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "items": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValActiveModel" } }, "buyerOrganizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValActiveModel" } }, "people": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.KeyValModel" } }, "invoiceAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "outStandingAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "paidAmount": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.AmountFilterBody" }, "amt30": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt30_60": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt60_90": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" }, "amt90": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.MinMaxModel" } } }, "api.revenue.ApiModels.Filters.KeyValActiveModel": { "type": "object", "properties": { "value": { "type": "string" }, "text": { "type": "string" }, "isActive": { "type": "boolean" } } }, "api.revenue.ApiModels.Reports.MonthEndReportFilterModel": { "type": "object", "properties": { "startDateMonth": { "format": "int32", "type": "integer" }, "startDateYear": { "format": "int32", "type": "integer" }, "endDateMonth": { "format": "int32", "type": "integer" }, "endDateYear": { "format": "int32", "type": "integer" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "searchText": { "type": "string" }, "isAscending": { "type": "boolean" }, "sortBy": { "type": "string" }, "isCount": { "format": "int32", "type": "integer" }, "showEventBundle": { "type": "boolean" }, "showEvent": { "type": "boolean" }, "showEventRevenue": { "type": "boolean" }, "showEventClass": { "type": "boolean" }, "showEventSession": { "type": "boolean" }, "showClassRevenue": { "type": "boolean" }, "showAwardRevenue": { "type": "boolean" }, "showShopItemRevenue": { "type": "boolean" }, "showManualInvoice": { "type": "boolean" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" } } }, "api.revenue.ApiModels.Reports.MonthEndReportResponseModel": { "type": "object", "properties": { "headers": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndRptHeader" }, "monthdata": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthData" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Reports.MonthEndRptHeader": { "type": "object", "properties": { "unitsSold": { "format": "int32", "type": "integer" }, "creationMonth": { "type": "string" }, "creationYear": { "type": "string" }, "creationMonthNumber": { "type": "string" }, "itemRevenue": { "format": "double", "type": "number" }, "eventBundleAmount": { "format": "double", "type": "number" }, "eventClassAmount": { "format": "double", "type": "number" }, "eventSessionAmount": { "format": "double", "type": "number" }, "cancellationFee": { "format": "double", "type": "number" }, "modificationAmount": { "format": "double", "type": "number" }, "invoiceCounts": { "format": "int32", "type": "integer" }, "creditNoteCounts": { "format": "int32", "type": "integer" }, "creditNoteAmount": { "format": "double", "type": "number" }, "invoiceAmount": { "format": "double", "type": "number" }, "netRevenue": { "format": "double", "type": "number" }, "eventAmount": { "format": "double", "type": "number" }, "isIncludedVoidedInvoice": { "type": "boolean" } } }, "api.revenue.ApiModels.Reports.MonthData": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "string" }, "creationMonthNumber": { "type": "string" }, "unitsSold": { "format": "int32", "type": "integer" }, "creationMonth": { "type": "string" }, "creationYear": { "type": "string" }, "itemRevenue": { "format": "double", "type": "number" }, "eventBundleAmount": { "format": "double", "type": "number" }, "eventClassAmount": { "format": "double", "type": "number" }, "eventSessionAmount": { "format": "double", "type": "number" }, "cancellationFee": { "format": "double", "type": "number" }, "modificationAmount": { "format": "double", "type": "number" }, "invoiceCounts": { "format": "int32", "type": "integer" }, "creditNoteCounts": { "format": "int32", "type": "integer" }, "creditNoteAmount": { "format": "double", "type": "number" }, "invoiceAmount": { "format": "double", "type": "number" }, "netRevenue": { "format": "double", "type": "number" }, "eventAmount": { "format": "double", "type": "number" }, "isIncludedVoidedInvoice": { "type": "boolean" } } }, "api.revenue.ApiModels.Reports.MonthEndEventReportResponseModel": { "type": "object", "properties": { "headers": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndRptHeader" }, "events": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.EventsData" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Reports.EventsData": { "type": "object", "properties": { "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemIcon": { "type": "string" }, "itemCategory": { "format": "int32", "type": "integer" }, "itemCategoryName": { "type": "string" }, "isIncludedVoidedInvoice": { "type": "boolean" }, "unitsSold": { "format": "int32", "type": "integer" }, "creationMonth": { "type": "string" }, "creationYear": { "type": "string" }, "creationMonthNumber": { "type": "string" }, "itemRevenue": { "format": "double", "type": "number" }, "eventBundleAmount": { "format": "double", "type": "number" }, "eventClassAmount": { "format": "double", "type": "number" }, "eventSessionAmount": { "format": "double", "type": "number" }, "cancellationFee": { "format": "double", "type": "number" }, "modificationAmount": { "format": "double", "type": "number" }, "invoiceCounts": { "format": "int32", "type": "integer" }, "creditNoteCounts": { "format": "int32", "type": "integer" }, "creditNoteAmount": { "format": "double", "type": "number" }, "invoiceAmount": { "format": "double", "type": "number" }, "netRevenue": { "format": "double", "type": "number" }, "eventAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Reports.MonthEndReportInvoiceFilterModel": { "type": "object", "properties": { "startDateMonth": { "format": "int32", "type": "integer" }, "startDateYear": { "format": "int32", "type": "integer" }, "endDateMonth": { "format": "int32", "type": "integer" }, "endDateYear": { "format": "int32", "type": "integer" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "searchText": { "type": "string" }, "searchInvoiceText": { "type": "string" }, "searchBuyerText": { "type": "string" }, "itemId": { "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "isHeader": { "type": "boolean" }, "ispaginationRequired": { "type": "boolean" }, "isCount": { "type": "boolean" }, "isAscending": { "type": "boolean" }, "sortBy": { "type": "string" }, "showEvent": { "type": "boolean" }, "showEventRevenue": { "type": "boolean" }, "showEventBundle": { "type": "boolean" }, "showEventClass": { "type": "boolean" }, "showEventSession": { "type": "boolean" }, "showClassRevenue": { "type": "boolean" }, "showAwardRevenue": { "type": "boolean" }, "showShopItemRevenue": { "type": "boolean" }, "showManualInvoice": { "type": "boolean" }, "showCreditNote": { "type": "boolean" }, "showAllInvoices": { "type": "boolean" }, "showModification": { "type": "boolean" }, "variantName": { "enum": [ "SpecificEvent", "CompleteMonth", "GrandTotal" ], "type": "string" }, "itemCategoryName": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" } } }, "api.revenue.ApiModels.Reports.MonthEndInvoiceReportResponseModel": { "type": "object", "properties": { "headers": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndRptHeader" }, "invoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.InvoiceData" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "isIncludeVoidedInvoice": { "type": "boolean" } } }, "api.revenue.ApiModels.Reports.InvoiceData": { "type": "object", "properties": { "creationMonth": { "type": "string" }, "creationYear": { "type": "string" }, "creationMonthNumber": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" }, "invoiceAmount": { "format": "double", "type": "number" }, "buyerName": { "type": "string" }, "buyerId": { "format": "uuid", "type": "string" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.OrganizationViewModel" } }, "createdByName": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemIcon": { "type": "string" }, "itemCategoryName": { "type": "string" }, "itemAmount": { "format": "double", "type": "number" }, "invoiceIssueDate": { "format": "date-time", "type": "string" }, "invoiceDueDate": { "format": "date-time", "type": "string" }, "buyerIcon": { "type": "string" }, "eventClassAmount": { "format": "double", "type": "number" }, "eventAmount": { "format": "double", "type": "number" }, "eventSessionAmount": { "format": "double", "type": "number" }, "eventBundleAmount": { "format": "double", "type": "number" }, "modificationAmount": { "format": "double", "type": "number" }, "cancellationFee": { "format": "double", "type": "number" }, "balanceDue": { "format": "double", "type": "number" }, "status": { "type": "string" }, "buyerType": { "format": "int32", "type": "integer" }, "buyerStatus": { "type": "boolean" }, "eventId": { "format": "uuid", "type": "string" }, "eventName": { "type": "string" }, "creditNoteCategory": { "type": "string" }, "cnSourceId": { "type": "string" }, "invoiceRegistrants": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.InvoiceRegistrants" } }, "lastReminderSent": { "$ref": "#/definitions/api.revenue.ApiModels.LastReminderSentViewModel" } } }, "api.revenue.ApiModels.Reports.InvoiceRegistrants": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" } } }, "api.revenue.ApiModels.Reports.GrantTotalItemRevenueDataReportModel": { "type": "object", "properties": { "headers": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndRptHeader" }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "events": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Reports.MonthEndItemRevenueDataModel" } } } }, "api.revenue.ApiModels.Reports.MonthEndItemRevenueDataModel": { "type": "object", "properties": { "itemId": { "format": "uuid", "type": "string" }, "itemName": { "type": "string" }, "itemCategoryName": { "type": "string" }, "itemRevenue": { "format": "double", "type": "number" }, "count": { "format": "int32", "type": "integer" }, "itemIcon": { "type": "string" }, "eventClassAmount": { "format": "double", "type": "number" }, "eventSessionAmount": { "format": "double", "type": "number" }, "eventBundleAmount": { "format": "double", "type": "number" }, "modificationAmount": { "format": "double", "type": "number" }, "cancellationFee": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Reports.MonthEndReportInvoiceExportFilterModel": { "type": "object", "properties": { "startDateMonth": { "format": "int32", "type": "integer" }, "startDateYear": { "format": "int32", "type": "integer" }, "endDateMonth": { "format": "int32", "type": "integer" }, "endDateYear": { "format": "int32", "type": "integer" }, "searchInvoiceText": { "type": "string" }, "searchBuyerText": { "type": "string" }, "itemId": { "format": "uuid", "type": "string" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "showEvent": { "type": "boolean" }, "showEventClass": { "type": "boolean" }, "showEventSession": { "type": "boolean" } } }, "api.revenue.ApiModels.EventClasses.EventClassModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "classId": { "format": "uuid", "type": "string" }, "clientId": { "format": "uuid", "type": "string" }, "isDeleted": { "type": "boolean" }, "sourceId": { "format": "uuid", "type": "string" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.Event.EventSessionModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "eventId": { "format": "uuid", "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "agenda": { "type": "string" }, "isDeleted": { "type": "boolean" }, "createdById": { "format": "uuid", "type": "string" }, "dateCreated": { "format": "date-time", "type": "string" }, "dateModified": { "format": "date-time", "type": "string" }, "iconUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "modifiedById": { "format": "uuid", "type": "string" }, "activityTypeId": { "format": "uuid", "type": "string" }, "defaultPrice": { "format": "float", "type": "number" }, "clientId": { "format": "uuid", "type": "string" }, "sourceId": { "format": "uuid", "type": "string" }, "eventName": { "type": "string" } } }, "api.revenue.ApiModels.Filters.CreditNoteFilterBody": { "type": "object", "properties": { "type": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "fileName": { "type": "string" } } }, "api.revenue.ApiModels.Filters.CreditNoteReportFilterModel": { "type": "object", "properties": { "type": { "format": "int32", "type": "integer" }, "period": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.PeriodFilterBody" }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerName": { "type": "string" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "buyerOrganizations": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "people": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "consumerIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "nameFormat": { "type": "string" }, "text": { "type": "string" }, "creditNoteText": { "type": "string" }, "item": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Transaction.CreditNoteGroupListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteReportListViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteReportHeadersData" } } }, "api.revenue.ApiModels.Transaction.CreditNoteReportListViewModel": { "type": "object", "properties": { "creditNoteCount": { "format": "int32", "type": "integer" }, "customerType": { "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "customerName": { "type": "string" }, "imageUrl": { "type": "string" }, "totalIssuedAmount": { "format": "double", "type": "number" }, "totalUsedAmount": { "format": "double", "type": "number" }, "totalBalanceAmount": { "format": "double", "type": "number" }, "totalRefundedAmount": { "format": "double", "type": "number" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.OrganizationViewModel" } } } }, "api.revenue.ApiModels.Transaction.CreditNoteReportHeadersData": { "type": "object", "properties": { "totalIssuedAmount": { "format": "double", "type": "number" }, "totalUsedAmount": { "format": "double", "type": "number" }, "totalBalanceAmount": { "format": "double", "type": "number" }, "totalRefundedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Transaction.CreditNoteReportDetailListModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteReportDetailModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.CreditNoteReportDetailsHeadersData" } } }, "api.revenue.ApiModels.Transaction.CreditNoteReportDetailModel": { "type": "object", "properties": { "creditNoteId": { "format": "uuid", "type": "string" }, "creditNoteNumber": { "type": "string" }, "creditNoteStatus": { "format": "int32", "type": "integer" }, "creditNoteDate": { "format": "date-time", "type": "string" }, "creditNoteCreatedOn": { "format": "date-time", "type": "string" }, "createdByName": { "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "buyerType": { "type": "string" }, "buyerName": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "icon": { "type": "string" }, "buyerId": { "format": "uuid", "type": "string" }, "issuedAmount": { "format": "double", "type": "number" }, "usedAmount": { "format": "double", "type": "number" }, "balanceAmount": { "format": "double", "type": "number" }, "refundedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Transaction.CreditNoteReportDetailsHeadersData": { "type": "object", "properties": { "totalIssuedAmount": { "format": "double", "type": "number" }, "totalUsedAmount": { "format": "double", "type": "number" }, "totalBalanceAmount": { "format": "double", "type": "number" }, "totalRefundedAmount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Filters.CreditNoteReportExportModel": { "type": "object", "properties": { "filterModel": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.CreditNoteReportFilterModel" }, "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.TrialReportInvoiceListModel": { "type": "object", "properties": { "emailSubject": { "type": "string" }, "emailBody": { "type": "string" }, "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportInvoiceModel" } }, "headerData": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TrialReportDetailsHeadersData" }, "billingContactList": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.BillingContactViewModel" } }, "isInvoicePaid": { "type": "boolean" } } }, "api.revenue.ApiModels.Transaction.TrialReportInvoiceModel": { "type": "object", "properties": { "organizationId": { "format": "uuid", "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "invoiceNumber": { "type": "string" }, "invoiceCreatedOn": { "format": "date-time", "type": "string" }, "invoiceDate": { "format": "date-time", "type": "string" }, "invoiceDueDate": { "format": "date-time", "type": "string" }, "createdById": { "format": "uuid", "type": "string" }, "imageUrl": { "type": "string" }, "createdByName": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "paidAmount": { "format": "double", "type": "number" }, "outstandingAmount": { "format": "double", "type": "number" }, "invoiceStatus": { "type": "string" }, "buyerType": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "buyerId": { "type": "string" }, "buyerName": { "type": "string" }, "icon": { "type": "string" }, "invoiceItemsDetail": { "type": "string" }, "openCreditNotebalance": { "format": "double", "type": "number" }, "paymentLinks": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.PaymentViewModel" } }, "orgBillingContactId": { "format": "uuid", "type": "string" }, "indvBillingContactId": { "format": "uuid", "type": "string" }, "indvBillingContactEmail": { "type": "string" }, "indvBillingContactImageUrl": { "type": "string" }, "indvBillingContactFirstName": { "type": "string" }, "indvBillingContactLastName": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.BillingContactViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.PaymentViewModel": { "type": "object", "properties": { "billingContactId": { "format": "uuid", "type": "string" }, "billingContactEmail": { "type": "string" }, "paymentLink": { "type": "string" } } }, "api.revenue.DomainModels.ExportReportField": { "type": "object", "properties": { "text": { "type": "string" }, "isChecked": { "type": "boolean" }, "value": { "type": "string" }, "isDisabled": { "type": "boolean" }, "fieldId": { "format": "uuid", "type": "string" }, "displayName": { "type": "string" }, "isVisible": { "type": "boolean" }, "sequence": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "categoryId": { "format": "int32", "type": "integer" }, "tenantId": { "format": "uuid", "type": "string" }, "tenant": { "$ref": "#/definitions/api.revenue.DomainModels.Tenant" }, "createdBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "modifiedBy": { "$ref": "#/definitions/api.revenue.DomainModels.TenantUser" }, "createdById": { "format": "uuid", "type": "string" }, "modifiedById": { "format": "uuid", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "modifiedOn": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.CreateCustomerProfileRequestModel": { "type": "object", "properties": { "cardDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CardModel" }, "bankDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.BankDetail" }, "payerDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PayerDetail" }, "emailId": { "type": "string" } } }, "api.revenue.ApiModels.Payment.BankDetail": { "type": "object", "properties": { "bankName": { "type": "string" }, "accountNumber": { "type": "string" }, "routingNumber": { "type": "string" }, "accountType": { "format": "int32", "type": "integer" }, "eCheckType": { "format": "int32", "type": "integer" }, "nameOnAccount": { "type": "string" }, "accountHolderType": { "type": "string" }, "currency": { "type": "string" } } }, "api.revenue.ApiModels.Payment.PayerDetail": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "address": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.AddressDetail" } } }, "api.revenue.ApiModels.Payment.ChargeCreditCardRequestModel": { "type": "object", "properties": { "cardDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CardModel" }, "billingAddress": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.AddressDetail" }, "amount": { "format": "double", "type": "number" }, "refTransId": { "type": "string" }, "shippingAddress": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.AddressDetail" }, "orderInformation": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.OrderInformation" } } }, "api.revenue.ApiModels.Payment.RefundTransactionRequestModel": { "type": "object", "properties": { "transactionId": { "type": "string" }, "transactionAmount": { "format": "double", "type": "number" }, "cardDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.CardModel" }, "refundId": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.VoidTransactionRequestModel": { "type": "object", "properties": { "transactionId": { "type": "string" }, "transactionAmount": { "format": "double", "type": "number" }, "refundId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Payment.DebitBankAccountRequestModel": { "type": "object", "properties": { "amount": { "format": "double", "type": "number" }, "bankDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.BankDetail" } } }, "api.revenue.ApiModels.Payment.CreditBankAccountRequestModel": { "type": "object", "properties": { "bankDetail": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.BankDetail" }, "transactionId": { "type": "string" }, "amount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Payment.ChargeCustomerProfileRequestModel": { "type": "object", "properties": { "customerProfileId": { "type": "string" }, "customerPaymentProfileId": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "refTransId": { "type": "string" } } }, "api.revenue.ApiModels.SubscriptionAddonPostModel": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "nameColor": { "type": "string" }, "type": { "format": "int32", "type": "integer" }, "buyer": { "format": "int32", "type": "integer" }, "minimumMembers": { "format": "int32", "type": "integer" }, "costType": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.SubscriptionAddonListView": { "type": "object", "properties": { "id": { "type": "string" }, "isFavourite": { "type": "boolean" }, "icon": { "type": "string" }, "name": { "type": "string" }, "nameColor": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "buyer": { "type": "string" }, "activationCount": { "format": "int32", "type": "integer" }, "cancellationCount": { "format": "int32", "type": "integer" }, "reactivationCount": { "format": "int32", "type": "integer" }, "addedDate": { "format": "date-time", "type": "string" }, "lastSubscribedDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "isSubscribed": { "type": "boolean" } } }, "api.revenue.ApiModels.SubscriptionAddonEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "icon": { "type": "string" }, "name": { "type": "string" }, "nameColor": { "type": "string" }, "description": { "type": "string" }, "pid": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "type": { "format": "int32", "type": "integer" }, "buyer": { "format": "int32", "type": "integer" }, "minimumMembers": { "format": "int32", "type": "integer" }, "costType": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "frequencyType": { "format": "int32", "type": "integer" }, "minStartDate": { "format": "date-time", "type": "string" }, "invoiceTiming": { "format": "int32", "type": "integer" }, "paymentRequiredBeforeSubscriptionStartDate": { "type": "boolean" }, "expiryType": { "format": "int32", "type": "integer" }, "expiryYears": { "format": "int32", "type": "integer" }, "expiryMonths": { "format": "int32", "type": "integer" }, "expiryDays": { "format": "int32", "type": "integer" }, "expiryFromDate": { "format": "date-time", "type": "string" }, "expiryToDate": { "format": "date-time", "type": "string" }, "billCycles": { "format": "int32", "type": "integer" }, "subscriberTypes": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "subscriptionAddonReminderConfigurations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonReminderConfigurationEditModel" } } } }, "api.revenue.ApiModels.SubscriptionAddonReminderConfigurationEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "numberOfDays": { "format": "int32", "type": "integer" }, "templateId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" } } }, "api.revenue.ApiModels.CopySubscriptionAddonEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "copyType": { "type": "boolean" }, "copyBuyer": { "type": "boolean" }, "copyPlanDetails": { "type": "boolean" }, "copyReminderConfigurations": { "type": "boolean" }, "copyConsumerTypes": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.SubscriptionAddonFilterList": { "type": "object", "properties": { "text": { "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "activationCountFrom": { "format": "int32", "type": "integer" }, "activationCountTo": { "format": "int32", "type": "integer" }, "cancellationCountFrom": { "format": "int32", "type": "integer" }, "cancellationCountTo": { "format": "int32", "type": "integer" }, "reActivationCountFrom": { "format": "int32", "type": "integer" }, "reActivationCountTo": { "format": "int32", "type": "integer" }, "fromDate": { "format": "date-time", "type": "string" }, "toDate": { "format": "date-time", "type": "string" }, "lastSubscriptionFromDate": { "format": "date-time", "type": "string" }, "lastSubscriptionToDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionAddonListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonListView" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.SubscriptionEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "icon": { "type": "string" }, "name": { "type": "string" }, "nameColor": { "type": "string" }, "isFavorite": { "type": "boolean" }, "description": { "type": "string" }, "pid": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "type": { "type": "string" }, "buyer": { "format": "int32", "type": "integer" }, "minimumMembers": { "format": "int32", "type": "integer" }, "costType": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "frequencyType": { "format": "int32", "type": "integer" }, "minStartDate": { "format": "date-time", "type": "string" }, "invoiceTiming": { "format": "int32", "type": "integer" }, "invoiceTimingUnit": { "format": "int32", "type": "integer" }, "paymentRequiredBeforeSubscriptionStartDate": { "type": "boolean" }, "expiryType": { "format": "int32", "type": "integer" }, "expiryYears": { "format": "int32", "type": "integer" }, "expiryMonths": { "format": "int32", "type": "integer" }, "expiryDays": { "format": "int32", "type": "integer" }, "expiryFromDate": { "format": "date-time", "type": "string" }, "expiryToDate": { "format": "date-time", "type": "string" }, "expiryAfterDate": { "format": "date-time", "type": "string" }, "billCycles": { "format": "int32", "type": "integer" }, "subscriberTypes": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "subscriptionReminderConfigurations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionReminderConfigurationEditModel" } }, "paymentMethods": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Payment.PaymentMethodModel" } }, "isBillMeLater": { "type": "boolean" }, "isBillPaidByOrganisation": { "type": "boolean" }, "isBillPaidByParentOrganisation": { "type": "boolean" }, "subscriptionTypeId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.SubscriptionReminderConfigurationEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "numberOfDays": { "format": "int32", "type": "integer" }, "templateId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" } } }, "api.revenue.ApiModels.Payment.PaymentMethodModel": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "text": { "type": "string" }, "key": { "type": "string" }, "isSelected": { "type": "boolean" }, "options": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PaymentOptionItem" } } } }, "PaymentOptionItem": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "text": { "type": "string" }, "key": { "type": "string" }, "isSelected": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.SubscriptionAddonExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "activationCountFrom": { "format": "int32", "type": "integer" }, "activationCountTo": { "format": "int32", "type": "integer" }, "cancellationCountFrom": { "format": "int32", "type": "integer" }, "cancellationCountTo": { "format": "int32", "type": "integer" }, "reActivationCountFrom": { "format": "int32", "type": "integer" }, "reActivationCountTo": { "format": "int32", "type": "integer" }, "fromDate": { "format": "date-time", "type": "string" }, "toDate": { "format": "date-time", "type": "string" }, "lastSubscriptionFromDate": { "format": "date-time", "type": "string" }, "lastSubscriptionToDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionAddonSubscribeInfoView": { "type": "object", "properties": { "id": { "type": "string" }, "isFavourite": { "type": "boolean" }, "icon": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "activationCount": { "format": "int32", "type": "integer" }, "cancellationCount": { "format": "int32", "type": "integer" }, "reactivationCount": { "format": "int32", "type": "integer" }, "addedDate": { "format": "date-time", "type": "string" }, "lastSubscribedDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "isSubscribed": { "type": "boolean" }, "userIdentityId": { "type": "string" } } }, "api.revenue.ApiModels.NetGrossActivationView": { "type": "object", "properties": { "year": { "format": "int32", "type": "integer" }, "totalSubscriptions": { "format": "int32", "type": "integer" }, "activeSubscription": { "format": "int32", "type": "integer" }, "netRevenue": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QuarterRevenueView" } }, "grossRevenue": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.QuarterRevenueView" } } } }, "api.revenue.ApiModels.QuarterRevenueView": { "type": "object", "properties": { "quarter": { "type": "string" }, "amount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.TotalMembershipSubscriptionView": { "type": "object", "properties": { "totalRevenue": { "format": "double", "type": "number" }, "currentYearYTD": { "format": "double", "type": "number" }, "lastMonthRevenue": { "format": "double", "type": "number" }, "lastYearRevenue": { "format": "double", "type": "number" }, "changeInTotalMembership": { "format": "int32", "type": "integer" }, "changePercentInTotalMembership": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.FinanceAccountingView": { "type": "object", "properties": { "totalActivations": { "format": "int32", "type": "integer" }, "asOnDate": { "format": "date-time", "type": "string" }, "active": { "format": "int32", "type": "integer" }, "cancelled": { "format": "int32", "type": "integer" }, "reActivated": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.MonthlyRevenueView": { "type": "object", "properties": { "year": { "format": "int32", "type": "integer" }, "revenues": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.RevenueView" } }, "icon": { "type": "string" }, "color": { "type": "string" } } }, "api.revenue.ApiModels.RevenueView": { "type": "object", "properties": { "month": { "type": "string" }, "amount": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Filters.SubscriptionAddonConsumersFilterList": { "type": "object", "properties": { "serviceAddonId": { "format": "uuid", "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionAddonMemberConsumerViewModel": { "type": "object", "properties": { "consumers": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonMemberConsumerView" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.SubscriptionAddonMemberConsumerView": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "organisation": { "type": "string" }, "lastPaymentStatus": { "type": "string" }, "invoiceNo": { "type": "string" }, "lastBillDate": { "format": "date-time", "type": "string" }, "nextBillDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.SubscriptionAddonOrganizationConsumerViewModel": { "type": "object", "properties": { "consumers": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.SubscriptionAddonOrganizationConsumerView" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.SubscriptionAddonOrganizationConsumerView": { "type": "object", "properties": { "organisation": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "organisationType": { "type": "string" }, "lastPaymentStatus": { "type": "string" }, "lastInvoiceNo": { "type": "string" }, "paymentMethod": { "type": "string" }, "mainContact": { "type": "string" } } }, "api.revenue.ApiModels.Filters.SubscriptionConsumersFilterList": { "type": "object", "properties": { "subscriptionId": { "format": "uuid", "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.IndividualSubscriberViewModel": { "type": "object", "properties": { "consumers": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.IndividualSubscriberView" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.IndividualSubscriberView": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "organisation": { "type": "string" }, "lastPaymentStatus": { "type": "string" }, "invoiceNo": { "type": "string" }, "lastBillDate": { "format": "date-time", "type": "string" }, "nextBillDate": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.Settings.RevenueTemplateViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": "string" }, "isSelected": { "type": "boolean" } } }, "api.revenue.ApiModels.Settings.SettingModel": { "type": "object", "properties": { "invoiceSettingModel": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.InvoiceSettingModel" }, "revenueRecognizeSettings": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.RevenueRecognizeModel" } }, "invoiceGenerationSettings": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.InvoiceGenerationModel" } }, "paymentGatewaySettingModel": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentGatewaySettingModel" } }, "paymentTermSettingModel": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.PaymentTermSettingModel" } }, "transactionSerialStartValueModel": { "$ref": "#/definitions/api.revenue.ApiModels.TransactionSerialStartValueModel" } } }, "api.revenue.ApiModels.Settings.InvoiceSettingModel": { "type": "object", "properties": { "templateId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Settings.RevenueRecognizeModel": { "type": "object", "properties": { "objectCategotyId": { "format": "int32", "type": "integer" }, "objectTypeId": { "format": "int32", "type": "integer" }, "isDefault": { "type": "string" }, "generationSteps": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.StepSelectionModel" } } } }, "api.revenue.ApiModels.Settings.InvoiceGenerationModel": { "type": "object", "properties": { "objectCategotyId": { "format": "int32", "type": "integer" }, "objectTypeId": { "format": "int32", "type": "integer" }, "isDefault": { "type": "boolean" }, "generationStepId": { "format": "int32", "type": "integer" }, "generationDaysBefore": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.TransactionSerialStartValueModel": { "type": "object", "properties": { "invoiceStartValue": { "format": "int64", "type": "integer" }, "paymentStartValue": { "format": "int64", "type": "integer" }, "creditNoteStartValue": { "format": "int64", "type": "integer" }, "refundStartValue": { "format": "int64", "type": "integer" } } }, "api.revenue.ApiModels.Settings.StepSelectionModel": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "type": { "format": "int32", "type": "integer" }, "value": { "type": "string" }, "isSelect": { "type": "boolean" }, "textValue": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Settings.CreateRevenueTemplateResponseModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "model": { "$ref": "#/definitions/api.revenue.ApiModels.Settings.SettingModel" } } }, "Engagifii.common.GlobalHelpers.Domain.ConfigurationSettings.PeopleDisplayNameView": { "type": "object", "properties": { "settingName": { "type": "string" }, "settingLable": { "type": "string" }, "displayNameTemplate": { "type": "string" }, "midNameInitials": { "type": "string" }, "sortBy": { "type": "string" } } }, "api.revenue.ApiModels.Settings.PaymentFormFieldsPostViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "isRequired": { "type": "boolean" } } }, "api.revenue.ApiModels.SubscriptionStepsModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "subscriptionId": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "sequence": { "format": "int32", "type": "integer" }, "type": { "type": "string" }, "isEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "api.revenue.ApiModels.SubscriptionInlineEditModel": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "nameColor": { "type": "string" }, "type": { "format": "uuid", "type": "string" }, "buyer": { "format": "int32", "type": "integer" }, "minimumMembers": { "format": "int32", "type": "integer" }, "costType": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "frequencyType": { "format": "int32", "type": "integer" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.Filters.SubscriptionListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "activationCountFrom": { "format": "int32", "type": "integer" }, "activationCountTo": { "format": "int32", "type": "integer" }, "cancellationCountFrom": { "format": "int32", "type": "integer" }, "cancellationCountTo": { "format": "int32", "type": "integer" }, "reActivationCountFrom": { "format": "int32", "type": "integer" }, "reActivationCountTo": { "format": "int32", "type": "integer" }, "fromDate": { "format": "date-time", "type": "string" }, "toDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastSubscriptionFromDate": { "format": "date-time", "type": "string" }, "lastSubscriptionToDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.CopySubscriptionEditModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "copyType": { "type": "boolean" }, "copyBuyer": { "type": "boolean" }, "copyPrice": { "type": "boolean" }, "copyBillingFrequency": { "type": "boolean" }, "copyTags": { "type": "boolean" }, "copyAvailableStarting": { "type": "boolean" }, "copyInvoiceTiming": { "type": "boolean" }, "copyPaymentTiming": { "type": "boolean" }, "copyReminderConfigurations": { "type": "boolean" }, "copyExpiration": { "type": "boolean" }, "copyPaymentMethod": { "type": "boolean" }, "copyBenefits": { "type": "boolean" }, "copyDocuments": { "type": "boolean" }, "copyPlanDetails": { "type": "boolean" }, "copyConsumerTypes": { "type": "boolean" } } }, "api.revenue.ApiModels.Filters.SubscriptionExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "activationCountFrom": { "format": "int32", "type": "integer" }, "activationCountTo": { "format": "int32", "type": "integer" }, "cancellationCountFrom": { "format": "int32", "type": "integer" }, "cancellationCountTo": { "format": "int32", "type": "integer" }, "reActivationCountFrom": { "format": "int32", "type": "integer" }, "reActivationCountTo": { "format": "int32", "type": "integer" }, "fromDate": { "format": "date-time", "type": "string" }, "toDate": { "format": "date-time", "type": "string" }, "createdOn": { "format": "date-time", "type": "string" }, "lastSubscriptionFromDate": { "format": "date-time", "type": "string" }, "lastSubscriptionToDate": { "format": "date-time", "type": "string" }, "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.SubscriptionTagEditModel": { "type": "object", "properties": { "tags": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "subscriptionId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.SubscriptionTypeEditModel": { "type": "object", "properties": { "description": { "type": "string" }, "tenantId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.ManualInvoiceItemViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "itemType": { "type": "string" }, "icon": { "type": "string" }, "itemCategory": { "type": "string" }, "itemName": { "type": "string" }, "itemId": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "sku": { "format": "int32", "type": "integer" }, "quantity": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "float", "type": "number" }, "totalPrice": { "format": "float", "type": "number" }, "tax": { "format": "double", "type": "number" }, "itemCategoryName": { "type": "string" } } }, "api.revenue.ApiModels.Transaction.TransactionListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TransactionViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" }, "buyerNames": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerOrganization": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.TransactionBuyerOrgWithActive" } }, "itemNames": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumbers": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "paymentTransaction": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.Transaction.TransactionViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "transactionId": { "format": "uuid", "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "buyerType": { "type": "string" }, "buyerStatus": { "type": "boolean" }, "icon": { "type": "string" }, "customerIcon": { "type": "string" }, "invoiceNumber": { "type": "string" }, "parentInvoiceNumber": { "type": "string" }, "buyerName": { "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "invoiceItems": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceItemModel" } }, "itemsCount": { "format": "int32", "type": "integer" }, "appliedInvoices": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.InvoiceSimpleModel" } }, "amount": { "format": "double", "type": "number" }, "dueDate": { "format": "date-time", "type": "string" }, "fullPaymentDate": { "format": "date-time", "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "amountPaidOrUsed": { "format": "double", "type": "number" }, "activityCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "parentInvoiceId": { "format": "uuid", "type": "string" }, "invoiceStatusId": { "format": "int32", "type": "integer" }, "paymentStatusId": { "format": "int32", "type": "integer" }, "refundStatusId": { "format": "int32", "type": "integer" }, "buyerTypeId": { "format": "int32", "type": "integer" }, "type": { "type": "string" }, "isFavorite": { "type": "boolean" }, "isOverdue": { "type": "boolean" }, "createdBy": { "type": "string" }, "paymentMethod": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "paymentTermId": { "format": "uuid", "type": "string" }, "latePayment": { "format": "double", "type": "number" }, "purchaseOrderNumber": { "type": "string" }, "totalTransactionAmount": { "format": "double", "type": "number" }, "appliedCredit": { "format": "double", "type": "number" }, "organizations": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.OrganizationViewModel" } }, "organizationIds": { "uniqueItems": false, "type": "array", "items": { "format": "uuid", "type": "string" } }, "isMarkVoidAllowed": { "type": "boolean" }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "createdById": { "format": "uuid", "type": "string" }, "consolidatedInvoiceId": { "format": "uuid", "type": "string" }, "consolidatedInvoiceNumber": { "type": "string" }, "invoiceType": { "format": "int32", "type": "integer" }, "originalCreationDate": { "format": "date-time", "type": "string" }, "originalInvoiceId": { "type": "string" }, "originalInvoiceNumber": { "type": "string" }, "paymentGateway": { "type": "string" }, "paymentTransactionId": { "type": "string" }, "isPaymentSuccess": { "type": "boolean" }, "referenceNumber": { "type": "string" }, "clearingDate": { "format": "date-time", "type": "string" }, "cardNumber": { "type": "string" }, "cardType": { "type": "string" }, "voidRemarks": { "type": "string" }, "auditRemarks": { "type": "string" }, "refundDetailsCount": { "format": "int32", "type": "integer" }, "creditDetailsCount": { "format": "int32", "type": "integer" }, "paymentDetailsCount": { "format": "int32", "type": "integer" }, "isRevised": { "type": "boolean" }, "refundType": { "type": "string" }, "refCreditNoteId": { "format": "uuid", "type": "string" }, "invoiceAllowPay": { "type": "boolean" }, "issuedAgainst": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.PaymentSimpleModel" } }, "acctSysSync": { "type": "string" }, "requestedBy": { "type": "string" }, "lastReminderSent": { "$ref": "#/definitions/api.revenue.ApiModels.LastReminderSentViewModel" } } }, "api.revenue.ApiModels.Transaction.TransactionBuyerOrgWithActive": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "api.revenue.ApiModels.PaymentSimpleModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "paymentNumber": { "type": "string" }, "invoiceId": { "format": "uuid", "type": "string" }, "invoiceNumber": { "type": "string" } } }, "api.revenue.ApiModels.Filters.TransactionFilterOptionDataModel": { "type": "object", "properties": { "consumerType": { "enum": [ "Item", "Individual", "Organization" ], "type": "string" }, "consumerId": { "type": "string" }, "isFavorite": { "type": "boolean" }, "dataFilterType": { "format": "int32", "type": "integer" }, "dayFilter": { "format": "int32", "type": "integer" }, "dataFilterCreationDateStart": { "format": "date-time", "type": "string" }, "dataFilterCreationDateEnd": { "format": "date-time", "type": "string" } } }, "api.revenue.ApiModels.StripeCustomer": { "type": "object", "properties": { "emailId": { "type": "string" }, "source": { "type": "string" } } }, "api.revenue.ApiModels.Filters.TransactionExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "headerProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "transactionIds": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.TransactionByIdModel" } }, "fileName": { "type": "string" }, "reportType": { "type": "string" }, "exportingCustomerTransactions": { "type": "boolean" }, "exportItemCategoryType": { "format": "int32", "type": "integer" }, "text": { "type": "string" }, "invoiceId": { "type": "string" }, "invoiceType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "nameFormat": { "type": "string" }, "paymentStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "acctSysSync": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "refundStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "creditNoteStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "itemType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumber": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "creationDate": { "format": "date-time", "type": "string" }, "consumerType": { "enum": [ "Item", "Individual", "Organization" ], "type": "string" }, "consumerId": { "type": "string" }, "cnStatus": { "type": "boolean" }, "isPersonSpecific": { "type": "boolean" }, "viewHoldInvoices": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "showUniqueTransactions": { "type": "boolean" }, "uniqueLastState": { "type": "boolean" }, "paymentMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "refundMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "invoicePaidInFullDate": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "exportDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "clearingDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "originalDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "itemName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerOrganization": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "viewMyTransactions": { "type": "boolean" }, "viewMyOrganizationTransactions": { "type": "boolean" }, "permisionType": { "format": "int32", "type": "integer" }, "tenantUserId": { "format": "uuid", "type": "string" }, "consolidatedInvoiceId": { "format": "uuid", "type": "string" }, "paymentGateway": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "revisionStatus": { "format": "int32", "type": "integer" }, "localDateTime": { "format": "date-time", "type": "string" }, "pmtGatewayTrxId": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "showPayments": { "type": "boolean" }, "showInvoices": { "type": "boolean" }, "showRefunds": { "type": "boolean" }, "showCreditNotes": { "type": "boolean" }, "showFailedPayments": { "type": "boolean" }, "exportType": { "type": "string" }, "groupId": { "format": "uuid", "type": "string" }, "registrationId": { "format": "uuid", "type": "string" }, "isLineItemExport": { "type": "boolean" }, "isEmpty": { "type": "boolean", "readOnly": true }, "includePayments": { "type": "boolean", "readOnly": true }, "includeInvoices": { "type": "boolean", "readOnly": true }, "includeRefunds": { "type": "boolean", "readOnly": true }, "includeCreditNotes": { "type": "boolean", "readOnly": true }, "dataFilterType": { "format": "int32", "type": "integer" }, "dataFilter": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DataFilterModel" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.TransactionByIdModel": { "type": "object", "properties": { "transactionId": { "format": "uuid", "type": "string" }, "transactionType": { "enum": [ "Invoice", "Payment", "Refund", "CreditNote" ], "type": "string" } } }, "api.revenue.ApiModels.InvoiceListExportFilterModel": { "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "invoiceId": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myfavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.PaymentTransactionExportFilter": { "description": "this filter class will be used to filter the data to be exported", "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "paymentNumber": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myfavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.RefundTransactionExportFilter": { "description": "this filter class will be used to filter the data to be exported", "type": "object", "properties": { "includedProperties": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "text": { "type": "string" }, "refundNumber": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.ListFilterDataViewModel": { "type": "object", "properties": { "itemNames": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerNames": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumbers": { "uniqueItems": false, "type": "array", "items": { "type": "string" } } } }, "api.revenue.ApiModels.Filters.ConsumerTransactionListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "invoiceId": { "type": "string" }, "invoiceType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "paymentStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "invoiceStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "refundStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "creditNoteStatus": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "paymentMethod": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "itemType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "itemName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerName": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "buyerOrganization": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "purchaseOrderNumber": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "whoIsThisFor": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "types": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "creationDate": { "format": "date-time", "type": "string" }, "originalDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "clearingDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "consumerType": { "enum": [ "Item", "Individual", "Organization" ], "type": "string" }, "consumerId": { "type": "string" }, "invoicePaidInFullDate": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "creationDateRange": { "$ref": "#/definitions/api.revenue.ApiModels.Filters.DateFilterModel" }, "isPersonSpecific": { "type": "boolean" }, "paymentGateway": { "uniqueItems": false, "type": "array", "items": { "type": "string" } }, "showUniqueTransactions": { "type": "boolean" }, "nameFormat": { "type": "string" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Filters.InvoiceTransactionListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "invoiceId": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int64", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myfavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Transaction.InvoiceTransactionListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.InvoiceTransactionViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Transaction.InvoiceTransactionViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "buyerType": { "type": "string" }, "invoiceNumber": { "type": "string" }, "buyerName": { "type": "string" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "amount": { "format": "double", "type": "number" }, "buyerTypeId": { "format": "int32", "type": "integer" }, "dueDate": { "format": "date-time", "type": "string" }, "balanceDue": { "format": "double", "type": "number" }, "statusId": { "format": "int64", "type": "integer" }, "activityCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "isItemSelected": { "type": "boolean" }, "createdBy": { "type": "string" }, "icon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "isFavorite": { "type": "boolean" }, "paymentTermId": { "format": "uuid", "type": "string" }, "isRecognized": { "type": "boolean" }, "latePayment": { "format": "double", "type": "number" } } }, "api.revenue.ApiModels.Filters.PaymentTransactionListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "paymentNumber": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myfavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Transaction.PaymentTransactionListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.PaymentTransactionViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Transaction.PaymentTransactionViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "dateOfCreation": { "format": "date-time", "type": "string" }, "buyerType": { "type": "string" }, "buyerTypeId": { "format": "int32", "type": "integer" }, "paymentNumber": { "type": "string" }, "buyerName": { "type": "string" }, "amount": { "format": "float", "type": "number" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "dateOfPayment": { "format": "date-time", "type": "string" }, "paymentMethod": { "type": "string" }, "activityCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "statusId": { "format": "int32", "type": "integer" }, "isItemSelected": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "createdBy": { "type": "string" }, "icon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.Filters.RefundTransactionListFilterModel": { "type": "object", "properties": { "text": { "type": "string" }, "refundNumber": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "status": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "buyerType": { "uniqueItems": false, "type": "array", "items": { "format": "int32", "type": "integer" } }, "isPersonSpecific": { "type": "boolean" }, "myFavorite": { "type": "boolean" }, "sortBy": { "type": "string" }, "nameSortBy": { "type": "string" }, "isAscending": { "type": "boolean" }, "isCount": { "type": "boolean" }, "pageNumber": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "toatalPage": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.Transaction.RefundTransactionListViewModel": { "type": "object", "properties": { "collection": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.Transaction.RefundTransactionViewModel" } }, "paging": { "$ref": "#/definitions/api.revenue.ApiModels.PagingModel" } } }, "api.revenue.ApiModels.Transaction.RefundTransactionViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "dateOfCreation": { "format": "date-time", "type": "string" }, "buyerType": { "type": "string" }, "buyerTypeId": { "format": "int32", "type": "integer" }, "refundNumber": { "type": "string" }, "buyerName": { "type": "string" }, "amount": { "format": "float", "type": "number" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "dateOfRefund": { "format": "date-time", "type": "string" }, "refundMethod": { "type": "string" }, "activityCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "statusId": { "format": "int32", "type": "integer" }, "isItemSelected": { "type": "boolean" }, "createdBy": { "type": "string" }, "icon": { "type": "string" }, "customerId": { "format": "uuid", "type": "string" }, "personId": { "format": "uuid", "type": "string" }, "isFavorite": { "type": "boolean" } } }, "api.revenue.ApiModels.ValidateModel": { "type": "object", "properties": { "invoiceId": { "format": "uuid", "type": "string" }, "buyerType": { "type": "string" } } }, "api.revenue.ApiModels.ValidateInvoiceModel": { "type": "object", "properties": { "isRelationValid": { "type": "boolean" }, "isStatusValid": { "type": "boolean" }, "buyerId": { "format": "uuid", "type": "string" }, "buyerName": { "type": "string" }, "buyerType": { "type": "string" }, "dataDisplayText": { "type": "string" }, "emailId": { "type": "string" }, "imageUrl": { "type": "string" }, "moduleEntityId": { "format": "uuid", "type": "string" }, "moduleId": { "format": "int32", "type": "integer" } } }, "api.revenue.ApiModels.TransactionActivityLogViewModel": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, "activityById": { "format": "uuid", "type": "string" }, "activityBy": { "type": "string" }, "description": { "type": "string" }, "activityByImage": { "type": "string" }, "entityType": { "type": "string" }, "activityType": { "type": "string" }, "amount": { "format": "double", "type": "number" }, "activityDate": { "format": "date-time", "type": "string" }, "invoiceNumber": { "type": "string" }, "paymentId": { "format": "uuid", "type": "string" } } }, "api.revenue.ApiModels.SaveActivityModel": { "type": "object", "properties": { "entityId": { "format": "uuid", "type": "string" }, "transactionEntityType": { "enum": [ "invoice", "payment", "creditNote", "refund" ], "type": "string" }, "transactionActivityType": { "enum": [ "created", "updated", "recorded", "added", "delete", "Void", "MarkFavorite", "UnMarkFavorite", "Viewed", "Downloaded", "Printed", "Notification", "PartialPaid", "Sent", "removed", "paid", "MemoUpdated", "Shared", "Generated", "Datechanged", "Amountchanged", "PaymentTerm", "BillingInformation", "PaymentReferenceNo", "DeliveryAddress", "ACHPaymentFailed", "Cancel", "InvoiceReminderSent" ], "type": "string" }, "activityDesc": { "$ref": "#/definitions/api.revenue.ApiModels.ActivtyDescriptionModel" } } }, "api.revenue.ApiModels.ActivtyDescriptionModel": { "type": "object", "properties": { "shareOption": { "type": "string" }, "emailSubject": { "type": "string" }, "notificationName": { "type": "string" }, "itemName": { "type": "string" }, "itemQty": { "format": "double", "type": "number" }, "itemTotal": { "format": "double", "type": "number" }, "receipientNames": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/api.revenue.ApiModels.ReceipientModel" } } } }, "api.revenue.ApiModels.ReceipientModel": { "type": "object", "properties": { "name": { "type": "string" }, "imageUrl": { "type": "string" } } }, "api.revenue.ApiModels.UserUiPreferenceModel": { "type": "object", "properties": { "subscriptionListColumnSelection": { "type": "string" }, "subscriptionFilterOptionList": { "type": "string" }, "subscriptionSortingOptionList": { "type": "string" }, "serviceListColumnSelection": { "type": "string" }, "serviceListFilter": { "type": "string" }, "serviceSortingOptionList": { "type": "string" }, "serviceDisplaySettingsOptionsList": { "type": "string" }, "subscriptionDisplaySettingsOptionsList": { "type": "string" }, "allTransactionListColumnSelection": { "type": "string" }, "invoiceTransactionListColumnSelection": { "type": "string" }, "invoiceTransactionFilterOptionList": { "type": "string" }, "allTransactionListFilter": { "type": "string" }, "paymentTransactionListFilter": { "type": "string" }, "paymentListColumnSelection": { "type": "string" }, "paymentSortingOptionList": { "type": "string" }, "allTransactionSortingOptionList": { "type": "string" }, "revenueTransactionSortingOptionList": { "type": "string" }, "revenueTransactionListColumnSelection": { "type": "string" }, "revenueTransactionListFilter": { "type": "string" }, "eventsTransactionSortingOptionList": { "type": "string" }, "eventsTransactionListColumnSelection": { "type": "string" }, "eventsTransactionListFilter": { "type": "string" }, "classesTransactionSortingOptionList": { "type": "string" }, "classesTransactionListColumnSelection": { "type": "string" }, "classesTransactionListFilter": { "type": "string" }, "awardsTransactionSortingOptionList": { "type": "string" }, "awardsTransactionListColumnSelection": { "type": "string" }, "awardsTransactionListFilter": { "type": "string" }, "eventSessionsTransactionSortingOptionList": { "type": "string" }, "eventSessionsTransactionListColumnSelection": { "type": "string" }, "eventSessionsTransactionListFilter": { "type": "string" }, "peopleTransactionSortingOptionList": { "type": "string" }, "peopleTransactionListColumnSelection": { "type": "string" }, "peopleTransactionListFilter": { "type": "string" }, "orgsTransactionSortingOptionList": { "type": "string" }, "orgsTransactionListColumnSelection": { "type": "string" }, "orgsTransactionListFilter": { "type": "string" }, "myTransactionSortingOptionList": { "type": "string" }, "myTransactionListColumnSelection": { "type": "string" }, "myTransactionListFilter": { "type": "string" }, "favoritesTransactionSortingOptionList": { "type": "string" }, "favoritesTransactionListColumnSelection": { "type": "string" }, "favoritesTransactionListFilter": { "type": "string" }, "favoritesLineItemExport": { "type": "string" }, "myTransactionLineItemExport": { "type": "string" }, "allTransactionLineItemExport": { "type": "string" }, "orgsLineItemExport": { "type": "string" }, "peopleLineItemExport": { "type": "string" }, "eventSessionsLineItemExport": { "type": "string" }, "awardsLineItemExport": { "type": "string" }, "eventsLineItemExport": { "type": "string" }, "classesLineItemExport": { "type": "string" }, "accountingMetricsWidgetToggle": { "type": "string" } } }, "api.revenue.ApiModels.CustomerPaymentProfileViewMOdel": { "type": "object", "properties": { "customerProfileId": { "format": "uuid", "type": "string" }, "paymentProfileId": { "type": "string" }, "cardNumber": { "type": "string" } } } }, "securityDefinitions": { "Bearer": { "name": "Authorization", "in": "header", "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"" } }, "security": [ { "Bearer": [] } ], "tags": [] }