--- title: "List or find Customer objects" method: GET path: "/customer" tags: ["customer"] --- # List or find Customer objects `GET /customer` ## Request - Base URL: `https://serverRoot/tmf-api/customerManagement/v4` - URL: `https://serverRoot/tmf-api/customerManagement/v4/customer` - Auth: one of: - API key in header `X-API-Key` - OAuth 2 - Client credentials - Token URL: `https://api.mtn.com/v1/oauth/access_token` - TypeScript: (a function with typed inputs; its response is checked against the schema) This operation list or find Customer entities ## Query parameters - `fields` string - `csrId` string - `sortKey` string - `sortOrder` string - `retrievalType` string, required - `retrievalLimit` string - `objKeys` string - `customerType` string - `customerRank` integer - `listEntCustFlag` integer - `searchKey` string - `searchValue` string - `rootNodeId` string - `parentNodeId` string - `individualId` string - `reason` string ## Response `200` Success - CustomerList: Customer List - `allObjKeys` ObjectKey[]: All object keys which met search criteria. This information is used for pagination. - `totalObjects` integer: Total number of items matching criteria - `customers` Customer[]: Describes the list of customers with details - `id` string, required: Customer id, SV_MAPPING:CustAcct.ObjectKey - `href` string, required: Reference of the customer - :// - `case` CaseRef: The Case data structure - `id` string: Identifier of the Case, SV_MAPPING:Case.ObjectKey - `href` string: Reference of the case - :// - `status` string: The Status of Case, Possible Values New/Open/Closed. SV_MAPPING:Case.Status - `name` string: The name of the case, SV_MAPPING:Case.Name - `name` string: Customer Name, SV_MAPPING:Cust_Acct.CustAcctName_X - `status` string: Customer Status, SV_MAPPING:Cust_Acct.CustStatus_R - `statusChangeReason` string: Customer Status Change Reason. SV_MAPPING:Cust_Acct.CustStatusChangeReason_X. - `defaultDisplayAccount` string: Default Account Id. SV_MAPPING:Cust_Acct.PrimaryAcctID_I or Account.AcctID_I - `validFor` TimePeriod: A base / value business entity used to represent a period of time between two timepoints. - `startDateTime` string, date-time: Start Date format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveStartDate_T - `endDateTime` string, date-time: The effective end date Format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveEndDate_T - `engagedParty` PartyRef[]: Describes defines people who are contacts for a customer. Note: phoneNumber will only be shown in the contactMedium. 'op' attribute will not be returned by GET customer - `@referredType` string, required: This is type of related party which it reffers, possible values individual, organization, customer. SV_MAPPING: perestapi.REFERRED_TYPE - `id` string, required: Contact Id, SV_MAPPING:contact.ObjectKey (Primary) or SV_MAPPING:contact.ObjectKey (Secondary) or Customer id, SV_MAPPING:Cust_Acct.ObjectKey - `href` string: Reference of the party - ://customer - :// - `name` string: Contact display name, SV_MAPPING:contact.Display_Name, customer display name SV_MAPPING:Cust_Acct.CustAcctName_X or parent customer display name SV_MAPPING:Cust_Acct.ParentCustAcct_R@ - `role` string: Primary | Secondary | Parent | Child. SV_MAPPING: perestapi.RELATED_PARTY_ROLE - `individualIdentification` IndividualIdentification[] - `identificationId` string: SV_MAPPING: NationalId ->Contact.Ul_National_Id_X - `identificationType` string: NationalId - `partyCharacteristic` Characteristic[]: Characteristic name supported: PersonalVatNumber | CorporateVatNumber | ContactRole. Characteristic value supported: PersonalVatNumber -> SV_MAPPING:Contact.General10_X | CorporateVatNumber -> SV_MAPPING:Contact.General10_X | ContactRole -> SV_MAPPING:perestapi.imp.CONTACT_ROLE. Characteristic value type supported: string - `name` string, required: Name of the characteristic. - `valueType` string: The type of the value provided. - `value` string, required: The value of the characteristic provided as a string.The value of this attribute is depending on the corresponding name attribute value which indirectly determines the correct internal field to map. - `contactMedium` ContactMedium[] - `mediumType` string, required: Type of the contact medium i.e.: PostalAddress | SiteAddress |HomeNumber | WorkNumber | MobileNumber. SV_MAPPING: perestapi.MEDIUM_TYPE RT - `characteristic` MediumCharacteristic, required: Describes the contact medium characteristics that could be used to contact a party - `street1` string: Line 1, SV_MAPPING: Cust_Acct.PostalLine1_X | Cust_Acct.SiteLine1_X - `street2` string: Line 2, SV_MAPPING: Cust_Acct.PostalLine2_X | Cust_Acct.SiteLine2_X - `suburb` string: Suburban, SV_MAPPING: Cust_Acct.PostalSubDistrict_R | Cust_Acct.SiteSubDistrict_R - `city` string: City, SV_MAPPING: Cust_Acct.PostalCity_R | Cust_Acct.SiteCity_R - `postCode` string: Post Code, SV_MAPPING: Cust_Acct.PostalPostCode_X | Cust_Acct.SitePostCode_X - `stateOrProvince` string: State, SV_MAPPING: Cust_Acct.PostalDistrict_R | Cust_Acct.SiteDistrict_R - `country` string: Country, SV_MAPPING: Cust_Acct.PostalCountry_R | Cust_Acct.SiteCountry_R - `addressLine1` string: Address line 1, SV_MAPPING: Cust_Acct.PostalLine7_X | Cust_Acct.SiteLine7_X - `geocode` string: What3words, SV_MAPPING: Cust_Acct.PostalGeocode_X | Cust_Acct.SiteGeocode_X - `subDoorNumber` string: Sub Door number, SV_MAPPING: Cust_Acct.PostalSubDoorNumber_X | Cust_Acct.SiteSubDoorNumber_X - `genericAddress` string: Generic Address when the actual address is not known, SV_MAPPING: Cust_Acct.PostalGenericAddress_X | Cust_Acct.SiteGenericAddress_X - `phoneNumber` string: These are the phone numbers of the primary contact of customer. HomeNumber->SV_MAPPING:Contact.HomePhone_X,WorkNumber->SV_MAPPING:Contact.WorkPhone_X, MobileNumber->SV_MAPPING:Contact.MobilePhone_X - `xpos` number, float: X coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalXPos_D | Cust_Acct.SiteXPos_D - `ypos` number, float: Y coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalYPos_D | Cust_Acct.SiteYPos_D - `op` string: add | replace | remove. SV_MAPPING: perestapi.OPERATION - `characteristic` Characteristic[]: Characteristic name supported: CreationDate | ActivationDate | CustomerType | PrimaryAccount | IndustryType | CustomerVatNumber | SalesRepresentative | CompanyNumer | PrepaidWithoutStatement | DepositAccountNumber | OpenCasesCount | PlanName | ServiceName | ServiceStatus | TotalPurchasedServices | CompanyType | CompanyRegistrationNumber | CUGId | EmployeeCount | FoundedDate | CustomerRank | VATExempt | OfficialLetterRequired | SpecialistCSR | PaysForSelf | PaysBySalary | PaymentDueDateOffset | PaymentDueDatePreference | TotalChildCustomers | VoucherTopUpStatus | ApartmentOwner | EncouragementDiscountPlan | AdminNumber | DoorLockPin | OfficerCSR | ResponsibleTeam | SubTeam | PaymentDueDateUOM | MaximumInvoiceAmountPayableCompany | PartialAmount | InvoiceEmailAddress. Characteristic value supported: CreationDate -> SV_MAPPING:Cust_Acct.CreatedDate_T| ActivationDate -> SV_MAPPING:Cust_Acct.ActiveDate_T | CustomerType -> SV_MAPPING:Cust_Acct.Type_R | PrimaryAccount -> SV_MAPPING:Cust_Acct.PrimaryAcctNum_X | IndustryType -> SV_MAPPING:Cust_Acct.Industry_R | CustomerVatNumber -> SV_MAPPING:Cust_Acct.UI_CustomerVATNumber_X | SalesRepresentative -> SV_MAPPING:Cust_Acct.SalesRepresentative_R | CompanyNumer -> SV_MAPPING:Cust_Acct.CompanyNum_X | PrepaidWithoutStatement -> SV_MAPPING:Cust_Acct.PrepaidWithoutStatement_B | DepositAccountNumber -> SV_MAPPING:Cust_Acct.DepositAcctNum_X | OpenCasesCount -> SV_MAPPING:Cust_Acct.CustOpenCases_I | PlanName -> SV_MAPPING:PurchasedProduct.Offer_R | ServiceName -> SV_MAPPING:PurchasedProduct.PrimaryService_X | ServiceStatus -> SV_MAPPING:PurchasedProduct.Status_R@ | TotalPurchasedServices -> SV_MAPPING:Cust_Acct.CountActiveBaseProducts_I | CompanyType -> SV_MAPPING:Cust_Acct.CompanyType_R | CompanyRegistrationNumber -> SV_MAPPING:Cust_Acct.CompanyRegNum_X | CUGId -> SV_MAPPING:Cust_Acct.CorporateIdentifier_X | EmployeeCount -> SV_MAPPING:Cust_Acct.Employee_Count_I | FoundedDate -> SV_MAPPING:Cust_Acct.Founded_Date_T | CustomerRank -> SV_MAPPING:Cust_Acct.CustomerRank_R | VATExempt -> SV_MAPPING:Cust_Acct.VatExempt_B | OfficialLetterRequired -> SV_MAPPING:Cust_Acct.OfficialLetterReq_B | SpecialistCSR -> SV_MAPPING:Cust_Acct.SpecialistCSR_R | PaysForSelf -> SV_MAPPING:Cust_Acct.PaysForSelf_B | PaysBySalary -> SV_MAPPING:Cust_Acct.PaysBySalary_B | PaymentDueDateOffset -> SV_MAPPING:Cust_Acct.PaymentOffsetDays_I | PaymentDueDatePreference -> SV_MAPPING:Cust_Acct.PaymentDuePref_R | TotalChildCustomers -> Derived | VoucherTopUpStatus -> SV_MAPPING:Cust_Acct.VoucherTopUpStatus_B | SecutityGroup -> SV_MAPPING:Cust_Acct.Security_Group | ApartmentOwner -> SV_MAPPING:Cust_Acct.ApartmentOwner_R | EncouragementDiscountPlan -> SV_MAPPING:Cust_Acct.DiscountPlan_R | AdminNumber -> SV_MAPPING:Cust_Acct.AdminNumber_X | DoorLockPin -> SV_MAPPING:Cust_Acct.DoorLockPin_X | OfficerCSR -> SV_MAPPING:Cust_Acct.OfficerCSR_R | ResponsibleTeam -> SV_MAPPING:Cust_Acct.ResponseTeam_R | SubTeam -> SV_MAPPING:Cust_Acct.SubTeam_R | PaymentDueDateUOM -> SV_MAPPING:Cust_Acct.PaymentDueDateUOM_R | MaximumInvoiceAmountPayableCompany -> SV_MAPPING:Cust_Acct.MaxInvAmtPayByComp_R | PartialAmount -> SV_MAPPING:Cust_Acct.MaxInvAmtPayByComp_C | TimeZone -> SV_MAPPING:Cust_Acct.TimeZone_R. Characteristic value type supported: string | InvoiceEmailAddress -> SV_MAPPING:Cust_Acct.InvoiceEmail_X - `name` string, required: Name of the characteristic. - `valueType` string: The type of the value provided. - `value` string, required: The value of the characteristic provided as a string.The value of this attribute is depending on the corresponding name attribute value which indirectly determines the correct internal field to map. - `relatedParty` PartyRef[]: Describes the parent / child customer details. Note: Attributes to be displayed are id, role, href and @referredType only. - `@referredType` string, required: This is type of related party which it reffers, possible values individual, organization, customer. SV_MAPPING: perestapi.REFERRED_TYPE - `id` string, required: Contact Id, SV_MAPPING:contact.ObjectKey (Primary) or SV_MAPPING:contact.ObjectKey (Secondary) or Customer id, SV_MAPPING:Cust_Acct.ObjectKey - `href` string: Reference of the party - ://customer - :// - `name` string: Contact display name, SV_MAPPING:contact.Display_Name, customer display name SV_MAPPING:Cust_Acct.CustAcctName_X or parent customer display name SV_MAPPING:Cust_Acct.ParentCustAcct_R@ - `role` string: Primary | Secondary | Parent | Child. SV_MAPPING: perestapi.RELATED_PARTY_ROLE - `individualIdentification` IndividualIdentification[] - `identificationId` string: SV_MAPPING: NationalId ->Contact.Ul_National_Id_X - `identificationType` string: NationalId - `partyCharacteristic` Characteristic[]: Characteristic name supported: PersonalVatNumber | CorporateVatNumber | ContactRole. Characteristic value supported: PersonalVatNumber -> SV_MAPPING:Contact.General10_X | CorporateVatNumber -> SV_MAPPING:Contact.General10_X | ContactRole -> SV_MAPPING:perestapi.imp.CONTACT_ROLE. Characteristic value type supported: string - `name` string, required: Name of the characteristic. - `valueType` string: The type of the value provided. - `value` string, required: The value of the characteristic provided as a string.The value of this attribute is depending on the corresponding name attribute value which indirectly determines the correct internal field to map. - `contactMedium` ContactMedium[] - `mediumType` string, required: Type of the contact medium i.e.: PostalAddress | SiteAddress |HomeNumber | WorkNumber | MobileNumber. SV_MAPPING: perestapi.MEDIUM_TYPE RT - `characteristic` MediumCharacteristic, required: Describes the contact medium characteristics that could be used to contact a party - `street1` string: Line 1, SV_MAPPING: Cust_Acct.PostalLine1_X | Cust_Acct.SiteLine1_X - `street2` string: Line 2, SV_MAPPING: Cust_Acct.PostalLine2_X | Cust_Acct.SiteLine2_X - `suburb` string: Suburban, SV_MAPPING: Cust_Acct.PostalSubDistrict_R | Cust_Acct.SiteSubDistrict_R - `city` string: City, SV_MAPPING: Cust_Acct.PostalCity_R | Cust_Acct.SiteCity_R - `postCode` string: Post Code, SV_MAPPING: Cust_Acct.PostalPostCode_X | Cust_Acct.SitePostCode_X - `stateOrProvince` string: State, SV_MAPPING: Cust_Acct.PostalDistrict_R | Cust_Acct.SiteDistrict_R - `country` string: Country, SV_MAPPING: Cust_Acct.PostalCountry_R | Cust_Acct.SiteCountry_R - `addressLine1` string: Address line 1, SV_MAPPING: Cust_Acct.PostalLine7_X | Cust_Acct.SiteLine7_X - `geocode` string: What3words, SV_MAPPING: Cust_Acct.PostalGeocode_X | Cust_Acct.SiteGeocode_X - `subDoorNumber` string: Sub Door number, SV_MAPPING: Cust_Acct.PostalSubDoorNumber_X | Cust_Acct.SiteSubDoorNumber_X - `genericAddress` string: Generic Address when the actual address is not known, SV_MAPPING: Cust_Acct.PostalGenericAddress_X | Cust_Acct.SiteGenericAddress_X - `phoneNumber` string: These are the phone numbers of the primary contact of customer. HomeNumber->SV_MAPPING:Contact.HomePhone_X,WorkNumber->SV_MAPPING:Contact.WorkPhone_X, MobileNumber->SV_MAPPING:Contact.MobilePhone_X - `xpos` number, float: X coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalXPos_D | Cust_Acct.SiteXPos_D - `ypos` number, float: Y coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalYPos_D | Cust_Acct.SiteYPos_D - `op` string: add | replace | remove. SV_MAPPING: perestapi.OPERATION - `account` AccountRef[]: Describes the customer primary account details. - `id` string: Primary account id or prepaid account id, SV_MAPPING:Cust_Acct.PrimaryAcctID_I or Account.AcctID_I - `name` string, required: Name of the account - `accountNumber` string: Primary account number or prepaid account number, SV_MAPPING:Cust_Acct.PrimaryAcctNum_X or Account.Name - `accountBalance` string: ACCOUNT_BALANCE, SV_MAPPING:Cust_Acct.PrimAcctBal_C or Account.AcctBalance_C - `href` string: Reference of the account - ://. Not implemented yet. - `accountType` string: Account type, SV_MAPPING:Account.Type_R - `creditLimit` string: Credit Limit, SV_MAPPING:Account.CreditLimit_C - `availableCredit` string: AVAILABLE_CREDIT, SV_MAPPING:Account.AvailableCredit_C - `billStructure` BillStructure: The bill structure that associated to the customer. - `cycleSpecification` CycleSpecification: The customer bill cycle. - `name` string: Schedule Name, SV_MAPPING:Cust_Acct.InvoiceCycle_R - `preferredCurrency` string: Preferred Currency, SV_MAPPING:Cust_Acct.Currency_R - `reportLevel` string: Report Level, SV_MAPPING:Cust_Acct.ReportLevel_R - `suppressBilling` string: Suppress Billing Flag, SV_MAPPING:Cust_Acct.SuppressBilling_B, Possible value 1 and 0 - `suppressCycles` string: Suppress for number of Cycles, SV_MAPPING:Cust_Acct.SuppressCycles_I - `suppressUntilDate` string: Bill suppress date, SV_MAPPING:Cust_Acct.SuppressDate_T - `transferredAccountNumber` string: Transferred account number. SV_MAPPING:Cust_Acct.TransferAccountNumber_X - `billEndDate` string: Bill End Date. Describes the Bill cycle end date - `format` Format[]: The bill invoice format. - `name` string: Invoice formate name, SV_MAPPING:CustAcctInvoiceFormat.InvoiceFormat_R - `presentationMedia` PresentationMedia: The bill invoice presentation media. - `name` string: Invoice Delivery, SV_MAPPING:CustAcctInvoiceFormat.InvoiceDelivery_R - `characteristic` Characteristic[]: Characteristic name supported: sendInvoiceTo | contactId | itemized | addressChoice | invoiceLanguage | op | seqnr.Characteristic value supported: CustAcctInvoiceFormat.Contact_R, CustAcctInvoiceFormat.InvoiceItemised_R, CustAcctInvoiceFormat.AddressChoice_R, CustAcctInvoiceFormat.InvoiceLanguage_R, perestapi.OPERATION (op) and CustAcctInvoiceFormat.SequenceNum_I.Characteristic value type supported: string. For PATCH request, the combination of op and seqnr characteristics are mandatory values.They indicate the type of action (add/replace/remove) to perform on an identified invoice format entity, as well as all other attribute values under the format attribute object e.g.: name, presentationMedia and the list of other characteristic values.For GET request, the op characteristic will not be returned.For POST request, the op and seqnr characteristics will not be used. - `name` string, required: Name of the characteristic. - `valueType` string: The type of the value provided. - `value` string, required: The value of the characteristic provided as a string.The value of this attribute is depending on the corresponding name attribute value which indirectly determines the correct internal field to map. - `paymentPlan` PaymentPlan: The payment plan that associated to the account. - `paymentMethod` string: Payment method, SV_MAPPING:Cust_Acct.PayMethod_R - `paymentLocation` string: Payment location, SV_MAPPING:Cust_Acct.PaymentLocation_R - `autoPay` string: Describes the customer is registered for auto pay or not, SV_MAPPING:RT-YES_NO - `dunningCase` DunningCase: Customer treatment process. - `id` string: Treatment query id. SV_MAPPING: CustAcctQuery.QueryID_I - `name` string: Treatment query number. SV_MAPPING: CustAcctQuery.Name - `href` string: Not implemented yet - `status` string: Treatment query status. SV_MAPPING: CustAcctQuery.QueryStatus_R - `currentAmountDue` Money: A base / value business entity used to represent money - `unit` string: Currency (ISO4217 norm uses 3 letters to define the currency). SV_MAPPING: CURRENCY_TRE_V.CURRENCY_SYMBOL - `value` number, float: A positive floating-point number - `creditProfile` CreditProfile: Credit profile for the party. - `creditProfileDate` string, date-time, required: The date the profile was established - `creditRiskRating` string: Credit rating, SV_MAPPING:Cust_Acct.CreditRating_R - `creditLimit` string: CREDIT_LIMIT, SV_MAPPING:Cust_Acct.CreditLimit_C - `creditLimitCurrency` string: Credit limit Currency, SV_MAPPING:Cust_Acct.CreditLimitCurrency_R - `expectedRevenue` string: Expected revenue, SV_MAPPING:Cust_Acct.ExptRevAmt_C - `expRevCurrency` string: Expected revenue currency, SV_MAPPING:Cust_Acct.ExptRevCurrency_R - `creditComments` string: Credit comments, SV_MAPPING:Cust_Acct.CreditComments_X - `taxClass` string: Tax class, SV_MAPPING:Cust_Acct.TaxClass_R - `creditScore` string: Credit score, SV_MAPPING:Cust_Acct.CreditScore_X - `validFor` TimePeriod, required: A base / value business entity used to represent a period of time between two timepoints. - `startDateTime` string, date-time: Start Date format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveStartDate_T - `endDateTime` string, date-time: The effective end date Format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveEndDate_T - `contactMedium` ContactMedium[]: Describes the customer contact medium details. Note: phoneNumber will not be returned by GET customer. - `mediumType` string, required: Type of the contact medium i.e.: PostalAddress | SiteAddress |HomeNumber | WorkNumber | MobileNumber. SV_MAPPING: perestapi.MEDIUM_TYPE RT - `characteristic` MediumCharacteristic, required: Describes the contact medium characteristics that could be used to contact a party - `street1` string: Line 1, SV_MAPPING: Cust_Acct.PostalLine1_X | Cust_Acct.SiteLine1_X - `street2` string: Line 2, SV_MAPPING: Cust_Acct.PostalLine2_X | Cust_Acct.SiteLine2_X - `suburb` string: Suburban, SV_MAPPING: Cust_Acct.PostalSubDistrict_R | Cust_Acct.SiteSubDistrict_R - `city` string: City, SV_MAPPING: Cust_Acct.PostalCity_R | Cust_Acct.SiteCity_R - `postCode` string: Post Code, SV_MAPPING: Cust_Acct.PostalPostCode_X | Cust_Acct.SitePostCode_X - `stateOrProvince` string: State, SV_MAPPING: Cust_Acct.PostalDistrict_R | Cust_Acct.SiteDistrict_R - `country` string: Country, SV_MAPPING: Cust_Acct.PostalCountry_R | Cust_Acct.SiteCountry_R - `addressLine1` string: Address line 1, SV_MAPPING: Cust_Acct.PostalLine7_X | Cust_Acct.SiteLine7_X - `geocode` string: What3words, SV_MAPPING: Cust_Acct.PostalGeocode_X | Cust_Acct.SiteGeocode_X - `subDoorNumber` string: Sub Door number, SV_MAPPING: Cust_Acct.PostalSubDoorNumber_X | Cust_Acct.SiteSubDoorNumber_X - `genericAddress` string: Generic Address when the actual address is not known, SV_MAPPING: Cust_Acct.PostalGenericAddress_X | Cust_Acct.SiteGenericAddress_X - `phoneNumber` string: These are the phone numbers of the primary contact of customer. HomeNumber->SV_MAPPING:Contact.HomePhone_X,WorkNumber->SV_MAPPING:Contact.WorkPhone_X, MobileNumber->SV_MAPPING:Contact.MobilePhone_X - `xpos` number, float: X coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalXPos_D | Cust_Acct.SiteXPos_D - `ypos` number, float: Y coordinate of the geographic address, SV_MAPPING: Cust_Acct.PostalYPos_D | Cust_Acct.SiteYPos_D - `paymentMethod` PaymentMethodRef[]: Describes the customer payment methods. - `@type` 'bankAccountDebit' | 'bankCard': Payment method type i.e.: bankAccountDebit | bankCard. SV_MAPPING: perestapi.PAYMENT_METHOD_TYPE RT - `details` object: If @type is bankAccountDebit then the details attribute object values will be derived from BankAccountDebitType object type. If @type is bankCard then the details attribute object values will be derived from BankCardType object type - `id` string, required: Unique identifier of the payment mean - `href` string: Reference of the payment mean - `name` string: Name of the payment mean - `taxExemptionCertificate` TaxExemptionCertificate[]: Describes the customer tax exemptions. - `id` string: Certificate, SV_MAPPING: CustAcctList.ResultFact01_X - `documentId` string: Document id, SV_MAPPING: CustAcctList.ResultFact04_X - `description` string: Document Description, SV_MAPPING: CustAcctList.ResultFact05_X - `validFor` TimePeriod: A base / value business entity used to represent a period of time between two timepoints. - `startDateTime` string, date-time: Start Date format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveStartDate_T - `endDateTime` string, date-time: The effective end date Format: yyyy-mm-ddThh:nn:ss, SV_MAPPING:Cust_Acct.EffectiveEndDate_T - `taxDefinition` TaxDefinition[] - `taxType` string: Tax Association Code, SV_MAPPING: CustAcctList.IndexValue01_X - `treatmentExemption` TreatmentExemption: Customer treatment exemption. - `id` string: Treatment exemption derived attribute id, SV_MAPPING: CustAcctList.CustListID_I - `exemption` string: Treatment exemption flag, SV_MAPPING: CustAcctList.IndexValue01_X - `description` string: Treatment exemption description, SV_MAPPING: CustAcctList.Description_X - `treatmentSuspension` TreatmentSuspension: Customer treatment suspension. - `suspensionReasonCode` string: Treatment Suspension reason code, fetched from customer DA List. If suspensionReasonCode is not passed in the request or null then its delete suspension record from Treatment Suspension Attributes customer DA.SV_MAPPING:CustAcctList.ResultFact01_X - `suspensionEndDate` string, date-time: Suspension End Date,fetched from customer DA List. SV_MAPPING:CustAcctList.ResultFact02_X - `id` string: Treatment suspension derived attribute id, this is only used in case of GET Customer API. SV_MAPPING: CustAcctList.CustListID_I - `suspensionDuration` string: Suspension Duration,fetched from customer DA List. SV_MAPPING:CustAcctList.ResultFact04_X - `warningMessage` string: Warning message details. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `405`: Method Not allowed - `409`: Conflict - `500`: Internal Server Error --- [API](https://skmtc.dev/mtn/apis/tmf629-customer-management.md) - [All operations](https://skmtc.dev/mtn/apis/tmf629-customer-management/llms.txt) - [OpenAPI document](https://skmtc.dev/mtn/apis/tmf629-customer-management/revisions/3a9e7f18e53f?raw)