Registry

documento /v3/api docs/registry · pacote generated/registry · 133 operações método do sdk descrição http caminho escopo exigido corpo departmentcontrollercreate cadastra um novo departamento post /api/registry/departments manage departments departmentrequest departmentcontrollerdelete remove um departamento delete /api/registry/departments/{id} manage departments — departmentcontrollerfindall lista os departamentos get /api/registry/departments read registry — departmentcontrollerfindbyid retorna um departamento pelo identificador get /api/registry/departments/{id} read registry — departmentcontrollerupdate atualiza um departamento existente put /api/registry/departments/{id} manage departments departmentrequest dependentcontrollerofemployee — get /api/registry/employees/{employeeid}/dependents manage employee dependent — dependentcontrollerregister — post /api/registry/employees/{employeeid}/dependents manage employee dependent dependentrequest employeecontrollercreate cadastra um novo funcionário post /api/registry/employees manage departments employeerequest employeecontrollerfindall lista os funcionários get /api/registry/employees manage departments — employeecontrollerfindbyid retorna um funcionário pelo identificador get /api/registry/employees/{id} manage departments — employeecontrolleroptions lista os funcionários como opções de seleção get /api/registry/employees/options read registry — employeecontrollerupdate atualiza um funcionário existente put /api/registry/employees/{id} manage departments employeerequest employeepersonaldatacontrollerfind — get /api/registry/employees/{employeeid}/personal data manage employee personal data — employeepersonaldatacontrollersave — put /api/registry/employees/{employeeid}/personal data manage employee personal data employeepersonaldatarequest employeephotocontrollercontent — get /api/registry/employees/{employeeid}/photo/content manage departments — employeephotocontrollercurrent — get /api/registry/employees/{employeeid}/photo manage departments — employeephotocontrollerremove — delete /api/registry/employees/{employeeid}/photo manage departments — employeephotocontrollerupload — post /api/registry/employees/{employeeid}/photo manage departments — externalvacancycontrolleropen — get /api/registry/external/vacancies submit vacancy application — externalvacancycontrollersubmit — post /api/registry/external/vacancies/{processid}/applications submit vacancy application submission externalvacancycontrollertrack — get /api/registry/external/vacancies/applications/{trackingtoken} submit vacancy application — partnercontrolleraddaddress adiciona um endereço a um parceiro post /api/registry/partners/{id}/addresses manage partner partneraddressrequest partnercontrolleraddcontact adiciona um contato a um parceiro post /api/registry/partners/{id}/contacts manage partner partnercontactrequest partnercontrolleraddrole adiciona um papel a um parceiro post /api/registry/partners/{id}/roles manage partner — partnercontrollercreate cadastra um novo parceiro (cliente ou fornecedor) post /api/registry/partners manage partner partnerrequest partnercontrollerdelete inativa um parceiro pelo identificador delete /api/registry/partners/{id} manage partner — partnercontrollerenrich enriquece um parceiro com dados públicos do cnpj post /api/registry/partners/{id}/enrich manage partner — partnercontrollerfindall lista os parceiros get /api/registry/partners read registry — partnercontrollerfindbyid retorna um parceiro pelo identificador get /api/registry/partners/{id} read registry — partnercontrollerfindbyroot lista os parceiros pela raiz do cnpj get /api/registry/partners/by root/{root} read registry — partnercontrollerfindbytaxid retorna o parceiro pelo cnpj ou cpf, com ou sem pontuação get /api/registry/partners/by tax id read registry — partnercontrollergetaddresses lista os endereços de um parceiro get /api/registry/partners/{id}/addresses read registry — partnercontrollergetcontacts lista os contatos de um parceiro get /api/registry/partners/{id}/contacts read registry — partnercontrollerlookup consulta parceiros por critérios de busca post /api/registry/partners/lookup read registry — partnercontrollerregeocodeaddress recalcula as coordenadas geográficas de um endereço de parceiro post /api/registry/partners/addresses/{addressid}/geocode manage partner — partnercontrollerremoveaddress remove um endereço do parceiro delete /api/registry/partners/addresses/{addressid} manage partner — partnercontrollerremovecontact remove um contato do parceiro delete /api/registry/partners/contacts/{contactid} manage partner — partnercontrollerrestore reativa um parceiro post /api/registry/partners/{id}/restore manage partner — partnercontrollerupdate atualiza os dados de um parceiro existente put /api/registry/partners/{id} manage partner partnerrequest partnercontrollerupdateaddress atualiza um endereço do parceiro put /api/registry/partners/addresses/{addressid} manage partner partneraddressrequest partnercontrollerupdatecontact atualiza um contato do parceiro put /api/registry/partners/contacts/{contactid} manage partner partnercontactrequest partnergroupcontrollercreate cadastra um novo grupo de parceiros post /api/registry/partner groups manage partner partnergrouprequest partnergroupcontrollerdelete remove um grupo de parceiros delete /api/registry/partner groups/{id} manage partner — partnergroupcontrollerfindall lista os grupos de parceiros get /api/registry/partner groups read registry — partnergroupcontrollerfindbyid retorna um grupo de parceiros pelo identificador get /api/registry/partner groups/{id} read registry — partnergroupcontrollerfindpartners — get /api/registry/partner groups/{id}/partners read registry — partnergroupcontrollerupdate atualiza um grupo de parceiros existente put /api/registry/partner groups/{id} manage partner partnergrouprequest paymentconditioncontrollercreate cadastra uma nova condição de pagamento post /api/registry/payment conditions manage partner paymentconditionrequest paymentconditioncontrollerdeactivate desativa uma condição de pagamento delete /api/registry/payment conditions/{id} manage partner — paymentconditioncontrollerfindall lista as condições de pagamento get /api/registry/payment conditions read registry — paymentconditioncontrollerfindbyid retorna uma condição de pagamento pelo identificador get /api/registry/payment conditions/{id} read registry — paymentconditioncontrollerupdate atualiza uma condição de pagamento put /api/registry/payment conditions/{id} manage partner paymentconditionrequest positioncertificationcontrollerattach — post /api/registry/positions/{positionid}/certifications manage departments positioncertificationrequest positioncertificationcontrollerdetach — delete /api/registry/positions/{positionid}/certifications/{certificationid} manage departments — positioncertificationcontrollerfindall — get /api/registry/positions/{positionid}/certifications read registry — positioncertificationcontrollerupdate — put /api/registry/positions/{positionid}/certifications/{certificationid} manage departments positioncertificationrequest positioncontrollercreate cadastra um novo cargo no organograma post /api/registry/positions manage departments positionrequest positioncontrollerdeactivate desativa um cargo delete /api/registry/positions/{id} manage departments — positioncontrollerfindall lista os cargos get /api/registry/positions read registry — positioncontrollerfindbyid retorna um cargo pelo identificador get /api/registry/positions/{id} read registry — positioncontrollersetparent reposiciona um cargo na hierarquia organizacional put /api/registry/positions/{id}/parent manage departments positionparentrequest positioncontrollerupdate atualiza um cargo put /api/registry/positions/{id} manage departments positionrequest positiondutycontrollerfindall — get /api/registry/positions/{positionid}/duties read registry — positiondutycontrollerreplace — put /api/registry/positions/{positionid}/duties manage departments positiondutiesrequest positionprofilecontrollerattach — post /api/registry/positions/{positionid}/competencies manage departments positioncompetencyrequest positionprofilecontrollercopydraft — get /api/registry/positions/{positionid}/competencies/copy draft read registry — positionprofilecontrollerdetach — delete /api/registry/positions/{positionid}/competencies/{linkid} manage departments — positionprofilecontrollerfindall — get /api/registry/positions/{positionid}/competencies read registry — positionprofilecontrollerupdate — put /api/registry/positions/{positionid}/competencies/{linkid} manage departments positioncompetencyrequest pricetablecontrolleradditem adiciona um item a uma tabela de preço post /api/registry/price tables/{id}/items manage price table pricetableitemrequest pricetablecontrolleraddtarget adiciona um alvo de aplicação a uma tabela de preço post /api/registry/price tables/{id}/targets manage price table pricetabletargetrequest pricetablecontrolleradjust reajusta todos os preços da tabela por um percentual post /api/registry/price tables/{id}/adjust manage price table — pricetablecontrolleradjustbatch reajusta várias tabelas de preço por um mesmo percentual post /api/registry/price tables/adjust batch manage price table — pricetablecontrolleradjustbatchapply aplica o reajuste em lote a várias tabelas de preço post /api/registry/price tables/adjust batch/apply manage price table — pricetablecontrolleradjustbatchpreview simula o reajuste em lote de várias tabelas de preço post /api/registry/price tables/adjust batch/preview manage price table — pricetablecontrolleradjustbyindexreference reajusta os preços da tabela pela variação de um índice no período post /api/registry/price tables/{id}/adjust by index manage price table — pricetablecontrollercreate cadastra uma nova tabela de preço post /api/registry/price tables manage price table pricetablerequest pricetablecontrollercsvimporthistory lista o histórico de importações csv de uma tabela de preço get /api/registry/price tables/{id}/csv imports read registry — pricetablecontrollerdelete inativa uma tabela de preços delete /api/registry/price tables/{id} manage price table — pricetablecontrollerduplicate duplica uma tabela de preço com seus itens e alvos post /api/registry/price tables/{id}/duplicate manage price table — pricetablecontrollerfindall lista as tabelas de preço get /api/registry/price tables read registry — pricetablecontrollerfindbyid retorna uma tabela de preço pelo identificador get /api/registry/price tables/{id} read registry — pricetablecontrollergetitems lista os itens de uma tabela de preço get /api/registry/price tables/{id}/items read registry — pricetablecontrollergettargets lista os alvos de aplicação de uma tabela de preço get /api/registry/price tables/{id}/targets read registry — pricetablecontrollergetversions lista as versões de uma tabela de preço get /api/registry/price tables/{id}/versions read registry — pricetablecontrollerimportcsv importa itens de uma tabela de preço via arquivo csv post /api/registry/price tables/{id}/import csv manage price table — pricetablecontrollerindexvariation retorna a variação acumulada de um índice no período get /api/registry/price tables/index variation manage price table — pricetablecontrollerpublish publica a tabela de preço, gerando uma nova versão post /api/registry/price tables/{id}/publish manage price table — pricetablecontrollerremoveitem remove um item de uma tabela de preços delete /api/registry/price tables/items/{itemid} manage price table — pricetablecontrollerremovetarget remove um público alvo de uma tabela de preços delete /api/registry/price tables/targets/{targetid} manage price table — pricetablecontrollerresolveforpartner resolve a tabela de preço aplicável a um parceiro get /api/registry/price tables/resolve read registry — pricetablecontrollerrestore reativa uma tabela de preço post /api/registry/price tables/{id}/restore manage price table — pricetablecontrollerupdate atualiza uma tabela de preços put /api/registry/price tables/{id} manage price table pricetablerequest pricetablecontrollerupdatefromcost recalcula os preços da tabela a partir do custo padrão com markup post /api/registry/price tables/{id}/update from cost manage price table pricetablecostupdaterequest pricetablecontrollerupdatefromcosthistory lista o histórico de atualizações por custo de uma tabela de preço get /api/registry/price tables/{id}/update from cost/history read registry — pricetablecontrollerupdateitem atualiza um item de uma tabela de preços put /api/registry/price tables/items/{itemid} manage price table pricetableitemrequest pricetableitemtiercontrolleradd adiciona uma faixa de quantidade a um item da tabela de preço post /api/registry/price tables/items/{itemid}/tiers manage price table pricetableitemtierrequest pricetableitemtiercontrollerlist lista as faixas de quantidade de um item da tabela de preço get /api/registry/price tables/items/{itemid}/tiers read registry — pricetableitemtiercontrollerremove remove uma faixa de quantidade de um item da tabela de preços delete /api/registry/price tables/tiers/{tierid} manage price table — pricetableitemtiercontrollerupdate atualiza uma faixa de quantidade de um item da tabela de preços put /api/registry/price tables/tiers/{tierid} manage price table pricetableitemtierrequest productcontrolleraddimage adiciona uma imagem ao produto post /api/registry/products/{id}/images manage product productimagerequest productcontrollercreate cadastra um novo produto post /api/registry/products manage product productrequest productcontrollerdelete inativa um produto delete /api/registry/products/{id} manage product — productcontrollerduplicate duplica um produto sob um novo código interno post /api/registry/products/{id}/duplicate manage product — productcontrollerfindall lista os produtos get /api/registry/products read registry — productcontrollerfindbybarcode retorna um produto pelo código de barras get /api/registry/products/by barcode/{barcode} read registry — productcontrollerfindbyid retorna um produto pelo identificador get /api/registry/products/{id} read registry — productcontrollergetcodes lista os códigos de um produto get /api/registry/products/{id}/codes read registry — productcontrollergetimages lista as imagens de um produto get /api/registry/products/{id}/images read registry — productcontrollerremoveimage remove uma imagem de um produto delete /api/registry/products/images/{imageid} manage product — productcontrollerrestore reativa um produto post /api/registry/products/{id}/restore manage product — productcontrollersetcodes substitui os códigos (gtin/ean) de um produto put /api/registry/products/{id}/codes manage product productcoderequest productcontrollersetprimaryimage define a imagem principal de um produto put /api/registry/products/images/{imageid}/primary manage product — productcontrollerupdate atualiza um produto existente put /api/registry/products/{id} manage product productrequest productgroupcontrollercreate cadastra um novo grupo de produtos post /api/registry/product groups manage product productgrouprequest productgroupcontrollerdelete inativa um grupo de produtos delete /api/registry/product groups/{id} manage product — productgroupcontrollerfindall lista os grupos de produtos get /api/registry/product groups read registry — productgroupcontrollerfindbyid retorna um grupo de produtos pelo identificador get /api/registry/product groups/{id} read registry — productgroupcontrollerrestore reativa um grupo de produtos post /api/registry/product groups/{id}/restore manage product — productgroupcontrollerupdate atualiza um grupo de produtos put /api/registry/product groups/{id} manage product productgrouprequest productunitcontrollercreate cadastra uma nova unidade de medida do produto post /api/registry/product units manage product productunitrequest productunitcontrollerdelete remove uma unidade de medida de um produto delete /api/registry/product units/{id} manage product — productunitcontrollerfindbyproduct lista as unidades de medida de um produto get /api/registry/product units read registry — productunitcontrollerupdate atualiza uma unidade de medida de um produto put /api/registry/product units/{id} manage product productunitrequest projectcontrollercreate cadastra um novo projeto post /api/registry/projects manage projects projectrequest projectcontrollerdelete remove um projeto (bloqueado se estiver em uso) delete /api/registry/projects/{id} manage projects — projectcontrollerfindall lista os projetos get /api/registry/projects read registry — projectcontrollerfindbyid retorna um projeto pelo identificador get /api/registry/projects/{id} read registry — projectcontrollerupdate atualiza um projeto existente put /api/registry/projects/{id} manage projects projectrequest salarybandcontrollercreate — post /api/registry/positions/{positionid}/salary bands manage departments salarybandrequest salarybandcontrollereffectiveat — get /api/registry/positions/{positionid}/salary bands/effective read salary band — salarybandcontrollerfindall — get /api/registry/positions/{positionid}/salary bands read salary band — salarybandcontrollerupdate — put /api/registry/positions/{positionid}/salary bands/{bandid} manage departments salarybandrequest corpos de requisição departmentrequest campo tipo obrigatório observação attachmentallowedmimetypes string — máx 1000 attachmentmaxsizebytes integer (int64) — — code string sim máx 32 defaultcostcenterid string (uuid) — — level string — superintendency · management · supervision manageremployeeid string (uuid) — — name string sim máx 200 parentdepartmentid string (uuid) — — dependentrequest campo tipo obrigatório observação birthdate string (date) — — document string — — esocialtype string — — name string — — employeepersonaldatarequest campo tipo obrigatório observação birthcountryid string (uuid) — — birthdate string (date) — — ctpsnumber string — — ctpsseries string — — ctpsstate string — — disabilityhearing boolean — — disabilityintellectual boolean — — disabilitymental boolean — — disabilitynote string — — disabilityphysical boolean — — disabilityquotacounted boolean — — disabilityvisual boolean — — maritalstatus string — single · married · divorced · separated · widowed nationalitycountryid string (uuid) — — pisnis string — — racecolor string — white · black · mixed · asian · indigenous · not informed rehabilitated boolean — — socialname string — — employeerequest campo tipo obrigatório observação appuserid string (uuid) — — document string sim máx 20 email string — máx 200 name string sim máx 200 status string — active · inactive partneraddressrequest campo tipo obrigatório observação city string — máx 120 cityid string (uuid) — — complement string — máx 120 country string — máx 60 countryid string (uuid) — — district string — máx 120 latitude number — — longitude number — — main boolean — — number string — máx 20 regionid string (uuid) — — state string — máx 2 street string — máx 200 type string sim main · billing · shipping zipcode string — máx 12 partnercontactrequest campo tipo obrigatório observação city string — máx 120 complement string — máx 120 country string — máx 60 district string — máx 120 email string — máx 160 jobtitle string — máx 80 main boolean — — name string sim máx 160 number string — máx 20 phone string — máx 32 state string — máx 60 street string — máx 200 zipcode string — máx 12 partnergrouprequest campo tipo obrigatório observação description string — máx 512 name string sim máx 160 type string sim economic group · segment · profile partnerrequest campo tipo obrigatório observação address partneraddressrequest — — appuserid string (uuid) — — businessunitids string\[] — — cnaecode string — máx 16 companysize string — mei · me · epp · medium · large creditnotes string — máx 500 creditrating string — máx 16 creditscore integer (int32) — — defaultpaymentmethod string — cash · pix · bank slip · bank transfer · credit card · debit card · check email string sim máx 160 employeecount integer (int32) — — fiscalclassification string — icms taxpayer · icms exempt · non taxpayer foundeddate string (date) — — legalnature string — máx 120 municipalregistration string — máx 32 name string sim máx 200 partnergroupid string (uuid) — — persontype string sim individual · company phone string — máx 32 preferreddeliverytype string — máx 40 registrationstatus string — máx 32 roles string\[] — — routeid string (uuid) — — salespotential string — low · medium · high simplesnacionalannex string — anexo iii · anexo iv · anexo v stateregistration string — máx 32 taxid string sim máx 18 taxregime string — simples nacional · lucro presumido · lucro real · mei · imune isento tradename string — máx 200 paymentconditioninstallmentrequest campo tipo obrigatório observação daysoffset integer (int32) — — percentage number sim — paymentconditionrequest campo tipo obrigatório observação active boolean — — code string sim máx 32 description string — máx 512 installments paymentconditioninstallmentrequest \[] sim — name string sim máx 160 positioncertificationrequest campo tipo obrigatório observação issuer string — máx 200 mandatory boolean — — name string sim máx 200 validitymonths integer (int32) — — positioncompetencyrequest campo tipo obrigatório observação competencyid string (uuid) sim — mandatory boolean — — requiredlevel integer (int32) sim mín 1 weight number — — positiondutiesrequest campo tipo obrigatório observação descriptions string\[] sim — positionparentrequest campo tipo obrigatório observação parentpositionid string (uuid) — — positionrequest campo tipo obrigatório observação attachmentallowedmimetypes string — máx 1000 attachmentmaxsizebytes integer (int64) — — description string — máx 400 name string sim máx 200 parentpositionid string (uuid) — — pricetablecostupdaterequest campo tipo obrigatório observação defaultfactor number sim — mode string sim markup · margin overridesbygroup object — — preview boolean — — roundingpolicy string — half up · psychological 99 · nearest tenth · nearest half pricetableitemrequest campo tipo obrigatório observação minprice number — — price number sim — productid string (uuid) sim — pricetableitemtierrequest campo tipo obrigatório observação minprice number — — minqty number sim — price number sim — pricetablerequest campo tipo obrigatório observação name string sim máx 160 paymentconditionid string (uuid) — — paymenttermdays integer (int32) — — type string sim sale · purchase validfrom string (date) sim — validto string (date) — — validityenforcement string — block · warn pricetabletargetrequest campo tipo obrigatório observação targetref string sim máx 64 targettype string sim region · state · route · partner profile · partner · product group productcoderequest campo tipo obrigatório observação code string sim máx 40 partnerid string (uuid) — — type string sim gtin · ean · supplier code productgrouprequest campo tipo obrigatório observação name string sim máx 160 parentgroupid string (uuid) — — type string sim group · family · genus productimagerequest campo tipo obrigatório observação attachmentid string (uuid) sim — filename string — máx 512 primary boolean — — productrequest campo tipo obrigatório observação cest string — máx 16 classificationnodeid string (uuid) — — description string sim máx 200 federalsupplycode string — máx 16 internalcode string sim máx 40 maxstockquantity number — — minstockquantity number — — ncm string — máx 16 productgroupid string (uuid) — — stocknature string — merchandise · rental · supply · internal use tracksexpiry boolean — — trackslot boolean — — tracksserial boolean — — type string — product · service · raw material unitofmeasure string — máx 12 productunitrequest campo tipo obrigatório observação conversionfactor number sim — description string — máx 120 packagingkind string — pair · dozen · pack · box · pallet productid string (uuid) sim — unitcode string sim máx 16 projectrequest campo tipo obrigatório observação code string sim máx 32 contractid string (uuid) — — customerpartnerid string (uuid) — — enddate string (date) — — manageremployeeid string (uuid) — — name string sim máx 200 notes string — máx 1000 startdate string (date) — — status string — planned · active · suspended · completed · cancelled salarybandrequest campo tipo obrigatório observação currency string — máx 3 grade string sim máx 32 maxamount number sim — midamount number — — minamount number sim — validfrom string (date) sim — validto string (date) — — submission campo tipo obrigatório observação birthdate string (date) — — city string — máx 120 consented boolean — — document string — máx 32 educationlevel string — primary · secondary · technical · bachelor · postgraduate · master · doctorate email string — máx 200 experienceyears integer (int32) — mín 0 · máx 80 name string sim máx 200 phone string — máx 32 salaryexpectation number — mín 0 state string — máx 2