| Name | Description | Type | Additional information |
|---|---|---|---|
| apiCode | integer |
None. |
|
| pageNumber | integer |
None. |
|
| pageSize | integer |
None. |
|
| status | integer |
None. |
|
| areaId_filter | Collection of integer |
None. |
|
| areaIds | Collection of integer |
None. |
|
| name | string |
None. |
|
| sortBy | string |
None. |
|
| sortAs | string |
None. |
|
| taqaId | integer |
None. |
|
| transactionId | globally unique identifier |
None. |
|
| crn | integer |
None. |
|
| oldCrn | integer |
None. |
|
| contract | string |
None. |
|
| meter | string |
None. |
|
| phone | string |
None. |
|
| identifier | string |
None. |
|
| string |
None. |
||
| password | string |
None. |
|
| ocrId | integer |
None. |
|
| ocrRealReading | integer |
None. |
|
| ocrStatus | integer |
None. |
|
| dateFrom | date |
None. |
|
| dateTo | date |
None. |
|
| collectorName | string |
None. |
|
| ResetPasswordEmail | string |
None. |
|
| companyId | string |
None. |
|
| CompanyName | string |
None. |
|
| companyCode | string |
None. |
|
| isActive | integer |
None. |
|
| hasChildrenIn | string |
None. |
|
| searchObject | SearchModel |
None. |
|
| filterObject | FilterModel |
None. |
|
| screenID | string |
None. |
|
| governorateId | string |
None. |
|
| governorateName | string |
None. |
|
| governorateCode | string |
None. |
|
| areaId | string |
None. |
|
| areaName | string |
None. |
|
| areaCode | string |
None. |
|
| blockId | string |
None. |
|
| blockName | string |
None. |
|
| blockCode | string |
None. |
|
| exportType | string |
None. |
|
| branchId | string |
None. |
|
| branchName | string |
None. |
|
| placeId | string |
None. |
|
| placeName | string |
None. |
|
| contractedCompanyId | string |
None. |
|
| contractedCompanyName | string |
None. |
|
| contractedCompanyNumber | string |
None. |
|
| contractedCompanyAddress | string |
None. |
|
| contractedCompanyAgentName | string |
None. |
|
| contractedCompanyAgentNationalId | string |
None. |
|
| contractedCompanyAgentNumber | string |
None. |
|
| contractedCompanyCommercialRecord | string |
None. |
|
| contractedCompanyTaxId | string |
None. |
|
| contractedCompanyServices | Collection of integer |
None. |
|
| contractedCompanyBranchIds | Collection of integer |
None. |
|
| enumType | string |
None. |
|
| activityId | string |
None. |
|
| activityName | string |
None. |
|
| activityContractUsageType | string |
None. |
|
| activityDiscountPercentOnUsage | decimal number |
None. |
|
| activityTaxApplied | integer |
None. |
|
| activityRequiredDocuments | Collection of integer |
None. |
|
| activityAGCC | string |
None. |
|
| cityGateId | string |
None. |
|
| cityGateCapacity | string |
None. |
|
| cityGateAreaIDs | Collection of string |
None. |
|
| cityGateName | string |
None. |
|
| userClassificationId | string |
None. |
|
| userClassificationName | string |
None. |
|
| apiCodes | Collection of integer |
None. |
|
| IdentifierNumber | string |
None. |
|
| childrenId | string |
None. |
|
| salesPersonId | string |
None. |
|
| salesPersonNationalId | string |
None. |
|
| salesPersonInsuranceNumber | string |
None. |
|
| salesPersonUserId | string |
None. |
|
| salesPersonManagerId | string |
None. |
|
| financialAccountId | string |
None. |
|
| financialAccountName | string |
None. |
|
| financialAccountNo | string |
None. |
|
| financialAccountTaxPercent | decimal number |
None. |
|
| financialAccountIsMandatory | integer |
None. |
|
| financialAccountParent | integer |
None. |
|
| financialAccountType | string |
None. |
|
| profileId | string |
None. |
|
| profileName | string |
None. |
|
| profileAreas | Collection of integer |
None. |
|
| profileTypeId | string |
None. |
|
| profileContractUsageTypeId | string |
None. |
|
| profileStartDate | date |
None. |
|
| profileEndDate | date |
None. |
|
| profileAccounts | Collection of ProfileAccountDetailViewModel |
None. |
|
| isProfileAccountsEditable | integer |
None. |
|
| validateAcccounts | integer |
None. |
|
| sectorId | string |
None. |
|
| sectorName | string |
None. |
|
| sectorCode | string |
None. |
|
| toReadOnly | integer |
None. |
|
| providerId | string |
None. |
|
| Provider_Id | integer |
None. |
|
| providerName | string |
None. |
|
| providerConfigs | Collection of ProviderConfigViewModel |
None. |
|
| needsBankMgmt | integer |
None. |
|
| providerAccountNo | integer |
None. |
|
| amountToBeInstalled | decimal number |
None. |
|
| mainProviderId | integer |
None. |
|
| installmentProgramName | string |
None. |
|
| installmentProgramId | string |
None. |
|
| installmentProgramServiceIds | Collection of integer |
None. |
|
| installmentProgramAccountId | string |
None. |
|
| installmentProgramInterestAccountId | integer |
None. |
|
| installmentProgramFinePercentage | decimal number |
None. |
|
| installmentProgramStartingFineMonth | integer |
None. |
|
| installmentProgramFineAccountId | integer |
None. |
|
| installmentProgramAcceptanceId | string |
None. |
|
| installmentPlans | Collection of InstallmentPlanViewModel |
None. |
|
| validatePlans | integer |
None. |
|
| installmentPlanCsv | string |
None. |
|
| postListExcelSheetUrl | string |
None. |
|
| Person | Person |
None. |
|
| Address | Address |
None. |
|
| ContractInfo | Contract |
None. |
|
| Company | Company |
None. |
|
| ConsumptionDeposit | ConsumptionDeposit |
None. |
|
| CommercialIndustrialContract | CommercialIndustrialContract |
None. |
|
| CommercialIndustrialAddress | CommercialIndustrialAddress |
None. |
|
| CommercialIndustrialPerson | CommercialIndustrialPerson |
None. |
|
| buildingId | string |
None. |
|
| buildingCrn | string |
None. |
|
| buildingStatus | string |
None. |
|
| areaToUseIn | integer |
None. |
|
| crmTypeId | string |
None. |
|
| crmTypeName | string |
None. |
|
| crmServiceTypeId | integer |
None. |
|
| crmTopicId | string |
None. |
|
| crmTopicName | string |
None. |
|
| solvingDays | integer |
None. |
|
| isRequireFile | boolean |
None. |
|
| isEmergency | boolean |
None. |
|
| CurrentReading | integer |
None. |
|
| PreviousReading | integer |
None. |
|
| ReadingByCollector | integer |
None. |
|
| EmployeeID | integer |
None. |
|
| MobileUniqueNumber | string |
None. |
|
| PaymentID | integer |
None. |
|
| NumberOfInstallments | integer |
None. |
|
| IsExternal | boolean |
None. |
|
| TransactionReceiptNo | string |
None. |
|
| meterReset | boolean |
None. |
|
| paymentMethodId | string |
None. |
|
| batchNo | string |
None. |
|
| authNo | string |
None. |
|
| uploadedFileURL | string |
None. |
|
| paymentTypeId | integer |
None. |
|
| advancedAmount | decimal number |
None. |
|
| SAPId | string |
None. |
|
| contractSubTypeId | integer |
None. |
|
| arrayUpdatedAccounts | Collection of EditAccountsViewModel |
None. |
|
| ownershipTransferReason | integer |
None. |
|
| postAccountNumber | globally unique identifier |
None. |
|
| postAccountClosingDocURL | string |
None. |
|
| bankInquiryId | integer |
None. |
|
| bankInquiryReplyDoc | string |
None. |
|
| bankInquiryStatusId | byte |
None. |
|
| bankInquiryReplyAmount | decimal number |
None. |
|
| invoiceTxId | globally unique identifier |
None. |
|
| warningId | string |
None. |
|
| warningDetails | string |
None. |
|
| warningReasonId | string |
None. |
|
| advanceAmount | decimal number |
None. |
|
| installmentCalculationsVariablesDTO | InstallmentCalculationsVariablesDTO |
None. |
|
| ProviderTransactionID | globally unique identifier |
None. |
|
| ProviderAccountId | integer |
None. |
|
| MonthsToPay | integer |
None. |
|
| installmentMonths | integer |
None. |
|
| contractUsageTypeId | integer |
None. |
|
| transactionPaymentMethodId | integer |
None. |
|
| transactionCardAuthorityNumber | string |
None. |
|
| transactionCardBatchNumber | string |
None. |
|
| chequeBankName | string |
None. |
|
| chequeNumber | integer |
None. |
|
| chequeAmount | decimal number |
None. |
|
| paymentDate | date |
None. |
|
| swiftCode | string |
None. |
|
| DelayedInvoicesTransactionIds | Collection of globally unique identifier |
None. |
|
| invoiceConsumptionComment | string |
None. |
|
| DelayInvoiceType | integer |
None. |
|
| arrayClients | Collection of integer |
None. |
|
| arrayClientsTransactionIds | Collection of globally unique identifier |
None. |
|
| postStatusId | string |
None. |
|
| arrayClientsBatchNo | integer |
None. |
|
| clientExcelSheetURL | string |
None. |
|
| previousBatchesHQ | boolean |
None. |
|
| monthlyClientsRequestDate | date |
None. |
|
| monthlyClientHasBankAccountNumber | boolean |
None. |
|
| monthlyClientIsPayOff | boolean |
None. |
|
| monthlyClientIsPrepaid | boolean |
None. |
|
| monthlyInstallmentPaymentType | integer |
None. |
|
| ClientTransactionId | globally unique identifier |
None. |
|
| gasPriceId | string |
None. |
|
| gasPriceStartDate | date |
None. |
|
| gasPriceEndDate | date |
None. |
|
| gasPriceStepTariffCount | integer |
None. |
|
| gasPriceUsageTypeId | string |
None. |
|
| stepTariffs | Collection of StepTariffViewModel |
None. |
|
| complaintId | string |
None. |
|
| complaintTopicId | string |
None. |
|
| complaintFinalSlaDate | date |
None. |
|
| complaintDescription | string |
None. |
|
| complaintComment | string |
None. |
|
| isGeneral | integer |
None. |
|
| identificationNumber | string |
None. |
|
| personName | string |
None. |
|
| personPhone | string |
None. |
|
| addressDetails | string |
None. |
|
| personRegistered | boolean |
None. |
|
| complaintStatus | byte |
None. |
|
| EGASDocURL | string |
None. |
|
| searchString | string |
None. |
|
| searchType | integer |
None. |
|
| employeeAreas | Collection of integer |
None. |
|
| userAssignedToEmployee | string |
None. |
|
| buildingIDs | Collection of integer |
None. |
|
| employeeContractUsageTypeId | Collection of integer |
None. |
|
| employeeParent | integer |
None. |
|
| employeeMaxCustomersCount | integer |
None. |
|
| employeeMinCustomersCount | integer |
None. |
|
| employeeMinOcrImagesCount | integer |
None. |
|
| employeeDeleteComment | string |
None. |
|
| employeeUsername | string |
None. |
|
| employeePassword | string |
None. |
|
| employeeDeviceId | string |
None. |
|
| employeeEmail | string |
None. |
|
| userBranchId | integer |
None. |
|
| updateEmployeePassword | boolean |
None. |
|
| employeeGovernorate | integer |
None. |
|
| arrayContractDetails | Collection of EditContractDetailsViewModel |
None. |
|
| withDetails | integer |
None. |
|
| TransferedToEmployeeId | string |
None. |
|
| vaultId | string |
None. |
|
| vaultName | string |
None. |
|
| vaultType | integer |
None. |
|
| bankName | string |
None. |
|
| bankBranchName | string |
None. |
|
| bankAccountNumber | string |
None. |
|
| bankSwift | string |
None. |
|
| bankIBAN | string |
None. |
|
| vaultRemovedAmount | decimal number |
None. |
|
| vaultTransferFromId | string |
None. |
|
| vaultTransferToId | string |
None. |
|
| vaultTransferredAmount | decimal number |
None. |
|
| vaultAreaIds | Collection of integer |
None. |
|
| transactionsIds | Collection of globally unique identifier |
None. |
|
| collectedAmount | decimal number |
None. |
|
| notes | string |
None. |
|
| financialDocumentsIds | Collection of integer |
None. |
|
| financialDocumentId | integer |
None. |
|
| docURL | string |
None. |
|
| importRequestId | integer |
None. |
|
| importRequestRejectionReason | string |
None. |
|
| importRequestAreaId | integer |
None. |
|
| installInvoiceWFARequestId | integer |
None. |
|
| installInvoiceWFARequestStatus | byte |
None. |
|
| installInvoiceRequestRejectionReason | string |
None. |
|
| payAccumulationsWFARequestId | integer |
None. |
|
| payAccumulationsWFARequestStatus | byte |
None. |
|
| payAccumulationsConsumptionComment | string |
None. |
|
| payAccumulationsRequestRejectionReason | string |
None. |
|
| invoiceAmount | decimal number |
None. |
|
| cancelConversionWFARequestId | integer |
None. |
|
| cancelConversionWFARequestStatus | byte |
None. |
|
| cancelConversionRequestRejectionReason | string |
None. |
|
| excelSheetURL | string |
None. |
|
| userId | integer |
None. |
|
| start | date |
None. |
|
| end | date |
None. |
|
| transactionType | integer |
None. |
|
| accountId | integer |
None. |
|
| requestId | string |
None. |
|
| requestType | string |
None. |
|
| requestStatus | string |
None. |
|
| identificationType | string |
None. |
|
| personCRN | integer |
None. |
|
| requestComment | string |
None. |
|
| inspectionDate | date |
None. |
|
| contractType | integer |
None. |
|
| AccNo | integer |
None. |
|
| userName | string |
None. |
|
| userEmail | string |
None. |
|
| userNationalID | string |
None. |
|
| userStaffNumber | string |
None. |
|
| userPhoneNumber | string |
None. |
|
| userRole | integer |
None. |
|
| userLevel | integer |
None. |
|
| userCompany | integer |
None. |
|
| userBranch | integer |
None. |
|
| userAreas | Collection of integer |
None. |
|
| token | string |
None. |
|
| correctionAmount | decimal number |
None. |
|
| correctionType | integer |
None. |
|
| correctionDescription | string |
None. |
|
| eGASBatchtId | integer |
None. |
|
| eGASBatchDescription | string |
None. |
|
| customersTAQAId | Collection of integer |
None. |
|
| headOfficeBatchtId | integer |
None. |
|
| headOfficeBatchDescription | string |
None. |
|
| eGASBatchesId | Collection of integer |
None. |
|
| monthsFrom | integer |
None. |
|
| monthsTo | integer |
None. |
|
| transactionTypeNullable | integer |
None. |
|
| contractDateFrom | date |
None. |
|
| contractDateTo | date |
None. |
|
| cancelationDateFrom | date |
None. |
|
| cancelationDateTo | date |
None. |
|
| conversionDateFrom | date |
None. |
|
| conversionDateTo | date |
None. |
|
| createDateFrom | date |
None. |
|
| createDateTo | date |
None. |
|
| govId | integer |
None. |
|
| arId | integer |
None. |
|
| contractUsageTypeIds | Collection of integer |
None. |
|
| invoiceReceiptNo | string |
None. |
|
| invoiceId | string |
None. |
|
| InvoiceCancelationReasonId | string |
None. |
|
| SAPCustomerConversionDetails | Collection of SAPCustomerConversionViewModel |
None. |
|
| meterId | integer |
None. |
|
| meterNewNumber | string |
None. |
|
| meterInstallationDate | date |
None. |
|
| meterReplaceFeeValue | decimal number |
None. |
|
| meterNewReading | integer |
None. |
|
| meterTxId | globally unique identifier |
None. |
|
| MeterDigits | byte |
None. |
|
| MeterCollectFee | decimal number |
None. |
|
| MeterEgasSiancoFee | decimal number |
None. |
|
| MeterStartDate | date |
None. |
|
| MeterEndDate | date |
None. |
|
| MeterType | string |
None. |
|
| MeterFeesId | integer |
None. |
|
| EmpId | integer |
None. |
|
| Area_Id | integer |
None. |
|
| transactionIds | Collection of globally unique identifier |
None. |
|
| importRequestNote | string |
None. |
|
| accountIds | Collection of integer |
None. |
|
| contractRefundedAmount | decimal number |
None. |
|
| contractCancelationReason | integer |
None. |
|
| canceledCustomerId | integer |
None. |
|
| cheques | Collection of ChequeModel |
None. |
|
| IsTaqaEmployee | boolean |
None. |
|
| IsMeterViewed | boolean |
None. |
|
| contractTerminationReasonId | integer |
None. |
|
| contractTerminationDocURL | string |
None. |