TOTVS - RESTFul API


Service: /healthcare/

Serviços REST da Central de Obrigações

Métodos

DELETE
{version}/shareholders/{shareholderSCpfCnpj}

Description

Shareholders - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
shareholderscpfcnpj string optional

DELETE
{version}/contractConsolidation/{riskPool}

Description

Contract Consolidation - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
riskpool string optional

DELETE
{version}/realEstGarAsset/{providerRegister}

Description

Real Est Gar Asset - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
realestategeneralregis string optional
commitmentyear string optional
_pathparam UndefinedUndefined
providerregister string optional

DELETE
{version}/analyticDmedExpenses/{expenseKey}

Description

Analytic Dmed Expenses - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
titleholderenrollment string optional
dependentssn string optional
dependentenrollment string optional
expensekey string optional
period string optional
_pathparam UndefinedUndefined
expensekey string optional

DELETE
{version}/personsInCharge/{uniqueKey}

Description

Persons In Charge - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
ssn string optional
_pathparam UndefinedUndefined
uniquekey string optional

DELETE
{version}/operatorsDiops/{uniqueKey}

Description

Operators Diops - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
registernumber string optional
operatorcnpj string optional
_pathparam UndefinedUndefined
uniquekey string optional

DELETE
{version}/beneficiaries/{subscriberId}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
codecco string optional
_pathparam UndefinedUndefined
subscriberid string optional

DELETE
{version}/idssIndicators/{uniqueKey}

Description

Idss Indicators - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
referenceyear string optional
_pathparam UndefinedUndefined
uniquekey string optional

DELETE
{version}/trimesterBalanceSheet/{accountCode}

Description

Trimester Balance Sheet - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

DELETE
{version}/cooperCheckAccnt/{taxType}

Description

Cooper Check Accnt - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
taxname string optional
perioddate string optional
commitmentyear string optional
_pathparam UndefinedUndefined
taxtype string optional

DELETE
{version}/assistanceCoverage/{typeOfPlan}

Description

Assistance Coverage - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
paymentorigin string optional
_pathparam UndefinedUndefined
typeofplan string optional

DELETE
{version}/stipulatedContracts/{operatorRecordInAns}

Description

Stipulated Contracts - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
trimester string optional
_pathparam UndefinedUndefined
operatorrecordinans string optional

DELETE
{version}/controlledAffiliates/{legalEntityNatRegister}

Description

Controlled Affiliates - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

DELETE
{version}/commitment/{commitmentCode}

Description

Commitment - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
obligationcode string optional
providerregister string optional
referenceyear string optional
obligationtype string optional
_pathparam UndefinedUndefined
commitmentcode string optional

DELETE
{version}/coresponsibilityGranted/{ansEventCode}

Description

Coresponsibility Granted - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
anseventcode string optional

DELETE
{version}/products/{healthInsuranceCode}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
_pathparam UndefinedUndefined
healthinsurancecode string optional

DELETE
{version}/premises/{legalEntityNatRegister}

Description

Premises - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

DELETE
{version}/indemnifiableEvents/{eventCodeAns}

Description

Indemnifiable Events - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
eventcodeans string optional

DELETE
{version}/cashFlow/{cashFlowCode}

Description

Cash Flow - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
status string optional
_pathparam UndefinedUndefined
cashflowcode string optional

DELETE
{version}/commonFunds/{fundType}

Description

Common Funds - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
cnpjorfundansrec string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
fundtype string optional

DELETE
{version}/profitsAndLosses/{accountCode}

Description

Profits And Losses - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

DELETE
{version}/capitalStandardModel/{commitmentCode}

Description

Capital Standard Model - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentcode string optional

DELETE
{version}/listOfCities/{stateAcronym}

Description

List Of Cities - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
ibgecitycode string optional
providerregister string optional
_pathparam UndefinedUndefined
stateacronym string optional

DELETE
{version}/obligations/{obligationCode}

Description

Obligations - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
obligationcode string optional

DELETE
{version}/operators/{operatorCnpj}

Description

Operators - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
operatorcnpj string optional

DELETE
{version}/liabilityTaxAccnt/{accountCode}

Description

Liability Tax Accnt - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
accountcode string optional

DELETE
{version}/pecuniaryConsideration/{counterpartCoveragePeri}

Description

Pecuniary Consideration - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
plantype string optional
commitmentyear string optional
_pathparam UndefinedUndefined
counterpartcoverageperi string optional

DELETE
{version}/provNetSinEvPesl/{commitmentYear}

Description

Prov Net Sin Ev Pesl - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentyear string optional

DELETE
{version}/ansAccountPlan/{accountCode}

Description

Ans Account Plan - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
validityenddate string optional
validitystartdate string optional
_pathparam UndefinedUndefined
accountcode string optional

DELETE
{version}/charts/{diopsChart}

Description

Charts - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
diopschart string optional

DELETE
{version}/representatives/{registrationOfIndividua}

Description

Representatives - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
registrationofindividua string optional

DELETE
{version}/personsResponsible/{responsibilityType}

Description

Persons Responsible - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
cpfcnpj string optional
responsibleleorindivid string optional
_pathparam UndefinedUndefined
responsibilitytype string optional

DELETE
{version}/activeBalanceAge/{financialDueDate}

Description

Active Balance Age - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
financialduedate string optional

DELETE
{version}/transContrAmtSegr/{benefitAdmOperCode}

Description

Trans Contr Amt Segr - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
benefitadmopercode string optional

DELETE
{version}/liabilityBalanceAge/{financialDueDate}

Description

Liability Balance Age - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
financialduedate string optional

DELETE
{version}/liabilityAdequationTest/{planType}

Description

Liability Adequation Test - Delete

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
plantype string optional

GET
{version}/shareholders

Description

Shareholders - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
providerregister string optional
shareholderscpfcnpj string optional
corporatename string optional
numberofshares string optional
shareholdertype string optional

GET
{version}/shareholders/{shareholderSCpfCnpj}

Description

Shareholders - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
shareholderscpfcnpj string optional

GET
{version}/contractConsolidation

Description

Contract Consolidation - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
riskpool string optional
pcecorrespongranted string optional
pceissuedcounterprov string optional
eveclaimsknownpce string optional
placorrespongranted string optional
issuedconsiderationspla string optional
plaknowllossevents string optional
trimester string optional
status string optional

GET
{version}/contractConsolidation/{riskPool}

Description

Contract Consolidation - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
riskpool string optional

GET
{version}/realEstGarAsset

Description

Real Est Gar Asset - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
realestategeneralregis string optional
commitmentyear string optional
assitance string optional
ownnetwork string optional
trimester string optional
status string optional
validityenddate string optional
validitystartdate string optional
accountingvalue string optional

GET
{version}/realEstGarAsset/{providerRegister}

Description

Real Est Gar Asset - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
realestategeneralregis string optional
commitmentyear string optional
_pathparam UndefinedUndefined
providerregister string optional

GET
{version}/files/{yearMonthRefer}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
page string optional
pagesize string optional
fields string optional
order string optional
_pathparam UndefinedUndefined
yearmonthrefer string optional

GET
{version}/analyticDmedExpenses

Description

Analytic Dmed Expenses - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
healthinsurercode string optional
ssnholder string optional
titleholderenrollment string optional
dependentssn string optional
dependentenrollment string optional
expensekey string optional
period string optional
holdername string optional
dependentname string optional
dependentbirthdate string optional
dependencerelationships string optional
expenseamount string optional
refundamount string optional
previousyearrefundamt string optional
providerssnein string optional
providername string optional
status string optional
inicialdate string optional
finaldate string optional

GET
{version}/analyticDmedExpenses/{expenseKey}

Description

Analytic Dmed Expenses - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
fields string optional
healthinsurercode string optional
titleholderenrollment string optional
dependentssn string optional
dependentenrollment string optional
ssnholder string optional
period string optional
_pathparam UndefinedUndefined
expensekey string optional

GET
{version}/beneficiaries

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
search string optional
fields string optional
order string optional
expand string optional
healthinsurercode string optional
codecco string optional
subscriberid string optional
name string optional
gender string optional
birthdate string optional
effectivedate string optional
blockdate string optional
stateabbreviation string optional
healthinsurancecode string optional
unblockdate string optional
pispasep string optional
mothersname string optional
declarationoflivebirth string optional
nationalhealthcard string optional
address string optional
housenumbering string optional
addresscomplement string optional
district string optional
citycode string optional
citycoderesidence string optional
zipcode string optional
typeofaddress string optional
residentabroad string optional
holderrelationship string optional
holdersubscriberid string optional
codesusep string optional
codescpa string optional
partialcoverage string optional
guarantorcnpj string optional
guarantorcei string optional
holdercpf string optional
mothercpf string optional
sponsorcpf string optional
excludeditems string optional
skiprulename string optional
skiprulemothersname string optional
blockingreason string optional
statusans string optional
caepf string optional
portabilityplancode string optional
guarantorname string optional
beneficiariestatus string optional
graceperiod string optional
beneficiariemirrorstatus string optional

GET
{version}/beneficiaries/{uniqueKey}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
fields string optional
healthinsurercode string optional
codecco string optional
_pathparam UndefinedUndefined
uniquekey string optional

GET
{version}/personsInCharge

Description

Persons In Charge - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
search string optional
fields string optional
order string optional
expand string optional
healthinsurercode string optional
ssn string optional
name string optional
areacode string optional
phonenumber string optional
extensionline string optional
fax string optional
email string optional
active string optional

GET
{version}/personsInCharge/{uniqueKey}

Description

Persons In Charge - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
fields string optional
healthinsurercode string optional
ssn string optional
_pathparam UndefinedUndefined
uniquekey string optional

GET
{version}/operatorsDiops

Description

Operators Diops - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
filter string optional
page string optional
pagesize string optional
search string optional
fields string optional
order string optional
expand string optional
registernumber string optional
operatorcnpj string optional
corporatename string optional
tradename string optional
legalnature string optional
operatormode string optional
operatorsegmentation string optional

GET
{version}/operatorsDiops/{uniqueKey}

Description

Operators Diops - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
fields string optional
registernumber string optional
operatorcnpj string optional
_pathparam UndefinedUndefined
uniquekey string optional

GET
{version}/idssIndicators

Description

Idss Indicators - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
search string optional
fields string optional
order string optional
expand string optional
healthinsurercode string optional
referenceyear string optional
numeratortissratio string optional
denominatortissratio string optional
partialtissratio string optional
totaltissratio string optional

GET
{version}/idssIndicators/{uniqueKey}

Description

Idss Indicators - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
expand string optional
fields string optional
healthinsurercode string optional
referenceyear string optional
_pathparam UndefinedUndefined
uniquekey string optional

GET
{version}/trimesterBalanceSheet

Description

Trimester Balance Sheet - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
accountcode string optional
credits string optional
debits string optional
trimester string optional
previousbalance string optional
finalbalance string optional
status string optional

GET
{version}/trimesterBalanceSheet/{accountCode}

Description

Trimester Balance Sheet - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

GET
{version}/cooperCheckAccnt

Description

Cooper Check Accnt - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
taxname string optional
perioddate string optional
taxtype string optional
commitmentyear string optional
monetaryupdate string optional
amtpaidtrimester string optional
totalamtfinanced string optional
totalamtpaid string optional
dateadhesiontorefis string optional
numberofinstallments string optional
numbdueinstallments string optional
numbofpaidinstallm string optional
trimester string optional
trimesterfinalbalance string optional
trimesterinitialbalance string optional
status string optional

GET
{version}/cooperCheckAccnt/{taxType}

Description

Cooper Check Accnt - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
taxname string optional
perioddate string optional
commitmentyear string optional
_pathparam UndefinedUndefined
taxtype string optional

GET
{version}/files/ccos/{fileName}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
name string optional
subscriberid string optional
codecco string optional
_pathparam UndefinedUndefined
filename string optional

GET
{version}/assistanceCoverage

Description

Assistance Coverage - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
typeofplan string optional
paymentorigin string optional
otherpayments string optional
trimester string optional
status string optional
therapies string optional
medicalappointment string optional
otherexpenses string optional
examinations string optional
hospitalizations string optional

GET
{version}/assistanceCoverage/{typeOfPlan}

Description

Assistance Coverage - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
paymentorigin string optional
_pathparam UndefinedUndefined
typeofplan string optional

GET
{version}/stipulatedContracts

Description

Stipulated Contracts - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
operatorrecordinans string optional
trimester string optional
status string optional
billingvalue string optional

GET
{version}/stipulatedContracts/{operatorRecordInAns}

Description

Stipulated Contracts - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
trimester string optional
_pathparam UndefinedUndefined
operatorrecordinans string optional

GET
{version}/controlledAffiliates

Description

Controlled Affiliates - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
legalentitynatregister string optional
providerregister string optional
quantityofactions string optional
companyname string optional
totalofactionsorquota string optional
typeofshare string optional
companyclassification string optional

GET
{version}/controlledAffiliates/{legalEntityNatRegister}

Description

Controlled Affiliates - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

GET
{version}/commitment

Description

Commitment - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
obligationcode string optional
commitmentcode string optional
providerregister string optional
referenceyear string optional
obligationtype string optional
commitmentduedate string optional
duedatenotification string optional
trimester string optional
synthetizesbenefit string optional
status string optional

GET
{version}/commitment/{commitmentCode}

Description

Commitment - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
obligationcode string optional
providerregister string optional
referenceyear string optional
obligationtype string optional
_pathparam UndefinedUndefined
commitmentcode string optional

GET
{version}/coresponsibilityGranted

Description

Coresponsibility Granted - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
anseventcode string optional
obligationcode string optional
providerregister string optional
trimester string optional
status string optional
amt1stmthtrimester string optional
amt2ndmthtrimester string optional
amt3rdmthtrimester string optional

GET
{version}/coresponsibilityGranted/{ansEventCode}

Description

Coresponsibility Granted - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
anseventcode string optional

GET
{version}/premises

Description

Premises - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
providerregister string optional
legalentitynatregister string optional
postaddrcode string optional
longdistancecode string optional
internationalcallinfcd string optional
district string optional
ibgecitycode string optional
addresscomplement string optional
email string optional
addressname string optional
corporatename string optional
addressnumber string optional
extensionline string optional
stateacronym string optional
telephonenumber string optional
dependencetype string optional

GET
{version}/premises/{legalEntityNatRegister}

Description

Premises - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

GET
{version}/indemnifiableEvents

Description

Indemnifiable Events - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
eventcodeans string optional
obligationcode string optional
providerregister string optional
trimester string optional
status string optional
quartermthfirstvalue string optional
quartermthsecvalue string optional
quartermththirdvalue string optional

GET
{version}/indemnifiableEvents/{eventCodeAns}

Description

Indemnifiable Events - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
eventcodeans string optional

GET
{version}/cashFlow

Description

Cash Flow - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
cashflowcode string optional
obligationcode string optional
providerregister string optional
status string optional
value string optional
trimester string optional

GET
{version}/cashFlow/{cashFlowCode}

Description

Cash Flow - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
status string optional
_pathparam UndefinedUndefined
cashflowcode string optional

GET
{version}/commonFunds

Description

Common Funds - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
cnpjorfundansrec string optional
obligationcode string optional
providerregister string optional
fundtype string optional
fundname string optional
trimester string optional
creditbalanceoffund string optional
debitorbalanceoffund string optional
status string optional

GET
{version}/commonFunds/{fundType}

Description

Common Funds - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
cnpjorfundansrec string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
fundtype string optional

GET
{version}/profitsAndLosses

Description

Profits And Losses - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
accountcode string optional
description string optional
trimester string optional
status string optional
accountingvalue string optional

GET
{version}/profitsAndLosses/{accountCode}

Description

Profits And Losses - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

GET
{version}/capitalStandardModel

Description

Capital Standard Model - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
tempremidnumber string optional
vitremidnumber string optional
trimester string optional
tempexpsom string optional
vitexpsom string optional
tempremissom string optional
vitremissom string optional
status string optional

GET
{version}/capitalStandardModel/{commitmentCode}

Description

Capital Standard Model - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentcode string optional

GET
{version}/listOfCities

Description

List Of Cities - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
ibgecitycode string optional
providerregister string optional
stateacronym string optional

GET
{version}/listOfCities/{stateAcronym}

Description

List Of Cities - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
ibgecitycode string optional
providerregister string optional
_pathparam UndefinedUndefined
stateacronym string optional

GET
{version}/obligations

Description

Obligations - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
obligationcode string optional
providerregister string optional
obligationdescription string optional
seasonality string optional
obligationtype string optional
activeinactive string optional
duedatenotification string optional

GET
{version}/obligations/{obligationCode}

Description

Obligations - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
obligationcode string optional

GET
{version}/operators

Description

Operators - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
operatorcnpj string optional
providerregister string optional
operatormode string optional
legalnature string optional
tradename string optional
corporatename string optional
operatorsegmentation string optional

GET
{version}/operators/{operatorCnpj}

Description

Operators - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
operatorcnpj string optional

GET
{version}/liabilityTaxAccnt

Description

Liability Tax Accnt - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
accountcode string optional
commitmentyear string optional
monetaryupdate string optional
competencedate string optional
trimester string optional
balanceattheendofthe string optional
status string optional
initialvalue string optional
valuepaid string optional

GET
{version}/liabilityTaxAccnt/{accountCode}

Description

Liability Tax Accnt - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
accountcode string optional

GET
{version}/pecuniaryConsideration

Description

Pecuniary Consideration - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
counterpartcoverageperi string optional
plantype string optional
commitmentyear string optional
valuetoexpire string optional
receivedvalue string optional
trimester string optional
status string optional
duevalueinarrears string optional
netissuedvalue string optional

GET
{version}/pecuniaryConsideration/{counterpartCoveragePeri}

Description

Pecuniary Consideration - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
plantype string optional
commitmentyear string optional
_pathparam UndefinedUndefined
counterpartcoverageperi string optional

GET
{version}/provNetSinEvPesl

Description

Prov Net Sin Ev Pesl - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
evcorrassummajorper string optional
lastdaysassumcorrev string optional
greaterdangerlossevent string optional
latestdaysevents string optional
noofbeneficiaries string optional
trimester string optional
status string optional

GET
{version}/provNetSinEvPesl/{commitmentYear}

Description

Prov Net Sin Ev Pesl - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentyear string optional

GET
{version}/ansAccountPlan

Description

Ans Account Plan - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
providerregister string optional
accountcode string optional
validityenddate string optional
validitystartdate string optional
accountdescription string optional

GET
{version}/ansAccountPlan/{accountCode}

Description

Ans Account Plan - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
validityenddate string optional
validitystartdate string optional
_pathparam UndefinedUndefined
accountcode string optional

GET
{version}/products

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
healthinsurercode string optional
code string optional
wayofhiring string optional
marketsegmentation string optional
coveragearea string optional
description string optional
description string optional

GET
{version}/products/{healthInsuranceCode}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
fields string optional
_pathparam UndefinedUndefined
healthinsurancecode string optional

GET
{version}/charts

Description

Charts - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
diopschart string optional
chartreceived string optional
validatechart string optional

GET
{version}/charts/{diopsChart}

Description

Charts - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
diopschart string optional

GET
{version}/representatives

Description

Representatives - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
registrationofindividua string optional
providerregister string optional
addresscomplement string optional
district string optional
representativesposition string optional
ibgecitycode string optional
postaddrcode string optional
nationalcallingcd string optional
internationalcallinfcd string optional
idissuedate string optional
addressname string optional
representativesname string optional
idnumber string optional
addressnumber string optional
idissuingbody string optional
country string optional
extension string optional
stateacronym string optional
telephonenumber string optional

GET
{version}/representatives/{registrationOfIndividua}

Description

Representatives - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
_pathparam UndefinedUndefined
registrationofindividua string optional

GET
{version}/personsResponsible

Description

Persons Responsible - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
providerregister string optional
cpfcnpj string optional
responsibleleorindivid string optional
responsibilitytype string optional
namecorporatename string optional
recordnumber string optional

GET
{version}/personsResponsible/{responsibilityType}

Description

Persons Responsible - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
providerregister string optional
cpfcnpj string optional
responsibleleorindivid string optional
_pathparam UndefinedUndefined
responsibilitytype string optional

GET
{version}/activeBalanceAge

Description

Active Balance Age - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
financialduedate string optional
debwportfacquis string optional
mktonoperations string optional
debitswithoperators string optional
benefdepcontrapins string optional
eventclaimnetpres string optional
eventclaimnetsus string optional
otherdeboprwplan string optional
otherdebitstopay string optional
trimester string optional
hthcareservprov string optional
status string optional
billschargescollect string optional

GET
{version}/activeBalanceAge/{financialDueDate}

Description

Active Balance Age - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
financialduedate string optional

GET
{version}/transContrAmtSegr

Description

Trans Contr Amt Segr - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
benefitadmopercode string optional
obligationcode string optional
providerregister string optional
trimester string optional
status string optional
amt1stmthtrimester string optional
amt2ndmthtrimester string optional
amt3rdmthtrimester string optional

GET
{version}/transContrAmtSegr/{benefitAdmOperCode}

Description

Trans Contr Amt Segr - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
benefitadmopercode string optional

GET
{version}/liabilityBalanceAge

Description

Liability Balance Age - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
financialduedate string optional
collectivefloating string optional
collectivefixed string optional
beneficiariesoperationc string optional
postpaymentopercredit string optional
individualfloating string optional
individualfixed string optional
prepaymentoperatorscre string optional
othercreditswithplan string optional
othercrednotrelatplan string optional
partbenefineveclaim string optional
trimester string optional
status string optional

GET
{version}/liabilityBalanceAge/{financialDueDate}

Description

Liability Balance Age - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
financialduedate string optional

GET
{version}/liabilityAdequationTest

Description

Liability Adequation Test - Get Collection

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page string optional
pagesize string optional
fields string optional
order string optional
expand string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
plantype string optional
contractcancelrate string optional
biomtabadjustment string optional
cashflowadjestimation string optional
utiofrangesrn632003 string optional
estimatedmedicalinflati string optional
ettjintermethod string optional
averageadjustmentperva string optional
estimatedmaximumadjustm string optional
trimester string optional
status string optional

GET
{version}/liabilityAdequationTest/{planType}

Description

Liability Adequation Test - Get Single

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fields string optional
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
plantype string optional

POST
{version}/shareholders

Description

Shareholders - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/contractConsolidation

Description

Contract Consolidation - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/realEstGarAsset

Description

Real Est Gar Asset - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/monitOtherRemuneration

Description

monitOtherRemuneration - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/monitPresetValue

Description

monitPresetValue - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/analyticDmedExpenses

Description

Analytic Dmed Expenses - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/personsInCharge

Description

Persons In Charge - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/operatorsDiops

Description

Operators Diops - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/idssIndicators

Description

Idss Indicators - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/trimesterBalanceSheet

Description

Trimester Balance Sheet - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/monitForm

Description

monitForm - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/monitDirectSupply

Description

monitDirectSupply - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/beneficiaries/{subscriberId}/block

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
subscriberid string optional

POST
{version}/cooperCheckAccnt

Description

Cooper Check Accnt - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/beneficiaries/{subscriberId}/changerContract

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
subscriberid string optional

POST
{version}/assistanceCoverage

Description

Assistance Coverage - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/stipulatedContracts

Description

Stipulated Contracts - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/controlledAffiliates

Description

Controlled Affiliates - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/commitment

Description

Commitment - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/coresponsibilityGranted

Description

Coresponsibility Granted - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/premises

Description

Premises - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/indemnifiableEvents

Description

Indemnifiable Events - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/cashFlow

Description

Cash Flow - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/commonFunds

Description

Common Funds - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/beneficiaries

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/products

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/beneficiaries/batch/

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/profitsAndLosses

Description

Profits And Losses - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/capitalStandardModel

Description

Capital Standard Model - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/listOfCities

Description

List Of Cities - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/obligations

Description

Obligations - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/operators

Description

Operators - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/liabilityTaxAccnt

Description

Liability Tax Accnt - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/pecuniaryConsideration

Description

Pecuniary Consideration - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/provNetSinEvPesl

Description

Prov Net Sin Ev Pesl - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/ansAccountPlan

Description

Ans Account Plan - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/charts

Description

Charts - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/beneficiaries/{subscriberId}/unblock

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
subscriberid string optional

POST
{version}/representatives

Description

Representatives - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/personsResponsible

Description

Persons Responsible - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/activeBalanceAge

Description

Active Balance Age - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/transContrAmtSegr

Description

Trans Contr Amt Segr - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/liabilityBalanceAge

Description

Liability Balance Age - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
{version}/liabilityAdequationTest

Description

Liability Adequation Test - Post

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
{version}/shareholders/{shareholderSCpfCnpj}

Description

Shareholders - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
shareholderscpfcnpj string optional

PUT
{version}/contractConsolidation/{riskPool}

Description

Contract Consolidation - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
riskpool string optional

PUT
{version}/realEstGarAsset/{providerRegister}

Description

Real Est Gar Asset - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
realestategeneralregis string optional
commitmentyear string optional
_pathparam UndefinedUndefined
providerregister string optional

PUT
{version}/beneficiaries/{subscriberId}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
codecco string optional
_pathparam UndefinedUndefined
subscriberid string optional

PUT
{version}/products/{healthInsuranceCode}

Description

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
_pathparam UndefinedUndefined
healthinsurancecode string optional

PUT
{version}/analyticDmedExpenses/{expenseKey}

Description

Analytic Dmed Expenses - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
titleholderenrollment string optional
dependentssn string optional
dependentenrollment string optional
ssnholder string optional
period string optional
_pathparam UndefinedUndefined
expensekey string optional

PUT
{version}/personsInCharge/{uniqueKey}

Description

Persons In Charge - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
ssn string optional
_pathparam UndefinedUndefined
uniquekey string optional

PUT
{version}/operatorsDiops/{uniqueKey}

Description

Operators Diops - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
registernumber string optional
operatorcnpj string optional
_pathparam UndefinedUndefined
uniquekey string optional

PUT
{version}/idssIndicators/{uniqueKey}

Description

Idss Indicators - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
healthinsurercode string optional
referenceyear string optional
_pathparam UndefinedUndefined
uniquekey string optional

PUT
{version}/trimesterBalanceSheet/{accountCode}

Description

Trimester Balance Sheet - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

PUT
{version}/cooperCheckAccnt/{taxType}

Description

Cooper Check Accnt - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
taxname string optional
perioddate string optional
commitmentyear string optional
_pathparam UndefinedUndefined
taxtype string optional

PUT
{version}/assistanceCoverage/{typeOfPlan}

Description

Assistance Coverage - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
paymentorigin string optional
_pathparam UndefinedUndefined
typeofplan string optional

PUT
{version}/stipulatedContracts/{operatorRecordInAns}

Description

Stipulated Contracts - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
trimester string optional
_pathparam UndefinedUndefined
operatorrecordinans string optional

PUT
{version}/controlledAffiliates/{legalEntityNatRegister}

Description

Controlled Affiliates - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

PUT
{version}/commitment/{commitmentCode}

Description

Commitment - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
obligationcode string optional
providerregister string optional
referenceyear string optional
obligationtype string optional
_pathparam UndefinedUndefined
commitmentcode string optional

PUT
{version}/coresponsibilityGranted/{ansEventCode}

Description

Coresponsibility Granted - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
anseventcode string optional

PUT
{version}/premises/{legalEntityNatRegister}

Description

Premises - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
legalentitynatregister string optional

PUT
{version}/indemnifiableEvents/{eventCodeAns}

Description

Indemnifiable Events - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
eventcodeans string optional

PUT
{version}/cashFlow/{cashFlowCode}

Description

Cash Flow - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
status string optional
_pathparam UndefinedUndefined
cashflowcode string optional

PUT
{version}/commonFunds/{fundType}

Description

Common Funds - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
cnpjorfundansrec string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
fundtype string optional

PUT
{version}/profitsAndLosses/{accountCode}

Description

Profits And Losses - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
accountcode string optional

PUT
{version}/capitalStandardModel/{commitmentCode}

Description

Capital Standard Model - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentcode string optional

PUT
{version}/listOfCities/{stateAcronym}

Description

List Of Cities - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
ibgecitycode string optional
providerregister string optional
_pathparam UndefinedUndefined
stateacronym string optional

PUT
{version}/obligations/{obligationCode}

Description

Obligations - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
obligationcode string optional

PUT
{version}/operators/{operatorCnpj}

Description

Operators - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
operatorcnpj string optional

PUT
{version}/liabilityTaxAccnt/{accountCode}

Description

Liability Tax Accnt - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
accountcode string optional

PUT
{version}/pecuniaryConsideration/{counterpartCoveragePeri}

Description

Pecuniary Consideration - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
plantype string optional
commitmentyear string optional
_pathparam UndefinedUndefined
counterpartcoverageperi string optional

PUT
{version}/provNetSinEvPesl/{commitmentYear}

Description

Prov Net Sin Ev Pesl - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
commitmentyear string optional

PUT
{version}/ansAccountPlan/{accountCode}

Description

Ans Account Plan - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
validityenddate string optional
validitystartdate string optional
_pathparam UndefinedUndefined
accountcode string optional

PUT
{version}/charts/{diopsChart}

Description

Charts - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
diopschart string optional

PUT
{version}/representatives/{registrationOfIndividua}

Description

Representatives - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
_pathparam UndefinedUndefined
registrationofindividua string optional

PUT
{version}/personsResponsible/{responsibilityType}

Description

Persons Responsible - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
providerregister string optional
cpfcnpj string optional
responsibleleorindivid string optional
_pathparam UndefinedUndefined
responsibilitytype string optional

PUT
{version}/activeBalanceAge/{financialDueDate}

Description

Active Balance Age - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentcode string optional
obligationcode string optional
providerregister string optional
commitmentyear string optional
_pathparam UndefinedUndefined
financialduedate string optional

PUT
{version}/transContrAmtSegr/{benefitAdmOperCode}

Description

Trans Contr Amt Segr - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
benefitadmopercode string optional

PUT
{version}/liabilityBalanceAge/{financialDueDate}

Description

Liability Balance Age - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
financialduedate string optional

PUT
{version}/liabilityAdequationTest/{planType}

Description

Liability Adequation Test - PUT

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
commitmentyear string optional
commitmentcode string optional
obligationcode string optional
providerregister string optional
_pathparam UndefinedUndefined
plantype string optional