Skip to main content

Totvs

Connect with Totvs standard message API.

Totvs Logo

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})

Available Actions

This connector provides 2300 actions:

ActionPurposeParameters
ecommercecustomer_v1_000/get_customersRetorna uma lista com todos os clientes E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommerceorder_v1_000/get_ordersRetorna uma lista com todos os pedidos de E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string)
branchId (string)
lastChange (string)
ecommerceproductbrand_v1_000/get_productbrandsRetorna uma lista com todas as Marcas de Produto E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommerceproductcategory_v1_000/get_productcategoriesRetorna uma lista com todas as Categorias de Produto E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommerceproductroot_v1_000/get_productrootsRetorna uma lista com todos Produtos Raiz E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommerceproductskuspecification_v1_000/get_productskuspecificationsRetorna uma lista com todas as Especificações de Produto SKU E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommerceproductsku_v1_000/get_productskusRetorna uma lista com todos os Produtos SKU E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommercestockproduct_v1_000/get_stockproductsRetorna uma lista com todos os Estoque de Produto SKU E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
ecommercetraceabilitydocuments_v1_000/get_documentsRetorna uma lista com todos os Documentos de rastreio de Pedidos E-CommerceAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
lastChange (string)
representative_v1_000/get_representativeRetorna lista completa dos Representantes.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
representative_v1_000/post_representativeMétodo não implementado.data (undefined) required
representative_v1_000/get_representative_by_internal_idRetorna o Representante pelo InternalId.InternalId (string)
Authorization (string) required
fields (string)
representative_v1_000/put_representative_by_internal_idMétodo não implementado.InternalId (string)
Authorization (string) required
fields (string)
data (undefined) required
representative_v1_000/delete_representative_by_internal_idMétodo não implementado.InternalId (string)
Authorization (string) required
gps/accommodationtype_v1_000/get_accommodation_types_by_codeRetorna dados de classe hospitalarcode (integer)
gps/accommodationtype_v1_000/delete_accommodation_types_by_codeExclui classe hospitalarcode (integer)
gps/accommodationtype_v1_000/put_accommodation_types_by_codeAtualiza um registro existente de classe hospitalarcode (integer)
data: {
. code (integer)
. description (string)
. hierarchicalLevel (integer)
. repaymentFactorFees (number)
. ptuAccommodationCode (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/accommodationtype_v1_000/get_accommodation_typesBusca dados de classe hospitalar existentescodeInitial (integer)
codeFinal (integer)
hierarchicalLevelInitial (integer)
hierarchicalLevelFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/accommodationtype_v1_000/post_accommodation_typesInclui um novo registro de classe hospitalardata: {
. code (integer)
. description (string)
. hierarchicalLevel (integer)
. repaymentFactorFees (number)
. ptuAccommodationCode (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/attachmenttype_v1_000/get_attachment_types_by_codeRetorna dados de tipo de documentoscode (integer)
gps/attachmenttype_v1_000/delete_attachment_types_by_codeExclui tipo de documentoscode (integer)
gps/attachmenttype_v1_000/put_attachment_types_by_codeAtualiza um registro existente de tipo de documentoscode (integer)
data: {
. code (integer)
. description (string)
. firedRetired (boolean)
. updateDate (string)
. updateUser (string)
} (object) required
gps/attachmenttype_v1_000/get_attachment_typesBusca dados de tipo de documentos existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/attachmenttype_v1_000/post_attachment_typesInclui um novo registro de tipo de documentosdata: {
. code (integer)
. description (string)
. firedRetired (boolean)
. updateDate (string)
. updateUser (string)
} (object) required
gps/beneficiarycardnumberstatus_v1_000/get_beneficiary_card_number_status_by_codeRetorna dados de situação do documento de identificação do beneficiáriocode (integer)
gps/beneficiarycardnumberstatus_v1_000/delete_beneficiary_card_number_status_by_codeExclui situação do documento de identificação do beneficiáriocode (integer)
gps/beneficiarycardnumberstatus_v1_000/put_beneficiary_card_number_status_by_codeAtualiza um registro existente de situação do documento de identificação do beneficiáriocode (integer)
data: {
. code (integer)
. description (string)
. status (boolean)
. chargeNewCopy (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/beneficiarycardnumberstatus_v1_000/get_beneficiary_card_number_statusBusca dados de situação do documento de identificação do beneficiário existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/beneficiarycardnumberstatus_v1_000/post_beneficiary_card_number_statusInclui um novo registro de situação do documento de identificação do beneficiáriodata: {
. code (integer)
. description (string)
. status (boolean)
. chargeNewCopy (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/beneficiarystatus_v1_000/get_beneficiary_status_by_codeRetorna dados de situação do beneficiáriocode (integer)
gps/beneficiarystatus_v1_000/delete_beneficiary_status_by_codeExclui situação do beneficiáriocode (integer)
gps/beneficiarystatus_v1_000/put_beneficiary_status_by_codeAtualiza um registro existente de situação do beneficiáriocode (integer)
data: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/beneficiarystatus_v1_000/get_beneficiary_statusBusca dados de situação do beneficiário existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/beneficiarystatus_v1_000/post_beneficiary_statusInclui um novo registro de situação do beneficiáriodata: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/contractstatus_v1_000/get_contract_status_by_codeRetorna dados de situação do contratocode (integer)
gps/contractstatus_v1_000/delete_contract_status_by_codeExclui situação do contratocode (integer)
gps/contractstatus_v1_000/put_contract_status_by_codeAtualiza um registro existente de situação do contratocode (integer)
data: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/contractstatus_v1_000/get_contract_statusBusca dados de situação do contrato existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/contractstatus_v1_000/post_contract_statusInclui um novo registro de situação do contratodata: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/copaymenttype_v1_000/get_copayment_types_by_codeRetorna dados de tipo de participaçãocode (integer)
gps/copaymenttype_v1_000/delete_copayment_types_by_codeExclui tipo de participaçãocode (integer)
gps/copaymenttype_v1_000/put_copayment_types_by_codeAtualiza um registro existente de tipo de participaçãocode (integer)
data: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/copaymenttype_v1_000/get_copayment_typesBusca dados de tipo de participação existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/copaymenttype_v1_000/post_copayment_typesInclui um novo registro de tipo de participaçãodata: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/coveragemodulegroup_v1_000/get_coverage_module_groups_by_codeRetorna dados de grupo de móduloscode (integer)
gps/coveragemodulegroup_v1_000/delete_coverage_module_groups_by_codeExclui grupo de móduloscode (integer)
gps/coveragemodulegroup_v1_000/put_coverage_module_groups_by_codeAtualiza um registro existente de grupo de móduloscode (integer)
data: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/coveragemodulegroup_v1_000/get_coverage_module_groupsBusca dados de grupo de módulos existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/coveragemodulegroup_v1_000/post_coverage_module_groupsInclui um novo registro de grupo de módulosdata: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/coveragemodule_v1_000/get_coverage_modules_by_codeRetorna dados de módulos de coberturacode (integer)
gps/coveragemodule_v1_000/delete_coverage_modules_by_codeExclui módulos de coberturacode (integer)
gps/coveragemodule_v1_000/put_coverage_modules_by_codeAtualiza um registro existente de módulos de coberturacode (integer)
data: {
. code (integer)
. description (string)
. moduleType (string)
. requireMedicalProcedure (boolean)
. controlProcedureWaitingPeriod (string)
. controlSuppliesWaitingPeriod (string)
. externalHealthInsuranceProduct (boolean)
. identifyCoverageModuleSIP (boolean)
. sosCoverageModule (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/coveragemodule_v1_000/get_coverage_modulesBusca dados de módulos de cobertura existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/coveragemodule_v1_000/post_coverage_modulesInclui um novo registro de módulos de coberturadata: {
. code (integer)
. description (string)
. moduleType (string)
. requireMedicalProcedure (boolean)
. controlProcedureWaitingPeriod (string)
. controlSuppliesWaitingPeriod (string)
. externalHealthInsuranceProduct (boolean)
. identifyCoverageModuleSIP (boolean)
. sosCoverageModule (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/creditstatus_v1_000/get_credit_status_by_codeRetorna dados de situação da análise de créditocode (integer)
gps/creditstatus_v1_000/delete_credit_status_by_codeExclui situação da análise de créditocode (integer)
gps/creditstatus_v1_000/put_credit_status_by_codeAtualiza um registro existente de situação da análise de créditocode (integer)
data: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/creditstatus_v1_000/get_credit_statusBusca dados de situação da análise de crédito existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/creditstatus_v1_000/post_credit_statusInclui um novo registro de situação da análise de créditodata: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/fingerprints_v1_000/get_fingerprints_by_card_number_by_positionRetorna a biometria cadastrada para o beneficiário na posição dedo indicadacardNumber (integer)
position (integer)
gps/fingerprints_v1_000/get_fingerprints_by_card_numberRetorna todas as biometrias cadastradas para o beneficiáriocardNumber (integer)
gps/fingerprints_v1_000/post_fingerprintsCria um novo registro de biometria para o beneficiário. Será atualizado caso já exista para a posição dedo indicadadata: {
. cardNumber (integer)
. finger (integer)
. fingerprint (string)
} (object) required
gps/healthcondition_v1_000/get_health_conditions_by_codeRetorna dados de condição de saúdecode (integer)
gps/healthcondition_v1_000/delete_health_conditions_by_codeExclui condição de saúdecode (integer)
gps/healthcondition_v1_000/put_health_conditions_by_codeAtualiza um registro existente de condição de saúdecode (integer)
data: {
. code (integer)
. description (string)
. isCid (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/healthcondition_v1_000/get_health_conditionsBusca dados de condição de saúde existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/healthcondition_v1_000/post_health_conditionsInclui um novo registro de condição de saúdedata: {
. code (integer)
. description (string)
. isCid (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/healthprovidergroup_v1_000/get_health_provider_groups_by_codeRetorna dados de grupo de prestadorescode (integer)
gps/healthprovidergroup_v1_000/delete_health_provider_groups_by_codeExclui grupo de prestadorescode (integer)
gps/healthprovidergroup_v1_000/put_health_provider_groups_by_codeAtualiza um registro existente de grupo de prestadorescode (integer)
data: {
. code (integer)
. description (string)
. divideInvoiceMainAuxiliaryAct (boolean)
. divideInvoiceServiceTax (boolean)
. generateProviderPaymentBill (boolean)
. sendEsocial (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/healthprovidergroup_v1_000/get_health_provider_groupsBusca dados de grupo de prestadores existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/healthprovidergroup_v1_000/post_health_provider_groupsInclui um novo registro de grupo de prestadoresdata: {
. code (integer)
. description (string)
. divideInvoiceMainAuxiliaryAct (boolean)
. divideInvoiceServiceTax (boolean)
. generateProviderPaymentBill (boolean)
. sendEsocial (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/healthproviderrelationtype_v1_000/get_health_provider_relation_types_by_codeRetorna dados de tipo de vinculos dos prestadorescode (integer)
gps/healthproviderrelationtype_v1_000/delete_health_provider_relation_types_by_codeExclui tipo de vinculos dos prestadorescode (integer)
gps/healthproviderrelationtype_v1_000/put_health_provider_relation_types_by_codeAtualiza um registro existente de tipo de vinculos dos prestadorescode (integer)
data: {
. code (integer)
. description (string)
. workType (boolean)
. medicalSpecialtyNumber (integer)
. considerBond (boolean)
. administrativeRegister (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/healthproviderrelationtype_v1_000/get_health_provider_relation_typesBusca dados de tipo de vinculos dos prestadores existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/healthproviderrelationtype_v1_000/post_health_provider_relation_typesInclui um novo registro de tipo de vinculos dos prestadoresdata: {
. code (integer)
. description (string)
. workType (boolean)
. medicalSpecialtyNumber (integer)
. considerBond (boolean)
. administrativeRegister (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/icd10_v1_000/get_icd10_by_codeRetorna dados de tabela de manutenção cid-10code (string)
gps/icd10_v1_000/delete_icd10_by_codeExclui tabela de manutenção cid-10code (string)
gps/icd10_v1_000/put_icd10_by_codeAtualiza um registro existente de tabela de manutenção cid-10code (string)
data: {
. code (string)
. description (string)
. shortDescription (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/icd10_v1_000/get_icd10Busca dados de tabela de manutenção cid-10 existentescodeInitial (string)
codeFinal (string)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/icd10_v1_000/post_icd10Inclui um novo registro de tabela de manutenção cid-10data: {
. code (string)
. description (string)
. shortDescription (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/indexincreasetype_v1_000/get_index_increase_types_by_codeRetorna dados de tipo de índice de reajustecode (integer)
gps/indexincreasetype_v1_000/delete_index_increase_types_by_codeExclui tipo de índice de reajustecode (integer)
gps/indexincreasetype_v1_000/put_index_increase_types_by_codeAtualiza um registro existente de tipo de índice de reajustecode (integer)
data: {
. code (integer)
. description (string)
. defaultPercentage (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/indexincreasetype_v1_000/get_index_increase_typesBusca dados de tipo de índice de reajuste existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/indexincreasetype_v1_000/post_index_increase_typesInclui um novo registro de tipo de índice de reajustedata: {
. code (integer)
. description (string)
. defaultPercentage (boolean)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/medicalspecialty_v1_000/get_medical_specialties_by_codeRetorna dados de tabela de especialidades medicascode (integer)
gps/medicalspecialty_v1_000/delete_medical_specialties_by_codeExclui tabela de especialidades medicascode (integer)
gps/medicalspecialty_v1_000/put_medical_specialties_by_codeAtualiza um registro existente de tabela de especialidades medicascode (integer)
data: {
. code (integer)
. description (string)
. complementaryDescription (string)
. medicalBoardCode (integer)
. nationalAgencySpeciality (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/medicalspecialty_v1_000/get_medical_specialtiesBusca dados de tabela de especialidades medicas existentesorder (array)
codeFinal (integer)
description (string)
page (integer)
pageSize (integer)
fields (string)
gps/medicalspecialty_v1_000/post_medical_specialtiesInclui um novo registro de tabela de especialidades medicasdata: {
. code (integer)
. description (string)
. complementaryDescription (string)
. medicalBoardCode (integer)
. nationalAgencySpeciality (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/medicinebranch_v1_000/get_medicine_branches_by_codeRetorna dados de tipo de medicinacode (integer)
gps/medicinebranch_v1_000/delete_medicine_branches_by_codeExclui tipo de medicinacode (integer)
gps/medicinebranch_v1_000/put_medicine_branches_by_codeAtualiza um registro existente de tipo de medicinacode (integer)
data: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/medicinebranch_v1_000/get_medicine_branchesBusca dados de tipo de medicina existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/medicinebranch_v1_000/post_medicine_branchesInclui um novo registro de tipo de medicinadata: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/proposalstatus_v1_000/get_proposal_status_by_codeRetorna dados de situação da propostacode (integer)
gps/proposalstatus_v1_000/delete_proposal_status_by_codeExclui situação da propostacode (integer)
gps/proposalstatus_v1_000/put_proposal_status_by_codeAtualiza um registro existente de situação da propostacode (integer)
data: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/proposalstatus_v1_000/get_proposal_statusBusca dados de situação da proposta existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/proposalstatus_v1_000/post_proposal_statusInclui um novo registro de situação da propostadata: {
. code (integer)
. description (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/proposaltype_v1_000/get_proposal_types_by_codeRetorna dados de tipo de propostacode (integer)
gps/proposaltype_v1_000/delete_proposal_types_by_codeExclui tipo de propostacode (integer)
gps/proposaltype_v1_000/put_proposal_types_by_codeAtualiza um registro existente de tipo de propostacode (integer)
data: {
. code (integer)
. description (string)
. monthlyPaymentFactor (number)
. enrollmentFactor (number)
. active (boolean)
. updateDate (string)
. updateUser (string)
} (object) required
gps/proposaltype_v1_000/get_proposal_typesBusca dados de tipo de proposta existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/proposaltype_v1_000/post_proposal_typesInclui um novo registro de tipo de propostadata: {
. code (integer)
. description (string)
. monthlyPaymentFactor (number)
. enrollmentFactor (number)
. active (boolean)
. updateDate (string)
. updateUser (string)
} (object) required
gps/registerstatus_v1_000/get_register_status_by_codeRetorna dados de situação de cadastroscode (integer)
gps/registerstatus_v1_000/delete_register_status_by_codeExclui situação de cadastroscode (integer)
gps/registerstatus_v1_000/put_register_status_by_codeAtualiza um registro existente de situação de cadastroscode (integer)
data: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/registerstatus_v1_000/get_register_statusBusca dados de situação de cadastros existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/registerstatus_v1_000/post_register_statusInclui um novo registro de situação de cadastrosdata: {
. code (integer)
. description (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/secondcopyreason_v1_000/get_second_copy_reasons_by_codeRetorna dados de motivo solicitação segunda via de cartãocode (integer)
gps/secondcopyreason_v1_000/delete_second_copy_reasons_by_codeExclui motivo solicitação segunda via de cartãocode (integer)
gps/secondcopyreason_v1_000/put_second_copy_reasons_by_codeAtualiza um registro existente de motivo solicitação segunda via de cartãocode (integer)
data: {
. code (integer)
. description (string)
. detailedMessage (string)
. status (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/secondcopyreason_v1_000/get_second_copy_reasonsBusca dados de motivo solicitação segunda via de cartão existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/secondcopyreason_v1_000/post_second_copy_reasonsInclui um novo registro de motivo solicitação segunda via de cartãodata: {
. code (integer)
. description (string)
. detailedMessage (string)
. status (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/textpattern_v1_000/get_text_patterns_by_codeRetorna dados de texto padrãocode (integer)
gps/textpattern_v1_000/delete_text_patterns_by_codeExclui texto padrãocode (integer)
gps/textpattern_v1_000/put_text_patterns_by_codeAtualiza um registro existente de texto padrãocode (integer)
data: {
. code (integer)
. description (string)
. text (string)
. updateDate (string)
. updateUser (string)
} (object) required
gps/textpattern_v1_000/get_text_patternsBusca dados de texto padrão existentescodeInitial (integer)
codeFinal (integer)
description (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
gps/textpattern_v1_000/post_text_patternsInclui um novo registro de texto padrãodata: {
. code (integer)
. description (string)
. text (string)
. updateDate (string)
. updateUser (string)
} (object) required
protheus/accountingcalendar_v1_000/get_accounting_calendarRetorna Cadastro do Calendário ContábilAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/accountingcalendar_v1_000/post_accounting_calendarIncluir um Calendário Contábil conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. CalendarCode (string)
. InternalId (string)
. FinancialYear (string)
. ListOfAccountingPeriods (array)
} (object) required
protheus/accountingcalendar_v1_000/get_accounting_calendar_by_internal_idRetorna a Calendário Contábil de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/accountingcalendar_v1_000/put_accounting_calendar_by_internal_idAtualiza o Calendário Contábil conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. CalendarCode (string)
. InternalId (string)
. FinancialYear (string)
. ListOfAccountingPeriods (array)
} (object) required
protheus/accountingcalendar_v1_000/delete_accounting_calendar_by_internal_idExclui um Calendário Contábil conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/accountingitems_v1_000/get_accounting_itemsRetorna lista completa de itens contábeisAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/accountingitems_v1_000/post_accounting_itemsInclui um item contábil conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Class (string)
. RegisterSituation (string)
. TopCode (string)
} (object) required
protheus/accountingitems_v1_000/get_accounting_items_by_internal_idRetorna o item contábil de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/accountingitems_v1_000/put_accounting_items_by_internal_idAtualiza o item contábil conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Class (string)
. RegisterSituation (string)
. TopCode (string)
} (object) required
protheus/accountingitems_v1_000/delete_accounting_items_by_internal_idExclui um Item Contábil conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/addressstock_v1_000/get_address_stocksRetorna lista completa de Grupo de ProdutoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/addressstock_v1_000/post_address_stocksInclui um EndereçoAuthorization (string) required
data (undefined) required
protheus/addressstock_v1_000/get_address_stocks_by_warehouse_codeRetorna os Endereços de um Local de Estoque específicoWarehouseCode (string)
Authorization (string) required
protheus/addressstock_v1_000/get_address_stocks_by_warehouse_code_by_location_codeRetorna os Endereços de um Local de Estoque específicoLocationCode (string)
WarehouseCode (string)
Authorization (string) required
protheus/addressstock_v1_000/put_address_stocks_by_warehouse_code_by_location_codeAtualiza cadastro de Endereço conforme dados enviados na requisiçãoLocationCode (string)
WarehouseCode (string)
Authorization (string) required
data (undefined) required
protheus/addressstock_v1_000/delete_address_stocks_by_warehouse_code_by_location_codeExclui Local de Estoque cadastrado conforme dados enviados na requisiçãoLocationCode (string)
WarehouseCode (string)
Authorization (string) required
protheus/annotation_v1_000/get_annotationsRetorna lista completa dos apontamentos de visitaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/annotation_v1_000/post_annotationsInclui um apontamento de visita conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerId (string)
. RegisterDate (string)
. Sequence (string)
. CustomerId (string)
. CustomerUnit (string)
. EventId (string)
. OpportunityID (string)
. ProspectId (string)
. ProspectUnit (string)
. ListOfAnnotationCost (object)
} (object) required
protheus/annotation_v1_000/get_annotations_by_internal_idRetorna o apontamento de visita pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
protheus/annotation_v1_000/put_annotations_by_internal_idAtualiza o apontamento de visita conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerId (string)
. RegisterDate (string)
. Sequence (string)
. CustomerId (string)
. CustomerUnit (string)
. EventId (string)
. OpportunityID (string)
. ProspectId (string)
. ProspectUnit (string)
. ListOfAnnotationCost (object)
} (object) required
protheus/annotation_v1_000/delete_annotations_by_internal_idExclui a apontamento de visita conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/approvalprofile_v1_000/get_supply_approval_profile_infoRetorna lista completa de Perfis de Aprovação.Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/approvalprofile_v1_000/post_supply_approval_profile_infoInclui um Perfil de Aprovador conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. companyInternalId (string)
. branchId (string)
. InternalId (string)
. code (string)
. descriptionProfile (string)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. approveLimitApprover (number)
. typeProfile (string)
. currencyProfileApprove (number)
. expenseTypeInitial (number)
. expenseTypeEnd (number)
. version (number)
. situation (string)
} (object) required
protheus/approvalprofile_v1_000/get_supply_approval_profile_info_by_codeRetorna um Perfil de Aprovadorcode (string)
Authorization (string) required
order (array)
fields (string)
protheus/approvalprofile_v1_000/put_supply_approval_profile_info_by_codeAtualiza o Vlr. Minimo e Vlr. Maximo do Perfil de Aprovador conforme dados enviados na requisição.code (string)
Authorization (string) required
fields (string)
data: {
. companyInternalId (string)
. branchId (string)
. InternalId (string)
. code (string)
. descriptionProfile (string)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. approveLimitApprover (number)
. typeProfile (string)
. currencyProfileApprove (number)
. expenseTypeInitial (number)
. expenseTypeEnd (number)
. version (number)
. situation (string)
} (object) required
protheus/approvalprofile_v1_000/delete_supply_approval_profile_info_by_codeExclui um Perfil de Aprovação conforme dados enviados na requisição.code (string)
Authorization (string) required
protheus/approvalprofile_v2_000/get_approval_profileRetorna lista completa de Perfis de Aprovação.Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyInternalId (string)
approveValueLimitMin (number)
approveValueLimitMax (number)
currencyProfileApprove (number)
expenseTypeInitial (number)
expenseTypeEnd (number)
version (number)
situation (string)
protheus/approvalprofile_v2_000/post_approval_profileInclui um Perfil de Aprovador conforme dados enviados na requisição.Authorization (string) required
fields (string)
data (object) required
protheus/approvalprofile_v2_000/get_approval_profile_by_codeRetorna um Perfil de Aprovadorcode (string)
Authorization (string) required
order (array)
fields (string)
protheus/approvalprofile_v2_000/put_approval_profile_by_codeAltera o Perfil de Aprovaçãocode (string)
Authorization (string) required
fields (string)
data (object) required
protheus/approvalprofile_v2_000/delete_approval_profile_by_codeExclui um Perfil de Aprovação conforme dados enviados na requisição.code (string)
Authorization (string) required
protheus/approvers_v1_000/get_approversRetorna todos Aprovadores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/approvers_v1_000/post_approversInclui Aprovadores passado na requisição.Authorization (string) required
data: {
. companyInternalId (string)
. branchId (string)
. code (string)
. userCode (object)
. userName (object)
. higherApprover (object)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. currencyApprove (number)
. approveLimitApprover (number)
. typeLimitApprove (string)
. limitedOrder (number)
. userLogin
. Company (string)
. lotation (string)
. viewPendingValue (boolean)
. conversionDatePendingValue (string)
. lotationDestiny (string)
. masterApprover (boolean)
. sendEmail (boolean)
. receiveEmail (boolean)
. receiveHTMLEmail (boolean)
. automaticApproval (boolean)
. email (string)
} (object) required
protheus/approvers_v1_000/get_approvers_by_codeRetorna o usuário do sistema indicado.code (string)
Authorization (string) required
protheus/approvers_v1_000/put_approvers_by_codeAltera o Aprovador passado na requisição.code (string)
Authorization (string) required
data: {
. companyInternalId (string)
. branchId (string)
. code (string)
. userCode (object)
. userName (object)
. higherApprover (object)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. currencyApprove (number)
. approveLimitApprover (number)
. typeLimitApprove (string)
. limitedOrder (number)
. userLogin
. Company (string)
. lotation (string)
. viewPendingValue (boolean)
. conversionDatePendingValue (string)
. lotationDestiny (string)
. masterApprover (boolean)
. sendEmail (boolean)
. receiveEmail (boolean)
. receiveHTMLEmail (boolean)
. automaticApproval (boolean)
. email (string)
} (object) required
protheus/approvers_v1_000/delete_approvers_by_codeExclusão do Aprovador.code (string)
Authorization (string) required
protheus/auditchecklist_v1_000/get_audit_checklist_by_internal_idRetorna uma ficha de checklist pelo NúmerointernalId (integer)
Authorization (string) required
order (array)
fields (string)
protheus/auditchecklist_v1_000/put_audit_checklist_by_internal_idAltera o cadastro de Checklist de auditoria conforme dados enviados na requisiçãointernalId (integer)
data: {
. companyId (string)
. branchId (string)
. checklist (string)
. revision (string)
. internalId (string)
. description (string)
. notes (string)
. lastRevision (string)
. accomplished (string)
} (object) required
protheus/auditchecklist_v1_000/delete_audit_checklist_by_internal_idExclui um checklist pelo códigointernalId (integer)
Authorization (string) required
order (array)
fields (string)
protheus/auditchecklist_v1_000/get_audit_checklistRetorna uma lista com Checklist de auditorias pendentesorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/auditchecklist_v1_000/post_audit_checklistinsereorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/auditpanel_v1_000/get_painel_auditoria_periodRetorna os períodos de apuração disponíveis no sistema.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_big_numbersRetorna os indicadores principais Big Numbers para o dashboard.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_employeesLista os funcionários vinculados ao processo de auditoria.No parameters
protheus/auditpanel_v1_000/post_painel_auditoria_update_feedbackEnvia uma atualização de feedback para um registro de auditoria.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_conformitiesLista os itens de verificação da auditoria, indicando quais regras de conformidade foram atendidas e quais apresentam inconsistências.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_branchesRetorna as filiais que o usuário logado tem permissão para visualizar, utilizado para o filtro de unidade de negócio do painel.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_last_updateInforma a data e hora em que os dados da auditoria foram processados pela última vez no backend, para controle de obsolescência.No parameters
protheus/auditpanel_v1_000/get_painel_auditoria_historyRetorna o histórico de execuções de auditorias passadas, permitindo a comparação de evolução de conformidade entre diferentes períodos.No parameters
protheus/auditquestionnaire_v1_000/get_audit_questionnaireRetorna uma lista com questionário de auditoriasorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/auditquestionnaire_v1_000/post_audit_questionnaireInsere um questionário de auditoriaorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/auditquestionnaire_v1_000/get_audit_questionnaire_by_internal_idRetorna um questionário de auditoria pelo IDinternalId (string)
Authorization (string) required
order (array)
fields (string)
protheus/auditquestionnaire_v1_000/put_audit_questionnaire_by_internal_idAltera o cadastro de questionário de auditoria conforme dados enviados na requisiçãointernalId (string)
data: {
. companyId (string)
. branchId (string)
. checklist (string)
. revision (string)
. topic (string)
. questionNumber (string)
. questionText (string)
. observations (string)
. requirements (string)
. initRange (number)
. finRange (number)
. lastRevis (string)
. questionValue (number)
. useOption (string)
. internalId (string)
} (object) required
protheus/auditquestionnaire_v1_000/delete_audit_questionnaire_by_internal_idExclui um questionário pelo códigointernalId (string)
Authorization (string) required
order (array)
fields (string)
protheus/audittopic_v1_000/put_audit_topic_by_internal_idAltera o cadastro de Topico de auditoriainternalId (string)
itemId (string)
data (object) required
protheus/audittopic_v1_000/get_audit_topic_by_internal_idRetorna um único registro Topico de AuditoriainternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/audittopic_v1_000/delete_audit_topic_by_internal_idDeletainternalId (string)
protheus/audittopic_v1_000/post_audit_topicCadastra um Topico de AuditoriaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/audittopic_v1_000/get_audit_topicRetorna uma ficha de auditoria pelo númerointernalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/audittopic_v1_000/put_audit_topic_by_internal_id_itens_table_topic_by_item_idAltera o cadastro de Topico de auditoriainternalId (string)
itemId (string)
data (array) required
protheus/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipationRetorna todos os registros de Coparticipações dos Beneficiários e seus dependentes.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string) required
companyid (string) required
protheus/beneficiariesdatacontent_v1_000/get_beneficiaries_data_contentRetorna todos os registros de beneficiários.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
branchId (string)
protheus/budgetbalancetype_v1_000/get_budget_balance_typeRetorna Cadastro de Tipo de Saldo OrçamentárioAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/budgetbalancetype_v1_000/post_budget_balance_typeIncluir um Tipo de Saldo Orçamentário conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
} (object) required
protheus/budgetbalancetype_v1_000/get_budget_balance_type_by_internal_idRetorna o Tipo de Saldo Orçamentário de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/budgetbalancetype_v1_000/put_budget_balance_type_by_internal_idAtualiza o Tipo de Saldo Orçamentário conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
} (object) required
protheus/budgetbalancetype_v1_000/delete_budget_balance_type_by_internal_idExclui um Tipo de Saldo Orçamentário conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/buyers_v1_000/get_buyersRetorna todos os Compradores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/buyers_v1_000/post_buyersAdiciona Comprador passado na requisiçãoAuthorization (string) required
data (object) required
protheus/buyers_v1_000/get_buyers_by_buyer_idRetorna o Comprador do sistema através de seu códigoBuyerId (string)
fields (string)
Authorization (string) required
protheus/buyers_v1_000/put_buyers_by_buyer_idAltera o comprador passado na requisiçãoBuyerId (string)
Authorization (string) required
data (undefined) required
protheus/buyers_v1_000/delete_buyers_by_buyer_idExclusão de Comprador da baseBuyerId (string)
Authorization (string) required
protheus/campaigns_v1_000/get_campaignsRetorna as campanhas cadastradasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/campaigns_v1_000/post_campaignsInclui uma nova campanhaAuthorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Type (string)
. CampaingDescription (string)
. InitDate (string)
. EndDate (string)
. Objective (string)
. Attendance (string)
. ExpectedPorcentage (number)
. BlockedRecord (string)
. Campaign_Evolution_Status (string)
. CampaingType (string)
. ListOfCampaigns (object)
} (object) required
protheus/campaigns_v1_000/get_campaigns_by_codeRetorna as informações da campanha informadaCode (string)
Authorization (string) required
fields (string)
protheus/campaigns_v1_000/put_campaigns_by_codeAltera a camapnha informadaCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Type (string)
. CampaingDescription (string)
. InitDate (string)
. EndDate (string)
. Objective (string)
. Attendance (string)
. ExpectedPorcentage (number)
. BlockedRecord (string)
. Campaign_Evolution_Status (string)
. CampaingType (string)
. ListOfCampaigns (object)
} (object) required
protheus/campaigns_v1_000/delete_campaigns_by_codeExclui a campanha informadaCode (string)
Authorization (string) required
protheus/candidates_v2_000/get_candidates_by_idRetorna dados de tabela da Candidato especificadaid (string)
Authorization (string) required
protheus/candidates_v2_000/delete_candidates_by_idExclui Candidatoid (string)
Authorization (string) required
protheus/candidates_v2_000/put_candidates_by_idAtualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
protheus/candidates_v2_000/get_candidatesRetorna todos as CandidatosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
personsIds (string)
protheus/candidates_v2_000/post_candidatesInclui um novo registro na tabela de CandidatosAuthorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
protheus/carrier_v1_000/get_carrierRetorna lista completa de TransportadorasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/carrier_v1_000/post_carrierInclui uma Transportadora conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Name (string)
. ShortName (string)
. RegisterSituation (string)
. governamentalInformation (array)
. address (array)
. listofComunicationInformation (array)
. CarrierType (string)
} (object) required
protheus/carrier_v1_000/get_carrier_by_internal_idRetorna a Transportadora conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/carrier_v1_000/put_carrier_by_internal_idAtualiza cadastro de Transportadoras conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Name (string)
. ShortName (string)
. RegisterSituation (string)
. governamentalInformation (array)
. address (array)
. listofComunicationInformation (array)
. CarrierType (string)
} (object) required
protheus/carrier_v1_000/delete_carrier_by_internal_idExclui cadastro de Transportadora conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/cashieroperator_v1_000/get_cashier_operatorsRetorna todos os operadores de caixaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/cashieroperator_v1_000/post_cashier_operatorsInclui operador de caixa passado na requisiçãoAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. CashierCode (string)
. InternalId (string)
. Name (string)
. ShortName (string)
. WithdrawalLimit (number)
. DiscountTotalPercent (number)
. DiscountTotalValue (number)
. DiscountItemPercent (number)
. DiscountItemValue (number)
. CardNumber (string)
. CanWithdrawal (string)
. CanCancelItem (string)
. CanCancelSale (string)
. CanEditPayment (string)
. CanOpenDrawer (string)
} (object) required
protheus/cashieroperator_v1_000/get_cashier_operators_by_internal_idRetorna os dados do operador de caixa de acordo com a filial e código do operador passados por parametroInternalId (string)
Authorization (string) required
protheus/cashieroperator_v1_000/put_cashier_operators_by_internal_idAtualiza a entidade operador de caixa passado na requisiçãoInternalId (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. CashierCode (string)
. InternalId (string)
. Name (string)
. ShortName (string)
. WithdrawalLimit (number)
. DiscountTotalPercent (number)
. DiscountTotalValue (number)
. DiscountItemPercent (number)
. DiscountItemValue (number)
. CardNumber (string)
. CanWithdrawal (string)
. CanCancelItem (string)
. CanCancelSale (string)
. CanEditPayment (string)
. CanOpenDrawer (string)
} (object) required
protheus/cashieroperator_v1_000/delete_cashier_operators_by_internal_idDeleta a entidade CashierOperator passado na requisiçãoInternalId (string)
protheus/catreport_v1_000/post_cat_reportInicia o processamento do Painel de Impressão da CATdata (object) required
protheus/catreport_v1_000/get_cat_report_statusRetorna o percentual de execução do Painel de Impressão da CATdata (object) required
protheus/catreport_v1_000/post_cat_report_cat_valuesRetorna o resultado do Painel de Impressão da CATpage (integer)
pageSize (integer)
data (object) required
protheus/catreport_v1_000/post_cat_report_cat_monitor_valuesRetorna o resultado do Painel do e-Social para impressão PDFdata (object) required
protheus/classvalue_v1_000/get_classvalueRetorna Cadastro de Classe de ValorAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/classvalue_v1_000/post_classvalueIncluir uma Classe de Valor conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Name (string)
. Class (string)
. RegisterSituation (string)
. TopCode (string)
} (object) required
protheus/classvalue_v1_000/get_classvalue_by_internal_idRetorna a Classe de Valor de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/classvalue_v1_000/put_classvalue_by_internal_idAtualiza a Classe de Valor conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Name (string)
. Class (string)
. RegisterSituation (string)
. TopCode (string)
} (object) required
protheus/classvalue_v1_000/delete_classvalue_by_internal_idExclui uma Classe de Valor conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposalRetorna uma lista de Propostas Comerciais relacionadas a uma Oportunidade de Venda pelo OpportunityIdOpportunityId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/commercialproposal_v1_000/post_opportunities_by_opportunity_id_commercialproposalInclui uma Proposta Comercial relacionada a uma Oportunidade de Venda pelo OpportunityIdOpportunityId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. CompanyInternalId (string)
. BranchId (string)
. ProposalNumber (string)
. ProposalReview (string)
. OpportunityId (string)
. OpportunityReview (string)
. OpportunityDescription (string)
. EntityType (string)
. EntityCode (string)
. EntityUnit (string)
. EntityDescription (string)
. SellerId (string)
. RegisterDate (string)
. PriceListId (string)
. DiscountPercentage (number)
. SynchronizeProposal (string)
. RegisterSituation (string)
. ListofProducts (array)
} (object) required
protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposal_by_internal_idRetorna uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de VendaInternalId (string)
OpportunityId (string)
Authorization (string) required
fields (string)
protheus/commercialproposal_v1_000/put_opportunities_by_opportunity_id_commercialproposal_by_internal_idAltera uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de VendaInternalId (string)
OpportunityId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. CompanyInternalId (string)
. BranchId (string)
. ProposalNumber (string)
. ProposalReview (string)
. OpportunityId (string)
. OpportunityReview (string)
. OpportunityDescription (string)
. EntityType (string)
. EntityCode (string)
. EntityUnit (string)
. EntityDescription (string)
. SellerId (string)
. RegisterDate (string)
. PriceListId (string)
. DiscountPercentage (number)
. SynchronizeProposal (string)
. RegisterSituation (string)
. ListofProducts (array)
} (object) required
protheus/commercialproposal_v1_000/delete_opportunities_by_opportunity_id_commercialproposal_by_internal_idExclui uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de VendaInternalId (string)
OpportunityId (string)
Authorization (string) required
protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_productsRetorna uma lista de Itens de uma Proposta Comercial relacionados pelo InternalIdInternalId (string)
OpportunityId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/commercialproposal_v1_000/post_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_productsInclui um item em uma Proposta Comercial relacionada a uma Oportunidade de Venda pelo OpportunityIdInternalId (string)
OpportunityId (string)
Authorization (string) required
fields (string)
data: {
. ItemInternalId (string)
. BranchId (string)
. ItemId (string)
. ProductId (string)
. ProductDescription (string)
. UnitOfMeasurement (string)
. Currency (string)
. PaymentModeId (string)
. TypeOut (string)
. Quantity (number)
. UnitPrice (number)
. UnitPriceList (number)
. TotalValue (number)
. ItemDiscountPercentage (number)
. ItemDiscountValue (number)
} (object) required
protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products_by_item_idRetorna um item de uma Proposta Comercial pelo ItemIdInternalId (string)
ItemId (string)
OpportunityId (string)
Authorization (string) required
fields (string)
protheus/commercialproposal_v1_000/put_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products_by_item_idAltera uma Proposta Comercial pelo ItemIdInternalId (string)
ItemId (string)
OpportunityId (string)
Authorization (string) required
fields (string)
data: {
. ItemInternalId (string)
. BranchId (string)
. ItemId (string)
. ProductId (string)
. ProductDescription (string)
. UnitOfMeasurement (string)
. Currency (string)
. PaymentModeId (string)
. TypeOut (string)
. Quantity (number)
. UnitPrice (number)
. UnitPriceList (number)
. TotalValue (number)
. ItemDiscountPercentage (number)
. ItemDiscountValue (number)
} (object) required
protheus/commercialproposal_v1_000/delete_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products_by_item_idExclui uma Proposta Comercial pelo ItemIdInternalId (string)
ItemId (string)
OpportunityId (string)
Authorization (string) required
protheus/contactrelationship_v1_000/get_contactrelationshipRetorna uma lista completa de Relacionamentos de Contato x EntidadeAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/contactrelationship_v1_000/post_contactrelationshipInclui uma Relacionamento de Contato conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. CompanyInternalId (string)
. InternalId (string)
. BranchId (string)
. Code (string)
. Entity (string)
. ListOfContacts (object)
} (object) required
protheus/contactrelationship_v1_000/get_contactrelationship_by_internal_idRetorna um Relacionamento de Contato x Entidade pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
protheus/contactrelationship_v1_000/put_contactrelationship_by_internal_idAltera um Relacionamento de Contato x Entidade pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. CompanyInternalId (string)
. InternalId (string)
. BranchId (string)
. Code (string)
. Entity (string)
. ListOfContacts (object)
} (object) required
protheus/contactrelationship_v1_000/delete_contactrelationship_by_internal_idExclui um Relacionamento de Contato de Entidade pelo InternalIdInternalId (string)
Authorization (string) required
protheus/contactrelationship_v1_000/get_contactrelationship_by_internal_id_listofcontactRetorna uma lista completa de items de todos Relacionamentos de Contato x EntidadeInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/contactrelationship_v1_000/post_contactrelationship_by_internal_id_listofcontactInclui um Item em um Relacionamento de Contato especifico conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
fields (string)
data: {
. ContactCode (string)
. ContactInternalId (string)
} (object) required
protheus/contactrelationship_v1_000/get_contactrelationship_by_internal_id_listofcontact_by_contact_codeRetorna um Item Especifico pelo ContactCode de Relacionamento de ContatoInternalId (string)
ContactCode (string)
Authorization (string) required
fields (string)
protheus/contactrelationship_v1_000/put_contactrelationship_by_internal_id_listofcontact_by_contact_codeAltera um Item especifico pelo ContactCode de Relacionamento de Contato x EntidadeInternalId (string)
ContactCode (string)
Authorization (string) required
fields (string)
data: {
. ContactCode (string)
. ContactInternalId (string)
} (object) required
protheus/contactrelationship_v1_000/delete_contactrelationship_by_internal_id_listofcontact_by_contact_codeExclui um Item especifico pelo ContactCode de Relacionamento de Contato x EntidadeInternalId (string)
ContactCode (string)
Authorization (string) required
protheus/contact_v1_000/get_contactsRetorna lista completa de ContatosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/contact_v1_000/post_contactsInclui um Contato conforme dados enviados na requisição.Authorization (string) required
data: {
. contactId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. internalId (string)
. name (string)
. governmentalInformation (object)
. address (array)
. listOfCommunicationInformation (array)
. treatment (string)
. gender (string)
. birthday (string)
. requester (string)
. situation (string)
} (object) required
protheus/contact_v1_000/get_contacts_by_contact_idRetorna o contato conforme dados enviados na requisiçãocontactId (string)
Authorization (string) required
fields (string)
protheus/contact_v1_000/put_contacts_by_contact_idAtualiza cadastro do Contato conforme dados enviados na requisiçãocontactId (string)
Authorization (string) required
fields (string)
data: {
. contactId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. internalId (string)
. name (string)
. governmentalInformation (object)
. address (array)
. listOfCommunicationInformation (array)
. treatment (string)
. gender (string)
. birthday (string)
. requester (string)
. situation (string)
} (object) required
protheus/contact_v1_000/delete_contacts_by_contact_idExclui cadastro do Contato conforme dados enviados na requisição.contactId (string)
Authorization (string) required
protheus/contaminants_v1_000/get_contaminantsRetorna todos os contaminantes da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/contaminants_v1_000/post_contaminantsInclui um contaminante passado na requisiçãoAuthorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Name (string)
. Description (string)
. Status (string)
. ResultType (string)
. ResultSize (string)
. ResultPrecision (string)
. WSAvailable (string)
. PropagationLevel (string)
. InclusionDate (date)
. InclusionHour (char)
. UpdateDate (date)
. UpdateHour (char)
. ListOfContaminantValues (object)
} (object) required
protheus/contaminants_v1_000/get_contaminants_by_internal_idRetorna o contaminante correspondente ao parametro informadoInternalId (string)
Authorization (string) required
protheus/contaminants_v1_000/put_contaminants_by_internal_idAltera o contaminante passado na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Name (string)
. Description (string)
. Status (string)
. ResultType (string)
. ResultSize (string)
. ResultPrecision (string)
. WSAvailable (string)
. PropagationLevel (string)
. InclusionDate (date)
. InclusionHour (char)
. UpdateDate (date)
. UpdateHour (char)
. ListOfContaminantValues (object)
} (object) required
protheus/contaminants_v1_000/delete_contaminants_by_internal_idDeleção do contaminante informado.InternalId (string)
Authorization (string) required
protheus/costcenter_v1_000/get_costcentersRetorna lista completa dos Centro de CustosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/costcenter_v1_000/post_costcentersInclui um Centro de Custo conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
protheus/costcenter_v1_000/get_costcenters_by_internal_idRetorna um centro de custo de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/costcenter_v1_000/patch_costcenters_by_internal_idAtualiza centro de custo somente com os dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
protheus/costcenter_v1_000/put_costcenters_by_internal_idAtualiza centro de custo conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
protheus/costcenter_v1_000/delete_costcenters_by_internal_idExclui um Centro de Custo conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/cottonbalesontreadmills_v1_000/get_cotton_bales_on_treadmillsRetorna todos os vinculos de esteira x fardão da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonbalesontreadmills_v1_000/post_cotton_bales_on_treadmillsNão é permitida a inclusão de um vínculo por motivos de regra de negócio.No parameters
protheus/cottonbalesontreadmills_v1_000/get_cotton_bales_on_treadmills_by_internal_idRetorna os fardões vinculados à esteira correspondente ao parâmetro informadoInternalId (string)
Authorization (string) required
protheus/cottonbalesontreadmills_v1_000/put_cotton_bales_on_treadmills_by_internal_idVincula um fardão a esteira passada na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Crop (string)
. AgriculturalOwnerCode (string)
. AgriculturalOwnerStoreCode (string)
. FarmCode (string)
. Order (string)
. CottonBaleCode (string)
. ProductCode (string)
. PartOfLand (string)
. Variety (string)
. NetWeight (number)
} (object) required
protheus/cottonbalesontreadmills_v1_000/delete_cotton_bales_on_treadmills_by_internal_idDeleção do fardão informado da fila a qual pertence.InternalId (string)
Authorization (string) required
protheus/cottonbales_v1_000/get_cotton_balesRetorna todos os fardões da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonbales_v1_000/post_cotton_balesInclui um fardão passado na requisiçãoAuthorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. ProductCode (string)
. DateOfTyping (string)
. WareHouse (string)
. Crop (string)
. Entity (string)
. EntityStore (string)
. Farm (string)
. EstimatedWeight (string)
. TypeOfPress (string)
. Margin (string)
. Unb (string)
. PartOfLand (string)
. AgriculturalVariety (string)
. IntendedIncome (string)
. Annotation (string)
. HarvestOrder (string)
. IdQCotton (string)
. TagQCotton (string)
. XCoordinate (string)
. YCoordinate (string)
. ZCoordinate (string)
. LotNumber (string)
. SubLotNumber (string)
. LotAddress (string)
. StartHarvestForecast (string)
. ClosingHarvestForecast (string)
. ProductionOrder (string)
. TareWeight (string)
} (object) required
protheus/cottonbales_v1_000/get_cotton_bales_by_internal_idRetorna o fardão correspondente ao código único informadoInternalId (string)
Authorization (string) required
protheus/cottonbales_v1_000/put_cotton_bales_by_internal_idAltera a Filial passado na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. ProductCode (string)
. DateOfTyping (string)
. WareHouse (string)
. Crop (string)
. Entity (string)
. EntityStore (string)
. Farm (string)
. EstimatedWeight (string)
. TypeOfPress (string)
. Margin (string)
. Unb (string)
. PartOfLand (string)
. AgriculturalVariety (string)
. IntendedIncome (string)
. Annotation (string)
. HarvestOrder (string)
. IdQCotton (string)
. TagQCotton (string)
. XCoordinate (string)
. YCoordinate (string)
. ZCoordinate (string)
. LotNumber (string)
. SubLotNumber (string)
. LotAddress (string)
. StartHarvestForecast (string)
. ClosingHarvestForecast (string)
. ProductionOrder (string)
. TareWeight (string)
} (object) required
protheus/cottonbales_v1_000/delete_cotton_bales_by_internal_idDeleção do fardão informadoInternalId (string)
Authorization (string) required
protheus/cottoncolorgrades_v1_000/get_cotton_color_gradesRetorna todos os tipos de classificação do algodão cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/cottoncolorgrades_v1_000/post_cotton_color_gradesInclui o tipo de classificação passado na requisição.No parameters
protheus/cottoncolorgrades_v1_000/get_cotton_color_grades_by_internal_idRetorna o tipo de classificação informado pelo parâmetroInternalId (string)
Authorization (string) required
fields (string)
protheus/cottoncolorgrades_v1_000/put_cotton_color_grades_by_internal_idAltera o tipo de classificação informado.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Description (string)
. ShortDescription (string)
. StandardUniversalCode (string)
} (object) required
protheus/cottoncolorgrades_v1_000/delete_cotton_color_grades_by_internal_idDeleção do tipo de classificação dos registros.InternalId (string)
Authorization (string) required
protheus/cottonginbreakpointings_v1_000/get_cotton_gin_break_pointingsRetorna todos os Motivo de Parada da beneficiadora.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonginbreakpointings_v1_000/post_cotton_gin_break_pointingsInclui o apontamento de motivo de parada para a beneficiadora passada na requisição.No parameters
protheus/cottonginbreakpointings_v1_000/get_cotton_gin_break_pointings_by_internal_idRetorna os apontamentos de parada da beneficiadora informada pelo parâmetroInternalId (string)
Authorization (string) required
protheus/cottonginbreakpointings_v1_000/put_cotton_gin_break_pointings_by_internal_idAltera o apontamento de motivo de parada da beneficiadora informada.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. CottonGinCode (string)
. CottonGinBreakCode (string)
. ShiftCode (string)
. StartDate (Date)
. StartTime (string)
. EndDate (Date)
. EndTime (string)
. Status (string)
. UserCode (char)
. Note (char)
} (object) required
protheus/cottonginbreakpointings_v1_000/delete_cotton_gin_break_pointings_by_internal_idDeleção do apontamento de parada da beneficiadora dos registros.InternalId (string)
Authorization (string) required
protheus/cottonginbreaks_v1_000/get_cotton_gin_breaksRetorna todos os Motivo de Parada da beneficiadora cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonginbreaks_v1_000/post_cotton_gin_breaksInclui o motivo de parada da beneficiadora passado na requisição.No parameters
protheus/cottonginbreaks_v1_000/get_cotton_gin_breaks_by_internal_idRetorna o motivo de parada da beneficiadora correspondente ao parâmetro informadoInternalId (string)
Authorization (string) required
protheus/cottonginbreaks_v1_000/put_cotton_gin_breaks_by_internal_idAlterada a descrição do motivo em questão.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Description (string)
} (object) required
protheus/cottonginbreaks_v1_000/delete_cotton_gin_breaks_by_internal_idDeleção do motivo de parada da beneficiadora dos registros.InternalId (string)
Authorization (string) required
protheus/cottonginmachines_v1_000/get_cotton_gin_machinesRetorna todos os conjuntos de beneficiamento de algodão cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonginmachines_v1_000/post_cotton_gin_machinesEfetua o cadastro de um conjunto de beneficiamento de algodão.No parameters
protheus/cottonginmachines_v1_000/get_cotton_gin_machines_by_internal_idRetorna o conjunto de beneficiamento requerido.InternalId (string)
Authorization (string) required
protheus/cottonginmachines_v1_000/put_cotton_gin_machines_by_internal_idAltera o conjunto de benficiamento informado.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. CottonGinMachineCode (string)
. Description (string)
. SAICode (string)
. CottonGinCode (string)
. CottonGinName (string)
. AdditionalBalanceWeight (string)
. MinimumWeight (string)
. MaximumWeight (string)
. MinimumYield (string)
. MaximumYield (string)
. AverageYield (string)
. ExpectedStartDate (date)
. ExpectedEndDate (date)
. NumberSaws (string)
. KilosPerHour (string)
. ProductiveHours (string)
. CottonBalesPerDay (string)
. ExceedIncome (string)
. AdditionalItems (object)
. ItemsPercentualSeparation (object)
} (object) required
protheus/cottonginmachines_v1_000/delete_cotton_gin_machines_by_internal_idExclui o conjunto de beneficiamento informado.InternalId (string)
Authorization (string) required
protheus/cottongins_v1_000/get_cotton_ginsRetorna todas as unidades de beneficamento da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottongins_v1_000/post_cotton_ginsInclui uma unidade de beneficamento passada na requisiçãoAuthorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. Description (string)
} (object) required
protheus/cottongins_v1_000/get_cotton_gins_by_internal_idRetorna a unidade de beneficamento correspondente ao parametro informadoInternalId (string)
Authorization (string) required
protheus/cottongins_v1_000/put_cotton_gins_by_internal_idAltera a unidade de beneficamento passada na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. Description (string)
} (object) required
protheus/cottongins_v1_000/delete_cotton_gins_by_internal_idDeleção da unidade de beneficamento informadaInternalId (string)
Authorization (string) required
protheus/cottonpoisoningpointings_v1_000/get_cotton_poisoning_pointingsRetorna todos os lançamentos de contaminantes em algodão cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/cottonpoisoningpointings_v1_000/post_cotton_poisoning_pointingsEfetua o lançamento de contaminante para algodão.No parameters
protheus/cottonpoisoningpointings_v1_000/get_cotton_poisoning_pointings_by_internal_idRetorna o lançamento requerido.InternalId (string)
Authorization (string) required
protheus/cottonpoisoningpointings_v1_000/put_cotton_poisoning_pointings_by_internal_idAltera o lançamento informado.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. CropCode (string)
. ProductCode (string)
. Lot (string)
. AnalysisType (string)
. Sequence (string)
. AnalysisVariable (string)
. VariableDescription (string)
. VariableType (string)
. ResultValue (number)
. ResultText (string)
. ResultDate (date)
. IncomeTax (string)
. Active (string)
. UpdateDate (date)
. UpdateUser (string)
. CaseUniqueCode (string)
. BlockUniqueCode (string)
. CottonWrapUniqueCode (string)
. CottonBaleUniqueCode (string)
. CottonBaleCode (string)
. BlockCode (string)
. ClassificationPackingList (string)
. EntityCode (string)
. EntityStoreCode (string)
. EntityFarm (string)
. CottonWrapCode (string)
. ClassificationPackingListType (string)
} (object) required
protheus/cottonpoisoningpointings_v1_000/delete_cotton_poisoning_pointings_by_internal_idExclui o lançamento informado.InternalId (string)
Authorization (string) required
protheus/currencyquote_v1_000/get_currency_quotesRetorna lista completa das Cotações de MoedasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/currencyquote_v1_000/post_currency_quotesInclui cotações de moedas conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Date (string)
. ListOfCurrency (array)
} (object) required
protheus/currencyquote_v1_000/get_currency_quotes_by_dateRetorna cotações de uma Data de acordo com o ID de pesquisaDate (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/currencyquote_v1_000/put_currency_quotes_by_dateAtualiza as cotações por Data conforme dados enviados na requisiçãoDate (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Date (string)
. ListOfCurrency (array)
} (object) required
protheus/currencyquote_v1_000/delete_currency_quotes_by_dateExclui as cotações por Data conforme dados enviados na requisição.Date (string)
Authorization (string) required
protheus/currency_v1_000/get_currencyRetorna lista completa de moedaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/currency_v1_000/post_currencyInclui MoedaAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Symbol (string)
. DecimalPlaces (integer)
. Situation (string)
} (object) required
protheus/currency_v1_000/get_currency_by_codeRetorna Moeda pelo seu códigoCode (string)
Authorization (string) required
protheus/currency_v1_000/put_currency_by_codeAtualiza cadastro de Moeda conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Symbol (string)
. DecimalPlaces (integer)
. Situation (string)
} (object) required
protheus/currency_v1_000/delete_currency_by_codeExclui Moeda conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
protheus/customercreditlimit_v1_000/get_customer_credit_limitRetorna uma lista com o Limite de credito de todos os ClientesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/customercreditlimit_v1_000/get_customer_credit_limit_by_customer_internal_idRetorna o Limite de credito de um ClienteCustomerInternalId (string)
Authorization (string) required
fields (string)
protheus/customershippingaddress_v1_000/get_customer_shipping_addressRetorna lista completa do Endereço de Entrega do ClienteAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/customershippingaddress_v1_000/post_customer_shipping_addressInclui um Endereço de Entrega do Cliente conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CustomerCode (string)
. GovernmentalInformation (object)
. InternalId (string)
. Code (string)
. ExternalId (string)
. ShippingAddressInformation (object)
. ShippingAddress (array)
. CarrierCode (string)
} (object) required
protheus/customershippingaddress_v1_000/get_customer_shipping_address_by_internal_idRetorna o Endereço de Entrega do Cliente de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/customershippingaddress_v1_000/put_customer_shipping_address_by_internal_idAtualiza o Endereço de Entrega do Cliente conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CustomerCode (string)
. GovernmentalInformation (object)
. InternalId (string)
. Code (string)
. ExternalId (string)
. ShippingAddressInformation (object)
. ShippingAddress (array)
. CarrierCode (string)
} (object) required
protheus/customershippingaddress_v1_000/delete_customer_shipping_address_by_internal_idExclui um Endereço de Entrega do Cliente conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/customervendor_v1_000/get_customer_vendorRetorna todos clientes e/ou fornecedoresAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/customervendor_v1_000/post_customer_vendorInclui a entidade Cliente/Fornecedor passada na requisiçãoAuthorization (string) required
fields (string)
data: {
. customerVendorId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. storeId (string)
. internalId (string)
. shortName (string)
. name (string)
. type (string)
. entityType (string)
. marketsegment (object)
. registerdate (string)
. registerSituation (string)
. comments (string)
. governmentalInformation (array)
. address (object)
. shippingAddress (object)
. listOfCommunicationInformation (array)
. listOfContacts (array)
. listOfBankingInformation (array)
. billingInformation (object)
. vendorInformation (object)
. fiscalInformation (object)
. creditInformation (object)
. paymentConditionCode (string)
. paymentConditionInternalId (string)
. priceListHeaderItemCode (string)
. priceListHeaderItemInternalId (string)
. carrierCode (integer)
. strategicCustomerType (string)
. rateDiscount (number)
. sellerCode (string)
. sellerInternalId (string)
. classification (string)
. recCreatedBy (string)
. recCreatedOn (string)
. recModifiedBy (string)
. recModifiedOn (string)
. creditLimit (number)
. lastChangeDate (string)
. optionalValue1 (number)
. optionalValue2 (number)
. optionalValue3 (number)
. patrimony (number)
. employeesNumber (integer)
. classificationCompanyId (integer)
. contributor (integer)
. blocked (integer)
. providerShippingPrice (number)
. takerType (integer)
. issContributor (integer)
. dependentsNumber (integer)
. publicBody (integer)
. selfEmployedCategory (integer)
. customerVendorIdentityId (integer)
. otherDeductionsIRRFCalculations (number)
. issRegime (string)
. issRetentionResponsible (string)
. fuelOperationType (integer)
. size (integer)
. activityBranch (integer)
. typeContributorINSS (integer)
. nationality (integer)
. taxCodeColcfo (integer)
. calculatesAVP (integer)
. nif (string)
. nifSituation (integer)
. incomeType (string)
. taxationForm (string)
. innovate_auto (integer)
. formulaApplication (string)
. automaticDebitCheckerType (string)
. executingEntityPaa (string)
. ownWork (integer)
. retiredPensioner (integer)
. socialCategoryId (integer)
. cooperativePartner (integer)
. complementaryFields (object)
} (object) required
protheus/customervendor_v1_000/get_customer_vendor_by_entity_typeRetorna todos os registros de uma entidade específica - Customer ou VendorentityType (array)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/customervendor_v1_000/get_customer_vendor_by_entity_type_by_customer_vendor_idRetorna Cliente ou Fornecedor com base no código da entidadecustomerVendorId (string)
entityType (array)
fields (string)
Authorization (string) required
protheus/customervendor_v1_000/put_customer_vendor_by_entity_type_by_customer_vendor_idAtualiza a entidade Cliente/Fornecedor informada na requisiçãocustomerVendorId (string)
entityType (array)
fields (string)
Authorization (string) required
data: {
. customerVendorId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. storeId (string)
. internalId (string)
. shortName (string)
. name (string)
. type (string)
. entityType (string)
. marketsegment (object)
. registerdate (string)
. registerSituation (string)
. comments (string)
. governmentalInformation (array)
. address (object)
. shippingAddress (object)
. listOfCommunicationInformation (array)
. listOfContacts (array)
. listOfBankingInformation (array)
. billingInformation (object)
. vendorInformation (object)
. fiscalInformation (object)
. creditInformation (object)
. paymentConditionCode (string)
. paymentConditionInternalId (string)
. priceListHeaderItemCode (string)
. priceListHeaderItemInternalId (string)
. carrierCode (integer)
. strategicCustomerType (string)
. rateDiscount (number)
. sellerCode (string)
. sellerInternalId (string)
. classification (string)
. recCreatedBy (string)
. recCreatedOn (string)
. recModifiedBy (string)
. recModifiedOn (string)
. creditLimit (number)
. lastChangeDate (string)
. optionalValue1 (number)
. optionalValue2 (number)
. optionalValue3 (number)
. patrimony (number)
. employeesNumber (integer)
. classificationCompanyId (integer)
. contributor (integer)
. blocked (integer)
. providerShippingPrice (number)
. takerType (integer)
. issContributor (integer)
. dependentsNumber (integer)
. publicBody (integer)
. selfEmployedCategory (integer)
. customerVendorIdentityId (integer)
. otherDeductionsIRRFCalculations (number)
. issRegime (string)
. issRetentionResponsible (string)
. fuelOperationType (integer)
. size (integer)
. activityBranch (integer)
. typeContributorINSS (integer)
. nationality (integer)
. taxCodeColcfo (integer)
. calculatesAVP (integer)
. nif (string)
. nifSituation (integer)
. incomeType (string)
. taxationForm (string)
. innovate_auto (integer)
. formulaApplication (string)
. automaticDebitCheckerType (string)
. executingEntityPaa (string)
. ownWork (integer)
. retiredPensioner (integer)
. socialCategoryId (integer)
. cooperativePartner (integer)
. complementaryFields (object)
} (object) required
protheus/customervendor_v1_000/delete_customer_vendor_by_entity_type_by_customer_vendor_idExclui a entidade Cliente/Fornecedor passada na requisiçãocustomerVendorId (string)
entityType (array)
Authorization (string) required
protheus/discoveryenvironments_v1_000/get_discovery_environmentsRetorna todos os ambientes cadastradosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/discoveryenvironments_v1_000/post_discovery_environmentsInclui a ambiente passada na requisiçãoAuthorization (string) required
data: {
. discoveryenvironmentid (string)
. stage (string)
. descriptionstage (string)
} (object) required
protheus/discoveryenvironments_v1_000/get_discovery_environments_by_discoveryenvironmentidRetorna o ambiente específico.discoveryenvironmentid (string)
Authorization (string) required
protheus/discoveryenvironments_v1_000/put_discovery_environments_by_discoveryenvironmentidInclui o ambiente passado na requisiçãodiscoveryenvironmentid (string)
Authorization (string) required
data: {
. discoveryenvironmentid (string)
. stage (string)
. descriptionstage (string)
} (object) required
protheus/discoveryenvironments_v1_000/delete_discovery_environments_by_discoveryenvironmentidExclusão de ambientediscoveryenvironmentid (string)
protheus/discoverykeys_v1_000/get_discovery_keysRetorna todos as stageKeysAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/discoverykeys_v1_000/get_discovery_keys_by_nameRetorna uma chave específica.name (string)
Authorization (string) required
protheus/discoverystages_v1_000/get_discovery_stagesRetorna todos os stages cadastradosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/discoverystages_v1_000/post_discovery_stagesInclui o stage passada na requisiçãoAuthorization (string) required
data: {
. discoverystageid (string)
. description (string)
} (object) required
protheus/discoverystages_v1_000/get_discovery_stages_by_discoverystageidRetorna o Stage específico.discoverystageid (string)
Authorization (string) required
protheus/discoverystages_v1_000/put_discovery_stages_by_discoverystageidInclui o ambiente passado na requisiçãodiscoverystageid (string)
Authorization (string) required
data: {
. discoverystageid (string)
. description (string)
} (object) required
protheus/discoverystages_v1_000/delete_discovery_stages_by_discoverystageidExclusão de ambientediscoverystageid (string)
protheus/documents_v1_000/get_documentsRetorna os documentos das entidades armazenado no banco de conhecimentoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/documents_v1_000/post_documentsInclui um novo documentos no banco de conhecimentoAuthorization (string) required
fields (string)
tenantId (string) required
data: {
. items (array)
} (object) required
protheus/documents_v1_000/get_documents_by_internal_idRetorna o documento da entidade armazenado no banco de conhecimentoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/documents_v1_000/put_documents_by_internal_idAltera o documento armazenado no banco de conhecimentoInternalId (string)
Authorization (string) required
fields (string)
data: {
. items (array)
} (object) required
protheus/documents_v1_000/delete_documents_by_internal_idExclui os documento armazenado no banco de conhecimentoInternalId (string)
Authorization (string) required
protheus/electronicdocuments_v1_000/post_electronic_documentsRealiza a integração dos Documentos Eletrônicos de Entrada e Saída Mercadoria/ServiçoAuthorization (string) required
tenantId (string) required
data (array) required
protheus/electronicdocuments_v1_000/put_electronic_documentsRealiza a alteração de um Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço existenteAuthorization (string) required
tenantId (string) required
data (array) required
protheus/electronicdocuments_v1_000/get_electronic_documentsRealiza a consulta de todos Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço de acordo com os parâmetros informadosAuthorization (string) required
tenantId (string) required
order (string)
page (integer)
pageSize (integer)
id (string)
number (string)
serie (string)
type (string)
participantCode (string)
issuanceDate (string)
processId (string)
protheus/electronicdocuments_v1_000/delete_electronic_document_by_idRealiza a exclusão do Documento Eletrônico de Entrada e Saída Mercadoria/Serviço pelo Id do documento informadoid (string)
Authorization (string) required
tenantId (string) required
protheus/electronicdocuments_v1_000/get_electronic_documents_queue_by_idRetorna as informações da fila de processamento dos Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço pelo Idid (string)
Authorization (string) required
tenantID (string) required
protheus/employeedatacontent_v1_000/get_employee_data_contentRetorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
protheus/employeesmanagerdatacontent_v1_000/get_employees_manager_data_contentRetornar a lista dos empregados com as informações do seu respectivo líder direto.Authorization (string) required
tenantId (string)
page (integer)
pageSize (integer)
companyId (string) required
branchId (string) required
employeeCode (string)
employeeCostCenterCode (string)
visionCode (string)
managerChangeDate (string)
protheus/entities_v1_000/get_entitiesRetorna todas as entidades cadastradas.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/entities_v1_000/post_entitiesInclui uma entidade.No parameters
protheus/entities_v1_000/get_entities_by_internal_idRetorna a entidade requerida.InternalId (string)
Authorization (string) required
protheus/entities_v1_000/put_entities_by_internal_idAltera a entidade informada.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. EntityCode (string)
. EntityStoreCode (string)
. CNPJEntity (string)
. StateRegistration (string)
. EntityName (string)
. EntityStoreName (string)
. Class (string)
. DAPIncentive (string)
. DAPExpirationDate (Date)
. DAPRegisterNumber (string)
. CompanyAndBranchCode (string)
. CompanyName (string)
. BranchName (string)
. ActiveRegister (string)
. SupplierCode (string)
. SupplierStoreCode (string)
. SupplierName (string)
. SupplierStoreName (string)
. CustomerCode (string)
. CustomerStoreCode (string)
. CustomerName (string)
. CustomerStoreName (string)
. CustomsWarehouse (string)
. IDIntegrationPIMS (string)
. BankDatas (object)
} (object) required
protheus/entities_v1_000/delete_entities_by_internal_idDeleção da entidade informada.InternalId (string)
Authorization (string) required
protheus/esocialaudit_v1_000/post_esocial_auditInclui a entidade evento passado na requisiçãocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
data (object) required
protheus/esocialaudit_v1_000/get_esocial_audit_statusRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
protheus/esocialaudit_v1_000/get_esocial_audit_audit_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
status (string)
page (integer)
pageSize (integer)
protheus/esocialaudit_v1_000/get_esocial_audit_chart_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
protheus/esocialbranches_v1_000/get_esocial_branchesRetorna o código da empresa e código da filial no TAFcompanyId (string) required
order (array)
page (integer)
pageSize (integer)
protheus/esocialestablishment_v1_000/get_esocial_establishmentRetorna lista completa com os Estabelecimentos CadastradoscompanyId (string) required
order (array)
page (integer)
pageSize (integer)
protheus/esocialevents_v1_000/get_esocial_eventsRetorna a lista de eventos do TAFcompanyId (string) required
eventsCheckPermissions (string)
protheus/events_v1_000/get_eventsRetorna os eventos cadastradosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/events_v1_000/post_eventsInclui um novo eventoAuthorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Description (string)
. Location (string)
. InitDate (string)
. EndDate (string)
. InitialTime (string)
. EndTime (string)
. Blocked (string)
. ListOfEvents (object)
} (object) required
protheus/events_v1_000/get_events_by_codeRetorna as informações do evento informadoCode (string)
Authorization (string) required
fields (string)
protheus/events_v1_000/put_events_by_codeAltera o evento informadoCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Description (string)
. Location (string)
. InitDate (string)
. EndDate (string)
. InitialTime (string)
. EndTime (string)
. Blocked (string)
. ListOfEvents (object)
} (object) required
protheus/events_v1_000/delete_events_by_codeExclui o evento informadoCode (string)
Authorization (string) required
protheus/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_processCarrega registros do evento S-5503, filtrados ou não, ordenados ou não.No parameters
protheus/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_processExclui eventos S-5503 conforme coleção de ID's informados.data: {
. companyId (string)
. id (array)
} (object) required
protheus/fgtsperworkerinlaborprocess_v1_000/post_fgtsper_worker_in_labor_process_xmlRetorna XML's do evento S-5503 encodados em base64data: {
. companyId (string)
. id (array)
} (object) required
protheus/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_categoryCarrega informações relativas a Matrícula e Categoria de trabalhador específico do evento S-5503, ordenadas ou não.No parameters
protheus/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_payment_and_amountsCarrega informações relativas a Identificação do estabelecimento responsável pelo pagamento a trabalhador específico dos valores informados do evento S-5503, ordenadas ou nãoNo parameters
protheus/freightaccountingbatches_v1_000/get_freight_accounting_batchesRetorna todos os lotes de provisão cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/freightaccountingbatches_v1_000/get_freight_accounting_batches_by_internal_idRetorna apenas um lote de provisão, requerido através da chave do registro InternalId.InternalId (string)
Authorization (string) required
protheus/freightaccountingbatches_v1_000/put_freight_accounting_batches_by_internal_idAltera a situação do lote de provisão informado através da chave InternalId.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. IssuerCode (string)
. AccountLotCode (string)
. Period (string)
. FinancialStatus (string)
. FinancialDate (string)
. FinancialRejectionReason (string)
. AccountingProvisionEntry (object)
. ReversalProvisionSubBatch (object)
. ReversalEntry (object)
} (object) required
protheus/freightcomponents_v1_000/get_freight_componentsRetorna lista de componentes de freteorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/freightcomponents_v1_000/post_freight_componentsAdd Freight Componentsdata: {
. CompanyId (string)
. Code (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Description (string)
. AttributeForCalculation (string)
. SuframaTable (string)
. ValueCategory (string)
. Service (string)
. ValuePerLoadManifest (string)
. DailyValueFreelanceCalculation (string)
. GroupValues (string)
. ServiceTypeCode (string)
. CalculateService (string)
. CalculationUnitizing (string)
} (object) required
protheus/freightcomponents_v1_000/get_freight_components_by_internal_idReturn the Freight ComponentsInternalId (string)
Authorization (string) required
protheus/freightcomponents_v1_000/put_freight_components_by_internal_idEdit Freight ComponentsInternalId (string)
data: {
. CompanyId (string)
. Code (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Description (string)
. AttributeForCalculation (string)
. SuframaTable (string)
. ValueCategory (string)
. Service (string)
. ValuePerLoadManifest (string)
. DailyValueFreelanceCalculation (string)
. GroupValues (string)
. ServiceTypeCode (string)
. CalculateService (string)
. CalculationUnitizing (string)
} (object) required
protheus/freightcomponents_v1_000/delete_freight_components_by_internal_idDelete Freight ComponentsInternalId (string)
protheus/freightdocuments_v1_000/get_freight_documentsRetorna todos os documentos de frete cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/freightdocuments_v1_000/get_freight_documents_by_internal_idRetorna o documento de frete requerido.InternalId (string)
Authorization (string) required
protheus/freightdocuments_v1_000/put_freight_documents_by_internal_idAltera a situação do documento de frete, requerido através da chave do registro InternalId.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. DocumentSpecie (string)
. IssuerCode (string)
. DocumentSerie (string)
. DocumentNumber (string)
. IssueDate (string)
. TypeofDocument (string)
. InputDate (string)
. TaxOpCode (string)
. InputUser (string)
. DocumentValue (string)
. TollValue (string)
. FreightToll (string)
. ICMSBaseToll (string)
. PisCofinsBaseToll (string)
. TaxType (string)
. TaxationType (string)
. TaxCalculationBase (string)
. TaxRate (string)
. TaxValue (string)
. WithheldTaxValue (string)
. WithheldTaxRate (string)
. Note (string)
. TaxCredit (string)
. ElectronicAccessKey (string)
. IntegrationDate (string)
. CofinsBaseValue (string)
. CofinsValue (string)
. PisBaseValue (string)
. PisValue (string)
. GenerateCredit (string)
. NaturSped (string)
. Purpose (string)
. TaxRejectionReason (string)
. ServiceType (string)
. cityOrigin (string)
. UFOrigin (string)
. cityOriginName (string)
. cityDestination (string)
. cityDestinationName (string)
. UFDestination (string)
. Status (string)
. AccountingMovements (object)
} (object) required
protheus/freightinvoices_v1_000/get_freight_invoicesRetorna todas as faturas de frete cadastradas.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/freightinvoices_v1_000/get_freight_invoices_by_internal_idRetorna apenas uma fatura de frete, requerida através da chave do registro InternalId.InternalId (string)
Authorization (string) required
protheus/freightinvoices_v1_000/put_freight_invoices_by_internal_idAltera a situação da fatura de frete informada através da chave InternalId.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. IssuerCode (string)
. InvoiceSeries (string)
. InvoiceNumber (string)
. IssueDate (string)
. InvoiceGrossValue (string)
. DiscountValue (string)
. CompensatoryDiscount (string)
. DocumentSerie (string)
. DocumentNumber (string)
. ElectronicAccessKey (string)
. ICMSValue (string)
. WithheldICMSValue (string)
. ISSValue (string)
. WithheldISSValue (string)
. InterestValue (string)
. InputDate (string)
. ExpirationDate (string)
. ApprovalStatus (string)
. ApprovalDate (string)
. ApprovalTime (string)
. ApprovalUser (string)
. BlockageDate (string)
. BlockageTime (string)
. InputUser (string)
. BlockageUser (string)
. BlockageReason (string)
. Note (string)
. WithheldICMSTaxCode (string)
. WithheldICMSTaxCategory (string)
. WithheldISSTaxCode (string)
. WithheldISSTaxCategory (string)
. WithheldISSTaxCatgory (string)
. FinancialDate (string)
. FinancialTime (string)
. FinancialStatus (string)
. FinancialUser (string)
. FinancialRejectionReason (string)
} (object) required
protheus/gpeesocialmotives_v1_000/get_esocial_motivesRetorna lista completa com os motivos de afastamentocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
protheus/grainqualitytestkinds_v1_000/get_grain_quality_test_kindsRetorna todos os tipos de desconto da classificação.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/grainqualitytestkinds_v1_000/post_grain_quality_test_kindsInclui o tipo de desconto passado na requisição.No parameters
protheus/grainqualitytestkinds_v1_000/get_grain_quality_test_kinds_by_internal_idRetorna o tipo de desconto informado pelo parâmetroInternalId (string)
Authorization (string) required
protheus/grainqualitytestkinds_v1_000/put_grain_quality_test_kinds_by_internal_idAltera o tipo de desconto informado.InternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. Code (string)
. Description (string)
. ProductCode (string)
. MeasurementUnit (string)
} (object) required
protheus/grainqualitytestkinds_v1_000/delete_grain_quality_test_kinds_by_internal_idDeleção do tipo de desconto dos registros.InternalId (string)
Authorization (string) required
protheus/itemreserve_v1_000/get_item_reservesRetorna todas as reservas de produtosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/itemreserve_v1_000/post_item_reservesInclui a entidade ItemReserve passada na requisiçãoAuthorization (string) required
data: {
. CompanyId (boolean)
. BranchId (string)
. InternalId (string)
. ReserveNumber (string)
. ReserveType (string)
. DocumentReserve (string)
. Requester (string)
. RequestBranch (string)
. ReserveItemType (array)
} (object) required
protheus/itemreserve_v1_000/get_item_reserves_by_internal_idRetorna os dados da reserva de acordo com o número do documento da reserva e filial passadas por parametroInternalId (string)
Authorization (string) required
protheus/itemreserve_v1_000/put_item_reserves_by_internal_idAtualiza a entidade ItemReserve passada na requisiçãoInternalId (string)
Authorization (string) required
data: {
. CompanyId (boolean)
. BranchId (string)
. InternalId (string)
. ReserveNumber (string)
. ReserveType (string)
. DocumentReserve (string)
. Requester (string)
. RequestBranch (string)
. ReserveItemType (array)
} (object) required
protheus/itemreserve_v1_000/delete_item_reserves_by_internal_idDeleta a entidade ItemReserve passada na requisiçãoInternalId (string)
protheus/jobscheduler_v1_001/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/jobscheduler_v1_001/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
protheus/jobscheduler_v1_001/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/jobscheduler_v1_001/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
protheus/jobscheduler_v1_001/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
protheus/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
protheus/jobscheduler_v1_001/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
protheus/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
protheus/jobscheduler_v1_100/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/jobscheduler_v1_100/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
protheus/jobscheduler_v1_100/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/jobscheduler_v1_100/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
protheus/jobscheduler_v1_100/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
protheus/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
protheus/jobscheduler_v1_100/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
protheus/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
protheus/mrpallocations_v1_000/post_mrpallocationsInclui ou atualiza um ou mais registros de empenho da produção MRPdata (object) required
protheus/mrpallocations_v1_000/get_mrpallocationsRetorna lista de empenhos da produção MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
product (string)
productionOrder (string)
productionOrderOrig (string)
allocationDate (string)
sequence (string)
quantity (string)
suspendedQuantity (string)
warehouse (string)
protheus/mrpallocations_v1_000/delete_mrpallocationsRemove um ou mais Empenho da ordem de produção do MRPdata (object) required
protheus/mrpallocations_v1_000/get_mrpallocations_by_branch_id_by_codeRetorna um Empenho da Ordem de Produção MRPbranchId (string)
code (string)
fields (string)
protheus/mrpallocations_v1_000/post_mrpallocations_syncSincroniza os registros de empenho da produção MRPdata (object) required
protheus/mrpbomrouting_v1_000/post_mrpbomroutingInclui ou atualiza uma ou mais estrutura por operação do MRPdata: {
. items (array)
} (object) required
protheus/mrpbomrouting_v1_000/get_mrpbomroutingRetorna lista de estrutura por operação do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
product (string)
routing (string)
protheus/mrpbomrouting_v1_000/delete_mrpbomroutingRemove uma ou mais estruturas por operação do MRPdata: {
. items (array)
} (object) required
protheus/mrpbomrouting_v1_000/get_mrpbomrouting_by_branch_id_by_product_by_routing_by_operationRetorna a estrutura por operação do MRPbranchId (string)
product (string)
routing (string)
operation (string)
fields (string)
protheus/mrpbillofmaterial_v1_000/post_mrpbillofmaterialInclui ou atualiza uma ou mais estruturas do MRPdata: {
. items (array)
} (object) required
protheus/mrpbillofmaterial_v1_000/get_mrpbillofmaterialRetorna lista de estrutura do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
product (string)
component (string)
sequence (string)
protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterialRemove uma ou mais estruturas do MRPdata: {
. items (array)
} (object) required
protheus/mrpbillofmaterial_v1_000/get_mrpbillofmaterial_by_branch_id_by_productRetorna uma estrutura do MRPbranchId (string)
product (string)
fields (string)
protheus/mrpbillofmaterial_v1_000/post_mrpbillofmaterial_syncSincroniza as estruturas do MRPdata: {
. items (array)
} (object) required
protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterial_componentRemove um ou mais componentes das estruturas do MRPdata: {
. items (array)
} (object) required
protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterial_alternativeRemove um ou mais alternativos dos componentes das estruturas do MRPdata: {
. items (array)
} (object) required
protheus/mrpcalendar_v1_000/post_mrpcalendarInclui ou atualiza um ou mais registros no calendário do MRPdata: {
. items (array)
} (object) required
protheus/mrpcalendar_v1_000/get_mrpcalendarRetorna lista de calendário do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
calendar (string)
date (string)
startTime (string)
endTime (string)
interval (string)
totalHours (string)
protheus/mrpcalendar_v1_000/delete_mrpcalendarRemove um ou mais período do Calendário do MRPdata: {
. items (array)
} (object) required
protheus/mrpcalendar_v1_000/get_mrpcalendar_by_branch_id_by_codeRetorna o Calendário do MRPbranchId (string)
code (string)
fields (string)
protheus/mrpcalendar_v1_000/post_mrpcalendar_syncInclui ou atualiza um ou mais registros no calendário do MRPdata: {
. items (array)
} (object) required
protheus/mrpdemands_v1_000/post_mrpdemandsInclui ou atualiza uma ou mais demandas do MRPdata: {
. items (array)
} (object) required
protheus/mrpdemands_v1_000/get_mrpdemandsRetorna lista de demandas do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
date (string)
product (string)
warehouse (string)
revision (string)
document (string)
source (string)
processed (string)
protheus/mrpdemands_v1_000/delete_mrpdemandsRemove uma ou mais Demandas do MRPdata: {
. items (array)
} (object) required
protheus/mrpdemands_v1_000/get_mrpdemands_by_branch_id_by_codeRetorna uma Demanda do MRPbranchId (string)
code (string)
fields (string)
protheus/mrpdemands_v1_000/post_mrpdemands_syncSincroniza os registros de demandas do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductindicator_v1_000/post_mrpproductindicatorInclui ou atualiza indicadores do produto do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductindicator_v1_000/get_mrpproductindicatorRetorna lista de indicadores do produto do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
product (string)
protheus/mrpproductindicator_v1_000/delete_mrpproductindicatorRemove os indicadores dos produtos do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductindicator_v1_000/get_mrpproductindicator_by_branch_id_by_productRetorna os indicadores do produto do MRPbranchId (string)
product (string)
fields (string)
protheus/mrpproductindicator_v1_000/post_mrpproductindicator_syncSincroniza os registros dos indicadores do produto do MRPdata: {
. items (array)
} (object) required
protheus/mrpproduct_v1_000/post_mrpproductInclui ou atualiza um ou mais produto do MRPdata: {
. items (array)
} (object) required
protheus/mrpproduct_v1_000/get_mrpproductRetorna lista de produtos do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
product (string)
protheus/mrpproduct_v1_000/delete_mrpproductRemove um ou mais produtos do MRPdata: {
. items (array)
} (object) required
protheus/mrpproduct_v1_000/get_mrpproduct_by_branch_id_by_productRetorna um produto do MRPbranchId (string)
product (string)
fields (string)
protheus/mrpproduct_v1_000/post_mrpproduct_syncSincroniza os registros do produto do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductionorders_v1_000/post_mrpproductionordersInclui ou atualiza uma ou mais ordens de produção do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductionorders_v1_000/get_mrpproductionordersRetorna lista de ordens de produção do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
productionOrder (string)
code (string)
deliveryDate (string)
startDate (string)
product (string)
warehouse (string)
protheus/mrpproductionorders_v1_000/delete_mrpproductionordersRemove uma ou mais Ordens de produção do MRPdata: {
. items (array)
} (object) required
protheus/mrpproductionorders_v1_000/get_mrpproductionorders_by_branch_id_by_codeRetorna uma ordem de produção do MRPbranchId (string)
code (string)
fields (string)
protheus/mrpproductionorders_v1_000/post_mrpproductionorders_syncSincroniza as ordens de produção do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaseorder_v1_000/post_mrppurchaseorderInclui ou atualiza um ou mais registros da solicitação de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaseorder_v1_000/get_mrppurchaseorderRetorna lista de solicitação de compra do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
purchase (string)
sequence (string)
product (string)
productionOrder (string)
deliveryDate (string)
quantity (string)
receivedQuantity (string)
warehouse (string)
type (string)
protheus/mrppurchaseorder_v1_000/delete_mrppurchaseorderRemove uma ou mais Solicitação de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaseorder_v1_000/get_mrppurchaseorder_by_branch_id_by_codeRetorna a Solicitação de Compra do MRPbranchId (string)
code (string)
fields (string)
protheus/mrppurchaseorder_v1_000/post_mrppurchaseorder_syncSincroniza registros da solicitação de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaserequest_v1_000/post_mrppurchaserequestInclui ou atualiza um ou mais registros do pedido de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaserequest_v1_000/get_mrppurchaserequestRetorna lista de pedidos de compra do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
request (string)
sequence (string)
product (string)
productionOrder (string)
deliveryDate (string)
quantity (string)
receivedQuantity (string)
warehouse (string)
type (string)
protheus/mrppurchaserequest_v1_000/delete_mrppurchaserequestRemove um ou mais Pedido de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrppurchaserequest_v1_000/get_mrppurchaserequest_by_branch_id_by_codeRetorna o Pedido de Compra do MRPbranchId (string)
code (string)
fields (string)
protheus/mrppurchaserequest_v1_000/post_mrppurchaserequest_syncSincroniza registros do pedido de compra do MRPdata: {
. items (array)
} (object) required
protheus/mrprejectedinventory_v1_000/post_mrprejectedinventoryInclui ou atualiza um ou mais registros no estoque rejeitado do MRPdata: {
. items (array)
} (object) required
protheus/mrprejectedinventory_v1_000/get_mrprejectedinventoryRetorna lista de estoques rejeitados do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
product (string)
warehouse (string)
invoiceDate (string)
quantity (string)
returnedQuantity (string)
protheus/mrprejectedinventory_v1_000/delete_mrprejectedinventoryRemove um ou mais saldo rejeitado em Estoque do MRPdata: {
. items (array)
} (object) required
protheus/mrprejectedinventory_v1_000/get_mrprejectedinventory_by_branch_id_by_codeRetorna o Estoque Rejeitado do MRPbranchId (string)
code (string)
fields (string)
protheus/mrprejectedinventory_v1_000/delete_mrprejectedinventory_clear_productZera os saldos de um ou mais produtos em um determinado armazémdata: {
. items (array)
} (object) required
protheus/mrprejectedinventory_v1_000/post_mrprejectedinventory_syncSincroniza registros do estoque rejeitado do MRPdata: {
. items (array)
} (object) required
protheus/mrprouting_v1_000/post_mrproutingInclui ou atualiza um ou mais roteiro do MRPdata: {
. items (array)
} (object) required
protheus/mrprouting_v1_000/get_mrproutingRetorna lista de roteiros do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
product (string)
routing (string)
protheus/mrprouting_v1_000/delete_mrproutingRemove um ou mais roteiro do MRPdata: {
. items (array)
} (object) required
protheus/mrprouting_v1_000/get_mrprouting_by_branch_id_by_product_by_routingRetorna um roteiro do MRPbranchId (string)
product (string)
routing (string)
fields (string)
protheus/mrprouting_v1_000/post_mrprouting_syncSincroniza os registros do roteiro de produção do MRPdata: {
. items (array)
} (object) required
protheus/mrpstockbalance_v1_000/post_mrpstockbalanceInclui ou atualiza um ou mais registros no estoque do MRPdata: {
. items (array)
} (object) required
protheus/mrpstockbalance_v1_000/get_mrpstockbalanceRetorna lista de estoques do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
product (string)
warehouse (string)
lot (string)
sublot (string)
expirationDate (string)
availableQuantity (string)
consignedOut (string)
consignedIn (string)
unavailableQuantity (string)
qualityControlBalance (string)
blockedBalance (string)
protheus/mrpstockbalance_v1_000/delete_mrpstockbalanceRemove um ou mais saldo em Estoque do MRPdata: {
. items (array)
} (object) required
protheus/mrpstockbalance_v1_000/get_mrpstockbalance_by_branch_id_by_codeRetorna o Estoque do MRPbranchId (string)
code (string)
fields (string)
protheus/mrpstockbalance_v1_000/delete_mrpstockbalance_clear_productZera os saldos de um ou mais produtos em um determinado armazémdata: {
. items (array)
} (object) required
protheus/mrpstockbalance_v1_000/post_mrpstockbalance_syncSincroniza registros no estoque do MRPdata: {
. items (array)
} (object) required
protheus/mrptransportinglanes_v1_000/post_mrptransportinglanesInclui ou atualiza uma ou mais malha de distribuição do MRPdata: {
. items (array)
} (object) required
protheus/mrptransportinglanes_v1_000/get_mrptransportinglanesRetorna lista de malhas de distribuição do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
startWarehouseGroup (string)
branchIdDest (string)
endWarehouseGroup (string)
protheus/mrptransportinglanes_v1_000/delete_mrptransportinglanesRemove uma ou mais malhas de distribuição do MRPdata: {
. items (array)
} (object) required
protheus/mrptransportinglanes_v1_000/get_mrptransportinglanes_by_branch_id_by_start_warehouse_group_by_end_warehouse_groupRetorna uma malha de distribuição do MRPbranchId (string)
startWarehouseGroup (string)
endWarehouseGroup (string)
fields (string)
protheus/mrptransportinglanes_v1_000/post_mrptransportinglanes_syncSincroniza os registros da malha da distribuição do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouseinventorypolicies_v1_000/post_mrpwarehouseinventorypoliciesInclui ou atualiza as políticas de estoque por grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouseinventorypolicies_v1_000/get_mrpwarehouseinventorypoliciesRetorna lista de políticas de estoque por grupo de armazém do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
product (string)
warehouseGroup (string)
protheus/mrpwarehouseinventorypolicies_v1_000/delete_mrpwarehouseinventorypoliciesRemove as políticas de estoque por grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouseinventorypolicies_v1_000/get_mrpwarehouseinventorypolicies_by_branch_id_by_product_by_warehouse_groupRetorna a política de estoque por grupo de armazém do MRPbranchId (string)
product (string)
warehouseGroup (string)
fields (string)
protheus/mrpwarehouseinventorypolicies_v1_000/post_mrpwarehouseinventorypolicies_syncSincroniza os registros da política de estoque por grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehousegroup_v1_000/post_mrpwarehousegroupInclui ou atualiza um ou mais grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehousegroup_v1_000/get_mrpwarehousegroupRetorna lista de grupos de armazéns do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
protheus/mrpwarehousegroup_v1_000/delete_mrpwarehousegroupRemove um ou mais grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehousegroup_v1_000/get_mrpwarehousegroup_by_branch_id_by_warehouse_groupRetorna um grupo de armazém do MRPbranchId (string)
warehouseGroup (string)
fields (string)
protheus/mrpwarehousegroup_v1_000/post_mrpwarehousegroup_syncSincroniza os registros do grupo de armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouse_v1_000/post_mrpwarehouseInclui ou atualiza um ou mais registros de Armazéns do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouse_v1_000/get_mrpwarehouseRetorna lista de Armazéns do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
warehouse (string) required
type (string) required
useMRP (string) required
protheus/mrpwarehouse_v1_000/delete_mrpwarehouseRemove um ou mais armazéns do MRPdata: {
. items (array)
} (object) required
protheus/mrpwarehouse_v1_000/get_mrpwarehouse_by_branch_id_by_codeRetorna o Armazém do MRPbranchId (string)
code (string)
fields (string)
protheus/mrpwarehouse_v1_000/post_mrpwarehouse_syncInclui ou atualiza um ou mais registros no Armazém do MRPdata: {
. items (array)
} (object) required
protheus/mrpworkcenter_v1_000/post_mrpworkcenterInclui ou atualiza um ou mais centro do trabalho do MRPdata: {
. items (array)
} (object) required
protheus/mrpworkcenter_v1_000/get_mrpworkcenterRetorna lista de centros de trabalho do MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
workcenter (string)
protheus/mrpworkcenter_v1_000/delete_mrpworkcenterRemove um ou mais centros de trabalho do MRPdata: {
. items (array)
} (object) required
protheus/mrpworkcenter_v1_000/get_mrpworkcenter_by_branch_id_by_workcenterRetorna um centro de trabalho do MRPbranchId (string)
workcenter (string)
fields (string)
protheus/manifest_v1_000/get_manifestRetorna todos os romaneios cadastrados.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/manifest_v1_000/get_manifest_by_idRetorna o romaneio requeridoId (string)
Authorization (string) required
protheus/manifest_v1_000/post_manifest_by_idInclui o romaneio.Id (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. ManifestNumber (string)
. OperType (string)
. FreightClas (string)
. Carrier (string)
. Driver (string)
. Driver2 (string)
. VehicleType (string)
. FrontLicencePlate (string)
. RearLicencePlate (string)
. IntermediateLicPlate (string)
. Situation (string)
. ManifestCreationDate (string)
. CreationHour (string)
. CalculationStatus (string)
. CalculationDate (string)
. CalculationHour (string)
. User (string)
. Source (string)
. OutflowInflowDt (string)
. OutflowInflowHr (string)
. Route (string)
. DestinyCity (string)
. DestinPostalCode (string)
. ReturnDate (string)
. ReturnTime (string)
. DepartureOdometerReadin (string)
. ReturnOdometerReading (string)
. TracingCode (string)
. TollAmount (string)
. TollVoucher (string)
. SerialNumber (string)
. TripNumber (string)
} (object) required
protheus/manifest_v1_000/put_manifest_by_idAltera o romaneio informado.Id (string)
Authorization (string) required
data: {
. InternalId (string)
. BranchId (string)
. ManifestNumber (string)
. OperType (string)
. FreightClas (string)
. Carrier (string)
. Driver (string)
. Driver2 (string)
. VehicleType (string)
. FrontLicencePlate (string)
. RearLicencePlate (string)
. IntermediateLicPlate (string)
. Situation (string)
. ManifestCreationDate (string)
. CreationHour (string)
. CalculationStatus (string)
. CalculationDate (string)
. CalculationHour (string)
. User (string)
. Source (string)
. OutflowInflowDt (string)
. OutflowInflowHr (string)
. Route (string)
. DestinyCity (string)
. DestinPostalCode (string)
. ReturnDate (string)
. ReturnTime (string)
. DepartureOdometerReadin (string)
. ReturnOdometerReading (string)
. TracingCode (string)
. TollAmount (string)
. TollVoucher (string)
. SerialNumber (string)
. TripNumber (string)
} (object) required
protheus/marketsegment_v2_000/get_market_segmentRetorna todos SegmentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/marketsegment_v2_000/post_market_segmentInclui segmento passado na requisiçãoAuthorization (string) required
data: {
. marketSegmentID (string)
. branchId (string)
. companyId (string)
. marketSegmentDescription (string)
. mainMarketSegment (boolean)
. parentMarketSegment (string)
. parentMarketSegmentDescription (string)
. childs (object)
. IsActive (boolean)
} (object) required
protheus/marketsegment_v2_000/get_market_segment_by_market_segment_idRetorna Segmento com base em seu CódigomarketSegmentID (string)
Authorization (string) required
protheus/marketsegment_v2_000/put_market_segment_by_market_segment_idAtualiza o segmento informado na requisiçãomarketSegmentID (string)
Authorization (string) required
data: {
. marketSegmentID (string)
. branchId (string)
. companyId (string)
. marketSegmentDescription (string)
. mainMarketSegment (boolean)
. parentMarketSegment (string)
. parentMarketSegmentDescription (string)
. childs (object)
. IsActive (boolean)
} (object) required
protheus/marketsegment_v2_000/delete_market_segment_by_market_segment_idExclui o cadastro de segmento passada na requisiçãomarketSegmentID (string)
Authorization (string) required
protheus/menus_v1_001/get_menusRetorna todas os resourcesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/menus_v1_001/get_menus_by_parent_idRetorna todas os resourcesparentId (string)
Authorization (string) required
protheus/mrpprodversion_v1_000/post_mrpproductionversionInclui ou atualiza um ou mais registros de versão da produção MRPdata (object) required
protheus/mrpprodversion_v1_000/get_mrpproductionversionRetorna lista de versões da produção MRPorder (array)
page (integer)
pageSize (integer)
fields (string)
branchId (string)
code (string)
product (string)
startDate (string)
endDate (string)
startQuantity (string)
endQuantity (string)
revision (string)
routing (string)
protheus/mrpprodversion_v1_000/delete_mrpproductionversionRemove uma ou mais Versões da produção MRPdata (object) required
protheus/mrpprodversion_v1_000/get_mrpproductionversion_by_branch_id_by_codeRetorna uma Versão da Produção MRPbranchId (string)
code (string)
fields (string)
protheus/mrpprodversion_v1_000/post_mrpproductionversion_syncSincroniza os registros da versão da produção MRPdata (object) required
protheus/notes_v1_000/get_notesRetorna lista completa das AnotaçõesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/notes_v1_000/post_notesInclui uma anotação conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. ResourceType (string)
. ResourceCode (string)
. Date (string)
. Content (string)
. Bloqued (string)
} (object) required
protheus/notes_v1_000/get_notes_by_internal_idRetorna a anotação de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/notes_v1_000/put_notes_by_internal_idAtualiza a anotação conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. ResourceType (string)
. ResourceCode (string)
. Date (string)
. Content (string)
. Bloqued (string)
} (object) required
protheus/notes_v1_000/delete_notes_by_internal_idExclui uma anotação conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/opportunity_v1_000/get_opportunitiesRetorna lista completa das oportunidades de VendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/opportunity_v1_000/post_opportunitiesInclui uma oportunidade de venda conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Review (string)
. Description (string)
. Seller (string)
. SellerName (string)
. ListofConsumer (array)
. StartDate (string)
. ClosingDate (string)
. Process (string)
. Stage (string)
. Notes (string)
. Currency (number)
. Priority (string)
. SuccessFactor (string)
. FailureFactor (string)
. Status (string)
. Ending (string)
. Reason (string)
. DateSignature (string)
. Comments (string)
. ListOfContacts (array)
} (object) required
protheus/opportunity_v1_000/get_opportunities_by_internal_idRetorna a oportunidade de venda pelo códigoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/opportunity_v1_000/put_opportunities_by_internal_idAtualiza a oportunidade de venda conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Review (string)
. Description (string)
. Seller (string)
. SellerName (string)
. ListofConsumer (array)
. StartDate (string)
. ClosingDate (string)
. Process (string)
. Stage (string)
. Notes (string)
. Currency (number)
. Priority (string)
. SuccessFactor (string)
. FailureFactor (string)
. Status (string)
. Ending (string)
. Reason (string)
. DateSignature (string)
. Comments (string)
. ListOfContacts (array)
} (object) required
protheus/opportunity_v1_000/delete_opportunities_by_internal_idExclui a oportunidade de venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/paymentcondition_v1_00/get_paymentconditionRetorna lista completa das condições de pagamentoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/paymentcondition_v1_00/post_paymentconditionInclui uma condição de pagamento conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. MeanTime (integer)
. DaysFirstDue (integer)
. QuantityPlots (integer)
. RangePlots (integer)
. WeekDayFixed (String)
. DayMonthFixed (integer)
. DaysCondition (String)
. FinancialDiscountDays (integer)
. PercentageDiscountDays (number)
. PercentageIncrease
. DaysCountWay (integer)
. PaymentSituation (integer)
. StartCounting (varchar)
. Plots (object)
} (object) required
protheus/paymentcondition_v1_00/get_paymentcondition_by_internal_idRetorna a condição de pagamento pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
protheus/paymentcondition_v1_00/put_paymentcondition_by_internal_idAtualiza a condição de pagamento conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. MeanTime (integer)
. DaysFirstDue (integer)
. QuantityPlots (integer)
. RangePlots (integer)
. WeekDayFixed (String)
. DayMonthFixed (integer)
. DaysCondition (String)
. FinancialDiscountDays (integer)
. PercentageDiscountDays (number)
. PercentageIncrease
. DaysCountWay (integer)
. PaymentSituation (integer)
. StartCounting (varchar)
. Plots (object)
} (object) required
protheus/paymentcondition_v1_00/delete_paymentcondition_by_internal_idExclui a condição de pagamento conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/payrollcontrol_v1_000/get_payroll_controlRetorna os dados da folha de pagamento de benefíciosAssitência Médica e OdontológicaAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
datemodified (string)
providerType (string) required
companyid (string) required
protheus/pricelistheaderitem_v2_005/get_price_list_header_itemsRetorna lista de Tabela de PreçoAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/pricelistheaderitem_v2_005/post_price_list_header_itemsInclui uma tabela de preço conforme dados enviados na requisição.Authorization (string) required
data (object) required
protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_codeRetorna a tabela de preço e todos os seus itens de acordo com o seu códigocode (string)
Authorization (string) required
order (array)
fields (string)
protheus/pricelistheaderitem_v2_005/put_price_list_header_items_by_codeAtualiza o cadastro da tabela de preço conforme dados enviados na requisiçãocode (string)
Authorization (string) required
data (object) required
protheus/pricelistheaderitem_v2_005/delete_price_list_header_items_by_codeExclui a tabela de preço conforme dados enviados na requisição.code (string)
Authorization (string) required
protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_priceRetorna os itens da tabela de preço de acordo com o seu códigocode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/pricelistheaderitem_v2_005/post_price_list_header_items_by_code_itens_table_priceInclui um novo item na tabela de preço conforme dados enviados.code (string)
Authorization (string) required
data: {
. items
} (object) required
protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price_by_item_listRetorna um item específico de preço de acordo com o seu códigocode (string)
itemList (undefined)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/pricelistheaderitem_v2_005/put_price_list_header_items_by_code_itens_table_price_by_item_listAtualiza um item da tabela de preço conforme dados enviados na requisiçãocode (string)
itemList (undefined)
Authorization (string) required
fields (string)
data: {
. items
} (object) required
protheus/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code_itens_table_price_by_item_listExclui um item da tabela de preço conforme dados enviados na requisição.code (string)
itemList (undefined)
Authorization (string) required
protheus/productsupplierrelationship_v1_000/get_product_supplier_relationshipRetorna lista completa de relacionamentos entre Produtos e FornecedoresAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/productsupplierrelationship_v1_000/post_product_supplier_relationshipInclui um relacionamento entre Produto e FornecedorAuthorization (string) required
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. VendorCode (string)
. CustomerVendorInternalId (string)
. InternalId (string)
. VendorName (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemName (string)
. Situation (integer)
. UnitOfMeasureInternalId (string)
. FornecUnitOfMeasureCode (string)
. ConversionFactor (string)
. ItemVendorCode (string)
} (object) required
protheus/productsupplierrelationship_v1_000/get_product_supplier_relationship_by_internal_idRetorna um registro de relacionamento de Produto e FornecedorInternalId (string)
Authorization (string) required
protheus/productsupplierrelationship_v1_000/put_product_supplier_relationship_by_internal_idAtualiza um registro de relacionamento de Produto e FornecedorInternalId (string)
Authorization (string) required
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. VendorCode (string)
. CustomerVendorInternalId (string)
. InternalId (string)
. VendorName (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemName (string)
. Situation (integer)
. UnitOfMeasureInternalId (string)
. FornecUnitOfMeasureCode (string)
. ConversionFactor (string)
. ItemVendorCode (string)
} (object) required
protheus/productsupplierrelationship_v1_000/delete_product_supplier_relationship_by_internal_idExclui um registro de relacionamento de produto e Fornecedor conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
protheus/prospects_v1_000/get_prospectsRetorna lista completa de prospectsAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/prospects_v1_000/post_prospectsInclui um prospect conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. ProspectSituation (string)
. GovernmentalInformation (array)
} (object) required
protheus/prospects_v1_000/get_prospects_by_codeRetorna prospect pelo seu CódigoCode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/prospects_v1_000/put_prospects_by_codeAtualiza cadastro de prospect conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. ProspectSituation (string)
. GovernmentalInformation (array)
} (object) required
protheus/prospects_v1_000/delete_prospects_by_codeExclui cadastro de Prospect conforme dados enviados na requisição.Code (string)
Authorization (string) required
protheus/purchasegroups_v1_000/get_purchase_groupsRetorna todos os Grupo Compras purchaseGroups do Protheus.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/purchasegroups_v1_000/post_purchase_groupsInclui um Grupo de Compras purchaseGroups, com base nos dados enviados na requisição.Authorization (string) required
data: {
. companyInternalId (string)
. InternalId (string)
. branchId (string)
. code (string)
. ListOfUserList (object)
} (object) required
protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_idRetorna um Grupo de Compras purchaseGroup, especifico com base nas informações enviadas na requisição.InternalId (string)
Authorization (string) required
protheus/purchasegroups_v1_000/put_purchase_groups_by_internal_idAltera um Grupo de Compras purchaseGroup, especifico com base nos dados enviados na requisição.InternalId (string)
Authorization (string) required
data: {
. companyInternalId (string)
. InternalId (string)
. branchId (string)
. code (string)
. ListOfUserList (object)
} (object) required
protheus/purchasegroups_v1_000/delete_purchase_groups_by_internal_idExclusão de um Grupo de Compras, baseado nas informações enviadas na requisição.InternalId (string)
Authorization (string) required
protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_id_purchase_groups_itensRetorna todos os Compradores Buyers cadastrados no Grupo de Compras purchaseGroup especifico.InternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/purchasegroups_v1_000/post_purchase_groups_by_internal_id_purchase_groups_itensInclui um Comprador Buyer em um Grupo de Compras purchaseGroup existente, baseado nos dados enviados na requisição.InternalId (string)
Authorization (string) required
data (array) required
protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequenceRetorna o Comprador Buyer especifico do Grupo de Compras purchaseGroup, baseado na requisição enviada.InternalId (string)
itemsequence (string)
Authorization (string) required
protheus/purchasegroups_v1_000/put_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequenceAltera um Comprador Buyer especifico do Grupo de Compras purchaseGroup, baseando nas informações passadas na requisição.InternalId (string)
itemsequence (string)
Authorization (string) required
data (array) required
protheus/purchasegroups_v1_000/delete_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequenceExclui um Comprador Buyer em um Grupo de Compras purchaseGroups baseado nos dados enviados na requisição.InternalId (string)
itemsequence (string)
Authorization (string) required
protheus/regiongroups_v1_000/get_regiongroupsRetorna lista completa do Grupo de RegiãoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/regiongroups_v1_000/post_regiongroupsInclui um Grupo de Região conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. TopGroup (string)
. State
. DestinationBranch (string)
. AssociatedCompanyRegionCode (string)
. AssociatedCompanyRegionDescription (string)
. RegionCategory (string)
. BaseTaxRegion (string)
. GroupCategory (string)
. RegionExemptTaxes (string)
. ISSRate (number)
. Country
. City
. TMSPortal (string)
} (object) required
protheus/regiongroups_v1_000/get_regiongroups_by_internal_idRetorna o Grupo de Região de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/regiongroups_v1_000/put_regiongroups_by_internal_idAtualiza o Grupo de Região conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. TopGroup (string)
. State
. DestinationBranch (string)
. AssociatedCompanyRegionCode (string)
. AssociatedCompanyRegionDescription (string)
. RegionCategory (string)
. BaseTaxRegion (string)
. GroupCategory (string)
. RegionExemptTaxes (string)
. ISSRate (number)
. Country
. City
. TMSPortal (string)
} (object) required
protheus/regiongroups_v1_000/delete_regiongroups_by_internal_idExclui um Grupo de Região conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/requesters_v1_000/get_requestersRetorna lista completa do SolicitanteAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/requesters_v1_000/post_requestersInclui um Solicitante conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. code (string)
. CustomerCode
. CustomerStoreId
. name (string)
. shortName (string)
. address (object)
. GovernmentalInformation
. contactInfo (object)
. communicationInfo (object)
. regionGroupCode (string)
. regionGroup (string)
. pickupInfo (object)
. Products (array)
} (object) required
protheus/requesters_v1_000/get_requesters_by_internal_idRetorna o Solicitante de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/requesters_v1_000/put_requesters_by_internal_idAtualiza o Solicitante conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. code (string)
. CustomerCode
. CustomerStoreId
. name (string)
. shortName (string)
. address (object)
. GovernmentalInformation
. contactInfo (object)
. communicationInfo (object)
. regionGroupCode (string)
. regionGroup (string)
. pickupInfo (object)
. Products (array)
} (object) required
protheus/requesters_v1_000/delete_requesters_by_internal_idExclui um Solicitante conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/resource_v1_001/post_resourcesAdiciona novo Recursodata: {
. ResourceId (string)
. Code (string)
. Type (string)
. Name (string)
. ProductionAreaCode (string)
. ProductionAreaDescription (string)
. ProductionShiftNumber (string)
. LaborCode (string)
. StartExpirationDate (string)
. EndExpirationDate (string)
. UnitCycleQuantity (integer)
. ToolCode (string)
. ToolDescription (string)
} (object) required
protheus/resource_v1_001/get_resourcesRetorna lista de Recursosorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/resource_v1_001/get_resources_by_resource_idRetorna um RecursoResourceId (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/resource_v1_001/put_resources_by_resource_idAtualiza um RecursoResourceId (string)
data: {
. ResourceId (string)
. Code (string)
. Type (string)
. Name (string)
. ProductionAreaCode (string)
. ProductionAreaDescription (string)
. ProductionShiftNumber (string)
. LaborCode (string)
. StartExpirationDate (string)
. EndExpirationDate (string)
. UnitCycleQuantity (integer)
. ToolCode (string)
. ToolDescription (string)
} (object) required
protheus/resource_v1_001/delete_resources_by_resource_idRemove um RecursoResourceId (string)
protheus/retailitem_v1_000/get_retail_itemRetorna uma lista com todos os ProdutosAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/retailpricelist_v1_000/get_retail_price_listRetorna uma lista com o cabeçalho de todas as Tabelas de PreçoAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/retailpricelist_v1_000/get_retail_price_list_by_internal_idRetorna o cabeçalho de uma única Tabela de Preço a partir do internalId identificador único da Tabela de PreçointernalId (string)
Authorization (string) required
order (array)
fields (string)
protheus/retailpricelist_v1_000/get_retail_price_list_by_internal_id_itens_table_priceRetorna todos os itens de uma única Tabela de Preço a partir do internalId identificador único da Tabela de PreçointernalId (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/retailsalesorders_v1_000/get_retail_sales_ordersLista todos os pedidos de venda do faturamento SC5 relacionados ao varejo.Authorization (string) required
protheus/retailsalesorders_v1_000/get_retail_sales_orders_by_internal_id_itemsExibe os detalhes dos itens do pedido de venda SC6 para o pedido informado.internalId (string)
Authorization (string) required
protheus/retailsales_v1_000/post_retail_sales_by_internal_id_cancelationCancela uma venda de acordo com os valores do parametro InternalId ''Filial|número da venda|operador|número cancelamento SAT'' envie o número cancelamento SAT caso existaInternalId (string)
Authorization (string) required
protheus/retailsales_v1_000/get_retail_salesRetorna todas as vendas varejoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/retailsales_v1_000/post_retail_salesInclui a entidade RetailSales passada na requisiçãoAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerInternalId (string)
. ComissionPercent (number)
. CustomerVendorInternalId (string)
. TotalPrice (number)
. DiscountValue (number)
. IncreaseValue (number)
. NetPrice (number)
. CashValue (number)
. ChecksValue (number)
. CardsValue (number)
. DebitValue (number)
. CovenantValue (number)
. VouchersValue (number)
. FinancedValue (number)
. OthersValue (number)
. InputValue (number)
. IssueDateDocument (string)
. EmisNf (string)
. DateTime (string)
. InvoiceMessages (string)
. DocumentCode (string)
. SerieCode (string)
. NumCFis (string)
. GrossPrice (number)
. CommodityPrice (number)
. DiscountPercent (number)
. OperatorCode (string)
. OperatorInternalId (string)
. CurrencyRate (number)
. Change (number)
. StationCode (string)
. DiscountPaymentTerm (number)
. CreditValue (number)
. KindOfDocument (string)
. CarrierCode (string)
. CarrierInternalId (string)
. Md5 (string)
. MovementNumber (string)
. ElectronicInvoiceComplement (string)
. PersonalIdentification (string)
. PurchaserName (string)
. DocForeignPurchase (string)
. IsCanceled (boolean)
. NfceProtocol (string)
. ListOfSaleItem (array)
. ListOfSaleCondition (array)
. ListOfTaxes (array)
. StationSalePointCode (string)
. StationSalePointInternalId (string)
. SerialNumberSATEquipament (string)
. SaleType (string)
. KeyAcessNFe (string)
. StateTaxBurden (number)
. MunicipalTaxBurden (number)
. FederalTaxBurden (number)
. TaxSource (string)
. BookingInformation (object)
. PresencialIndicator (string)
. IntermediaryCode (string)
} (object) required
protheus/retailsales_v1_000/get_retail_sales_by_internal_idRetorna os dados da venda de acordo com o número do documento da venda e filial passadas por parametroInternalId (string)
Authorization (string) required
protheus/retailsales_v1_000/put_retail_sales_by_internal_idAtualiza a entidade RetailSales passada na requisiçãoInternalId (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerInternalId (string)
. ComissionPercent (number)
. CustomerVendorInternalId (string)
. TotalPrice (number)
. DiscountValue (number)
. IncreaseValue (number)
. NetPrice (number)
. CashValue (number)
. ChecksValue (number)
. CardsValue (number)
. DebitValue (number)
. CovenantValue (number)
. VouchersValue (number)
. FinancedValue (number)
. OthersValue (number)
. InputValue (number)
. IssueDateDocument (string)
. EmisNf (string)
. DateTime (string)
. InvoiceMessages (string)
. DocumentCode (string)
. SerieCode (string)
. NumCFis (string)
. GrossPrice (number)
. CommodityPrice (number)
. DiscountPercent (number)
. OperatorCode (string)
. OperatorInternalId (string)
. CurrencyRate (number)
. Change (number)
. StationCode (string)
. DiscountPaymentTerm (number)
. CreditValue (number)
. KindOfDocument (string)
. CarrierCode (string)
. CarrierInternalId (string)
. Md5 (string)
. MovementNumber (string)
. ElectronicInvoiceComplement (string)
. PersonalIdentification (string)
. PurchaserName (string)
. DocForeignPurchase (string)
. IsCanceled (boolean)
. NfceProtocol (string)
. ListOfSaleItem (array)
. ListOfSaleCondition (array)
. ListOfTaxes (array)
. StationSalePointCode (string)
. StationSalePointInternalId (string)
. SerialNumberSATEquipament (string)
. SaleType (string)
. KeyAcessNFe (string)
. StateTaxBurden (number)
. MunicipalTaxBurden (number)
. FederalTaxBurden (number)
. TaxSource (string)
. BookingInformation (object)
. PresencialIndicator (string)
. IntermediaryCode (string)
} (object) required
protheus/retailsales_v1_000/delete_retail_sales_by_internal_idDeleta a entidade RetailSales passada na requisiçãoInternalId (string)
protheus/retailsales_v2_000/post_retail_salesInclui a entidade RetailSales passada na requisição por ExecAuto do LojaAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerInternalId (string)
. ComissionPercent (number)
. CustomerVendorInternalId (string)
. TotalPrice (number)
. DiscountValue (number)
. IncreaseValue (number)
. NetPrice (number)
. CashValue (number)
. ChecksValue (number)
. CardsValue (number)
. DebitValue (number)
. CovenantValue (number)
. VouchersValue (number)
. FinancedValue (number)
. OthersValue (number)
. InputValue (number)
. IssueDateDocument (string)
. EmisNf (string)
. DateTime (string)
. InvoiceMessages (string)
. DocumentCode (string)
. SerieCode (string)
. NumCFis (string)
. GrossPrice (number)
. CommodityPrice (number)
. DiscountPercent (number)
. OperatorCode (string)
. OperatorInternalId (string)
. CurrencyRate (number)
. Change (number)
. StationCode (string)
. DiscountPaymentTerm (number)
. CreditValue (number)
. KindOfDocument (string)
. CarrierCode (string)
. CarrierInternalId (string)
. Md5 (string)
. MovementNumber (string)
. ElectronicInvoiceComplement (string)
. PersonalIdentification (string)
. PurchaserName (string)
. DocForeignPurchase (string)
. IsCanceled (boolean)
. NfceProtocol (string)
. ListOfSaleItem (array)
. ListOfSaleCondition (array)
. ListOfTaxes (array)
. StationSalePointCode (string)
. StationSalePointInternalId (string)
. SerialNumberSATEquipament (string)
. SaleType (string)
. KeyAcessNFe (string)
. StateTaxBurden (number)
. MunicipalTaxBurden (number)
. FederalTaxBurden (number)
. TaxSource (string)
. BookingInformation (object)
. PresencialIndicator (string)
. IntermediaryCode (string)
} (object) required
protheus/retailstocklevel_v1_000/get_retail_stock_levelRetorna uma lista com todos os Produtos com saldo em estoqueAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/roles_v1_000/get_rolesRetorna todas os RolesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/salescharge_v1_000/get_sales_chargeRetorna todos as comissões dos vendedoresAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/salescharge_v1_000/post_sales_chargeInclui uma comissão para um determinado vendedorfields (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerInternalId (string)
. SellerId (string)
. AccountReceivableDocumentInternalId (string)
. AccountReceivableDocumentPrefix (string)
. AccountReceivableDocumentNumber (string)
. AccountReceivableDocumentParcel (string)
. AccountReceivableDocumentTypeCode (string)
. CustomerVendorInternalId (string)
. CustomerVendorCode (string)
. CustomerVendorStore (string)
. IssueDate (string)
. BaseValue (number)
. SalesChargePercentage (number)
. Value (number)
. DueDate (string)
. CurrencyInternalId (string)
. Currency (string)
. HotelInvoiceInternalID (string)
} (object) required
protheus/salescharge_v1_000/get_sales_charge_by_internal_idRetorna todas as comissões do vendedorInternalId (string)
Authorization (string) required
fields (string)
page (integer)
pageSize (integer)
protheus/salescharge_v1_000/get_sales_charge_by_internal_id_by_account_receivable_document_internal_idRetorna a comissão do vendedor, com base nos parâmetros passadosAccountReceivableDocumentInternalId (string)
InternalId (string)
Authorization (string) required
fields (string)
page (integer)
pageSize (integer)
protheus/salescharge_v1_000/put_sales_charge_by_internal_id_by_account_receivable_document_internal_idAtualiza a comissão do vendedor, com base nos parâmetros passadosInternalId (string)
AccountReceivableDocumentInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. SellerInternalId (string)
. SellerId (string)
. AccountReceivableDocumentInternalId (string)
. AccountReceivableDocumentPrefix (string)
. AccountReceivableDocumentNumber (string)
. AccountReceivableDocumentParcel (string)
. AccountReceivableDocumentTypeCode (string)
. CustomerVendorInternalId (string)
. CustomerVendorCode (string)
. CustomerVendorStore (string)
. IssueDate (string)
. BaseValue (number)
. SalesChargePercentage (number)
. Value (number)
. DueDate (string)
. CurrencyInternalId (string)
. Currency (string)
. HotelInvoiceInternalID (string)
} (object) required
protheus/salescharge_v1_000/delete_sales_charge_by_internal_id_by_account_receivable_document_internal_idExclui a comissão do vendedor, com base nos parâmetros passadosInternalId (string)
AccountReceivableDocumentInternalId (string)
Authorization (string) required
order (array)
protheus/salesprocess_v1_000/get_sales_processRetorna lista completa de Processos de VendaAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/salesprocess_v1_000/post_sales_processInclui um Processo de Venda conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Description (string)
. RegisterSituation (string)
. ListofStages (array)
. ListofRules (array)
} (object) required
protheus/salesprocess_v1_000/get_sales_process_by_internal_idRetorna o Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/salesprocess_v1_000/put_sales_process_by_internal_idAtualiza cadastro de Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Description (string)
. RegisterSituation (string)
. ListofStages (array)
. ListofRules (array)
} (object) required
protheus/salesprocess_v1_000/delete_sales_process_by_internal_idExclui cadastro de Processo de Venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_stagesRetorna lista completa de Estágios do Processo de VendaInternalId (string)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/salesprocess_v1_000/post_sales_process_by_internal_id_list_of_stagesInclui um Estágio no Processo de Venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. StageInternalId (string)
. StageId (string)
. StageDescription (string)
. Contribute (number)
. Notify (string)
. Action (string)
. FinancialEvaluation (string)
. ValueOverdue (number)
. DaysOverdue (number)
. ProspectEvaluation (string)
. DurationDays (number)
. DurationHours (string)
} (object) required
protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_stages_by_stage_idRetorna o Estágio do Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
StageId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/salesprocess_v1_000/put_sales_process_by_internal_id_list_of_stages_by_stage_idAtualiza a cadastro de um Estágio do Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
StageId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. StageInternalId (string)
. StageId (string)
. StageDescription (string)
. Contribute (number)
. Notify (string)
. Action (string)
. FinancialEvaluation (string)
. ValueOverdue (number)
. DaysOverdue (number)
. ProspectEvaluation (string)
. DurationDays (number)
. DurationHours (string)
} (object) required
protheus/salesprocess_v1_000/delete_sales_process_by_internal_id_list_of_stages_by_stage_idExclui cadastro de Estágio do Processo de Venda conforme dados enviados na requisição.InternalId (string)
StageId (string)
Authorization (string) required
protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_rulesRetorna lista completa de Regras do Processo de VendaInternalId (string)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/salesprocess_v1_000/post_sales_process_by_internal_id_list_of_rulesInclui uma Regra no Processo de Venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. RuleInternalId (string)
. RuleId (string)
. Operation (string)
. Event (string)
. Action (string)
. Stage (string)
} (object) required
protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_rules_by_rule_idRetorna a Regra do Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
RuleId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/salesprocess_v1_000/put_sales_process_by_internal_id_list_of_rules_by_rule_idAtualiza a cadastro de uma Regra do Processo de Venda conforme dados enviados na requisiçãoInternalId (string)
RuleId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. RuleInternalId (string)
. RuleId (string)
. Operation (string)
. Event (string)
. Action (string)
. Stage (string)
} (object) required
protheus/salesprocess_v1_000/delete_sales_process_by_internal_id_list_of_rules_by_rule_idExclui cadastro da Regra do Processo de Venda conforme dados enviados na requisição.InternalId (string)
RuleId (string)
Authorization (string) required
protheus/salestargets_v1_000/get_sales_targetRetorna uma lista completa de Metas de VendasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/salestargets_v1_000/post_sales_targetInclui uma Meta de venda conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. SalesTargetDescription (string)
. ListOfSalesTargets (object)
} (object) required
protheus/salestargets_v1_000/get_sales_target_by_internal_idRetorna uma Meta de Venda pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
protheus/salestargets_v1_000/put_sales_target_by_internal_idAltera uma Meta de Venda pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. SalesTargetDescription (string)
. ListOfSalesTargets (object)
} (object) required
protheus/salestargets_v1_000/delete_sales_target_by_internal_idExclui uma Meta de Venda pelo InternalIdInternalId (string)
Authorization (string) required
protheus/salestargets_v1_000/get_sales_target_by_internal_id_itens_sales_targetRetorna uma lista completa dos Itens das Metas de VendasInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/salestargets_v1_000/post_sales_target_by_internal_id_itens_sales_targetInclui um item de uma Meta de venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
fields (string)
data (array) required
protheus/salestargets_v1_000/get_sales_target_by_internal_id_itens_sales_target_by_item_idRetorna um item de uma Meta de Venda de venda especifica pelo ItemIdInternalId (string)
ItemId (string)
Authorization (string) required
fields (string)
protheus/salestargets_v1_000/put_sales_target_by_internal_id_itens_sales_target_by_item_idAltera um item de uma Meta de Venda de venda especifica pelo ItemIdInternalId (string)
ItemId (string)
Authorization (string) required
fields (string)
data (array) required
protheus/salestargets_v1_000/delete_sales_target_by_internal_id_itens_sales_target_by_item_idExclui um item de uma Meta de Venda de venda especifica pelo ItemIdInternalId (string)
ItemId (string)
Authorization (string) required
protheus/salestaxes_v1_000/get_sales_taxes_by_sales_order_idRetorna uma lista com os Valores e Tributos de um Pedido de Venda gravadoSalesOrderId (string)
Authorization (string) required
protheus/salestaxes_v1_000/post_sales_taxesRetorna uma lista com os Valores e Tributos de uma Simulação de Pedido de VendaAuthorization (string) required
fields (string)
data: {
. SalesType (string)
. CustomerId (string)
. CustomerUnit (string)
. CustomerIdDelivery (string)
. CustomerUnitDelivery (string)
. CustomerType (string)
. Payment (string)
. DiscountPercentage1 (number)
. DiscountPercentage2 (number)
. DiscountPercentage3 (number)
. DiscountPercentage4 (number)
. Currency (number)
. Freight (number)
. Insurance (number)
. Expense (number)
. ListofProducts (array)
} (object) required
protheus/custom/post_se2listaEndpoint custom não TTalk que aceita uma lista de títulos a pagar com os nomes de campo crus do Protheus e2_.autonum (boolean)
data: {
. se2 (array)
} (object) required
protheus/selleractivity_v1_000/get_selleractivityRetorna uma lista completa de Atividades dos vendedoresAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/selleractivity_v1_000/post_selleractivityInclui uma Atividade conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. Code (string)
. InternalId (string)
. Type (String)
. Status (String)
. Participant (string)
. LocalActivity (string)
. Subject (string)
. RegisterDate (string)
. Description (string)
. Owner (string)
. Priority (String)
. StartDate (string)
. StartTime (string)
. EndDate (string)
. EndTime (string)
. Duration (string)
. EntityId (string)
. EntityKey (string)
. RemindDate (string)
. RemindTime (string)
. CompletionPercentage (String)
. ConclusionDate (string)
. RegisterSituation (String)
} (object) required
protheus/selleractivity_v1_000/get_selleractivity_by_internal_idRetorna uma Atividade pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
protheus/selleractivity_v1_000/put_selleractivity_by_internal_idAltera uma Atividade pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. Code (string)
. InternalId (string)
. Type (String)
. Status (String)
. Participant (string)
. LocalActivity (string)
. Subject (string)
. RegisterDate (string)
. Description (string)
. Owner (string)
. Priority (String)
. StartDate (string)
. StartTime (string)
. EndDate (string)
. EndTime (string)
. Duration (string)
. EntityId (string)
. EntityKey (string)
. RemindDate (string)
. RemindTime (string)
. CompletionPercentage (String)
. ConclusionDate (string)
. RegisterSituation (String)
} (object) required
protheus/selleractivity_v1_000/delete_selleractivity_by_internal_idExclui uma Atividade pelo InternalIdInternalId (string)
Authorization (string) required
protheus/sellers_v2_000/get_sellerRetorna lista completa de vendedoresAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
protheus/sellers_v2_000/post_sellerInclui um vendedor conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. companyId (string)
. branchID (string)
. CompanyInternalId (string)
. code (string)
. internalId (string)
. name (string)
. shortName (string)
. personalIdentification (string)
. sellerPassWord (string)
. sellerPhoneDDD (string)
. sellerPhone (string)
. sellerEmail (string)
. address (object)
. salesChargeInformation (object)
. active (boolean)
. representativeType (string)
} (object) required
protheus/sellers_v2_000/get_seller_by_codeRetorna vendedor pelo seu Códigocode (string)
Authorization (string) required
fields (string)
protheus/sellers_v2_000/put_seller_by_codeAtualiza cadastro de vendedor conforme dados enviados na requisiçãocode (string)
Authorization (string) required
fields (string)
data: {
. companyId (string)
. branchID (string)
. CompanyInternalId (string)
. code (string)
. internalId (string)
. name (string)
. shortName (string)
. personalIdentification (string)
. sellerPassWord (string)
. sellerPhoneDDD (string)
. sellerPhone (string)
. sellerEmail (string)
. address (object)
. salesChargeInformation (object)
. active (boolean)
. representativeType (string)
} (object) required
protheus/sellers_v2_000/delete_seller_by_codeExclui cadastro de vendedor conforme dados enviados na requisição.code (string)
Authorization (string) required
protheus/stopreason_v1_000/post_stop_reasonsAdiciona novo Motivo de Paradadata: {
. Id (string)
. Code (string)
. Description (string)
. IsEfficiency (boolean)
. IsEmailEquipment (boolean)
. IsServiceRequest (boolean)
. IsSetup (boolean)
} (object) required
protheus/stopreason_v1_000/get_stop_reasonsRetorna lista de motivos de paradaorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/stopreason_v1_000/get_stop_reasons_by_idRetorna um único motivo de paradaId (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/stopreason_v1_000/put_stop_reasons_by_idAtualiza um Motivo de ParadaId (string)
data: {
. Id (string)
. Code (string)
. Description (string)
. IsEfficiency (boolean)
. IsEmailEquipment (boolean)
. IsServiceRequest (boolean)
. IsSetup (boolean)
} (object) required
protheus/stopreason_v1_000/delete_stop_reasons_by_idRemove um Motivo de ParadaId (string)
protheus/stopreport_v1_003/post_stop_reportsAdiciona novo Apontamento de Paradadata: {
. MachineCode (string)
. ProductionOrder (string)
. ActivityCode (string)
. ActivityId (string)
. MachineDescription (string)
. StopReasonCode (string)
. StopReasonDescription (string)
. StartDateTime (string)
. EndDateTime (string)
. ToolCode (string)
. ToolDescription (string)
. ProductionTeamCode (string)
. ProductionTeamName (string)
. OperatorCode (string)
. OperatorName (string)
. ProductionShiftCode (string)
. ProductionShiftDescription (string)
. ProductionShiftNumber (integer)
. StopType (string)
. ReportDateTime (string)
. GeneralStopCode (string)
. ReportSequence (integer)
. ReversedReport (boolean)
. IntegrationReport (string)
. ListOfDirectLabors (array)
. DocumentCode (string)
. StopCauseCode (string)
. Observation (string)
} (object) required
protheus/stopreport_v1_003/get_stop_reportsRetorna lista de Apontamentos de Paradaorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/stopreport_v1_003/get_stop_reports_by_integration_reportRetorna um Apontamento de ParadaIntegrationReport (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/stopreport_v1_003/delete_stop_reports_by_integration_report_reversalEstorna um Apontamento de ParadaIntegrationReport (string)
protheus/suspects_v1_000/get_suspectsRetorna lista completa de SuspectsAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/suspects_v1_000/post_suspectsInclui um Suspect conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. SuspectSituation (string)
. GovernmentalInformation (array)
} (object) required
protheus/suspects_v1_000/get_suspects_by_codeRetorna Suspect pelo seu CódigoCode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
protheus/suspects_v1_000/put_suspects_by_codeAtualiza cadastro de Suspect conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. SuspectSituation (string)
. GovernmentalInformation (array)
} (object) required
protheus/suspects_v1_000/delete_suspects_by_codeExclui cadastro de Suspect conforme dados enviados na requisição.Code (string)
Authorization (string) required
protheus/systemmodules_v1_000/get_system_modulesRetorna todas os SystemModulesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/systemmodules_v1_000/get_system_modules_by_idRetorna todas os SystemModulesid (string)
Authorization (string) required
protheus/systemparameter_v1_000/get_system_parametersRetorna todos os parâmetros do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
codes (string)
Accept-Language (string)
description (string)
protheus/systemparameter_v1_000/post_system_parametersInclui o parâmetro passado na requisiçãoAuthorization (string) required
data: {
. systemParameterId (string)
. companyID (string)
. branchID (string)
. code (string)
. type (string)
. description (array)
. value (array)
. scope (string)
. group (object)
} (object) required
protheus/systemparameter_v1_000/put_system_parameters_by_system_parameter_idAltera o parâmetro passado na requisiçãosystemParameterId (string)
Authorization (string) required
data: {
. systemParameterId (string)
. companyID (string)
. branchID (string)
. code (string)
. type (string)
. description (array)
. value (array)
. scope (string)
. group (object)
} (object) required
protheus/systemparameter_v1_000/delete_system_parameters_by_system_parameter_idExclusão de parâmetro da basesystemParameterId (string)
protheus/tafesocialremovecompany_v1_000/delete_tafesocial_remove_company_by_company_idRemove os dados do empregador do e-Social da base de dados do RETcompanyId (string)
protheus/tsibranches_v1_000/get_tsibranchesRetorna as filiais do grupo informado de acordo com o parâmetro 'companyId'.companyId (string) required
protheus/tsiintegrationerrors_v1_000/get_tsiintegration_errorsConsulta os erros ocorridos durante a integração dos dados entre o ERP e o TAF.companyId (string) required
branchCode (string) required
typeFilter (string) required
dateOf (date)
dateUp (date)
order (array)
page (integer)
pageSize (integer)
protheus/tsiservicestatus_v1_000/get_tsiservice_statusConsulta o status do serviço, se está configurado e/ou ativo.companyId (string) required
protheus/token_v1_000/post_tokenAplicativos realizam a requisição ao endpoint inserindo os parâmetros descritos a seguirgrant_type (string) required
username (string)
password (string)
refresh_token (string)
protheus/totalinputdocument_v1_000/get_total_input_documentQueryString Tags - 'Branches' Range de Filials 'FromDate' data inicial de busca formato 'AAAA-MM-DD' , 'ToDate' data final de busca formato 'AAAA-MM-DD'. Caso não exista nenhum parâmetro será retornado os valores Default 'Fromdate' = Data do Dia - 30 dias e 'Todate' = Data do Dia, para 'Branches' = Filial configurada.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
BrancheInternalId (string) required
FromDate (string) required
ToDate (string) required
protheus/totalinputdocument_v1_000/get_total_input_document_canceledQueryString Tags - 'Branches' Range de Filials 'FromDate' data inicial de busca formato 'AAAA-MM-DD' , 'ToDate' data final de busca formato 'AAAA-MM-DD'. Caso não exista nenhum parâmetro será retornado os valores Default 'Fromdate' = Data do Dia - 30 dias e 'Todate' = Data do Dia, para 'Branches' = Filial configurada.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
BrancheInternalId (string) required
FromDate (string) required
ToDate (string) required
protheus/totaloutputdocument_v1_000/get_total_output_documentQueryString Tags - 'Branches' Range de Filials 'FromDate' data inicial de busca formato 'AAAA-MM-DD' , 'ToDate' data final de busca formato 'AAAA-MM-DD'. Caso não exista nenhum parâmetro será retornado os valores Default 'Fromdate' = Data do Dia - 30 dias e 'Todate' = Data do Dia, para 'Branches' = Filial configurada.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
BrancheInternalId (string) required
FromDate (string) required
ToDate (string) required
protheus/totaloutputdocument_v1_000/get_total_output_document_canceledQueryString Tags - 'Branches' Range de Filials 'FromDate' data inicial de busca formato 'AAAA-MM-DD' , 'ToDate' data final de busca formato 'AAAA-MM-DD'. Caso não exista nenhum parâmetro será retornado os valores Default 'Fromdate' = Data do Dia - 30 dias e 'Todate' = Data do Dia, para 'Branches' = Filial configurada.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
BrancheInternalId (string) required
FromDate (string) required
ToDate (string) required
protheus/treadmills_v1_000/get_treadmillsRetorna todos as esteiras da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
protheus/treadmills_v1_000/post_treadmillsInclui uma esteira passada na requisiçãoAuthorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. Description (string)
. CottonGin (string)
} (object) required
protheus/treadmills_v1_000/get_treadmills_by_internal_idRetorna a esteira correspondente ao código único informadoInternalId (string)
Authorization (string) required
protheus/treadmills_v1_000/put_treadmills_by_internal_idAltera a esteira passada na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. SourceBranch (string)
. Code (string)
. Description (string)
. CottonGin (string)
} (object) required
protheus/treadmills_v1_000/delete_treadmills_by_internal_idDeleção da esteira informadaInternalId (string)
Authorization (string) required
protheus/unitofmeasure_v1_000/get_unit_of_measuresRetorna lista completa de Unidade de MedidaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/unitofmeasure_v1_000/post_unit_of_measuresInclui uma Unidade de MedidaAuthorization (string) required
data (undefined) required
protheus/unitofmeasure_v1_000/get_unit_of_measures_by_codeRetorna Unidade de Medida pelo seu CódigoCode (string)
Authorization (string) required
protheus/unitofmeasure_v1_000/put_unit_of_measures_by_codeAtualiza cadastro de Unidade de Medida conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data (undefined) required
protheus/unitofmeasure_v1_000/delete_unit_of_measures_by_codeExclui Unidade de Medida cadastrada conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
protheus/unitofmeasure_v2_000/get_unit_of_measuresRetorna lista completa de Unidade de MedidaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/unitofmeasure_v2_000/post_unit_of_measuresInclui uma Unidade de MedidaAuthorization (string) required
data: {
. Code (string)
. InternalId (string)
. Description (string)
. ShortName (string)
} (object) required
protheus/unitofmeasure_v2_000/get_unit_of_measures_by_codeRetorna Unidade de Medida pelo seu CódigoCode (string)
Authorization (string) required
protheus/unitofmeasure_v2_000/put_unit_of_measures_by_codeAtualiza cadastro de Unidade de Medida conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. Code (string)
. InternalId (string)
. Description (string)
. ShortName (string)
} (object) required
protheus/unitofmeasure_v2_000/delete_unit_of_measures_by_codeExclui Unidade de Medida cadastrada conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
protheus/urbanocoletor_v1_000/post_coletor_urbanoInclui informações do coletor na prestação de contasdata (object) required
protheus/user_v1_000/get_usersRetorna todos usuários do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
userIds (string)
name (string)
protheus/user_v1_000/post_usersInclui usuário passado na requisiçãoAuthorization (string) required
data (object) required
protheus/user_v1_000/get_users_by_idRetorna o usuário do sistema indicadoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
protheus/user_v1_000/put_users_by_idAltera o usuário passado na requisiçãoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
data (undefined) required
protheus/user_v1_000/delete_users_by_idExclusão de usuário da baseid (string)
Authorization (string) required
foundBy (string)
domainId (string)
protheus/wastereason_v1_000/post_waste_reasonsAdiciona novo Motivo de Refugodata: {
. Code (string)
. Description (string)
. IsRework (boolean)
. IsScrapMaterial (boolean)
} (object) required
protheus/wastereason_v1_000/get_waste_reasonsRetorna lista de motivos de refugoorder (array)
page (integer)
pageSize (integer)
fields (string)
protheus/wastereason_v1_000/get_waste_reasons_by_codeRetorna um Motivo de RefugoCode (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
protheus/wastereason_v1_000/put_waste_reasons_by_codeAtualiza um Motivo de RefugoCode (string)
data: {
. Code (string)
. Description (string)
. IsRework (boolean)
. IsScrapMaterial (boolean)
} (object) required
protheus/wastereason_v1_000/delete_waste_reasons_by_codeRemove um Motivo de RefugoCode (string)
rm/accountingentry_v1_000/get_accounting_entriesRetorna uma lista de Lançamentos Contábeis da ColigadaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
rm/accountingentry_v1_000/post_accounting_entriesInclui um Lançamento Contábil conforme dados enviados na requisição.Authorization (string) required
companyId (integer) required
data: {
. companyId (integer)
. batchCode (integer)
. description (string)
. accountEntry (array)
} (object) required
rm/accountingentry_v1_000/get_accounting_entries_by_idRetorna o Lançamento Contábil da Coligada, Id Lançamento e Código do Loteid (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/accountingentry_v1_000/put_accounting_entries_by_idAtualiza o Lançamento Contábil conforme os dados enviados na requisiçãoid (string)
Authorization (string) required
data: {
. companyId (integer)
. batchCode (integer)
. description (string)
. accountEntry (array)
} (object) required
rm/accountingentry_v1_000/patch_accounting_entries_by_idAtualiza o Lançamento contábil conforme os dados enviados na requisiçãoid (string)
Authorization (string) required
fields (string)
data: {
. companyId (integer)
. batchCode (integer)
. description (string)
. accountEntry (array)
} (object) required
rm/accountingentry_v1_000/delete_accounting_entries_by_idExclui o Lançamento Contábil conforme os dados enviados na requisição.id (string)
Authorization (string) required
rm/accountingplan_v1_000/get_accounting_planRetorna lista de Plano Contas ContábeisAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/accountingplan_v1_000/post_accounting_planInclui um Plano de conta contábil conforme dados enviados na requisição.Authorization (string) required
fields (string)
data (undefined) required
rm/accountingplan_v1_000/get_accounting_plan_by_idRetorna um plano de conta contábil de acordo com o ID de pesquisaid (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/accountingplan_v1_000/put_accounting_plan_by_idAtualiza o plano de conta contábil conforme os dados enviados na requisiçãoid (string)
Authorization (string) required
fields (string)
data (undefined) required
rm/accountingplan_v1_000/patch_accounting_plan_by_idAtualiza o plano de conta contábil conforme os dados enviados na requisiçãoid (string)
Authorization (string) required
fields (string)
data (undefined) required
rm/accountingplan_v1_000/delete_accounting_plan_by_idExclui um Plano de conta contábil conforme os dados enviados na requisição.id (string)
Authorization (string) required
rm/accountingtransactions_v1_000/get_accounting_transactionsRetorna uma lista de movimentação em Contas Contábeis.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
date (string) required
currency (string)
account (string)
branchId (integer)
costCenterCode (string)
rm/accountingtransactions_v1_000/get_accounting_transactions_accountRetorna um único registro com a movimentação de acordo com a Conta, período e moeda informada.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
date (string) required
currency (string) required
account (string) required
branchId (integer)
rm/allowancetypes_v1_000/get_allowance_types_by_idRetorna dados do tipo de abonoid (string)
Authorization (string) required
rm/allowancetypes_v1_000/delete_allowance_types_by_idExclui registro de tipo de abonoid (string)
rm/allowancetypes_v1_000/put_allowance_types_by_idAtualiza um registro de tipo de abono. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (integer)
. Code (string)
. Description (string)
. IncludeWorkedHours (integer)
. AllowanceTypeDSR (integer)
. AllowanceDaysLimit (integer)
. Period (integer)
. ActiveInPortal (integer)
. id (string)
} (object) required
rm/allowancetypes_v1_000/get_allowance_typesRetorna todas os tipos de abonosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/allowancetypes_v1_000/post_allowance_typesInclui um novo registro na tabela de tipo de abonodata: {
. CompanyCode (integer)
. Code (string)
. Description (string)
. IncludeWorkedHours (integer)
. AllowanceTypeDSR (integer)
. AllowanceDaysLimit (integer)
. Period (integer)
. ActiveInPortal (integer)
. id (string)
} (object) required
rm/apacnephrologiesdrcs_v1_000/get_apac_nephrologies_drcsRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/apacnephrologiesdrcs_v1_000/post_apac_nephrologies_drcsInsere um registroAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. height (number)
. weight (number)
. albumin (number)
. antibodiesToHcv (string)
. antibodiesToHbsag (string)
. hiv (string)
. hemoglobinHb (number)
. treatmentFeatures (string)
. startDateTreatment (string)
. phosphorus (number)
. parathyroidHormone (number)
. favForwarding (string)
. catheterForwarding (string)
. vaccinationStatus (string)
. antibodiesToHbs (string)
. influenza (string)
. dt (string)
. pneumococcus (string)
. ieca (string)
. bra (string)
} (object) required
rm/apacnephrologiesdrcs_v1_000/get_apac_nephrologies_drcs_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/apacnephrologiesdrcs_v1_000/put_apac_nephrologies_drcs_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. height (number)
. weight (number)
. albumin (number)
. antibodiesToHcv (string)
. antibodiesToHbsag (string)
. hiv (string)
. hemoglobinHb (number)
. treatmentFeatures (string)
. startDateTreatment (string)
. phosphorus (number)
. parathyroidHormone (number)
. favForwarding (string)
. catheterForwarding (string)
. vaccinationStatus (string)
. antibodiesToHbs (string)
. influenza (string)
. dt (string)
. pneumococcus (string)
. ieca (string)
. bra (string)
} (object) required
rm/apacnephrologiesdrcs_v1_000/delete_apac_nephrologies_drcs_by_idExclui um registroid (string)
Authorization (string) required
rm/apacnephrologiesfistulas_v1_000/get_apac_nephrologies_fistulasRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/apacnephrologiesfistulas_v1_000/post_apac_nephrologies_fistulasInsere um registroAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. previousDuplex (string)
. venousCatheter (string)
. previousFav (string)
. phlebitis (string)
. bruises (string)
. visibleVein (string)
. pulsePresence (string)
. pulseWithoutThrill (string)
. veinDiameter (number)
. arteryDiameter (number)
. thrillFav (number)
} (object) required
rm/apacnephrologiesfistulas_v1_000/get_apac_nephrologies_fistulas_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/apacnephrologiesfistulas_v1_000/put_apac_nephrologies_fistulas_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. previousDuplex (string)
. venousCatheter (string)
. previousFav (string)
. phlebitis (string)
. bruises (string)
. visibleVein (string)
. pulsePresence (string)
. pulseWithoutThrill (string)
. veinDiameter (number)
. arteryDiameter (number)
. thrillFav (number)
} (object) required
rm/apacnephrologiesfistulas_v1_000/delete_apac_nephrologies_fistulas_by_idExclui um registroid (string)
Authorization (string) required
rm/apacnephrologies_v1_000/get_apac_nephrologiesRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/apacnephrologies_v1_000/post_apac_nephrologiesInsere um registroAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. mainCid (string)
. secundaryCid (string)
. startDateDialise (string)
. height (number)
. weight (number)
. diuresis (integer)
. glucose (integer)
. vascularAccess (string)
. abdominalUltrasound (string)
. ureaPreHemodialysisTru (number)
. quantityFistula (integer)
. inscribedOnTheCncdo (string)
. albumin (number)
. antibodiesToHcv (string)
. antibodiesToHbsag (string)
. hiv (string)
. hemoglobinHb (number)
. diagnosedPeritonitis (string)
. treatmentOfClinicIntercurrence (string)
. parathyroidHormone (number)
. weeklyKtv (number)
. phosphorus (number)
. transplantSituationIfApt (string)
. transplantSituation (string)
. initialTreatmentSituation (string)
. nephroMonitoring (string)
. vascularAccessForHemodialysis (string)
. treatmentFeatures (string)
. startDateDialiseClinic (string)
. associatedCauseCid (string)
. observation (string)
. tfg (number)
. cleardecreatinina (number)
. creatinina (number)
} (object) required
rm/apacnephrologies_v1_000/get_apac_nephrologies_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/apacnephrologies_v1_000/put_apac_nephrologies_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequential (integer)
. mainCid (string)
. secundaryCid (string)
. startDateDialise (string)
. height (number)
. weight (number)
. diuresis (integer)
. glucose (integer)
. vascularAccess (string)
. abdominalUltrasound (string)
. ureaPreHemodialysisTru (number)
. quantityFistula (integer)
. inscribedOnTheCncdo (string)
. albumin (number)
. antibodiesToHcv (string)
. antibodiesToHbsag (string)
. hiv (string)
. hemoglobinHb (number)
. diagnosedPeritonitis (string)
. treatmentOfClinicIntercurrence (string)
. parathyroidHormone (number)
. weeklyKtv (number)
. phosphorus (number)
. transplantSituationIfApt (string)
. transplantSituation (string)
. initialTreatmentSituation (string)
. nephroMonitoring (string)
. vascularAccessForHemodialysis (string)
. treatmentFeatures (string)
. startDateDialiseClinic (string)
. associatedCauseCid (string)
. observation (string)
. tfg (number)
. cleardecreatinina (number)
. creatinina (number)
} (object) required
rm/apacnephrologies_v1_000/delete_apac_nephrologies_by_idExclui um registroid (string)
Authorization (string) required
rm/apacprocedures_v1_000/get_apac_proceduresRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/apacprocedures_v1_000/post_apac_proceduresInsere um registroAuthorization (string) required
data: {
. id (string)
. CompanyId (integer)
. ApacId (integer)
. ApacSequence (integer)
. ProcedureSequence (integer)
. ProcedureCode (string)
. Cbo (string)
. Quantity (integer)
. Cnpj (string)
. Invoice (string)
. MainCid (string)
. SecundaryCid (string)
. Order (integer)
. basesaValue (number)
. totsaValue (number)
. reccreatedby (string)
. reccreatedon (string)
. recmodifiedby (string)
. recmodifiedon (string)
. TeamCode (string)
. TransferStatus (string)
} (object) required
rm/apacprocedures_v1_000/get_apac_procedures_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/apacprocedures_v1_000/put_apac_procedures_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. CompanyId (integer)
. ApacId (integer)
. ApacSequence (integer)
. ProcedureSequence (integer)
. ProcedureCode (string)
. Cbo (string)
. Quantity (integer)
. Cnpj (string)
. Invoice (string)
. MainCid (string)
. SecundaryCid (string)
. Order (integer)
. basesaValue (number)
. totsaValue (number)
. reccreatedby (string)
. reccreatedon (string)
. recmodifiedby (string)
. recmodifiedon (string)
. TeamCode (string)
. TransferStatus (string)
} (object) required
rm/apacprocedures_v1_000/delete_apac_procedures_by_idExclui um registroid (string)
Authorization (string) required
rm/apac_v1_000/get_apacRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/apac_v1_000/post_apacInsere um registroAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequence (integer)
. accountNumber (string)
. accountSequence (integer)
. numberApac (string)
. apresentation (string)
. apacType (string)
. attendanceType (string)
. exitReason (string)
. dateDeathExit (string)
. authorizingDoctor (integer)
. requestDate (string)
. authorizingDate (string)
. issuingOrgan (string)
. attendanceFeature (string)
. numberApacPrevious (string)
. mainProcedureCode (string)
. requestingCNES (string)
. status (string)
. initialDate (string)
. finalDate (string)
. errorFlag (string)
. serviceCode (string)
. classificationCode (string)
. teamCode (string)
. doctorCNSMainProcedure (string)
} (object) required
rm/apac_v1_000/get_apac_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/apac_v1_000/put_apac_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. apacId (integer)
. apacSequence (integer)
. accountNumber (string)
. accountSequence (integer)
. numberApac (string)
. apresentation (string)
. apacType (string)
. attendanceType (string)
. exitReason (string)
. dateDeathExit (string)
. authorizingDoctor (integer)
. requestDate (string)
. authorizingDate (string)
. issuingOrgan (string)
. attendanceFeature (string)
. numberApacPrevious (string)
. mainProcedureCode (string)
. requestingCNES (string)
. status (string)
. initialDate (string)
. finalDate (string)
. errorFlag (string)
. serviceCode (string)
. classificationCode (string)
. teamCode (string)
. doctorCNSMainProcedure (string)
} (object) required
rm/apac_v1_000/delete_apac_by_idExclui um registroid (string)
Authorization (string) required
rm/applicantresults_v1_000/get_applicant_results_by_idRetorna detalhes do resultado do candidato do processo seletivoId (string)
Authorization (string) required
expand (string)
rm/appliedmatrix_v1_000/get_academics_by_academic_internal_id_appliedmatrixesRetorna todas as matrizes aplicadas de uma matriz curricularAcademicInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/appliedmatrix_v1_000/post_academics_by_academic_internal_id_appliedmatrixesInclui o período passado na requisiçãoAcademicInternalId (string)
Authorization (string) required
data (undefined) required
rm/appliedmatrix_v1_000/get_academics_by_academic_internal_id_appliedmatrixes_by_internal_idRetorna a matriz aplicadaAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/appliedmatrix_v1_000/put_academics_by_academic_internal_id_appliedmatrixes_by_internal_idAltera o período passado na requisiçãoAcademicInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/appliedmatrix_v1_000/delete_academics_by_academic_internal_id_appliedmatrixes_by_internal_idExclusão de matriz aplicada da baseAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/appointmentavailable_v1_000/get_appointment_availablesRecupera uma lista com todos os CadastrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/appointmentavailable_v2_000/get_appointment_availablesRecupera uma lista com todos os CadastrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/appointment_v1_000/get_appointments_by_codeRetorna um Atendimentocode (string)
rm/appointment_v1_000/delete_appointments_by_codeExclui um Agendamentocode (string)
Authorization (string) required
rm/appointment_v1_000/get_appointmentsRecupera uma lista com todos os AgendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/appointment_v1_000/post_appointmentsInsere um registroAuthorization (string) required
data: {
. code (string)
. scheduleCode (string)
. insuranceCompanyCode (string)
. insurancePlanCode (string)
. patientCode (string)
. practitionerCode (string)
. companyId (integer)
. appointmentId (integer)
. scheduleId (integer)
. scheduleName (string)
. scheduleDate (date)
. startTime (string)
. endTime (string)
. practitionerId (integer)
. practitionerName (string)
. insurancePlanId (string)
. insuranceCompanyId (integer)
. insuranceCompanyName (string)
. insurancePlanName (string)
. insuranceSubPlan (string)
. activityId (integer)
. specialtyId (string)
. isGroup (string)
. timeSlot (string)
. patientId (integer)
. patientName (string)
. birthDate (date)
. appointmentType (string)
. workPhone (string)
. homePhone (string)
. cellPhone (string)
. email (string)
. postalCode (string)
. address (string)
. addressNumber (string)
. complement (string)
. neighborhood (string)
. unitId (integer)
. unitName (string)
. procedureId (string)
. procedureName (string)
. subsidiaryId (integer)
. subsidiaryName (string)
. city (string)
. status (integer)
. appointmentCreateDate (date)
} (object) required
rm/appointment_v2_000/get_appointmentsRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/appointment_v2_000/post_appointmentsInsere um registroAuthorization (string) required
data: {
. id (string)
. CompanyId (integer)
. AppointmentId (integer)
. ScheduleId (integer)
. ScheduleName (string)
. ScheduleDate (string)
. StartTime (string)
. EndTime (string)
. PractitionerId (integer)
. PractitionerIdName (string)
. InsurancePlanId (string)
. InsuranceCompanyId (integer)
. InsuranceCompanyName (string)
. InsurancePlanName (string)
. InsuranceSubPlan (string)
. ActivityId (integer)
. SpecialtyId (string)
. IsGroup (string)
. TimeSlot (string)
. PatientId (integer)
. PatientName (string)
. BirthDate (string)
. AppointmentType (string)
. WorkPhone (string)
. HomePhone (string)
. CellPhone (string)
. Email (string)
. PostalCode (string)
. Address (string)
. AddressNumber (string)
. Complement (string)
. Neighborhood (string)
. CovenantCard (string)
. UnitId (integer)
. UnitName (string)
. ProcedureId (string)
. ProcedureName (string)
. SubsidiaryId (integer)
. SubsidiaryName (string)
. City (string)
. Status (integer)
. AppointmentCreateDate (string)
. OnlineConsultation (integer)
. PractitionerCode (integer)
. InsuranceCompanyCode (integer)
. InsurancePlanCode (string)
. unidatendId (integer)
} (object) required
rm/appointment_v2_000/get_appointments_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/appointment_v2_000/put_appointments_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. CompanyId (integer)
. AppointmentId (integer)
. ScheduleId (integer)
. ScheduleName (string)
. ScheduleDate (string)
. StartTime (string)
. EndTime (string)
. PractitionerId (integer)
. PractitionerIdName (string)
. InsurancePlanId (string)
. InsuranceCompanyId (integer)
. InsuranceCompanyName (string)
. InsurancePlanName (string)
. InsuranceSubPlan (string)
. ActivityId (integer)
. SpecialtyId (string)
. IsGroup (string)
. TimeSlot (string)
. PatientId (integer)
. PatientName (string)
. BirthDate (string)
. AppointmentType (string)
. WorkPhone (string)
. HomePhone (string)
. CellPhone (string)
. Email (string)
. PostalCode (string)
. Address (string)
. AddressNumber (string)
. Complement (string)
. Neighborhood (string)
. CovenantCard (string)
. UnitId (integer)
. UnitName (string)
. ProcedureId (string)
. ProcedureName (string)
. SubsidiaryId (integer)
. SubsidiaryName (string)
. City (string)
. Status (integer)
. AppointmentCreateDate (string)
. OnlineConsultation (integer)
. PractitionerCode (integer)
. InsuranceCompanyCode (integer)
. InsurancePlanCode (string)
. unidatendId (integer)
} (object) required
rm/appointment_v2_000/delete_appointments_by_idExclui um registroid (string)
Authorization (string) required
rm/assignments_v1_000/get_professors_by_professor_internal_id_assignmentsRetorna todos as provas/avaliações da turma/disciplinaProfessorInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/assignments_v1_000/post_professors_by_professor_internal_id_assignmentsInclui a prova/avaliação passada na requisiçãoProfessorInternalId (string)
Authorization (string) required
data (undefined) required
rm/assignments_v1_000/get_professors_by_professor_internal_id_assignments_by_internal_idRetorna uma prova/avaliaçãoProfessorInternalId (string)
InternalId (string)
Authorization (string) required
rm/assignments_v1_000/put_professors_by_professor_internal_id_assignments_by_internal_idAltera a prova/avaliação passada na requisiçãoProfessorInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/assignments_v1_000/delete_professors_by_professor_internal_id_assignments_by_internal_idExclusão de prova/avaliaçãoProfessorInternalId (string)
InternalId (string)
Authorization (string) required
rm/attendanceregister_v1_000/get_attendance_registerRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/attendanceregister_v1_000/get_attendance_register_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/auditpanel_v1_000/get_painel_auditoria_periodRetorna os períodos de apuração disponíveis no sistema.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_big_numbersRetorna os indicadores principais Big Numbers para o dashboard.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_employeesLista os funcionários vinculados ao processo de auditoria.No parameters
rm/auditpanel_v1_000/post_painel_auditoria_update_feedbackEnvia uma atualização de feedback para um registro de auditoria.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_conformitiesLista os itens de verificação da auditoria, indicando quais regras de conformidade foram atendidas e quais apresentam inconsistências.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_branchesRetorna as filiais que o usuário logado tem permissão para visualizar, utilizado para o filtro de unidade de negócio do painel.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_last_updateInforma a data e hora em que os dados da auditoria foram processados pela última vez no backend, para controle de obsolescência.No parameters
rm/auditpanel_v1_000/get_painel_auditoria_historyRetorna o histórico de execuções de auditorias passadas, permitindo a comparação de evolução de conformidade entre diferentes períodos.No parameters
rm/authorizedovertime_v1_000/get_authorized_overtime_by_idRetorna dados da extra autorizadaid (string)
Authorization (string) required
rm/authorizedovertime_v1_000/get_authorized_overtimeRetorna todas as extras autorizadasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/availablecourse_v1_000/get_selection_processes_by_selection_process_id_available_coursesRetorna todas as áreas ofertadas do processo seletivoSelectionProcessId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/availablecourse_v1_000/get_selection_processes_by_selection_process_id_available_courses_by_available_course_idRetorna somente os dados de uma área ofertada do processo seletivoSelectionProcessId (string)
AvailableCourseId (string)
Authorization (string) required
expand (string)
rm/availableofferedactivities_v1_000/get_students_by_student_internal_id_offeredactivitiesRetorna todas as atividades ofertadas que o aluno pode visualizarStudentInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/availableofferedactivities_v1_000/get_students_by_student_internal_id_offeredactivities_by_internal_idRetorna somente a atividade ofertadaStudentInternalId (string)
InternalId (string)
Authorization (string) required
rm/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipationRetorna todos os registros de Coparticipações dos Beneficiários e seus dependentes.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string) required
companyid (string) required
rm/beneficiariesdatacontent_v1_000/get_beneficiaries_data_contentRetorna todos os registros de beneficiários.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
branchId (string)
rm/biologicalmonitoringresponsible_v1_000/get_biologicalmonitoringresponsible_by_idRetorna dados de tabela do Responsável pela Monitoração Biológica especificadoid (string)
Authorization (string) required
rm/biologicalmonitoringresponsible_v1_000/delete_biologicalmonitoringresponsible_by_idExclui um Responsável pela Monitoração Biológicaid (string)
Authorization (string) required
rm/biologicalmonitoringresponsible_v1_000/put_biologicalmonitoringresponsible_by_idAtualiza um registro existente da tabela do Responsável pela Monitoração Biológica. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data (object) required
rm/biologicalmonitoringresponsible_v1_000/get_biologicalmonitoringresponsibleRetorna todos os Responsáveis pela Monitoração BiológicaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Ids (string)
rm/biologicalmonitoringresponsible_v1_000/post_biologicalmonitoringresponsibleInclui um novo registro na tabela de medições de riscoAuthorization (string) required
data (object) required
rm/block_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocksRetorna todos os blocos do EducacionalProfessorInternalId (string)
BuildingInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/block_v1_000/post_professors_by_professor_internal_id_buildings_by_building_internal_id_blocksInclui o bloco passado na requisiçãoProfessorInternalId (string)
BuildingInternalId (string)
Authorization (string) required
data (undefined) required
rm/block_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_idRetorna o bloco educacionalProfessorInternalId (string)
BuildingInternalId (string)
InternalId (string)
Authorization (string) required
rm/block_v1_000/put_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_idAltera o bloco passado na requisiçãoProfessorInternalId (string)
BuildingInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/block_v1_000/delete_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_idExclusão de bloco da baseProfessorInternalId (string)
BuildingInternalId (string)
InternalId (string)
Authorization (string) required
rm/bookloans_v1_000/get_bookloans_by_user_internal_id_pendingsbookloansRetorna todos os empréstimos pendentes do usuário da bibliotecaUserInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/bookings_v1_000/post_bookingsRealiza a reserva na bibliotecaAuthorization (string) required
data (undefined) required
rm/branch_v1_000/get_branchesRetorna todas as Filiais da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
EnterpriseGroup (string)
rm/branch_v1_000/post_branchesInclui a Filial passada na requisiçãoAuthorization (string) required
data: {
. BranchInternalId (string)
. CompanyCode (string)
. UnitOfBusiness (string)
. ParentCode (string)
. Description (string)
. EnterpriseGroup (string)
. Code (string)
. Title (string)
. CGC (string)
. StateRegistration (string)
. DDD (string)
. Phone (string)
. Street (string)
. Complement (string)
. Neighborhood (string)
. State (string)
. City (string)
. ZipCode (string)
. CityCode (string)
. CNAECode (string)
. NatureCode (string)
. BillingAddress (string)
. BillingZipCode (string)
. BillingComplement (string)
. BillingNeighborhood (string)
. BillingCity (string)
. BillingState (string)
. NIRE (string)
. DTRE (string)
. Suframa (string)
. SubscriptionType (string)
. CityRegistration (string)
} (object) required
rm/branch_v1_000/get_branches_by_branch_internal_idRetorna todas as Filiais da baseBranchInternalId (string)
Authorization (string) required
rm/branch_v1_000/put_branches_by_branch_internal_idInclui a Filial passada na requisiçãoBranchInternalId (string)
Authorization (string) required
data: {
. BranchInternalId (string)
. CompanyCode (string)
. UnitOfBusiness (string)
. ParentCode (string)
. Description (string)
. EnterpriseGroup (string)
. Code (string)
. Title (string)
. CGC (string)
. StateRegistration (string)
. DDD (string)
. Phone (string)
. Street (string)
. Complement (string)
. Neighborhood (string)
. State (string)
. City (string)
. ZipCode (string)
. CityCode (string)
. CNAECode (string)
. NatureCode (string)
. BillingAddress (string)
. BillingZipCode (string)
. BillingComplement (string)
. BillingNeighborhood (string)
. BillingCity (string)
. BillingState (string)
. NIRE (string)
. DTRE (string)
. Suframa (string)
. SubscriptionType (string)
. CityRegistration (string)
} (object) required
rm/branch_v1_000/delete_branches_by_branch_internal_idNão é permitida a deleção da Filial por API, por motivos de segurançaBranchInternalId (string)
rm/brands_v1_000/get_brandsRetorna lista completa de MarcasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/brands_v1_000/post_brandsInclui uma MarcaAuthorization (string) required
data: {
. CompanyId (integer)
. BrandId (integer)
. Code (string)
. Description (string)
. RecCreatedBy (string)
. RecCreatedOn (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
} (object) required
rm/brands_v1_000/get_brands_by_codeRetorna Marca pelo seu CódigoCode (string)
Authorization (string) required
rm/brands_v1_000/put_brands_by_codeAtualiza cadastro de Marca conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. CompanyId (integer)
. BrandId (integer)
. Code (string)
. Description (string)
. RecCreatedBy (string)
. RecCreatedOn (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
} (object) required
rm/brands_v1_000/delete_brands_by_codeExclui Marca cadastrada conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
rm/breedcolor_v2_000/get_breedcolorRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/breedcolor_v2_000/get_breedcolor_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/building_v1_000/get_professors_by_professor_internal_id_buildingsRetorna todos os prédios educacionaisProfessorInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/building_v1_000/post_professors_by_professor_internal_id_buildingsInclui o prédio passado na requisiçãoProfessorInternalId (string)
Authorization (string) required
data (undefined) required
rm/building_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_idRetorna o prédio educacionalProfessorInternalId (string)
BuildingInternalId (string)
Authorization (string) required
rm/building_v1_000/put_professors_by_professor_internal_id_buildings_by_building_internal_idAltera o prédio passado na requisiçãoProfessorInternalId (string)
BuildingInternalId (string)
Authorization (string) required
data (undefined) required
rm/building_v1_000/delete_professors_by_professor_internal_id_buildings_by_building_internal_idExclusão de prédio da baseProfessorInternalId (string)
BuildingInternalId (string)
Authorization (string) required
rm/buyers_v1_000/get_buyersRetorna todos os Compradores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/buyers_v1_000/post_buyersAdiciona Comprador passado na requisiçãoAuthorization (string) required
data (object) required
rm/buyers_v1_000/get_buyers_by_buyer_idRetorna o Comprador do sistema através de seu códigoBuyerId (string)
fields (string)
Authorization (string) required
rm/buyers_v1_000/put_buyers_by_buyer_idAltera o comprador passado na requisiçãoBuyerId (string)
Authorization (string) required
data (undefined) required
rm/buyers_v1_000/delete_buyers_by_buyer_idExclusão de Comprador da baseBuyerId (string)
Authorization (string) required
rm/calculatedoccurrences_v1_000/get_calculated_occurrences_by_idRetorna dados da ocorrência calculadaid (string)
Authorization (string) required
rm/calculatedoccurrences_v1_000/get_calculated_occurrencesRetorna todas as ocorrências calculadasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/calculatedwarnings_v1_000/get_calculated_warnings_by_idRetorna dados do aviso calculadoid (string)
Authorization (string) required
rm/calculatedwarnings_v1_000/get_calculated_warningsRetorna todos os avisos calculadosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/calculationtables_v1_000/get_calculation_tables_by_idRetorna dados da tabela de cálculoid (string)
Authorization (string) required
rm/calculationtables_v1_000/delete_calculation_tables_by_idExclui tabela de cálculoid (string)
rm/calculationtables_v1_000/put_calculation_tables_by_idAtualiza uma tabela de cálculo. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. companyCode (integer)
. code (string)
. startOfValidity (datetime)
. name (string)
. endOfValidity (datetime)
. roundValue (smallint)
. disregardCents (smallint)
. finality (smallint)
. updateValidity (smallint)
. id (string)
} (object) required
rm/calculationtables_v1_000/get_calculation_tablesRetorna todas as tabelas de cálculoAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/calculationtables_v1_000/post_calculation_tablesInclui um novo registro na tabela de tabela de cálculodata: {
. companyCode (integer)
. code (string)
. startOfValidity (datetime)
. name (string)
. endOfValidity (datetime)
. roundValue (smallint)
. disregardCents (smallint)
. finality (smallint)
. updateValidity (smallint)
. id (string)
} (object) required
rm/calendarevent_v1_000/get_students_by_student_internal_id_calendar_eventsRetorna todos os eventos educacionais do alunoStudentInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/cancelbooking_v1_000/post_bookings_by_booking_internal_id_cancel_bookingsCancela a reserva de exemplar passada na requisiçãoBookingInternalId (string)
Authorization (string) required
data (undefined) required
rm/candidates_v1_000/get_candidates_by_idRetorna dados de tabela da Candidato especificadaid (string)
Authorization (string) required
rm/candidates_v1_000/delete_candidates_by_idExclui Candidatoid (string)
Authorization (string) required
rm/candidates_v1_000/put_candidates_by_idAtualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. Name (string)
. Birth (date)
. HomeState (string)
. Naturalness (string)
. NickName (string)
. Sex (string)
. Nationality (string)
. EducationalLevel (string)
. Street (string)
. Number (string)
. District (string)
. State (string)
. City (string)
. Cep (string)
. Country (string)
. ProfessionalRegistrationNumber (string)
. Cpf (string)
. ImageId (integer)
. PhoneNumber1 (string)
. PhoneNumber2 (string)
. identityNumber (string)
. IdentityNumberEmitterState (string)
. IdentityNumberEmitterAgency (string)
. IdentityNumberEmissionDate (date)
. ElectoralCard (string)
. ElectoralWard (string)
. ElectoralSection (string)
. WorkCard (string)
. WorkCardSerialNumber (string)
. WorkCardEmitterState (string)
. WorkCardEmissionDate (date)
. Nit (boolean)
. DriversLicense (string)
. DriversLicenseType (string)
. DriversLicenseExpirationDate (date)
. MilitaryDischargeCertificate (string)
. MilitaryGrade (string)
. BrazilConsort (boolean)
. Naturalized (boolean)
. BrazilianChildren (boolean)
. BrazilianChildrenNumber (integer)
. Email (string)
. PreviousTrainingInvestment (double)
. ShadeRace (integer)
. Disabled (boolean)
. UserCode (string)
. PhoneNumber3 (string)
. Company (string)
. OccupationCode (string)
. Rehabilitated (boolean)
. Smoker (boolean)
. AdjustsImageSize (boolean)
. DeafPerson (boolean)
. MutePerson (boolean)
. BlindPerson (boolean)
. MentallyImpairedPerson (boolean)
. CurriculumApprovalDate (date)
. Student (boolean)
. Teacher (boolean)
. Candidate (boolean)
. BibliosUser (boolean)
. Employee (boolean)
. FormerEmployee (boolean)
. IntellectualImpairedPerson (boolean)
. Deceased (boolean)
. Age (integer)
. RegistryDate (date)
. WageExpectation (number)
. AreaOfInterestCode1 (integer)
. AreaOfInterestCode2 (integer)
. WageExpectationTradable (integer)
. WorkExperienceTime (integer)
. WorkExperienceTimeArea1 (integer)
. WorkExperienceTimeArea2 (integer)
. ContraIndicated (integer)
. ContraindicationReason (string)
. Available (integer)
. FormOfRecruitment (string)
. ResumeSkillsId (integer)
. HierarchyLevelCode (integer)
. ProfessionalProfileDescription (string)
. AreaOfInterestDescription1 (string)
. AreaOfInterestDescription2 (string)
. HierarchyLevelDescription (string)
. ProfessionalSkillsResumeDescription (string)
. Employee1 (string)
. PersonalEmail (string)
. MaritalState (string)
. Complement (string)
. ArrivalDate (date)
. LetterModel19 (string)
. Rne (string)
. ImmigrationDecree (string)
. RneExpirationDate (date)
. WorkCardExpirationDate (date)
. VisaType (string)
. PassportNumber (string)
. NativeCountry (string)
. PassportExpirationDate (date)
. AccessibilityFeaturesForJobLocal (string)
. MilitaryDivision (string)
. MilitaryCertificateEmissionDate (date)
. MilitaryCertificateEmitterAgency (string)
. MilitaryRegion (string)
. MilitarySituation (string)
. ElectoralCardEmitterState (string)
. BloodType (string)
. Image (string)
. NeighborhoodTypeCode (integer)
. NaturalnessCode (string)
. NaturalisationDate (date)
. DriversLicenseEmitterAgency (string)
. RneEmitterAgency (string)
. CountryId (integer)
. DeceaseDate (date)
. DeathCertificateNumber (string)
. NaturalisationGatehouse (string)
. BrazilConditionClassification (string)
. DriversLicenseFirstEmissionDate (date)
. FirstJobYear (integer)
} (object) required
rm/candidates_v1_000/get_candidatesRetorna todos as CandidatosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
personsIds (string)
rm/candidates_v1_000/post_candidatesInclui um novo registro na tabela de CandidatosAuthorization (string) required
data: {
. id (string)
. Name (string)
. Birth (date)
. HomeState (string)
. Naturalness (string)
. NickName (string)
. Sex (string)
. Nationality (string)
. EducationalLevel (string)
. Street (string)
. Number (string)
. District (string)
. State (string)
. City (string)
. Cep (string)
. Country (string)
. ProfessionalRegistrationNumber (string)
. Cpf (string)
. ImageId (integer)
. PhoneNumber1 (string)
. PhoneNumber2 (string)
. identityNumber (string)
. IdentityNumberEmitterState (string)
. IdentityNumberEmitterAgency (string)
. IdentityNumberEmissionDate (date)
. ElectoralCard (string)
. ElectoralWard (string)
. ElectoralSection (string)
. WorkCard (string)
. WorkCardSerialNumber (string)
. WorkCardEmitterState (string)
. WorkCardEmissionDate (date)
. Nit (boolean)
. DriversLicense (string)
. DriversLicenseType (string)
. DriversLicenseExpirationDate (date)
. MilitaryDischargeCertificate (string)
. MilitaryGrade (string)
. BrazilConsort (boolean)
. Naturalized (boolean)
. BrazilianChildren (boolean)
. BrazilianChildrenNumber (integer)
. Email (string)
. PreviousTrainingInvestment (double)
. ShadeRace (integer)
. Disabled (boolean)
. UserCode (string)
. PhoneNumber3 (string)
. Company (string)
. OccupationCode (string)
. Rehabilitated (boolean)
. Smoker (boolean)
. AdjustsImageSize (boolean)
. DeafPerson (boolean)
. MutePerson (boolean)
. BlindPerson (boolean)
. MentallyImpairedPerson (boolean)
. CurriculumApprovalDate (date)
. Student (boolean)
. Teacher (boolean)
. Candidate (boolean)
. BibliosUser (boolean)
. Employee (boolean)
. FormerEmployee (boolean)
. IntellectualImpairedPerson (boolean)
. Deceased (boolean)
. Age (integer)
. RegistryDate (date)
. WageExpectation (number)
. AreaOfInterestCode1 (integer)
. AreaOfInterestCode2 (integer)
. WageExpectationTradable (integer)
. WorkExperienceTime (integer)
. WorkExperienceTimeArea1 (integer)
. WorkExperienceTimeArea2 (integer)
. ContraIndicated (integer)
. ContraindicationReason (string)
. Available (integer)
. FormOfRecruitment (string)
. ResumeSkillsId (integer)
. HierarchyLevelCode (integer)
. ProfessionalProfileDescription (string)
. AreaOfInterestDescription1 (string)
. AreaOfInterestDescription2 (string)
. HierarchyLevelDescription (string)
. ProfessionalSkillsResumeDescription (string)
. Employee1 (string)
. PersonalEmail (string)
. MaritalState (string)
. Complement (string)
. ArrivalDate (date)
. LetterModel19 (string)
. Rne (string)
. ImmigrationDecree (string)
. RneExpirationDate (date)
. WorkCardExpirationDate (date)
. VisaType (string)
. PassportNumber (string)
. NativeCountry (string)
. PassportExpirationDate (date)
. AccessibilityFeaturesForJobLocal (string)
. MilitaryDivision (string)
. MilitaryCertificateEmissionDate (date)
. MilitaryCertificateEmitterAgency (string)
. MilitaryRegion (string)
. MilitarySituation (string)
. ElectoralCardEmitterState (string)
. BloodType (string)
. Image (string)
. NeighborhoodTypeCode (integer)
. NaturalnessCode (string)
. NaturalisationDate (date)
. DriversLicenseEmitterAgency (string)
. RneEmitterAgency (string)
. CountryId (integer)
. DeceaseDate (date)
. DeathCertificateNumber (string)
. NaturalisationGatehouse (string)
. BrazilConditionClassification (string)
. DriversLicenseFirstEmissionDate (date)
. FirstJobYear (integer)
} (object) required
rm/candidates_v2_000/get_candidates_by_idRetorna dados de tabela da Candidato especificadaid (string)
Authorization (string) required
rm/candidates_v2_000/delete_candidates_by_idExclui Candidatoid (string)
Authorization (string) required
rm/candidates_v2_000/put_candidates_by_idAtualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
rm/candidates_v2_000/get_candidatesRetorna todos as CandidatosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
personsIds (string)
rm/candidates_v2_000/post_candidatesInclui um novo registro na tabela de CandidatosAuthorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
rm/classparticipants_v1_000/get_class_participants_by_idRetorna dados de tabela da turma especificadaid (string)
Authorization (string) required
rm/classparticipants_v1_000/delete_class_participants_by_idExclui participantes da turmaid (string)
Authorization (string) required
rm/classparticipants_v1_000/put_class_participants_by_idAtualiza um registro existente de participantes da turma. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. ClassCode (string)
. PersonInternalCode (string)
. PersonInternalCodeInternalId (string)
. Name (string)
. Chapa (string)
. ChapaInternalId (string)
. Email (string)
. Active (boolean)
. NumberOfOpenings (integer)
. Available (boolean)
} (object) required
rm/classparticipants_v1_000/get_class_participantsRetorna todos os participantes da turmaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
classParticipantsIds (string)
name (string)
rm/classparticipants_v1_000/post_class_participantsInclui um novo registro na tabela de participantes de turmaAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. ClassCode (string)
. PersonInternalCode (string)
. PersonInternalCodeInternalId (string)
. Name (string)
. Chapa (string)
. ChapaInternalId (string)
. Email (string)
. Active (boolean)
. NumberOfOpenings (integer)
. Available (boolean)
} (object) required
rm/classshifts_v1_000/get_professors_by_professor_internal_id_class_shiftsRetorna todos os turnos educacionaisProfessorInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/classshifts_v1_000/get_professors_by_professor_internal_id_class_shifts_by_class_shift_internal_idRetorna o turno educacionalProfessorInternalId (string)
ClassShiftInternalId (string)
Authorization (string) required
rm/classes_v1_000/get_classes_by_idRetorna dados de tabela da turma especificadaid (string)
Authorization (string) required
rm/classes_v1_000/delete_classes_by_idExclui turmaid (string)
Authorization (string) required
rm/classes_v1_000/put_classes_by_idAtualiza um registro existente de tabela de turmas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. ClassCode (string)
. ClassCodeInternalId (string)
. EntityCode (string)
. EntityCodeInternalId (string)
. Name (string)
. Active (boolean)
. NumberOfOpenings (integer)
. IsLocal (string)
. BeginTime (number)
. EndTime (number)
. CourseCode (string)
. CourseCodeInternalId (string)
. DateLastValidation (string)
. MinimumAttendance (number)
. Courseload (number)
. beginDate (string)
. EndDate (string)
. InstructorCode (number)
. InstructorCodeInternalId (string)
. showInternet (boolean)
. showAllCompany (boolean)
. isInternal (number)
. isActiveIMG (number)
} (object) required
rm/classes_v1_000/get_classesRetorna todos as turmasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
classesIds (string)
name (string)
rm/classes_v1_000/post_classesInclui um novo registro na tabela de turmasAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. ClassCode (string)
. ClassCodeInternalId (string)
. EntityCode (string)
. EntityCodeInternalId (string)
. Name (string)
. Active (boolean)
. NumberOfOpenings (integer)
. IsLocal (string)
. BeginTime (number)
. EndTime (number)
. CourseCode (string)
. CourseCodeInternalId (string)
. DateLastValidation (string)
. MinimumAttendance (number)
. Courseload (number)
. beginDate (string)
. EndDate (string)
. InstructorCode (number)
. InstructorCodeInternalId (string)
. showInternet (boolean)
. showAllCompany (boolean)
. isInternal (number)
. isActiveIMG (number)
} (object) required
rm/classificationtable_v1_000/get_classification_table_oneRetorna lista de Tabela de Classificação 1order (array)
page (integer)
pageSize (integer)
Authorization (string) required
rm/classificationtable_v1_000/post_classification_table_oneInclui um registro na Tabela de Classificação 1Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/get_classification_table_one_by_internal_idRetorna um registro da Tabela de Classificação 1InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/put_classification_table_one_by_internal_idAtualiza um registros da Tabela de Classificação 1InternalId (string)
Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/delete_classification_table_one_by_internal_idRemove um Registro da Tabela de Classificação 1InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/get_classification_table_twoRetorna lista de Tabela de Classificação 2order (array)
page (integer)
pageSize (integer)
Authorization (string) required
rm/classificationtable_v1_000/post_classification_table_twoInclui um registro na Tabela de Classificação 2Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/get_classification_table_two_by_internal_idRetorna a Tabela de Classificação 2InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/put_classification_table_two_by_internal_idAtualiza um registros da Tabela de Classificação 2InternalId (string)
Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/delete_classification_table_two_by_internal_idRemove um Registro da Tabela de Classificação 2InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/get_classification_table_threeRetorna lista de Tabela de Classificação 3order (array)
page (integer)
pageSize (integer)
Authorization (string) required
rm/classificationtable_v1_000/post_classification_table_threeInclui um registro na Tabela de Classificação 3Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/get_classification_table_three_by_internal_idRetorna um registro da Tabela de Classificação 3InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/put_classification_table_three_by_internal_idAtualiza um registros da Tabela de Classificação 3InternalId (string)
Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/delete_classification_table_three_by_internal_idRemove um Registro da Tabela de Classificação 3InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/get_classification_table_fourRetorna lista de Tabela de Classificação 4order (array)
page (integer)
pageSize (integer)
Authorization (string) required
rm/classificationtable_v1_000/post_classification_table_fourInclui um registro na Tabela de Classificação 4Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/get_classification_table_four_by_internal_idRetorna um registro da Tabela de Classificação 4InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/put_classification_table_four_by_internal_idAtualiza um registros da Tabela de Classificação 4InternalId (string)
Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/delete_classification_table_four_by_internal_idRemove um Registro da Tabela de Classificação 4InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/get_classification_table_fiveRetorna lista de Tabela de Classificação 5order (array)
page (integer)
pageSize (integer)
Authorization (string) required
rm/classificationtable_v1_000/post_classification_table_fiveInclui um registro na Tabela de Classificação 5Authorization (string) required
data (undefined) required
rm/classificationtable_v1_000/get_classification_table_five_by_internal_idRetorna um registro da Tabela de Classificação 5InternalId (string)
Authorization (string) required
rm/classificationtable_v1_000/put_classification_table_five_by_internal_idAtualiza um registros da Tabela de Classificação 5InternalId (string)
data (undefined) required
rm/classificationtable_v1_000/delete_classification_table_five_by_internal_idRemove um Registro da Tabela de Classificação 5InternalId (string)
Authorization (string) required
rm/compensatorytimebalance_v1_000/get_compensatory_time_balance_by_idRetorna dados do saldo de banco de horas do funcionárioid (string)
Authorization (string) required
rm/compensatorytimebalance_v1_000/get_compensatory_time_balanceRetorna todas as informações de saldo de banco de horas dos funcionáriosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/contractrestriction_v1_000/get_contract_restriction_examRetorna uma lista de restrições de contrato de exameAuthorization (string) required
companyId (integer) required
examId (integer) required
insuranceId (integer) required
planId (integer) required
subPlanId (integer)
unitAtendId (integer) required
rm/costcenter_v1_000/get_costcentersRetorna lista completa dos Centro de CustosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/costcenter_v1_000/post_costcentersInclui um Centro de Custo conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
rm/costcenter_v1_000/get_costcenters_by_internal_idRetorna um centro de custo de acordo com o ID de pesquisaInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/costcenter_v1_000/patch_costcenters_by_internal_idAtualiza centro de custo somente com os dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
rm/costcenter_v1_000/put_costcenters_by_internal_idAtualiza centro de custo conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Id (string)
. Code (string)
. InternalId (string)
. RegisterSituation (string)
. Name (string)
. ShortCode (string)
. SPED (string)
. AllowEntry (string)
. Class (string)
. TopCode (string)
. CreateDate (string)
. Accountable (string)
. recordCreatedOn (string)
. recordModifiedOn (string)
} (object) required
rm/costcenter_v1_000/delete_costcenters_by_internal_idExclui um Centro de Custo conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
rm/course_v1_000/get_academics_by_academic_internal_id_coursesRetorna todos os cursos cadastrados no sistemaAcademicInternalID (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/course_v1_000/post_academics_by_academic_internal_id_coursesInclui o Course passado na requisiçãoAcademicInternalID (string)
Authorization (string) required
data (undefined) required
rm/course_v1_000/get_academics_by_academic_internal_id_courses_by_internal_idRetorna o cursoAcademicInternalID (string)
InternalId (string)
Authorization (string) required
rm/course_v1_000/put_academics_by_academic_internal_id_courses_by_internal_idAltera o curso passado na requisiçãoAcademicInternalID (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/course_v1_000/delete_academics_by_academic_internal_id_courses_by_internal_idExclusão de curso da baseAcademicInternalID (string)
InternalId (string)
Authorization (string) required
rm/curriculumgrid_v1_000/get_academics_by_academic_internal_id_curriculum_gridsRetorna todas as matrizes curriculares educacionaisAcademicInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/curriculumgrid_v1_000/post_academics_by_academic_internal_id_curriculum_gridsInclui a matriz curricular passada na requisiçãoAcademicInternalId (string)
Authorization (string) required
data (undefined) required
rm/curriculumgrid_v1_000/get_academics_by_academic_internal_id_curriculum_grids_by_internal_idRetorna a matriz curricular do educacionalAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/curriculumgrid_v1_000/put_academics_by_academic_internal_id_curriculum_grids_by_internal_idAltera a matriz curricular passada na requisiçãoAcademicInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/curriculumgrid_v1_000/delete_academics_by_academic_internal_id_curriculum_grids_by_internal_idExclusão da matriz curricular da baseAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/customervendor_v1_000/get_customer_vendorRetorna todos clientes e/ou fornecedoresAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/customervendor_v1_000/post_customer_vendorInclui a entidade Cliente/Fornecedor passada na requisiçãoAuthorization (string) required
fields (string)
data: {
. customerVendorId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. storeId (string)
. internalId (string)
. shortName (string)
. name (string)
. type (string)
. entityType (string)
. marketsegment (object)
. registerdate (string)
. registerSituation (string)
. comments (string)
. governmentalInformation (array)
. address (object)
. shippingAddress (object)
. listOfCommunicationInformation (array)
. listOfContacts (array)
. listOfBankingInformation (array)
. billingInformation (object)
. vendorInformation (object)
. fiscalInformation (object)
. creditInformation (object)
. paymentConditionCode (string)
. paymentConditionInternalId (string)
. priceListHeaderItemCode (string)
. priceListHeaderItemInternalId (string)
. carrierCode (integer)
. strategicCustomerType (string)
. rateDiscount (number)
. sellerCode (string)
. sellerInternalId (string)
. classification (string)
. recCreatedBy (string)
. recCreatedOn (string)
. recModifiedBy (string)
. recModifiedOn (string)
. creditLimit (number)
. lastChangeDate (string)
. optionalValue1 (number)
. optionalValue2 (number)
. optionalValue3 (number)
. patrimony (number)
. employeesNumber (integer)
. classificationCompanyId (integer)
. contributor (integer)
. blocked (integer)
. providerShippingPrice (number)
. takerType (integer)
. issContributor (integer)
. dependentsNumber (integer)
. publicBody (integer)
. selfEmployedCategory (integer)
. customerVendorIdentityId (integer)
. otherDeductionsIRRFCalculations (number)
. issRegime (string)
. issRetentionResponsible (string)
. fuelOperationType (integer)
. size (integer)
. activityBranch (integer)
. typeContributorINSS (integer)
. nationality (integer)
. taxCodeColcfo (integer)
. calculatesAVP (integer)
. nif (string)
. nifSituation (integer)
. incomeType (string)
. taxationForm (string)
. innovate_auto (integer)
. formulaApplication (string)
. automaticDebitCheckerType (string)
. executingEntityPaa (string)
. ownWork (integer)
. retiredPensioner (integer)
. socialCategoryId (integer)
. cooperativePartner (integer)
. complementaryFields (object)
} (object) required
rm/customervendor_v1_000/get_customer_vendor_by_entity_typeRetorna todos os registros de uma entidade específica - Customer ou VendorentityType (array)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/customervendor_v1_000/get_customer_vendor_by_entity_type_by_customer_vendor_idRetorna Cliente ou Fornecedor com base no código da entidadecustomerVendorId (string)
entityType (array)
fields (string)
Authorization (string) required
rm/customervendor_v1_000/put_customer_vendor_by_entity_type_by_customer_vendor_idAtualiza a entidade Cliente/Fornecedor informada na requisiçãocustomerVendorId (string)
entityType (array)
fields (string)
Authorization (string) required
data: {
. customerVendorId (string)
. companyId (string)
. branchId (string)
. companyInternalId (string)
. code (string)
. storeId (string)
. internalId (string)
. shortName (string)
. name (string)
. type (string)
. entityType (string)
. marketsegment (object)
. registerdate (string)
. registerSituation (string)
. comments (string)
. governmentalInformation (array)
. address (object)
. shippingAddress (object)
. listOfCommunicationInformation (array)
. listOfContacts (array)
. listOfBankingInformation (array)
. billingInformation (object)
. vendorInformation (object)
. fiscalInformation (object)
. creditInformation (object)
. paymentConditionCode (string)
. paymentConditionInternalId (string)
. priceListHeaderItemCode (string)
. priceListHeaderItemInternalId (string)
. carrierCode (integer)
. strategicCustomerType (string)
. rateDiscount (number)
. sellerCode (string)
. sellerInternalId (string)
. classification (string)
. recCreatedBy (string)
. recCreatedOn (string)
. recModifiedBy (string)
. recModifiedOn (string)
. creditLimit (number)
. lastChangeDate (string)
. optionalValue1 (number)
. optionalValue2 (number)
. optionalValue3 (number)
. patrimony (number)
. employeesNumber (integer)
. classificationCompanyId (integer)
. contributor (integer)
. blocked (integer)
. providerShippingPrice (number)
. takerType (integer)
. issContributor (integer)
. dependentsNumber (integer)
. publicBody (integer)
. selfEmployedCategory (integer)
. customerVendorIdentityId (integer)
. otherDeductionsIRRFCalculations (number)
. issRegime (string)
. issRetentionResponsible (string)
. fuelOperationType (integer)
. size (integer)
. activityBranch (integer)
. typeContributorINSS (integer)
. nationality (integer)
. taxCodeColcfo (integer)
. calculatesAVP (integer)
. nif (string)
. nifSituation (integer)
. incomeType (string)
. taxationForm (string)
. innovate_auto (integer)
. formulaApplication (string)
. automaticDebitCheckerType (string)
. executingEntityPaa (string)
. ownWork (integer)
. retiredPensioner (integer)
. socialCategoryId (integer)
. cooperativePartner (integer)
. complementaryFields (object)
} (object) required
rm/customervendor_v1_000/delete_customer_vendor_by_entity_type_by_customer_vendor_idExclui a entidade Cliente/Fornecedor passada na requisiçãocustomerVendorId (string)
entityType (array)
Authorization (string) required
rm/departamentapi_v1_000/get_departmentRetorna todos os departamentosfilter (string)
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/discriminatedhistograms_v1_000/get_grouped_histogramsRetorna o histograma discriminado de um pedido de material um projeto.order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
projectId (integer) required
requestId (integer) required
rm/educationalreports_v1_000/get_educational_reportsRetorna todos os relatórios educacionaisAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/employeeassociatedvalue_v1_000/get_employeeassociatedvaluesRetorna todos os registros de Valores Associados cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/employeeassociatedvalue_v1_000/post_employeeassociatedvaluesInclui o Valor Associado passado na requisiçãoAuthorization (string) required
data: {
. companyId (integer)
. employeeId (string)
. code (string)
. date (string)
. value (number)
. note (string)
} (object) required
rm/employeeassociatedvalue_v1_000/get_employeeassociatedvalues_by_idRetorna o Valor Associado correspondente ao idid (string)
Authorization (string) required
rm/employeeassociatedvalue_v1_000/put_employeeassociatedvalues_by_idInclui/Edita o Valor Associado passado na requisiçãoid (string)
Authorization (string) required
data: {
. companyId (integer)
. employeeId (string)
. code (string)
. date (string)
. value (number)
. note (string)
} (object) required
rm/employeeassociatedvalue_v1_000/delete_employeeassociatedvalues_by_idDeleta o Valor Associado correspondente ao idid (string)
Authorization (string) required
rm/employeedatacontent_v1_000/get_employee_data_contentRetorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
rm/employeehistorydependents_v1_000/get_employeehistorydependentsRetorna os históricos de dependentes dos funcionários cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/employeehistorydependents_v1_000/post_employeehistorydependentsInclui o Histórico de Dependentes do Funcionário passado na requisiçãoAuthorization (string) required
data (undefined) required
rm/employeehistorydependents_v1_000/get_employeehistorydependents_by_idRetorna o histórico de dependentes indicado para o funcionárioid (string)
Authorization (string) required
rm/employeehistorydependents_v1_000/put_employeehistorydependents_by_idInclui/Edita o Histórico de Dependentes do Funcionário passado na requisiçãoid (string)
Authorization (string) required
data (undefined) required
rm/employeehistorydependents_v1_000/delete_employeehistorydependents_by_idDeleta o Histórico de Dependentes do Funcionário correspondente ao idid (string)
Authorization (string) required
rm/employeehistoryrole_v1_000/get_employeehistoryrolesRetorna todos os registros de Histórico de Função de Funcionário cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/employeehistoryrole_v1_000/post_employeehistoryrolesInclui o Histórico de Função de Funcionário passado na requisiçãoAuthorization (string) required
data (undefined) required
rm/employeehistoryrole_v1_000/get_employeehistoryroles_by_idRetorna o Histórico de Função de Funcionário correspondente ao idid (string)
Authorization (string) required
rm/employeehistoryrole_v1_000/put_employeehistoryroles_by_idInclui/Edita o Histórico de Função de Funcionário passado na requisiçãoid (string)
Authorization (string) required
data (undefined) required
rm/employeehistoryrole_v1_000/delete_employeehistoryroles_by_idDeleta o Histórico de Função de Funcionário correspondente ao idid (string)
Authorization (string) required
rm/employeehistorysection_v1_000/get_employee_history_sectionRetorna os históricos de seção dos funcionários cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/employeehistorysection_v1_000/post_employee_history_sectionInclui um novo histórico de seção para o funcionárioAuthorization (string) required
fields (string)
data (undefined) required
rm/employeehistorysection_v1_000/get_employee_history_section_by_idRetorna o histórico de seção indicado para o funcionárioid (string)
Authorization (string) required
rm/employeehistorysection_v1_000/delete_employee_history_section_by_idExclui histórico de seção do funcionárioid (string)
Authorization (string) required
rm/employeehistorysection_v1_000/put_employee_history_section_by_idAtualiza os dados de um item de histórico de seção do funcionário. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data (undefined) required
rm/employeehistorystatus_v1_000/get_employeehistorystatusRetorna os históricos de situação dos funcionários cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
employeeStatusIds (string)
rm/employeehistorystatus_v1_000/get_employeehistorystatus_by_idRetorna o histórico de situação indicado para o funcionárioid (string)
Authorization (string) required
rm/employeehistoryunioncontribution_v1_000/get_employeehistoryunioncontributionRetorna os históricos de Contribuição Sindical dos funcionários cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
employeeUnionContributionIds (string)
rm/employeehistoryunioncontribution_v1_000/get_employeehistoryunioncontribution_by_idRetorna o histórico de Contribuição Sindical indicado para o funcionárioid (string)
Authorization (string) required
rm/employeepayrollinfo_v1_000/post_employee_payroll_infoConsulta funcionário para avaliação de concessão de empréstimo consignadoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
data: {
. companyInternalId (string)
. companyFederalIdentification (string)
. employeeInternalId (string)
. employeeFederalIdentification (string)
. employeeCode (string)
} (object) required
rm/employeeusestimecard_v1_000/get_employee_uses_time_card_by_idRetorna dados da utilização de ponto dos funcionáriosid (string)
Authorization (string) required
rm/employeeusestimecard_v1_000/get_employee_uses_time_cardRetorna todos os funcionários e o status de utilização de pontoAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/esocialaudit_v1_000/post_esocial_auditInclui a entidade evento passado na requisiçãocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
data (object) required
rm/esocialaudit_v1_000/get_esocial_audit_statusRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
rm/esocialaudit_v1_000/get_esocial_audit_audit_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
status (string)
page (integer)
pageSize (integer)
rm/esocialaudit_v1_000/get_esocial_audit_chart_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
rm/esocialbranches_v1_000/get_esocial_branchesRetorna o código da empresa e código da filial no TAFcompanyId (string) required
order (array)
page (integer)
pageSize (integer)
rm/esocialestablishment_v1_000/get_esocial_establishmentRetorna lista completa com os Estabelecimentos CadastradoscompanyId (string) required
order (array)
page (integer)
pageSize (integer)
rm/esocialevents_v1_000/get_esocial_eventsRetorna a lista de eventos do TAFcompanyId (string) required
eventsCheckPermissions (string)
rm/examappointment_v1_000/get_appointments_exams_examRetorna lista de horários disponiveis para agendamento do exameAuthorization (string) required
companyId (integer) required
ExamId (integer) required
SearchEndDate (string)
ResultPage (integer)
PageSize (integer)
rm/examappointment_v1_000/get_appointments_exams_prep_by_tipo_examRetorna o preparo do exametipo (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
ExamId (integer) required
rm/examappointment_v1_000/get_appointments_exams_unidRetorna o Endereço de Unidade de AtendimentoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
CareUnitId (integer) required
rm/examappointment_v1_000/post_appointments_exams_appointmentInsere um registro de Agendamento para o exame informadoAuthorization (string) required
data: {
. id (string)
. CompanyId (integer)
. AppointmentId (integer)
. ExamId (integer)
. ScheduleId (integer)
. ScheduleName (string)
. ScheduleDate (string)
. StartTime (string)
. EndTime (string)
. PractitionerId (integer)
. PractitionerIdName (string)
. InsurancePlanId (string)
. InsuranceCompanyId (integer)
. InsuranceCompanyName (string)
. InsurancePlanName (string)
. InsuranceSubPlan (string)
. ActivityId (integer)
. SpecialtyId (string)
. IsGroup (string)
. TimeSlot (string)
. PatientId (integer)
. PatientName (string)
. BirthDate (string)
. AppointmentType (string)
. WorkPhone (string)
. HomePhone (string)
. CellPhone (string)
. Email (string)
. PostalCode (string)
. Address (string)
. AddressNumber (string)
. Complement (string)
. Neighborhood (string)
. CovenantCard (string)
. CovenantCardExpireDate (string)
. Observation (string)
. UnitId (integer)
. UnitName (string)
. ProcedureId (string)
. ProcedureName (string)
. SubsidiaryId (integer)
. SubsidiaryName (string)
. City (string)
. Status (integer)
. AppointmentCreateDate (string)
. OnlineConsultation (integer)
. PractitionerCode (integer)
. InsuranceCompanyCode (integer)
. InsurancePlanCode (string)
} (object) required
rm/examappointment_v1_000/put_appointments_exams_appointmentAtualiza um agendamento de exameAuthorization (string) required
data: {
. CompanyId (integer)
. AppointmentId (integer)
. ScheduleDate (string)
. StartTime (string)
. ExamId (integer)
. Observation (string)
. InsurancePlanId (string)
. InsuranceCompanyId (integer)
. InsuranceSubPlan (string)
. CovenantCard (string)
. CovenantCardExpireDate (string)
. PractitionerId (integer)
} (object) required
rm/examappointment_v1_000/delete_appointments_exams_appointmentExclui um agendamento de exameAuthorization (string) required
companyId (integer) required
AppointmentId (integer) required
ExamId (integer) required
rm/examresult_v1_000/get_exams_results_patient_requestLista de Resultados de Exames do Paciente Laboratorial e ImagemAuthorization (string) required
companyId (integer) required
patientId (integer) required
serviceOrder (integer) required
examDescription (string)
rm/examresult_v1_000/get_exams_results_patient_reportRetorna o Laudo dos Resultados de Exames do Paciente Arquivo PDFAuthorization (string) required
companyId (integer) required
patientId (integer) required
serviceOrder (integer) required
examDesexamIdcription (integer)
sequential (integer)
group (string)
rm/examresult_v1_000/get_exams_results_patient_historicRetorna uma lista com o historico de resultados de um determinado exameAuthorization (string) required
patientId (integer) required
examDesexamIdcription (integer)
rm/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_processCarrega registros do evento S-5503, filtrados ou não, ordenados ou não.No parameters
rm/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_processExclui eventos S-5503 conforme coleção de ID's informados.data: {
. companyId (string)
. id (array)
} (object) required
rm/fgtsperworkerinlaborprocess_v1_000/post_fgtsper_worker_in_labor_process_xmlRetorna XML's do evento S-5503 encodados em base64data: {
. companyId (string)
. id (array)
} (object) required
rm/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_categoryCarrega informações relativas a Matrícula e Categoria de trabalhador específico do evento S-5503, ordenadas ou não.No parameters
rm/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_payment_and_amountsCarrega informações relativas a Identificação do estabelecimento responsável pelo pagamento a trabalhador específico dos valores informados do evento S-5503, ordenadas ou nãoNo parameters
rm/financialagreements_v1_000/get_financial_agreementsRetorna todos os lançamentos passíveis de acordo financeiroAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/financialbudgetarynatures_v1_000/get_financial_budgetary_naturesRetorna lista completa de Naturezas Orçamentárias/FinanceirasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/financialbudgetarynatures_v1_000/post_financial_budgetary_naturesInclui uma Natureza Orçamentária/FinanceiraAuthorization (string) required
data (undefined) required
rm/financialbudgetarynatures_v1_000/get_financial_budgetary_natures_by_codeRetorna uma Natureza Orçamentária/Financeira a partir de seu CódigoCode (string)
Authorization (string) required
rm/financialbudgetarynatures_v1_000/put_financial_budgetary_natures_by_codeAtualiza cadastro de Natureza Orçamentária/Financeira conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data (undefined) required
rm/financialbudgetarynatures_v1_000/delete_financial_budgetary_natures_by_codeExclui Natureza Orçamentária/Financeira conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
rm/financialpaymentlink_v1_000/post_paymenthub_by_payment_internal_id_linkRealiza solicitação de pagamento do TOTVS Pagamento DigitalPaymentInternalId (string)
Content-Type (string) required
Authorization (string) required
data: {
. amount (number)
. bankBilletList (array)
} (object) required
rm/financialpaymentlink_v1_000/get_paymenthub_by_payment_internal_id_link_by_transaction_internal_idRetorna os dados da transação do TOTVS Pagamento DigitalPaymentInternalId (string)
TransactionInternalId (string)
Authorization (string) required
rm/financialrefund_v1_000/post_paymenthub_refundRealiza solicitação de reembolso de uma transação com TOTVS Pagamento DigitalContent-Type (string) required
Authorization (string) required
data: {
. transactionCode (int)
. amount (number)
} (object) required
rm/gpeesocialmotives_v1_000/get_esocial_motivesRetorna lista completa com os motivos de afastamentocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
rm/griddiscipline_v1_000/get_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplinesRetorna todas as disciplinas de um período de uma gradeAcademicInternalId (string)
PeriodInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/griddiscipline_v1_000/post_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplinesInclui uma disciplina em uma grade passado na requisiçãoAcademicInternalId (string)
PeriodInternalId (string)
Authorization (string) required
data (undefined) required
rm/griddiscipline_v1_000/get_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_idRetorna a matriz aplicadaAcademicInternalId (string)
PeriodInternalId (string)
InternalId (string)
Authorization (string) required
rm/griddiscipline_v1_000/put_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_idAltera o período passado na requisiçãoAcademicInternalId (string)
PeriodInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/griddiscipline_v1_000/delete_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_idExclusão de disciplina de uma matriz aplicada da baseAcademicInternalId (string)
PeriodInternalId (string)
InternalId (string)
Authorization (string) required
rm/groupedhistogramsgroupingperiods_v1_000/post_grouped_histograms_by_internal_id_grouping_periodsAgrupa períodos no histograma agrupado de um pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. inputIdList (array)
. destinationDate (string)
. dateOriginPeriodList (array)
} (object) required
rm/groupedhistograms_v1_000/get_grouped_histogramsRetorna o histograma agrupado de um pedido de material um projeto.order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
projectId (integer) required
requestId (integer) required
rm/hazardmeasurement_v1_000/get_hazardmeasurement_by_idRetorna dados de tabela da medição de risco especificadaid (string)
Authorization (string) required
rm/hazardmeasurement_v1_000/delete_hazardmeasurement_by_idExclui uma medição de riscoid (string)
Authorization (string) required
rm/hazardmeasurement_v1_000/put_hazardmeasurement_by_idAtualiza um registro existente de tabela de medição de riscos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data (object) required
rm/hazardmeasurement_v1_000/get_hazardmeasurementRetorna todas as medições de riscoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Ids (string)
rm/hazardmeasurement_v1_000/post_hazardmeasurementInclui um novo registro na tabela de medições de riscoAuthorization (string) required
data: {
. CompanyCode (string)
. HazardItemCode (string)
. MeasurementControl (integer)
. QuantitativeValue (number)
. QualitativeValue (string)
. MeasurementCode (string)
. Date (string)
. SectionCode (string)
. MeasurementTechniqueCode (string)
. EndOfMeasurementDate (string)
. WorkStationCode (string)
. WorkPlaceCode (string)
. FunctionCode (string)
. Operator (string)
. TaskCode (string)
. PersonCode (integer)
. TributaryOccupancyCode (string)
} (object) required
rm/ignoredplannedabsences_v1_000/get_ignored_planned_absences_by_idRetorna dados da ausência planejada ignoradaid (string)
Authorization (string) required
rm/ignoredplannedabsences_v1_000/delete_ignored_planned_absences_by_idExclui registro de ausência planejada ignoradaid (string)
rm/ignoredplannedabsences_v1_000/put_ignored_planned_absences_by_idAtualiza um registro de ausência planejada ignorada. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (integer)
. EmployeeId (string)
. Date (datetime)
. Ignore (integer)
. FinishDate (datetime)
. id (string)
} (object) required
rm/ignoredplannedabsences_v1_000/get_ignored_planned_absencesRetorna todas as ausências planejadas ignoradasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/ignoredplannedabsences_v1_000/post_ignored_planned_absencesInclui um novo registro na tabela de ausência planejada ignoradadata: {
. CompanyCode (integer)
. EmployeeId (string)
. Date (datetime)
. Ignore (integer)
. FinishDate (datetime)
. id (string)
} (object) required
rm/imageexamresult_v1_000/get_image_exams_results_patientRetorna uma lista Exames / Resultados de Imagem do PacienteAuthorization (string) required
companyId (integer) required
PatientId (integer) required
ResultPage (integer)
PageSize (integer)
rm/indigenousethnicity_v2_000/get_indigenousethnicityRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/indigenousethnicity_v2_000/get_indigenousethnicity_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/inscriptionfiles_v1_000/get_applicant_registry_by_inscricao_id_inscription_filesRetorna todos os arquivos enviados pelo candidatoInscricaoId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/inscriptionfiles_v1_000/post_applicant_registry_by_inscricao_id_inscription_filesInsere um novo arquivo do candidatoInscricaoId (string)
InscriptionFilesId (string)
Accept-Language (string)
data (object) required
rm/inscriptionfiles_v1_000/get_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_idRetorna os dados de somente um arquivo enviado do candidatoInscricaoId (string)
InscriptionFilesId (string)
fields (string)
Authorization (string) required
rm/inscriptionfiles_v1_000/put_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_idAltera o registro passado na requisiçãoInscricaoId (string)
InscriptionFilesId (string)
Authorization (string) required
data (object) required
rm/inscriptionfiles_v1_000/delete_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_idDeleta um arquivo do candidatoInscricaoId (string)
InscriptionFilesId (string)
Accept-Language (string)
rm/insurancecompany_v1_000/get_insurance_companiesRecupera uma lista com todos os ConvêniosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/insuranceplan_v1_000/get_insurance_plans_by_codeRetorna os dados de uma Agendacode (string)
rm/insuranceplan_v1_000/get_insurance_plansRecupera uma lista de Planos.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/intermittentworkconvocation_v1_000/get_intermittentworkconvocationsRetorna todos os registros de Convocação de Funcionário para Trabalho Intermitente cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
expand (string)
rm/intermittentworkconvocation_v1_000/post_intermittentworkconvocationsInclui a Convocação de Funcionário para Trabalho Intermitente passada na requisiçãoAuthorization (string) required
data: {
. companyId (integer)
. employeeId (string)
. convocationDate (string)
. employeeAnswerDate (string)
. convocationStatusCode (integer)
. servicePlaceCode (integer)
. workingDayDescription (string)
. timeCode (string)
. timeStartIndex (integer)
. serviceStartDate (string)
. serviceEndDate (string)
. expectedPaymentDate (string)
. serviceInterruptionDate (string)
. streetTypeCode (integer)
. street (string)
. number (string)
. complement (string)
. neighborhood (string)
. zipCode (string)
. cityCode (string)
. state (string)
. countryId (integer)
} (object) required
rm/intermittentworkconvocation_v1_000/get_intermittentworkconvocations_by_idRetorna a Convocação de Funcionário para Trabalho Intermitente correspondente ao idid (string)
Authorization (string) required
rm/intermittentworkconvocation_v1_000/put_intermittentworkconvocations_by_idInclui/Edita a Convocação de Funcionário para Trabalho Intermitente passada na requisiçãoid (string)
Authorization (string) required
data (object) required
rm/intermittentworkconvocation_v1_000/delete_intermittentworkconvocations_by_idDeleta a Convocação de Funcionário para Trabalho Intermitente correspondente ao idid (string)
Authorization (string) required
rm/inventorycounts_v1_000/get_inventory_countsRetorna uma ou mais de fichas de inventário conforme parâmetros recebidoscompanyCode (string)
sequenceCountingSheetNumber (integer)
countingSheetNumber (integer)
inventoryDate (string)
inventoryTime (string)
itemCode (string)
groupingCode (number)
lecturerUser1 (string)
lecturerUser2 (string)
lecturerUser3 (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/inventorycounts_v1_000/post_inventory_countsGeração de ficha de inventário. Informar a quantidade apurada na primeira contagem. A atualização da segunda/terceira contagem deve ser enviado via método PUTdata: {
. internalId (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. warehouseCode (string)
. companyCode (string)
. locationCode (string)
. sublocationCode (string)
. referenceCode (string)
. inventoryDate (string)
. inventoryTime (string)
. itemCode (string)
. lotCode (string)
. lotExpirationDate (date)
. statusItem (string)
. countedValue (number)
. groupingCode (number)
. lecturerUser (string)
} (object) required
rm/inventorycounts_v1_000/get_inventory_counts_by_internal_idRetorna uma ficha de inventário correspondente ao número informadointernalId (string)
fields (string)
rm/inventorycounts_v1_000/put_inventory_counts_by_internal_idMétodo responsável pela atualização das quantidades apuradas na ficha de inventário. Caso ainda não exista a ficha no sistema, deve ser previamente criada por meio do método POSTinternalId (string)
data: {
. internalId (string)
. companyCode (string)
. inventoryDate (string)
. inventoryTime (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. numOfCount (number)
. countedValue (number)
. lecturerUser (string)
} (object) required
rm/inventorycounts_v1_000/delete_inventory_counts_by_internal_idElimina a ficha de inventário pelo número e data de saldointernalId (string)
rm/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_countsMétodo responsável pela eliminação das contagens. Contagens voltam ao estado inicialinternalId (string)
rm/jobopportunityprofiles_v1_000/get_jobopportunityprofiles_by_idRetorna dados de tabela do perfil de vaga especificadoid (string)
Authorization (string) required
rm/jobopportunityprofiles_v1_000/delete_jobopportunityprofiles_by_idExclui um perfil de vagaid (string)
Authorization (string) required
rm/jobopportunityprofiles_v1_000/put_jobopportunityprofiles_by_idAtualiza um registro existente de tabela de pessoas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. JobOpportunityCode (string)
. Name (string)
. BeginDate (string)
. EndDate (string)
. FunctionCode (string)
. ShouldPublish (integer)
. Complement (string)
. ShouldPublishComplement (integer)
. EductionLevel (int)
. ShouldPublishEducationLevel (integer)
. Remuneration (string)
. ShouldPublishRemuneration (integer)
. Active (integer)
. FunctionName (string)
. EducationLevelComplement (string)
. OptionalWorkExperiences (string)
. ObligatoryWorkExperiences (string)
. TypeOfStepProgress (integer)
} (object) required
rm/jobopportunityprofiles_v1_000/get_personsRetorna todos os perfís de vagaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Ids (string)
name (string)
rm/jobopportunityprofiles_v1_000/post_personsInclui um novo registro na tabela de perfil de vagaAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. JobOpportunityCode (string)
. Name (string)
. BeginDate (string)
. EndDate (string)
. FunctionCode (string)
. ShouldPublish (integer)
. Complement (string)
. ShouldPublishComplement (integer)
. EductionLevel (int)
. ShouldPublishEducationLevel (integer)
. Remuneration (string)
. ShouldPublishRemuneration (integer)
. Active (integer)
. FunctionName (string)
. EducationLevelComplement (string)
. OptionalWorkExperiences (string)
. ObligatoryWorkExperiences (string)
. TypeOfStepProgress (integer)
} (object) required
rm/jobscheduler_v1_001/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/jobscheduler_v1_001/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
rm/jobscheduler_v1_001/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/jobscheduler_v1_001/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
rm/jobscheduler_v1_001/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
rm/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
rm/jobscheduler_v1_001/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
rm/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
rm/jobscheduler_v1_100/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/jobscheduler_v1_100/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
rm/jobscheduler_v1_100/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/jobscheduler_v1_100/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
rm/jobscheduler_v1_100/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
rm/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
rm/jobscheduler_v1_100/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
rm/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
rm/laboratoryexamitems_v1_000/get_laboratory_exam_itemsRecupera uma lista de exames integradosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/laboratoryexamresult_v1_000/get_laboratory_exams_resultsRecupera uma lista com todos os CadastrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/laboratoryexamresult_v1_000/post_laboratory_exams_resultsInsere um Resultado de ExameAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. serviceOrder (integer)
. examId (integer)
. sequential (integer)
. methodCode (integer)
. methodCodeDescription (string)
. type (string)
. examDescription (string)
. materialCode (string)
. materialDescription (string)
. collectDate (date)
. date (date)
. mnemonic (string)
. patient (object)
. sample (object)
. results (array)
. file
} (object) required
rm/laboratoryexamresult_v2_000/get_laboratory_exams_results_patientRetorna uma lista Exames / Resultados Laboratoriais do PacienteAuthorization (string) required
companyId (integer) required
PatientId (integer) required
ResultPage (integer)
PageSize (integer)
rm/lessonplan_v1_000/get_students_by_student_internal_id_lesson_plansRetorna todos os planos aulaStudentInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/lessonplan_v1_000/get_students_by_student_internal_id_lesson_plans_by_internal_idRetorna todos os planos de aula da baseStudentInternalId (string)
InternalId (string)
Authorization (string) required
rm/major_v1_000/get_academics_by_academic_internal_id_majorsRetorna todas as habilitações educacionaisAcademicInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/major_v1_000/post_academics_by_academic_internal_id_majorsInclui a habilitação passado na requisiçãoAcademicInternalId (string)
Authorization (string) required
data (undefined) required
rm/major_v1_000/get_academics_by_academic_internal_id_majors_by_internal_idRetorna a habilitação do educacionalAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/major_v1_000/put_academics_by_academic_internal_id_majors_by_internal_idAltera a habilitação passado na requisiçãoAcademicInternalId (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/major_v1_000/delete_academics_by_academic_internal_id_majors_by_internal_idExclusão da habilitação da baseAcademicInternalId (string)
InternalId (string)
Authorization (string) required
rm/mandatorytimes_v1_000/get_mandatory_times_by_idRetorna dados do horário obrigatórioid (string)
Authorization (string) required
rm/mandatorytimes_v1_000/delete_mandatory_times_by_idExclui registro de horário obrigatórioid (string)
rm/mandatorytimes_v1_000/put_mandatory_times_by_idAtualiza um registro de horário obrigatório. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (integer)
. EmployeeId (string)
. Date (datetime)
. InitialHour (integer)
. EndHour (integer)
. OvertimeOption (integer)
. DelayOption (integer)
. AbsenceOption (integer)
. id (string)
} (object) required
rm/mandatorytimes_v1_000/get_mandatory_timesRetorna todas os horários obrigatóriosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/mandatorytimes_v1_000/post_mandatory_timesInclui um novo registro na tabela de horário obrigatóriodata: {
. CompanyCode (integer)
. EmployeeId (string)
. Date (datetime)
. InitialHour (integer)
. EndHour (integer)
. OvertimeOption (integer)
. DelayOption (integer)
. AbsenceOption (integer)
. id (string)
} (object) required
rm/medicalconsultations_v1_000/get_medicalconsultations_by_idRetorna dados de tabela da consulta especificadaid (string)
Authorization (string) required
rm/medicalconsultations_v1_000/delete_medicalconsultations_by_idExclui uma consulta médicaid (string)
Authorization (string) required
rm/medicalconsultations_v1_000/put_medicalconsultations_by_idAtualiza um registro existente de tabela de consultas médicas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. MedicalConsultationCode (string)
. MedicalConsultationId (integer)
. personCode (integer)
. MedicalConsultationDate (string)
. MedicalConsultationType (string)
. DoctorName (string)
. MedicalBoardRegistration (string)
. Observation (string)
. PersonName (string)
. EmployeeId (string)
. MedicallyAble (integer)
. DoctorCode (integer)
. MedicalConsultationTypeCode (string)
. Type (integer)
. MedicalConsultationScheduledTime (integer)
. MedicalInstitutionCode (string)
. MedicalConsultationEndTime (string)
. AsoDate (string)
} (object) required
rm/medicalconsultations_v1_000/get_medicalconsultationsRetorna todos as consultasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Ids (string)
rm/medicalconsultations_v1_000/post_medicalconsultationsInclui um novo registro na tabela de consultasAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. MedicalConsultationCode (string)
. MedicalConsultationId (integer)
. personCode (integer)
. MedicalConsultationDate (string)
. MedicalConsultationType (string)
. DoctorName (string)
. MedicalBoardRegistration (string)
. Observation (string)
. PersonName (string)
. EmployeeId (string)
. MedicallyAble (integer)
. DoctorCode (integer)
. MedicalConsultationTypeCode (string)
. Type (integer)
. MedicalConsultationScheduledTime (integer)
. MedicalInstitutionCode (string)
. MedicalConsultationEndTime (string)
. AsoDate (string)
} (object) required
rm/medicalspecialty_v1_000/get_medical_specialties_by_codeRetorna dados de tabela de especialidades medicascode (integer)
rm/medicalspecialty_v1_000/delete_medical_specialties_by_codeExclui tabela de especialidades medicascode (integer)
rm/medicalspecialty_v1_000/put_medical_specialties_by_codeAtualiza um registro existente de tabela de especialidades medicascode (integer)
data: {
. code (integer)
. description (string)
. complementaryDescription (string)
. medicalBoardCode (integer)
. nationalAgencySpeciality (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
rm/medicalspecialty_v1_000/get_medical_specialtiesBusca dados de tabela de especialidades medicas existentesorder (array)
codeFinal (integer)
description (string)
page (integer)
pageSize (integer)
fields (string)
rm/medicalspecialty_v1_000/post_medical_specialtiesInclui um novo registro de tabela de especialidades medicasdata: {
. code (integer)
. description (string)
. complementaryDescription (string)
. medicalBoardCode (integer)
. nationalAgencySpeciality (string)
. note (string)
. updateDate (string)
. updateUser (string)
} (object) required
rm/movementsseller_v1_000/get_sellerRetorna lista completa dos Vendedores.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/movementsseller_v1_000/post_sellerMétodo não implementado.data (undefined) required
rm/movementsseller_v1_000/get_seller_by_internal_idRetorna o Vendedor pelo InternalId.InternalId (string)
Authorization (string) required
fields (string)
rm/movementsseller_v1_000/put_seller_by_internal_idMétodo não implementado.InternalId (string)
Authorization (string) required
fields (string)
data (undefined) required
rm/movementsseller_v1_000/delete_seller_by_internal_idMétodo não implementado.InternalId (string)
Authorization (string) required
rm/movements_v1_000/get_movementsRetorna uma lista de movimentos com base no filtro enviado junto a requisiçãoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/movements_v1_000/post_movementsInclui o movimento conforme dados enviados na requisiçãoAuthorization (string) required
data (undefined) required
rm/movements_v1_000/get_movements_by_internal_idRetorna o movimento que possui o código da colgiada e identificador informados no InternalIdInternalId (string)
Authorization (string) required
rm/movements_v1_000/put_movements_by_internal_idAtualiza o movimento que possui o código da colgiada e identificador informados no InternalId conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data (undefined) required
rm/movements_v1_000/delete_movements_by_internal_idExclui o movimento que possui o código da colgiada e identificador informados no InternalIdInternalId (string)
Authorization (string) required
rm/movements_v1_000/post_movements_cancel_by_internal_idCancela o movimento que possui o código da colgiada e identificador informados no InternalIdInternalId (string)
Authorization (string) required
rm/offeredactivities_v1_000/post_offeredactivities_by_offered_activity_internal_id_inscriptionRealiza a inscrição em atividade ofertadaOfferedActivityInternalId (string)
Authorization (string) required
data (undefined) required
rm/ppebatch_v1_000/get_ppebatchsRetorna todos os Lotes de EPIs cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/ppebatch_v1_000/post_ppebatchsInclui o Lote de EPI passado na requisiçãodata: {
. id (string)
. companyCode (integer)
. ppeCode (string)
. batchId (integer)
. approvalCertificate (string)
. acquisitionDate (date)
. shelfLifeDate (date)
. durabilityDate (date)
. approvalCertificateExpirationDate (date)
. durability (integer)
. amount (integer)
. importerRegistrationCertificate (string)
. producerRegistrationCertificate (string)
. producer (string)
. observations (string)
. sanitazed (boolean)
. invalid (boolean)
. ppeBatchItens (array[objects])
} (object) required
rm/ppebatch_v1_000/get_ppebatchs_by_idRetorna o Lote de EPIs indicado e uma lista dos itens do Lote.id (string)
rm/ppebatch_v1_000/put_ppebatchs_by_idAltera o Lote de EPIs passado na requisiçãoid (string)
data: {
. id (string)
. companyCode (integer)
. ppeCode (string)
. batchId (integer)
. approvalCertificate (string)
. acquisitionDate (date)
. shelfLifeDate (date)
. durabilityDate (date)
. approvalCertificateExpirationDate (date)
. durability (integer)
. amount (integer)
. importerRegistrationCertificate (string)
. producerRegistrationCertificate (string)
. producer (string)
. observations (string)
. sanitazed (boolean)
. invalid (boolean)
. ppeBatchItens (array[objects])
} (object) required
rm/ppe_v1_000/get_ppesRetorna todos os EPIs cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/ppe_v1_000/post_ppesInclui EPI passado na requisiçãodata: {
. id (string)
. companyCode (integer)
. ppeCode (string)
. ppeIdentifierCode (string)
. acquisitionDate (date)
. shelfLifeDate (date)
. durability (integer)
. invalid (boolean)
. borrowed (boolean)
. observations (string)
. status (string)
. approvalCertificate (string)
. batchId (integer)
. durabilityDate (date)
. approvalCertificateExpirationDate (date)
. periodicity (integer)
} (object) required
rm/ppe_v1_000/get_ppes_by_idRetorna o EPI indicadoid (string)
rm/ppe_v1_000/put_ppes_by_idAltera o EPI passado na requisiçãoid (string)
data: {
. id (string)
. companyCode (integer)
. ppeCode (string)
. ppeIdentifierCode (string)
. acquisitionDate (date)
. shelfLifeDate (date)
. durability (integer)
. invalid (boolean)
. borrowed (boolean)
. observations (string)
. status (string)
. approvalCertificate (string)
. batchId (integer)
. durabilityDate (date)
. approvalCertificateExpirationDate (date)
. periodicity (integer)
} (object) required
rm/patient_v1_000/get_patients_by_codeRetorna os dados de um pacientecode (string)
rm/patient_v1_000/get_patientsRecupera uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/patient_v1_000/post_patientsInsere um registroAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. patientId (integer)
. medicalRecords (string)
. patientName (string)
. birthDate (date)
. motherName (string)
. cpf (string)
. dddHomePhone (string)
. homePhone (string)
. dddWorkPhone (string)
. workPhone (string)
. dddContactPhone (string)
. contactPhone (string)
. email (string)
. celPhone (string)
. vipClient (string)
} (object) required
rm/patient_v2_000/get_patientsRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/patient_v2_000/post_patientsInsere um registroAuthorization (string) required
data: {
. id (string)
. CompanyId (integer)
. PatientId (integer)
. MedicalRecord (string)
. CellPhone (string)
. VipClient (string)
. CPF (string)
. PatientName (string)
. MotherName (string)
. BirthDate (string)
. Email (string)
. ContactPhone (string)
. DDDContactPhone (string)
. ContactName (string)
. SUSNumberCard (string)
. Sex (string)
. BreedColorCode (integer)
. EthnicityCode (integer)
. PublicPlaceCode (string)
. Address (string)
. Number (string)
. Complement (string)
. Neighborhood (string)
. NeighborhoodType (integer)
. CountyCode (string)
. StateAddress (string)
. ZipCode (string)
. SocialName (string)
. Observation (string)
} (object) required
rm/patient_v2_000/get_patients_by_idRecupera um registrocode (string)
id (string)
Authorization (string) required
expand (string)
fields (string)
rm/patient_v2_000/put_patients_by_idAtualiza um registrocode (string)
id (string)
Authorization (string) required
data: {
. id (string)
. CompanyId (integer)
. PatientId (integer)
. MedicalRecord (string)
. CellPhone (string)
. VipClient (string)
. CPF (string)
. PatientName (string)
. MotherName (string)
. BirthDate (string)
. Email (string)
. ContactPhone (string)
. DDDContactPhone (string)
. ContactName (string)
. SUSNumberCard (string)
. Sex (string)
. BreedColorCode (integer)
. EthnicityCode (integer)
. PublicPlaceCode (string)
. Address (string)
. Number (string)
. Complement (string)
. Neighborhood (string)
. NeighborhoodType (integer)
. CountyCode (string)
. StateAddress (string)
. ZipCode (string)
. SocialName (string)
. Observation (string)
} (object) required
rm/patrimonydepreciation_v1_000/get_patrimony_depreciationRetorna uma lista de registros de patrimônios e detalhes de sua depreciaçãoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/patrimonydepreciation_v1_000/get_patrimony_depreciation_by_idRecupera um item de depreciação patrimonialid (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/paymentcondition_v1_0000/get_paymentconditionRetorna lista completa das condições de pagamentoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/paymentcondition_v1_0000/post_paymentconditionInclui uma condição de pagamento conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. InternalId (string)
. CompanyId (integer)
. Code (string)
. Description (string)
. currencyRoundingInstallment (string)
. currencyRounding (string)
. Deflation (number)
. ApplicationFormula (string)
. PriceOneFormula (string)
. PriceTwoFormula (string)
. InterestRate (number)
. CompoundInterest (boolean)
. CommercialAutomationAvailable (integer)
. MonthlyCapitalization (number)
. PurchasePlan (boolean)
. SalesPlan (boolean)
. WeekDaysFixed (integer)
. FirstInstallmentFormula (string)
. Inactive (integer)
. DisregardsLimCred (boolean)
. PaymentAmountOne (number)
. NumberOfTimesOne (integer)
. intervalPeriodInDaysOne (integer)
. PaymentTermInDaysOne (integer)
. DayCountTypeOne (string)
. typeOfCalculationForInstallmentTermOne (string)
. PaymentAmountTwo (number)
. NumberOfTimesTwo (integer)
. intervalPeriodInDaysTwo (integer)
. PaymentTermInDaysTwo (integer)
. DayCountTypeTwo (string)
. typeOfCalculationForInstallmentTermTwo (string)
. PaymentAmountThree (number)
. NumberOfTimesThree (integer)
. intervalPeriodInDaysThree (integer)
. PaymentTermInDaysThree (integer)
. DayCountTypeThree (string)
. typeOfCalculationForInstallmentTermThree (string)
. PaymentAmountFour (number)
. NumberOfTimesFour (integer)
. intervalPeriodInDaysFour (integer)
. PaymentTermInDaysFour (integer)
. DayCountTypeFour (string)
. PaymentAmountFive (number)
. NumberOfTimesFive (integer)
. intervalPeriodInDaysFive (integer)
. PaymentTermInDaysFive (integer)
. DayCountTypeFive (string)
. typeOfCalculationForInstallmentTermFive (string)
} (object) required
rm/paymentcondition_v1_0000/get_paymentcondition_by_internal_idRetorna a condição de pagamento pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
rm/paymentcondition_v1_0000/put_paymentcondition_by_internal_idAtualiza a condição de pagamento conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. InternalId (string)
. CompanyId (integer)
. Code (string)
. Description (string)
. currencyRoundingInstallment (string)
. currencyRounding (string)
. Deflation (number)
. ApplicationFormula (string)
. PriceOneFormula (string)
. PriceTwoFormula (string)
. InterestRate (number)
. CompoundInterest (boolean)
. CommercialAutomationAvailable (integer)
. MonthlyCapitalization (number)
. PurchasePlan (boolean)
. SalesPlan (boolean)
. WeekDaysFixed (integer)
. FirstInstallmentFormula (string)
. Inactive (integer)
. DisregardsLimCred (boolean)
. PaymentAmountOne (number)
. NumberOfTimesOne (integer)
. intervalPeriodInDaysOne (integer)
. PaymentTermInDaysOne (integer)
. DayCountTypeOne (string)
. typeOfCalculationForInstallmentTermOne (string)
. PaymentAmountTwo (number)
. NumberOfTimesTwo (integer)
. intervalPeriodInDaysTwo (integer)
. PaymentTermInDaysTwo (integer)
. DayCountTypeTwo (string)
. typeOfCalculationForInstallmentTermTwo (string)
. PaymentAmountThree (number)
. NumberOfTimesThree (integer)
. intervalPeriodInDaysThree (integer)
. PaymentTermInDaysThree (integer)
. DayCountTypeThree (string)
. typeOfCalculationForInstallmentTermThree (string)
. PaymentAmountFour (number)
. NumberOfTimesFour (integer)
. intervalPeriodInDaysFour (integer)
. PaymentTermInDaysFour (integer)
. DayCountTypeFour (string)
. PaymentAmountFive (number)
. NumberOfTimesFive (integer)
. intervalPeriodInDaysFive (integer)
. PaymentTermInDaysFive (integer)
. DayCountTypeFive (string)
. typeOfCalculationForInstallmentTermFive (string)
} (object) required
rm/paymentcondition_v1_0000/delete_paymentcondition_by_internal_idExclui a condição de pagamento conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
rm/paymentplanssimulations_v1_000/post_students_by_student_internal_id_paymentplans_by_payment_plan_internal_id_simulationsExecuta a simulação de valores de parcelas de planos de pagamento com base em uma lista de turmas disciplinas, matriz aplicada e status de matrícula. Não precisa do aluno ter uma matrícula em disciplinas ou contrato prévio. A lista de bolsas é obtida através de concessões de bolsas futuras dos alunos.StudentInternalId (string)
PaymentPlanInternalId (string)
Authorization (string) required
data (undefined) required
rm/payrollcontrol_v1_000/get_payroll_controlRetorna os dados da folha de pagamento de benefíciosAssitência Médica e OdontológicaAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
datemodified (string)
providerType (string) required
companyid (string) required
rm/performanceevaluations_v1_000/get_performance_evaluations_by_idRetorna dados da avaliação de desempenhoid (string)
Authorization (string) required
rm/performanceevaluations_v1_000/delete_performance_evaluations_by_idExclui avaliação de desempenhoid (string)
Authorization (string) required
rm/performanceevaluations_v1_000/put_performance_evaluations_by_idAtualiza uma avaliação de desempenho. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. PerformanceAssessmentCode (string)
. PerformanceAssessmentCodeInternalId (string)
. OpeningDate (string)
. ClosingData (string)
. Name (string)
. Mode (integer)
. IsFinished (boolean)
} (object) required
rm/performanceevaluations_v1_000/get_performance_evaluationsRetorna todos as avaliações de desempenhoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
performanceEvaluationsIds (string)
name (string)
rm/performanceevaluations_v1_000/post_performance_evaluationsInclui um novo registro na tabela de avaliação de desempenhoAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. PerformanceAssessmentCode (string)
. PerformanceAssessmentCodeInternalId (string)
. OpeningDate (string)
. ClosingData (string)
. Name (string)
. Mode (integer)
. IsFinished (boolean)
} (object) required
rm/period_v1_000/get_academics_by_grade_internal_id_periodsRetorna todos os períodos de uma matriz curricularGradeInternalID (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/period_v1_000/post_academics_by_grade_internal_id_periodsInclui o período passado na requisiçãoGradeInternalID (string)
Authorization (string) required
data (undefined) required
rm/period_v1_000/get_academics_by_grade_internal_id_periods_by_internal_idRetorna o períodoGradeInternalID (string)
InternalId (string)
Authorization (string) required
rm/period_v1_000/put_academics_by_grade_internal_id_periods_by_internal_idAltera o período passado na requisiçãoGradeInternalID (string)
InternalId (string)
Authorization (string) required
data (undefined) required
rm/period_v1_000/delete_academics_by_grade_internal_id_periods_by_internal_idExclusão de período da baseGradeInternalID (string)
InternalId (string)
Authorization (string) required
rm/persons_v1_000/get_persons_by_idRetorna dados de tabela da pessoa especificadaid (string)
Authorization (string) required
rm/persons_v1_000/delete_persons_by_idExclui pessoaid (string)
Authorization (string) required
rm/persons_v1_000/put_persons_by_idAtualiza um registro existente de tabela de pessoas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. Code (string)
. Name (string)
. Birth (date)
. HomeState (string)
. Naturalness (string)
. NickName (string)
. Sex (string)
. Nationality (string)
. EducationalLevel (string)
. Street (string)
. Number (string)
. District (string)
. State (string)
. City (string)
. Cep (string)
. Country (string)
. ProfessionalRegistrationNumber (string)
. Cpf (string)
. ImageId (integer)
. PhoneNumber1 (string)
. identityNumber (string)
. IdentityNumberEmitterState (string)
. IdentityNumberEmitterAgency (string)
. IdentityNumberEmissionDate (date)
. ElectoralCard (string)
. ElectoralWard (string)
. ElectoralSection (string)
. WorkCard (string)
. WorkCardSerialNumber (string)
. WorkCardEmitterState (string)
. WorkCardEmissionDate (date)
. Nit (boolean)
. DriversLicense (string)
. DriversLicenseType (string)
. DriversLicenseExpirationDate (date)
. MilitaryDischargeCertificate (string)
. MilitaryGrade (string)
. BrazilConsort (boolean)
. Naturalized (boolean)
. BrazilianChildren (boolean)
. BrazilianChildrenNumber (integer)
. Email (string)
. PreviousTrainingInvestment (double)
. ShadeRace (integer)
. Disabled (boolean)
. UserCode (string)
. PhoneNumber3 (string)
. Company (string)
. OccupationCode (string)
. Rehabilitated (boolean)
. Smoker (boolean)
. AdjustsImageSize (boolean)
. DeafPerson (boolean)
. MutePerson (boolean)
. BlindPerson (boolean)
. MentallyImpairedPerson (boolean)
. CurriculumApprovalDate (date)
. Student (boolean)
. Teacher (boolean)
. Candidate (boolean)
. BibliosUser (boolean)
. Employee (boolean)
. FormerEmployee (boolean)
. IntellectualImpairedPerson (boolean)
. Deceased (boolean)
. Age (integer)
} (object) required
rm/persons_v1_000/get_personsRetorna todos as pessoasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
personsIds (string)
name (string)
rm/persons_v1_000/post_personsInclui um novo registro na tabela de pessoasAuthorization (string) required
data: {
. id (string)
. Code (string)
. Name (string)
. Birth (date)
. HomeState (string)
. Naturalness (string)
. NickName (string)
. Sex (string)
. Nationality (string)
. EducationalLevel (string)
. Street (string)
. Number (string)
. District (string)
. State (string)
. City (string)
. Cep (string)
. Country (string)
. ProfessionalRegistrationNumber (string)
. Cpf (string)
. ImageId (integer)
. PhoneNumber1 (string)
. identityNumber (string)
. IdentityNumberEmitterState (string)
. IdentityNumberEmitterAgency (string)
. IdentityNumberEmissionDate (date)
. ElectoralCard (string)
. ElectoralWard (string)
. ElectoralSection (string)
. WorkCard (string)
. WorkCardSerialNumber (string)
. WorkCardEmitterState (string)
. WorkCardEmissionDate (date)
. Nit (boolean)
. DriversLicense (string)
. DriversLicenseType (string)
. DriversLicenseExpirationDate (date)
. MilitaryDischargeCertificate (string)
. MilitaryGrade (string)
. BrazilConsort (boolean)
. Naturalized (boolean)
. BrazilianChildren (boolean)
. BrazilianChildrenNumber (integer)
. Email (string)
. PreviousTrainingInvestment (double)
. ShadeRace (integer)
. Disabled (boolean)
. UserCode (string)
. PhoneNumber3 (string)
. Company (string)
. OccupationCode (string)
. Rehabilitated (boolean)
. Smoker (boolean)
. AdjustsImageSize (boolean)
. DeafPerson (boolean)
. MutePerson (boolean)
. BlindPerson (boolean)
. MentallyImpairedPerson (boolean)
. CurriculumApprovalDate (date)
. Student (boolean)
. Teacher (boolean)
. Candidate (boolean)
. BibliosUser (boolean)
. Employee (boolean)
. FormerEmployee (boolean)
. IntellectualImpairedPerson (boolean)
. Deceased (boolean)
. Age (integer)
} (object) required
rm/practitioneronduty_v1_000/get_practitioner_on_dutyRetorna todos os Especialistas em PlantãoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/practitioner_v1_000/get_practitioners_by_codeRetorna todos as Atividades da Agendacode (string)
rm/practitioner_v1_000/get_practitionersRecupera uma lista com todos os CadastrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/products_v2_000/get_productsO retorno desta API possui informações do produto/serviços incluindo os grupos o qual o produto/serviços faz parte se houver.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/products_v2_000/post_productsInclui um novo Produto/ServiçoAuthorization (string) required
data (undefined) required
rm/products_v2_000/get_products_by_internal_idRetorna um Produto/Serviço a partir de sua chaveInternalId (string)
Authorization (string) required
rm/products_v2_000/put_products_by_internal_idAtualiza o cadastro de um Produto/Serviço conforme dados enviados no corpo da requisiçãoInternalId (string)
Authorization (string) required
data (undefined) required
rm/products_v2_000/delete_products_by_internal_idExclui um Produto/Serviço conforme dados enviados no corpo da requisiçãoInternalId (string)
Authorization (string) required
rm/professorcontext_v1_000/get_professor_contextsRetorna todos os contextos do professor do EducacionalAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/professordisciplineclass_v1_000/get_professors_by_professor_internal_id_disciplineclassesRetorna todas as turmas/disciplina do professor do EducacionalProfessorInternalId (string)
InternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/professorwarning_v1_000/get_professors_by_professor_internal_id_studentwarningsRetorna todas as ocorrências do aluno, cadastrados pelo professor do EducacionalProfessorInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/professorwarning_v1_000/post_professors_by_professor_internal_id_studentwarningsInclui a ocorrência passada na requisiçãoProfessorInternalId (string)
Authorization (string) required
rm/professorwarning_v1_000/get_professors_by_professor_internal_id_studentwarning_by_internal_idRetorna a ocorrência do aluno do educacionalProfessorInternalId (string)
InternalId (string)
Authorization (string) required
rm/professorwarning_v1_000/put_professors_by_professor_internal_id_studentwarning_by_internal_idAltera a ocorrência do aluno, feita pelo professor do educacionalProfessorInternalId (string)
InternalId (string)
Authorization (string) required
rm/professorwarning_v1_000/delete_professors_by_professor_internal_id_studentwarning_by_internal_idExclusão da ocorrência passada na requisiçãoProfessorInternalId (string)
InternalId (string)
Authorization (string) required
rm/projectapproverequest_v1_000/post_project_material_requests_extra_by_internal_id_approve_requestAprovar um pedido de material extrainternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
} (object) required
rm/projectcancelsupplies_v1_000/post_cancel_suppliesCancela um movimento para um pedido de materialAuthorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. uniqueMov (boolean)
. isMaterialRequestExtra (boolean)
} (object) required
rm/projectcostgroups_v1_000/get_cost_groupsRetorna uma lista de grupos de custo do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectcostgroups_v1_000/post_cost_groupsInsere um novo Grupo de CustoAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. costGroupId (integer)
. costGroupCode (string)
. groupDNER (string)
. bdi (number)
. socialLaw (integer)
. percentageOnDNITGroup (string)
. startInputCode (string)
. finalInputCode (string)
. unitCode (string)
. paymentTerms (string)
. journey (number)
. resupplyPeriod (integer)
. budgetaryNature (string)
. companyBudgetaryNature (integer)
. equalizable (integer)
} (object) required
rm/projectcostgroups_v1_000/get_cost_groups_by_idRecupera um Grupo de Custoid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectcostgroups_v1_000/put_cost_groups_by_idAtualiza um Grupo de Custoid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. costGroupId (integer)
. costGroupCode (string)
. groupDNER (string)
. bdi (number)
. socialLaw (integer)
. percentageOnDNITGroup (string)
. startInputCode (string)
. finalInputCode (string)
. unitCode (string)
. paymentTerms (string)
. journey (number)
. resupplyPeriod (integer)
. budgetaryNature (string)
. companyBudgetaryNature (integer)
. equalizable (integer)
} (object) required
rm/projectcostgroups_v1_000/delete_cost_groups_by_idExclui um Grupo de Custoid (string)
Authorization (string) required
rm/projectdisapproverequest_v1_000/post_project_material_requests_extra_by_internal_id_disapprove_requestReprovar um pedido de material extrainternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
} (object) required
rm/projectfinalizeapprovalrequest_v1_000/post_project_material_requests_extra_by_internal_id_finalize_approvalFinalizar aprovação de um pedido de material extrainternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
} (object) required
rm/projectgeneratematerialrequest_v1_000/post_project_material_requests_by_internal_id_generateGera um novo pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. startPeriod (string)
. finalPeriod (string)
. requestType (integer)
. startTaskCode (string)
. finalTaskCode (string)
. taskIdList (string)
. costGroupIdList (string)
. inputIdList (string)
. spreadsheetType (integer)
} (object) required
rm/projectgenerationsuppliesbydate_v1_000/post_generation_supplies_by_dateGerar um movimento por data para um pedido de materialAuthorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. uniqueMov (boolean)
. isMaterialRequestExtra (boolean)
} (object) required
rm/projectgenerationsupplies_v1_000/post_generation_suppliesGerar um movimento único para um pedido de materialAuthorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. uniqueMov (boolean)
. isMaterialRequestExtra (boolean)
} (object) required
rm/projectinputs_v1_000/get_inputsRetorna uma lista de insumos do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectinputs_v1_000/post_inputsInsere um novo insumoAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. inputId (integer)
. costGroupId (integer)
. inputType (integer)
. inputCode (string)
. description (string)
. unitCode (string)
. groupDNER (string)
. activeInputPriceId (integer)
. value (number)
. valueWithoutLaws (number)
. unproductiveValue (number)
. spreadsheetId (integer)
. applicationCode (string)
. productiveHourCostCell (string)
. unproductiveHourCostCell (string)
. factorK (number)
. codeEMOP (string)
. codeFGV (string)
. inputCodePINI (string)
. paymentTerms (string)
. notFractioned (integer)
. journey (number)
. resupplyPeriod (integer)
. calculationPriority (integer)
. derivationType (integer)
. formulaApplication (string)
. quantityFormula (string)
. valueFormula (string)
. taskFormula (string)
. minimumPercentage (number)
. maximumPercentage (number)
. percentageUnitValue (number)
. budgetaryNature (string)
. companyBudgetaryNature (integer)
. journeyPeriod (number)
. unproductivityPercentage (number)
. detailedInput (integer)
. purchaseType (integer)
. inputIdPINI (integer)
. codePINI (string)
. inputTypeHiring (integer)
. efficiencyFactor (integer)
. specialRetirement (integer)
} (object) required
rm/projectinputs_v1_000/get_inputs_by_idRecupera um insumoid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectinputs_v1_000/put_inputs_by_idAtualiza um insumoid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. inputId (integer)
. costGroupId (integer)
. inputType (integer)
. inputCode (string)
. description (string)
. unitCode (string)
. groupDNER (string)
. activeInputPriceId (integer)
. value (number)
. valueWithoutLaws (number)
. unproductiveValue (number)
. spreadsheetId (integer)
. applicationCode (string)
. productiveHourCostCell (string)
. unproductiveHourCostCell (string)
. factorK (number)
. codeEMOP (string)
. codeFGV (string)
. inputCodePINI (string)
. paymentTerms (string)
. notFractioned (integer)
. journey (number)
. resupplyPeriod (integer)
. calculationPriority (integer)
. derivationType (integer)
. formulaApplication (string)
. quantityFormula (string)
. valueFormula (string)
. taskFormula (string)
. minimumPercentage (number)
. maximumPercentage (number)
. percentageUnitValue (number)
. budgetaryNature (string)
. companyBudgetaryNature (integer)
. journeyPeriod (number)
. unproductivityPercentage (number)
. detailedInput (integer)
. purchaseType (integer)
. inputIdPINI (integer)
. codePINI (string)
. inputTypeHiring (integer)
. efficiencyFactor (integer)
. specialRetirement (integer)
} (object) required
rm/projectinputs_v1_000/delete_inputs_by_idExclui um insumosid (string)
Authorization (string) required
rm/projectitemrequestcontractapportionment_v1_000/post_project_items_material_requests_by_internal_id_update_quantityRateia o contrato dos itens de um pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. itemRequestIdList (array)
. quantity (number)
. percentage (number)
. newContractId (integer)
. newContractObjId (integer)
} (object) required
rm/projectitemrequestupdatequantity_v1_000/post_project_items_material_requests_by_internal_id_update_quantityAltera a quantidade dos itens de um pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. itemRequestIdList (array)
. quantity (number)
. percentage (number)
} (object) required
rm/projectitemsmaterialrequestsextra_v1_000/get_project_items_material_requests_extraRetorna uma lista de itens pedidos de materiais extra por projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
requestId (integer) required
rm/projectitemsmaterialrequestsextra_v1_000/post_project_items_material_requests_extraInsere um novo item no pedido de material extraAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. itemRequestId (integer)
. taskId (integer)
. taskCode (string)
. name (string)
. description (string)
. productId (integer)
. productCode (string)
. nickname (string)
. budgetedPrice (number)
. quantityRequest (number)
. dateDelivery (string)
. reasonId (integer)
. reason (string)
. contractId (integer)
. contractObjId (integer)
. contractNumber (string)
. statusApprovalId (integer)
. approverCode (string)
. quantityApproved (number)
. dateApproval (string)
. justificationApproval (string)
. movId (integer)
. movSequentialNumber (integer)
. approverName (string)
. statusApprovalName (string)
. reasonRequestName (string)
. statusRequestId (integer)
. unitPurchaseId (integer)
. quantityReversal (number)
} (object) required
rm/projectitemsmaterialrequestsextra_v1_000/get_project_items_material_requests_extra_by_idRecupera um item do pedido de material extraid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectitemsmaterialrequestsextra_v1_000/put_project_items_material_requests_extra_by_idAtualiza um item do pedido de material extraid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. itemRequestId (integer)
. taskId (integer)
. taskCode (string)
. name (string)
. description (string)
. productId (integer)
. productCode (string)
. nickname (string)
. budgetedPrice (number)
. quantityRequest (number)
. dateDelivery (string)
. reasonId (integer)
. reason (string)
. contractId (integer)
. contractObjId (integer)
. contractNumber (string)
. statusApprovalId (integer)
. approverCode (string)
. quantityApproved (number)
. dateApproval (string)
. justificationApproval (string)
. movId (integer)
. movSequentialNumber (integer)
. approverName (string)
. statusApprovalName (string)
. reasonRequestName (string)
. statusRequestId (integer)
. unitPurchaseId (integer)
. quantityReversal (number)
} (object) required
rm/projectitemsmaterialrequestsextra_v1_000/delete_project_items_material_requests_extra_by_idExclui um item do pedido de material extraid (string)
Authorization (string) required
rm/projectitemsmaterialrequests_v1_000/get_project_items_material_requestsRetorna uma lista dos itens de pedidos de materiais de um projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
requestId (integer) required
rm/projectitemsmaterialrequests_v1_000/get_project_items_material_requests_by_idRecupera um item de um pedido de materialid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectitemsmaterialrequests_v1_000/put_project_items_material_requests_by_idAtualiza um item de um pedido de materialid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. itemRequestId (integer)
. needId (integer)
. requestId (integer)
. taskId (integer)
. taskCode (string)
. name (string)
. description (string)
. inputId (integer)
. inputCode (string)
. inputDescription (string)
. projectRecId (integer)
. productId (integer)
. productCode (string)
. nickname (string)
. idMov (integer)
. movTypeCode (string)
. movItemSequence (integer)
. demandedQuantity (number)
. necessaryQuantity (number)
. reversedQuantity (number)
. deliveryDate (string)
. requestDate (string)
. needDate (string)
. reason (string)
. contractId (integer)
. contractObjId (integer)
. contractNumber (string)
. budgetedPrice (number)
. unitCode (string)
. purchaseUnitCode (string)
. resupplyPeriod (integer)
. spreadsheetType (integer)
} (object) required
rm/projectmaterialrequestimportquotedprices_v1_000/post_project_material_requests_by_internal_id_import_quoted_pricesImporta preços cotados de um pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. inputIdList (array)
. importValueWithTribute (boolean)
. activateImportedPrice (boolean)
. convertPriceUnitInput (boolean)
. functionAggregation (string)
. descriptionPriceDefault (string)
} (object) required
rm/projectmaterialrequestsextra_v1_000/get_project_material_requests_extraRetorna uma lista de pedidos de materiais extra por projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectmaterialrequestsextra_v1_000/post_project_material_requests_extraInsere um novo pedido de material extraAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. code (string)
. branchCode (integer)
. stockLocationCode (string)
. generateByTask (integer)
. generateWithPrice (integer)
. requestType (integer)
. groupedInWork (integer)
. movTypeCode (string)
. date (string)
. userSponsor (string)
. statusId (integer)
. statusName (string)
. img (string)
} (object) required
rm/projectmaterialrequestsextra_v1_000/get_project_material_requests_extra_by_idRecupera um pedido de material extraid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectmaterialrequestsextra_v1_000/put_project_material_requests_extra_by_idAtualiza um pedido de material extraid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. code (string)
. branchCode (integer)
. stockLocationCode (string)
. generateByTask (integer)
. generateWithPrice (integer)
. requestType (integer)
. groupedInWork (integer)
. movTypeCode (string)
. date (string)
. userSponsor (string)
. statusId (integer)
. statusName (string)
. img (string)
} (object) required
rm/projectmaterialrequestsextra_v1_000/delete_project_material_requests_extra_by_idExclui um pedido de material extraid (string)
Authorization (string) required
rm/projectmaterialrequests_v1_000/get_project_material_requestsRetorna uma lista de pedidos de materiais de um projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectmaterialrequests_v1_000/get_project_material_requests_by_idRecupera um pedido de materialid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectmaterialrequests_v1_000/put_project_material_requests_by_idAtualiza um pedido de materialid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. idMov (integer)
. code (string)
. branchCode (integer)
. stockLocationCode (string)
. generateByTask (integer)
. generateWithPrice (integer)
. requestType (integer)
. groupedInWork (integer)
. movTypeCode (string)
. date (string)
. userCode (string)
. status (integer)
. statusMov (string)
. countMov (integer)
. requestDescription (string)
. statusDescription (string)
. img (string)
} (object) required
rm/projectmaterialrequests_v1_000/delete_project_material_requests_by_idExclui um pedido de materialid (string)
Authorization (string) required
rm/projectmobilecollectorusers_v1_000/get_project_mobile_collector_usersRetorna uma lista de usuários de coletores móveis para projetos do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/projectmobilecollectorusers_v1_000/post_project_mobile_collector_usersInsere um novo usuários de coletores móveis para projetosAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. userCode (string)
. physicalProgress (boolean)
. manpowerPointing (boolean)
. equipmentPointing (boolean)
. transportCyclePointing (boolean)
. syncData (boolean)
. equipmentOperator (boolean)
. name (string)
. active (boolean)
} (object) required
rm/projectmobilecollectorusers_v1_000/get_project_mobile_collector_users_by_idRecupera um usuário de coletores móveis para projetosid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectmobilecollectorusers_v1_000/put_project_mobile_collector_users_by_idAtualiza um coletores móvel para projetosid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. userCode (string)
. physicalProgress (boolean)
. manpowerPointing (boolean)
. equipmentPointing (boolean)
. transportCyclePointing (boolean)
. syncData (boolean)
. equipmentOperator (boolean)
. name (string)
. active (boolean)
} (object) required
rm/projectmobilecollectorusers_v1_000/delete_project_mobile_collector_users_by_idExclui usuário de coletores móveis para projetosid (string)
Authorization (string) required
rm/projectmobilecollectors_v1_000/get_project_mobile_collectorsRetorna uma lista de coletores móveis para projetos do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/projectmobilecollectors_v1_000/post_project_mobile_collectorsInsere um novo coletores móveis para projetosAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. collectorId (integer)
. imei (string)
. name (string)
. model (string)
. active (boolean)
. control (string)
. activationDate (string)
} (object) required
rm/projectmobilecollectors_v1_000/get_project_mobile_collectors_by_idRecupera um coletor móvel para projetosid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectmobilecollectors_v1_000/put_project_mobile_collectors_by_idAtualiza um coletores móvel para projetosid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. collectorId (integer)
. imei (string)
. name (string)
. model (string)
. active (boolean)
. control (string)
. activationDate (string)
} (object) required
rm/projectmobilityteams_v1_000/get_mobility_project_teamsRetorna uma lista de equipes de projeto de mobilidade do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectmobilityteams_v1_000/post_mobility_project_teamsInsere uma nova Equipes de projeto de mobilidadeAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projectmobilityteams_v1_000/get_mobility_project_teams_by_idRecupera uma Equipes de projeto de mobilidadeid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectmobilityteams_v1_000/put_mobility_project_teams_by_idAtualiza uma Equipes de projeto de mobilidadeid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projectmobilityteams_v1_000/delete_mobility_project_teams_by_idExclui uma Equipes de projeto de mobilidadeid (string)
Authorization (string) required
rm/projectreasonsmaterialrequestextra_v1_000/get_project_material_requests_extraRetorna uma lista de motivos de solicitação de pedidos de materiais extra por projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectreasonsmaterialrequestextra_v1_000/post_project_material_requests_extraInsere um novo motivo de solicitação de pedido de material extraAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. reasonId (integer)
. reasonDescription (string)
} (object) required
rm/projectreasonsmaterialrequestextra_v1_000/get_project_material_requests_extra_by_idRecupera um motivo de solicitação de pedido de material extraid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectreasonsmaterialrequestextra_v1_000/put_project_material_requests_extra_by_idAtualiza um motivo de solicitação de pedido de material extraid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. reasonId (integer)
. reasonDescription (string)
} (object) required
rm/projectreasonsmaterialrequestextra_v1_000/delete_project_material_requests_extra_by_idExclui um motivo de solicitação de pedido de material extraid (string)
Authorization (string) required
rm/projectreturncreaterequest_v1_000/post_project_material_requests_extra_by_internal_id_return_createRetornar para criação um pedido de material extrainternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
} (object) required
rm/projectriskteams_v1_000/get_risk_project_teamsRetorna uma lista de equipes de projeto de risco do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectriskteams_v1_000/post_risk_project_teamsInsere uma nova Equipes de projeto de riscoAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projectriskteams_v1_000/get_risk_project_teams_by_idRecupera uma Equipes de projeto de riscoid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectriskteams_v1_000/put_risk_project_teams_by_idAtualiza uma Equipes de projeto de riscoid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projectriskteams_v1_000/delete_risk_project_teams_by_idExclui uma Equipes de projeto de riscoid (string)
Authorization (string) required
rm/projectserviceunits_v1_000/get_project_service_unitsRetorna uma lista de unidades de serviço de projetos do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projectserviceunits_v1_000/post_project_service_unitsInsere uma nova Unidades de serviço de projetosAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. serviceUnitId (integer)
. code (string)
. description (string)
. active (boolean)
} (object) required
rm/projectserviceunits_v1_000/get_project_service_units_by_idRecupera uma Unidades de serviço de projetosid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectserviceunits_v1_000/put_project_service_units_by_idAtualiza uma Unidades de serviço de projetosid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. serviceUnitId (integer)
. code (string)
. description (string)
. active (boolean)
} (object) required
rm/projectserviceunits_v1_000/delete_project_service_units_by_idExclui uma Unidades de serviço de projetosid (string)
Authorization (string) required
rm/projectsubmitapprovalrequest_v1_000/post_project_material_requests_extra_by_internal_id_submit_approval_requestEnviar um pedido de material extra para aprovaçãointernalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
} (object) required
rm/projecttimesheetteams_v1_000/get_timesheet_project_teamsRetorna uma lista de equipes de projeto de timesheet do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/projecttimesheetteams_v1_000/post_timesheet_project_teamsInsere uma nova Equipes de projeto de timesheetAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projecttimesheetteams_v1_000/get_timesheet_project_teams_by_idRecupera uma Equipes de projeto de timesheetid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projecttimesheetteams_v1_000/put_timesheet_project_teams_by_idAtualiza uma Equipes de projeto de timesheetid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. teamId (integer)
. extenalCode (string)
. teamType (string)
. description (string)
. active (boolean)
. employeeType (boolean)
. personCode (string)
. responsible (string)
. deactivationDate (string)
. teamStatus (boolean)
. plate (string)
} (object) required
rm/projecttimesheetteams_v1_000/delete_timesheet_project_teams_by_idExclui uma Equipes de projeto de timesheetid (string)
Authorization (string) required
rm/projecttraceabilitysupplies_v1_000/get_traceability_supplies_by_internal_idRastreabilidade de um movimento para projetosinternalId (string)
Authorization (string) required
rm/projectunproductivereasons_v1_000/get_project_unproductive_reasonsRetorna uma lista de motivos de improdutividadeAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
rm/projectunproductivereasons_v1_000/post_project_unproductive_reasonsInsere um novo motivo de improdutividadeAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. reasonId (integer)
. type (integer)
. reasonCode (string)
. description (string)
. associatedReasonId (integer)
} (object) required
rm/projectunproductivereasons_v1_000/get_project_unproductive_reasons_by_idRecupera um motivo de improdutividadeid (string)
Authorization (string) required
expand (string)
fields (string)
rm/projectunproductivereasons_v1_000/put_project_unproductive_reasons_by_idAtualiza um motivo de improdutividadeid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. reasonId (integer)
. type (integer)
. reasonCode (string)
. description (string)
. associatedReasonId (integer)
} (object) required
rm/projectunproductivereasons_v1_000/delete_project_unproductive_reasons_by_idExclui um motivo de improdutividadeid (string)
Authorization (string) required
rm/publication_v1_000/get_publicationsRetorna todas as publicações de acordo com o filtro passadoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/publication_v1_000/get_publications_by_publication_internal_idRetorna detalhes da publicaçãoPublicationInternalId (string)
Authorization (string) required
rm/renewbookloan_v1_000/post_bookloans_by_book_loan_internal_id_renew_book_loansRenova o empréstimo passado na requisiçãoBookLoanInternalId (string)
Authorization (string) required
data (undefined) required
rm/reportinputs_v1_000/get_report_inputs_input_by_idRecupera informações dos itens atendidos de uma 'solicitação de compra' ou 'solicitação de armazém'. brbr O id é uma chave para a solicitação criada, a API identifica os desdobramentos desta solicitação e conforme configurado identifica os produtos da solicitação que foram atendidos. br br O retorno desta API possui informações da solicitação e uma lista conténdo cada ocorrência do item atendido, representado por preço, quantidade e data em que foi atendido. brbr Essa API reporta informações soid (string)
Authorization (string) required
rm/restgroups_v1_000/get_rest_groups_by_idRetorna dados do grupo de descansoid (string)
Authorization (string) required
rm/restgroups_v1_000/delete_rest_groups_by_idExclui grupo de descansoid (string)
rm/restgroups_v1_000/put_rest_groups_by_idAtualiza um grupo de descanso. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (string)
. RestGroupCode (string)
. id (string)
. Description (string)
} (object) required
rm/restgroups_v1_000/get_rest_groupsRetorna todos os grupos de descansoAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/restgroups_v1_000/post_rest_groupsInclui um novo registro na tabela de grupo de descansodata: {
. CompanyCode (string)
. RestGroupCode (string)
. id (string)
. Description (string)
} (object) required
rm/roles_v1_000/get_rolesRetorna todas os RolesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/room_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_block_internal_id_roomsRetorna todas as salas do EducacionalProfessorInternalId (string)
BuildingInternalId (string)
BlockInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/room_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_block_internal_id_rooms_by_internal_idRetorna a sala educacionalProfessorInternalId (string)
BuildingInternalId (string)
BlockInternalId (string)
InternalId (string)
Authorization (string) required
rm/scheduleactivity_v1_000/get_schedule_activities_by_codeRetorna todos as Atividades da Agendacode (string)
rm/scheduleactivity_v1_000/put_schedule_activities_by_codeAtualiza uma Atividade de Agendacode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. activityId (integer)
. activityDescription (string)
. qtdMax (integer)
. qtdMaxGroup (integer)
. blockScheduleExceedingLimit (boolean)
} (object) required
rm/scheduleactivity_v1_000/delete_schedule_activities_by_codeExclui um Horário Agendadocode (string)
Authorization (string) required
rm/scheduleactivity_v1_000/get_schedule_activitiesRecupera uma lista com todas as Atividades de AgendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/scheduleactivity_v1_000/post_schedule_activitiesInsere uma AtividadeAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. activityId (integer)
. activityDescription (string)
. qtdMax (integer)
. qtdMaxGroup (integer)
. blockScheduleExceedingLimit (boolean)
} (object) required
rm/schedulelock_v1_000/get_schedule_locksRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/schedulelock_v1_000/post_schedule_locksInsere um registroAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. startDate (dateTime)
. endDate (dateTime)
. startPeriod (string)
. endPeriod (string)
. reason (string)
. holiday (boolean)
. scheduleExceptionReasonCod (integer)
. lockDate (dateTime)
. lockUser (string)
} (object) required
rm/schedulelock_v1_000/get_schedule_locks_by_codeRecupera um registrocode (string)
rm/schedulelock_v1_000/delete_schedule_locks_by_codeExclui um registrocode (string)
Authorization (string) required
rm/scheduleperiod_v1_000/get_schedule_periods_by_codeRetorna todas as Vigências de uma agendacode (string)
rm/scheduleperiod_v1_000/put_schedule_periods_by_codeAtualiza as informações de uma Vigência de Agendacode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. periodId (integer)
. scheduleCode (string)
. startDate (dateTime)
. endDate (dateTime)
. createDate (dateTime)
} (object) required
rm/scheduleperiod_v1_000/delete_schedule_periods_by_codeExclui uma agendacode (string)
Authorization (string) required
rm/scheduleperiod_v1_000/get_schedule_periodsRecupera uma lista com todas as Vigências de AgendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/scheduleperiod_v1_000/post_schedule_periodsInsere um Bloqueio de AgendaAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. periodId (integer)
. scheduleCode (string)
. startDate (dateTime)
. endDate (dateTime)
. createDate (dateTime)
} (object) required
rm/schedulespecialty_v1_000/get_schedule_specialties_by_codeRetorna todas as Especialidades de uma Agendacode (string)
rm/schedulespecialty_v1_000/put_schedule_specialties_by_codeAtualiza as informações de uma Especialidade de uma Agendacode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. specialtyId (string)
. specialtyDescription (string)
} (object) required
rm/schedulespecialty_v1_000/delete_schedule_specialties_by_codeExclui uma Especialidade de uma Agendacode (string)
Authorization (string) required
rm/schedulespecialty_v1_000/get_schedule_specialtiesRecupera uma lista com todas as Especialidades de uma AgendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/schedulespecialty_v1_000/post_schedule_specialtiesInsere uma EspecialidadeAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. specialtyId (string)
. specialtyDescription (string)
} (object) required
rm/scheduletime_v1_000/get_schedule_times_by_codeRetorna todos os Horários de Agendamentocode (string)
rm/scheduletime_v1_000/put_schedule_times_by_codeAtualiza as informações de um Horário de Agendamentocode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. periodId (integer)
. periodCode (string)
. day (integer)
. timeStart (string)
. timeEnd (string)
. maxTimeSlot (integer)
. weekDayDuration (integer)
. status (string)
} (object) required
rm/scheduletime_v1_000/delete_schedule_times_by_codeExclui um Horário Agendadocode (string)
Authorization (string) required
rm/scheduletime_v1_000/get_schedule_timesRecupera uma lista com todos os Horários de uma AgendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/scheduletime_v1_000/post_schedule_timesInsere uma HorárioAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. scheduleCode (string)
. periodId (integer)
. periodCode (string)
. day (integer)
. timeStart (string)
. timeEnd (string)
. maxTimeSlot (integer)
. weekDayDuration (integer)
. status (string)
} (object) required
rm/schedule_v1_000/get_schedules_by_codeRetorna os dados de uma Agendacode (string)
rm/schedule_v1_000/put_schedules_by_codeAtualiza as informações de uma Agendacode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. description (string)
. scheduleType (string)
. parentId (integer)
. unitAttendanceId (integer)
. ownerId (string)
. notes (string)
. visible (boolean)
. active (boolean)
} (object) required
rm/schedule_v1_000/delete_schedules_by_codeExclui uma agendacode (string)
Authorization (string) required
rm/schedule_v1_000/get_schedulesRecupera uma lista de registros de Agendas.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/schedule_v1_000/post_schedulesInsere um registroAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. scheduleId (integer)
. description (string)
. scheduleType (string)
. parentId (integer)
. unitAttendanceId (integer)
. ownerId (string)
. notes (string)
. visible (boolean)
. active (boolean)
} (object) required
rm/schedule_v2_000/get_schedulesRecupera uma lista de Agendas.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/schedule_v2_000/post_schedulesInsere um registroAuthorization (string) required
data: {
. companyId (integer)
. scheduleId (integer)
. description (string)
. parentId (integer)
. ownerId (string)
. notes (string)
. scheduleType (string)
. visible (string)
. active (string)
. activeOnPortal (string)
. activeOnOnlineConsultation (string)
. unitId (integer)
. unitName (string)
. unitAddress (string)
. unitAddressNumber (string)
. unitAddressComplement (string)
. UnitAddressNeighborhood (string)
. unitAddressCity (string)
. unitAddressState (string)
. unitImage (number)
. practitionerId (integer)
. practitionerName (string)
. practitionerUsePortalImage (string)
. practitionerCouncilId (string)
. practitionerCouncilName (string)
. practitionerImage (number)
. subsidiaryId (integer)
. subsidiaryName (string)
} (object) required
rm/schedule_v2_000/get_schedules_by_schedule_idRetorna os dados de uma Agenda.scheduleId (string)
rm/schedule_v2_000/put_schedules_by_schedule_idAtualiza as informações de uma Agenda.scheduleId (string)
Authorization (string) required
data: {
. companyId (integer)
. scheduleId (integer)
. description (string)
. parentId (integer)
. ownerId (string)
. notes (string)
. scheduleType (string)
. visible (string)
. active (string)
. activeOnPortal (string)
. activeOnOnlineConsultation (string)
. unitId (integer)
. unitName (string)
. unitAddress (string)
. unitAddressNumber (string)
. unitAddressComplement (string)
. UnitAddressNeighborhood (string)
. unitAddressCity (string)
. unitAddressState (string)
. unitImage (number)
. practitionerId (integer)
. practitionerName (string)
. practitionerUsePortalImage (string)
. practitionerCouncilId (string)
. practitionerCouncilName (string)
. practitionerImage (number)
. subsidiaryId (integer)
. subsidiaryName (string)
} (object) required
rm/schedule_v2_000/delete_schedules_by_schedule_idExclui uma agenda.scheduleId (string)
Authorization (string) required
rm/searchfield_v1_000/get_search_field_by_internal_idRetorna os filtros possíveis na pesquisa pública parametrizado no BibliotecaInternalId (string)
Authorization (string) required
fields (string)
rm/selectionprocessexplorer_v1_000/get_selection_processes_selection_process_explorerRetorna Processos seletivos venda online de cursosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/shippingcompany_v1_000/get_shipping_companyRetorna lista completa de TransportadorasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/shippingcompany_v1_000/post_shipping_companyInclui uma Transportadora conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. InternalId (string)
. CompanyId (integer)
. Code (string)
. Name (string)
. Address (string)
. Number (string)
. Complement (string)
. District (string)
. CityCode (string)
. StateId (string)
. ZipCode (string)
. Cgc (string)
. StateRegistration (string)
. Contact (string)
. PhoneNumber (string)
. Telex (string)
. FaxNumber (string)
. Free (string)
. TradingName (string)
. CountryCode (string)
. Cei (string)
. RegisterSituation (integer)
. Email (string)
. MunicipalRegistration (string)
. RecCreatedOn (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
. ComplementaryFields (object)
} (object) required
rm/shippingcompany_v1_000/get_shipping_company_by_internal_idRetorna a Transportadora conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/shippingcompany_v1_000/put_shipping_company_by_internal_idAtualiza cadastro de Transportadoras conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. InternalId (string)
. CompanyId (integer)
. Code (string)
. Name (string)
. Address (string)
. Number (string)
. Complement (string)
. District (string)
. CityCode (string)
. StateId (string)
. ZipCode (string)
. Cgc (string)
. StateRegistration (string)
. Contact (string)
. PhoneNumber (string)
. Telex (string)
. FaxNumber (string)
. Free (string)
. TradingName (string)
. CountryCode (string)
. Cei (string)
. RegisterSituation (integer)
. Email (string)
. MunicipalRegistration (string)
. RecCreatedOn (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
. ComplementaryFields (object)
} (object) required
rm/shippingcompany_v1_000/delete_shipping_company_by_internal_idExclui cadastro de Transportadora conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
rm/specializedmedicalreportitems_v1_000/get_specialized_medical_report_itemsRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/specializedmedicalreportitems_v1_000/post_specialized_medical_report_itemsInsere um registroAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. lmeId (integer)
. itemLmeSequence (integer)
. description (string)
. firstMonth (integer)
. secondMonth (integer)
. thirdMonth (integer)
. fourthMonth (integer)
. fifthMonth (integer)
. sixthMonth (integer)
} (object) required
rm/specializedmedicalreportitems_v1_000/get_specialized_medical_report_items_by_codeRecupera um registrocode (string)
Authorization (string) required
expand (string)
fields (string)
rm/specializedmedicalreportitems_v1_000/put_specialized_medical_report_items_by_codeAtualiza um registrocode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. lmeId (integer)
. itemLmeSequence (integer)
. description (string)
. firstMonth (integer)
. secondMonth (integer)
. thirdMonth (integer)
. fourthMonth (integer)
. fifthMonth (integer)
. sixthMonth (integer)
} (object) required
rm/specializedmedicalreportitems_v1_000/delete_specialized_medical_report_items_by_codeExclui um registrocode (string)
Authorization (string) required
rm/specializedmedicalreport_v1_000/get_specialized_medical_reportRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/specializedmedicalreport_v1_000/post_specialized_medical_reportInsere um registroAuthorization (string) required
data: {
. code (string)
. companyId (integer)
. lmeId (integer)
. patientAccountNumber (string)
. patientAccountSequence (integer)
. releaseDate (string)
. weight (number)
. height (number)
. cid (string)
. medicalDiagnostic (string)
. anamnese (string)
. treatment (string)
. treatmentDescription (string)
. certificate (string)
. providerCode (integer)
. requestDate (string)
. accountable (string)
. accountableName (string)
. accountableDocument (string)
. printed (string)
. emissaoDate (string)
} (object) required
rm/specializedmedicalreport_v1_000/get_specialized_medical_report_by_codeRecupera um registrocode (string)
Authorization (string) required
expand (string)
fields (string)
rm/specializedmedicalreport_v1_000/put_specialized_medical_report_by_codeAtualiza um registrocode (string)
Authorization (string) required
data: {
. code (string)
. companyId (integer)
. lmeId (integer)
. patientAccountNumber (string)
. patientAccountSequence (integer)
. releaseDate (string)
. weight (number)
. height (number)
. cid (string)
. medicalDiagnostic (string)
. anamnese (string)
. treatment (string)
. treatmentDescription (string)
. certificate (string)
. providerCode (integer)
. requestDate (string)
. accountable (string)
. accountableName (string)
. accountableDocument (string)
. printed (string)
. emissaoDate (string)
} (object) required
rm/specializedmedicalreport_v1_000/delete_specialized_medical_report_by_codeExclui um registrocode (string)
Authorization (string) required
rm/specialty_v1_000/get_specialtiesRecupera uma lista com todas as EspecialidadesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/statefiscal_v1_000/get_stateRetorna todos os estadosfields (string)
order (array)
page (integer)
pageSize (integer)
rm/stockgroup_v1_000/get_stock_groupsRetorna lista completa de Grupo de ProdutoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/stockgroup_v1_000/post_stock_groupsInclui a entidade Grupo de Produto passada na requisiçãoAuthorization (string) required
data (undefined) required
rm/stockgroup_v1_000/get_stock_groups_by_codeRetorna Grupo de Produto pelo seu CódigoCode (string)
Authorization (string) required
rm/stockgroup_v1_000/put_stock_groups_by_codeAtualiza cadastro de Grupo de Produto conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data (undefined) required
rm/stockgroup_v1_000/delete_stock_groups_by_codeExclui grupo de produto cadastrado conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
rm/studentcontext_v1_000/get_student_contextsRetorna todos os contextos do aluno do EducacionalAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/studentwarninggroup_v1_000/get_professors_by_professor_internal_id_student_warning_groupsRetorna todos os grupos de ocorrência do EducacionalProfessorInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/studentwarninggroup_v1_000/get_professors_by_professor_internal_id_student_warning_groups_by_internal_idRetorna o grupo de ocorrência do educacionalProfessorInternalId (string)
InternalId (string)
Authorization (string) required
fields (string)
rm/studentwarning_v1_000/get_students_by_student_internal_id_studentwarningsRetorna todas as ocorrências do aluno do EducacionalStudenteInternalId (string)
StudentInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
rm/studentwarning_v1_000/get_students_by_student_internal_id_studentwarning_by_internal_idRetorna a ocorrência do aluno do educacionalStudenteInternalId (string)
InternalId (string)
StudentInternalId (string)
Authorization (string) required
rm/summaryhistogramsalterdeliverydateitems_v1_000/post_summary_histograms_by_internal_id_change_delivery_dateAltera a data de entrega dos itens de um pedido de materialinternalId (string)
Authorization (string) required
data: {
. internalId (string)
. companyId (integer)
. projectId (integer)
. requestId (integer)
. itemRequestIdList (array)
. changeDeliveryDate (boolean)
. deliveryDate (string)
. changeReason (boolean)
. reason (string)
} (object) required
rm/summaryhistograms_v1_000/get_summary_histogramsRetorna uma lista com os histogramas resumo dos pedidos de materiais do projetoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
requestId (integer) required
rm/summaryhistograms_v1_000/get_summary_histograms_by_idRecupera histograma resumo de um pedido de materialid (string)
Authorization (string) required
expand (string)
fields (string)
rm/summaryhistograms_v1_000/delete_summary_histograms_by_idExclui um histograma resumo do pedido de materialid (string)
Authorization (string) required
rm/supplyppe_v1_000/get_supplyppesRetorna todos os fornecimentos/devoluções/descartes cadastrados no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/supplyppe_v1_000/get_supplyppes_by_idRetorna o fornecimento do sistemaid (string)
Authorization (string) required
rm/supplyppe_v1_000/post_supplyppes_ppeborrowFornece o EPI passado por parâmetrodata: {
. id (string)
. companyCode (integer)
. sequentialCode (string)
. ppeCode (string)
. ppeIdentifierCode (string)
. borrowingDate (date)
. personCode (integer)
. devolutionDate (date)
. shelfLifeDate (date)
. effective (boolean)
. borrowingId (integer)
. returnId (integer)
. discardId (integer)
. batchId (integer)
. ppe (object)
. amount (integer)
} (object) required
rm/supplyppe_v1_000/post_supplyppes_ppereturn_by_idDevolve o EPI passado por parâmetroid (string)
Authorization (string) required
data: {
. id (string)
. companyCode (integer)
. sequentialCode (string)
. ppeCode (string)
. ppeIdentifierCode (string)
. borrowingDate (date)
. personCode (integer)
. devolutionDate (date)
. shelfLifeDate (date)
. effective (boolean)
. borrowingId (integer)
. returnId (integer)
. discardId (integer)
. batchId (integer)
. ppe (object)
. amount (integer)
} (object) required
rm/supplyppe_v1_000/post_supplyppes_ppedisposal_by_idDescarta o EPI passado por parâmetroid (string)
Authorization (string) required
data: {
. id (string)
. companyCode (integer)
. sequentialCode (string)
. ppeCode (string)
. ppeIdentifierCode (string)
. borrowingDate (date)
. personCode (integer)
. devolutionDate (date)
. shelfLifeDate (date)
. effective (boolean)
. borrowingId (integer)
. returnId (integer)
. discardId (integer)
. batchId (integer)
. ppe (object)
. amount (integer)
} (object) required
rm/topmobiletasksheet_v1_000/get_top_mobile_tasksheetRetorna informações de folhas tarefas e tarefas de mobilidade do TOTVS Obras e Projetosorder (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
imeiDevice (string) required
currentUser (string) required
appVersion (string) required
rm/taskcostassigments_v1_000/get_task_cost_assigmentsRetorna uma lista de apropriações realizadas em um projeto.order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
projectId (integer) required
rm/taskcostassigments_v1_000/post_task_cost_assigmentsIncluir uma apropriação.Authorization (string) required
data: {
. id (integer)
. companyId (string)
. projectId (integer)
. documentType (string)
. apportionmentOrigin (string)
. documentNumber (string)
. itemNumberDocument (string)
. taskId (integer)
. taskCode (string)
. taskName (string)
. taskDescription (string)
. inputId (integer)
. inputCode (string)
. inputDescription (string)
. inputUnitOfMeasureCode (string)
. itemCompany (string)
. itemId (integer)
. itemCode (string)
. itemName (string)
. itemUnitOfMeasureCode (string)
. customerVendorCompany (string)
. customerVendorCode (string)
. customerVendorName (string)
. apportionmentDate (string)
. currencyCode (string)
. quantity (number)
. unitPrice (number)
. increase (number)
. decrease (number)
. totalPrice (number)
. externalNumberId (string)
. createdDate (string)
. createdBy (string)
. modifiedDate (string)
. modifiedBy (string)
} (object) required
rm/taskcostassigments_v1_000/get_task_cost_assigments_by_idRetorna uma apropriação.id (string)
Authorization (string) required
rm/taskcostassigments_v1_000/put_task_cost_assigments_by_idAtualiza uma apropriação.id (string)
Authorization (string) required
data: {
. id (integer)
. companyId (string)
. projectId (integer)
. documentType (string)
. apportionmentOrigin (string)
. documentNumber (string)
. itemNumberDocument (string)
. taskId (integer)
. taskCode (string)
. taskName (string)
. taskDescription (string)
. inputId (integer)
. inputCode (string)
. inputDescription (string)
. inputUnitOfMeasureCode (string)
. itemCompany (string)
. itemId (integer)
. itemCode (string)
. itemName (string)
. itemUnitOfMeasureCode (string)
. customerVendorCompany (string)
. customerVendorCode (string)
. customerVendorName (string)
. apportionmentDate (string)
. currencyCode (string)
. quantity (number)
. unitPrice (number)
. increase (number)
. decrease (number)
. totalPrice (number)
. externalNumberId (string)
. createdDate (string)
. createdBy (string)
. modifiedDate (string)
. modifiedBy (string)
} (object) required
rm/taskcostassigments_v1_000/delete_task_cost_assigments_by_idExcluir uma apropriação de custo.id (string)
Authorization (string) required
rm/term_v1_000/get_academics_by_academic_internal_id_termsRetorna todos os Períodos LetivosAcademicInternalId (string)
AcademicInternalID (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/term_v1_000/post_academics_by_academic_internal_id_termsInclui o Período Letivo passado na requisiçãoAcademicInternalId (string)
AcademicInternalID (string)
Authorization (string) required
data (undefined) required
rm/term_v1_000/get_academics_by_academic_internal_id_terms_by_internal_idRetorna um Período LetivoAcademicInternalId (string)
InternalId (string)
AcademicInternalID (string)
Authorization (string) required
rm/term_v1_000/put_academics_by_academic_internal_id_terms_by_internal_idAltera o Período Letivo passado na requisiçãoAcademicInternalId (string)
InternalId (string)
AcademicInternalID (string)
Authorization (string) required
data (undefined) required
rm/term_v1_000/delete_academics_by_academic_internal_id_terms_by_internal_idExclusão de Período Letivo da baseAcademicInternalId (string)
InternalId (string)
AcademicInternalID (string)
Authorization (string) required
rm/ticketattachments_v1_000/get_ticket_attachmentsRetorna uma lista de arquivos anexos de atendimentos do CRMorder (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
ticketId (integer) required
locationId (integer) required
rm/ticketattachments_v1_000/post_ticket_attachmentsIncluir arquivo anexo de um atendimentoAuthorization (string) required
data: {
. id (integer)
. FileCode (integer)
. AttendantCode (integer)
. AttendantInCurrentCode (integer)
. TicketId (integer)
. CompanyCode (integer)
. CompanyAttendantCurrentCode (integer)
. CompanyAttendantCode (integer)
. LocationCode (integer)
. DescriptionFile (string)
. FileName (string)
. CreatedUserCode (string)
. CreatedDate (string)
. ModifiedUserCode (string)
. ModifiedDate (string)
. FileSize (string)
. Status (string)
. TicketAttachmentFile (object)
} (object) required
rm/ticketattachments_v1_000/get_ticket_attachments_by_idRetorna arquivo anexo de um atendimento.id (string)
Authorization (string) required
rm/ticketattachments_v1_000/put_ticket_attachments_by_idAtualizar um arquivo anexo de atendimentoid (string)
Authorization (string) required
data: {
. id (integer)
. FileCode (integer)
. AttendantCode (integer)
. AttendantInCurrentCode (integer)
. TicketId (integer)
. CompanyCode (integer)
. CompanyAttendantCurrentCode (integer)
. CompanyAttendantCode (integer)
. LocationCode (integer)
. DescriptionFile (string)
. FileName (string)
. CreatedUserCode (string)
. CreatedDate (string)
. ModifiedUserCode (string)
. ModifiedDate (string)
. FileSize (string)
. Status (string)
. TicketAttachmentFile (object)
} (object) required
rm/ticketattachments_v1_000/delete_ticket_attachments_by_idExcluir arquivo anexo de um atendimentoid (string)
Authorization (string) required
rm/ticketstepforward_v1_000/post_tickets_by_internal_id_step_forwardExcutar o processo de avanço de etapa de um tendimentointernalId (string)
Authorization (string) required
data: {
. internalId (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. NextStepCode (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. ActionsTask (array)
. CauseCode (integer)
. Origin (string)
. FlowsStepCode (integer)
. IsNewCustomerContact (boolean)
} (object) required
rm/ticketstepforward_v1_001/get_tickets_step_forward_params_by_internal_idRetornar as informações necessárias para utilização no processo de avanço de etapa de atendimentointernalId (string)
Authorization (string) required
rm/ticketstepforward_v1_001/post_tickets_by_internal_id_step_forwardExcutar o processo de avanço de etapa de um tendimentointernalId (string)
Authorization (string) required
data: {
. internalId (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. NextStepCode (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. ActionsTask (array)
. CauseCode (integer)
. Origin (string)
. FlowsStepCode (integer)
. IsNewCustomerContact (boolean)
} (object) required
rm/tickets_v1_000/get_ticketsRetorna uma lista de atendimentos do CRMorder (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
rm/tickets_v1_000/post_ticketsIncluir um atendimentoAuthorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_000/get_tickets_by_idRetorna um atendimento.id (string)
Authorization (string) required
rm/tickets_v1_000/put_tickets_by_idAtualizar um atendimentoid (string)
Authorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_000/delete_tickets_by_idExcluir um atendimentoid (string)
Authorization (string) required
rm/tickets_v1_001/get_ticketsRetorna uma lista de atendimentos do CRMorder (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
rm/tickets_v1_001/post_ticketsIncluir um atendimentoAuthorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_001/get_tickets_by_idRetorna um atendimento.id (string)
Authorization (string) required
rm/tickets_v1_001/put_tickets_by_idAtualizar um atendimentoid (string)
Authorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_001/delete_tickets_by_idExcluir um atendimentoid (string)
Authorization (string) required
rm/tickets_v1_001/get_tickets_by_id_request_detailsListar detalhes de solicitação um atendimentosid (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
rm/tickets_v1_001/post_tickets_by_id_request_detailsIncluir um detalhe de solicitação de um atendimentoid (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. CreateDate (string)
. RequestDescription (string)
. ForumUserCode (string)
} (object) required
rm/tickets_v1_001/get_tickets_by_id_request_details_by_id_detailRetorna um detalhe de solicitação de atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/tickets_v1_001/put_tickets_by_id_request_details_by_id_detailAtualizar um detalhe de solicitação de um atendimentoid (string)
idDetail (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. CreateDate (string)
. RequestDescription (string)
. ForumUserCode (string)
} (object) required
rm/tickets_v1_001/delete_tickets_by_id_request_details_by_id_detailExcluir um detalhe de solicitação de um atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/tickets_v1_002/get_ticketsRetorna uma lista de atendimentos do CRMorder (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
companyId (integer) required
rm/tickets_v1_002/post_ticketsIncluir um atendimentoAuthorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_002/get_tickets_by_idRetorna um atendimento.id (string)
Authorization (string) required
rm/tickets_v1_002/put_tickets_by_idAtualizar um atendimentoid (string)
Authorization (string) required
data: {
. id (integer)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. StartDate (string)
. ScheduleDate (string)
. PreviousScheduleDate (string)
. WaitingForOther (integer)
. Topic (string)
. RequestDescription (string)
. Rating (integer)
. CustomerSatisfaction (integer)
. AttendantAlarmCode (integer)
. AttendantCode (integer)
. AttendantInChargeConclusionCode (integer)
. AttendantInChargeExecutionCode (integer)
. AttendantInChargeCode (integer)
. OriginAttendant (string)
. TicketIdIntegration (string)
. CampaignCode (integer)
. GeneralCategoryCode (integer)
. ClassificationCode (string)
. CompanyAlarmCode (integer)
. CompanyAttendantCode (integer)
. CreatorAttendantcompany (integer)
. CompanyAttendantInChargeConclusionCode (integer)
. CompanyAttendantInChargeExecutionCode (integer)
. CompanyFaqCode (integer)
. CompanyAttendantInChargeCode (integer)
. CompanyAgentCode (integer)
. CompanyModuleCode (integer)
. CompanyItemCode (integer)
. FaqCode (integer)
. TicketGroupCode (integer)
. SubItemCode (string)
. DeliveryLocationCode (integer)
. ModuleCode (integer)
. InsatisfactionReasonCode (integer)
. ItemCode (integer)
. AgentCode (string)
. SessionCode (string)
. Status (string)
. TaskCode (integer)
. PreviousTaskCode (integer)
. TicketWorkFlowCode (integer)
. AlarmDate (string)
. ExpectedFinishDate (string)
. ActualFinishDate (string)
. ActualStartDate (string)
. SearchDate (string)
. NextAlarmDate (string)
. LastTicketTransferDate (string)
. ClosedDate (string)
. DifficultyLevel (integer)
. ElapsedTime (integer)
. ContactCode (integer)
. ContactAgentCode (integer)
. AccessLevel (integer)
. ScheduleCount (integer)
. ProposalSolutionReprovedCount (integer)
. SerialNumberItem (string)
. ExpectedElapsedTime (integer)
. ActualElapsedTime (integer)
. OriginContact (integer)
. CompletionPercentage (integer)
. DeadlineDate (string)
. PreviousDeadlineDate (string)
. CustomerfirstContactDate (string)
. TicketPriority (integer)
. Requester (integer)
. ContactType (integer)
} (object) required
rm/tickets_v1_002/delete_tickets_by_idExcluir um atendimentoid (string)
Authorization (string) required
rm/tickets_v1_002/get_tickets_by_id_request_detailsListar detalhes de solicitação um atendimentosid (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
rm/tickets_v1_002/post_tickets_by_id_request_detailsIncluir um detalhe de solicitação de um atendimentoid (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. CreateDate (string)
. RequestDescription (string)
. ForumUserCode (string)
} (object) required
rm/tickets_v1_002/get_tickets_by_id_request_details_by_id_detailRetorna um detalhe de solicitação de atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/tickets_v1_002/put_tickets_by_id_request_details_by_id_detailAtualizar um detalhe de solicitação de um atendimentoid (string)
idDetail (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. CompanyId (string)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. CreateDate (string)
. RequestDescription (string)
. ForumUserCode (string)
} (object) required
rm/tickets_v1_002/delete_tickets_by_id_request_details_by_id_detailExcluir um detalhe de solicitação de um atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/tickets_v1_002/get_tickets_by_id_discussion_detailsListar detalhes da discussão de um atendimentosid (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
Authorization (string) required
rm/tickets_v1_002/post_tickets_by_id_discussion_detailsIncluir um detalhe de discussão de um atendimentoid (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. DiscussionDescription (string)
. CompanyId (integer)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. Publish (integer)
. CreateDate (string)
. DiscussionType (integer)
. ForumUserCode (string)
. PublishForum (integer)
} (object) required
rm/tickets_v1_002/get_tickets_by_id_discussion_details_by_id_detailRetorna um detalhe da discussão de atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/tickets_v1_002/put_tickets_by_id_discussion_details_by_id_detailAtualizar um detalhe da discussão de um atendimentoid (string)
idDetail (string)
Authorization (string) required
data: {
. id (string)
. idDetail (string)
. DiscussionDescription (string)
. CompanyId (integer)
. LocationId (integer)
. TickedId (integer)
. CompanyAttendantCode (integer)
. AttendantCode (integer)
. UserCreateCode (string)
. Publish (integer)
. CreateDate (string)
. DiscussionType (integer)
. ForumUserCode (string)
. PublishForum (integer)
} (object) required
rm/tickets_v1_002/delete_tickets_by_id_discussion_details_by_id_detailExcluir um detalhe da discussão de um atendimentoid (string)
idDetail (string)
Authorization (string) required
rm/transportcycle_v1_000/get_transportcycleRetorna uma lista de registrosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
companyId (integer) required
projectId (integer) required
rm/transportcycle_v1_000/post_transportcycleInsere um registroAuthorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. cycleId (integer)
. description (string)
. inputProjectId (integer)
. inputId (integer)
. distance (number)
. collectorAvailable (integer)
. distanceCalculateConsider (integer)
. capacityCalculateConsider (integer)
. active (integer)
. barCode (string)
} (object) required
rm/transportcycle_v1_000/get_transportcycle_by_idRecupera um registroid (string)
Authorization (string) required
expand (string)
fields (string)
rm/transportcycle_v1_000/put_transportcycle_by_idAtualiza um registroid (string)
Authorization (string) required
data: {
. id (string)
. companyId (integer)
. projectId (integer)
. cycleId (integer)
. description (string)
. inputProjectId (integer)
. inputId (integer)
. distance (number)
. collectorAvailable (integer)
. distanceCalculateConsider (integer)
. capacityCalculateConsider (integer)
. active (integer)
. barCode (string)
} (object) required
rm/transportcycle_v1_000/delete_transportcycle_by_idExclui um registroid (string)
Authorization (string) required
rm/transportationfare_v1_000/get_transportationfaresRetorna todas as Tarifa de Transporte cadastradas no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/transportationfare_v1_000/post_transportationfaresInclui a Tarifa de Transporte passada na requisiçãoAuthorization (string) required
data (undefined) required
rm/transportationfare_v1_000/get_transportationfares_by_idRetorna a Tarifa de Transporte correspondente ao idid (string)
Authorization (string) required
rm/transportationfare_v1_000/put_transportationfares_by_idInclui/Edita a Tarifa de Transporte passada na requisiçãoid (string)
Authorization (string) required
data (undefined) required
rm/transportationfare_v1_000/delete_transportationfares_by_idDeleta a Tarifa de Transporte correspondente ao idid (string)
Authorization (string) required
rm/transportationline_v1_000/get_transportationlinesRetorna todas as Linhas de Transporte cadastradas no sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/transportationline_v1_000/post_transportationlinesInclui a Linha de Transporte passada na requisiçãoAuthorization (string) required
data (undefined) required
rm/transportationline_v1_000/get_transportationlines_by_idRetorna a Linha de Transporte correspondente ao idid (string)
Authorization (string) required
rm/transportationline_v1_000/put_transportationlines_by_idInclui/Edita a Linha de Transporte passada na requisiçãoid (string)
Authorization (string) required
data (undefined) required
rm/transportationline_v1_000/delete_transportationlines_by_idDeleta a Linha de Transporte correspondente ao idid (string)
Authorization (string) required
rm/tributarylotations_v1_000/get_tributary_lotations_by_idRetorna dados da lotação tributáriaid (string)
Authorization (string) required
rm/tributarylotations_v1_000/delete_tributary_lotations_by_idExclui lotação tributáriaid (string)
rm/tributarylotations_v1_000/put_tributary_lotations_by_idAtualiza uma lotação tributária. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. companyCode (integer)
. lotationCode (string)
. id (string)
. typeLotation (string)
. sectionCode (string)
. companyCodeBorrower (string)
. borrowerCode (string)
. idCei (integer)
. useSectionData (smallint)
. fpas (string)
. thirdPartyCode (string)
. thirdPartySuspendedCode (string)
} (object) required
rm/tributarylotations_v1_000/get_tributary_lotationsRetorna todas as lotações tributáriasAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/tributarylotations_v1_000/post_tributary_lotationsInclui um novo registro na tabela de lotação tributáriadata: {
. companyCode (integer)
. lotationCode (string)
. id (string)
. typeLotation (string)
. sectionCode (string)
. companyCodeBorrower (string)
. borrowerCode (string)
. idCei (integer)
. useSectionData (smallint)
. fpas (string)
. thirdPartyCode (string)
. thirdPartySuspendedCode (string)
} (object) required
rm/unitofmeasures_v1_000/get_unit_of_measuresRetorna lista completa de Unidade de MedidaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/unitofmeasures_v1_000/post_unit_of_measuresInclui uma Unidade de MedidaAuthorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. UnitOfMeasuresBaseCode (string)
. UnitMeasurementConversions (number)
. IsBase (integer)
. PriceDecimalPlaces (integer)
. Initials (string)
. Taxable (integer)
. TaxableUnitMeasurementCode (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
} (object) required
rm/unitofmeasures_v1_000/get_unit_of_measures_by_codeRetorna Unidade de Medida pelo seu CódigoCode (string)
Authorization (string) required
rm/unitofmeasures_v1_000/put_unit_of_measures_by_codeAtualiza cadastro de Unidade de Medida conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. UnitOfMeasuresBaseCode (string)
. UnitMeasurementConversions (number)
. IsBase (integer)
. PriceDecimalPlaces (integer)
. Initials (string)
. Taxable (integer)
. TaxableUnitMeasurementCode (string)
. RecModifiedBy (string)
. RecModifiedOn (string)
} (object) required
rm/unitofmeasures_v1_000/delete_unit_of_measures_by_codeExclui Unidade de Medida cadastrada conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
rm/urbanocoletor_v1_000/post_coletor_urbanoInclui informações do coletor na prestação de contasdata (object) required
rm/user_v1_000/get_usersRetorna todos usuários do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
userIds (string)
name (string)
rm/user_v1_000/post_usersInclui usuário passado na requisiçãoAuthorization (string) required
data (object) required
rm/user_v1_000/get_users_by_idRetorna o usuário do sistema indicadoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
rm/user_v1_000/put_users_by_idAltera o usuário passado na requisiçãoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
data (undefined) required
rm/user_v1_000/delete_users_by_idExclusão de usuário da baseid (string)
Authorization (string) required
foundBy (string)
domainId (string)
rm/vieweducationalreport_v1_000/post_educational_reports_by_educational_report_id_view_educational_reportsDe acordo com os parâmetros passados é gerado o relatório educacional disponível ao usuárioEducationalReportId (string)
Authorization (string) required
data: {
. CompanyCode (string)
. CompanyInternalId (string)
. BranchCode (string)
. BranchInternalId (string)
. LevelEducationCode (integer)
. LevelEducationInternalId (string)
. ReportCompanyCode (string)
. ReportId (integer)
. ReportInternalId (string)
. InternalId (string)
. StudentCode (string)
. StudentInternalId (string)
. TermCode (integer)
. TermInternalId (string)
. SpecializationBranchCode (integer)
. SpecializationBranchInternalId (string)
. EducationalContractCode (string)
. EducationalContractInternalId (string)
. ReportFile (string)
} (object) required
rm/visitorpunches_v1_000/get_visitor_punches_by_idRetorna dados da batida de visitanteid (string)
Authorization (string) required
rm/visitorpunches_v1_000/delete_visitor_punches_by_idExclui batida de visitanteid (string)
rm/visitorpunches_v1_000/put_visitor_punches_by_idAtualiza uma batida de visitante. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (string)
. EmployeeId (string)
. ClockingDate (date)
. Clocking (integer)
. Status (string)
. Direction (integer)
. PunchHour (string)
. SetDirection (string)
. id (string)
} (object) required
rm/visitorpunches_v1_000/get_visitor_punchesRetorna todas as batidas de visitantesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/visitorpunches_v1_000/post_visitor_punchesInclui um novo registro na tabela de batidas de visitantesdata: {
. CompanyCode (string)
. EmployeeId (string)
. ClockingDate (date)
. Clocking (integer)
. Status (string)
. Direction (integer)
. PunchHour (string)
. SetDirection (string)
. id (string)
} (object) required
rm/visitors_v1_000/get_visitors_by_idRetorna dados do visitanteid (string)
Authorization (string) required
rm/visitors_v1_000/delete_visitors_by_idExclui visitanteid (string)
rm/visitors_v1_000/put_visitors_by_idAtualiza informações do visitante. Caso não seja informada alguma propriedade para ser atualizada, está será considerada nula.id (string)
data: {
. CompanyCode (integer)
. EmployeeId (string)
. Name (string)
. Company (string)
. RecordDate (date)
. Responsible (string)
. Code (integer)
. id (string)
} (object) required
rm/visitors_v1_000/get_visitorsRetorna todos os visitantesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rm/visitors_v1_000/post_visitorsInclui um novo registro na tabela de visitantesdata: {
. CompanyCode (integer)
. EmployeeId (string)
. Name (string)
. Company (string)
. RecordDate (date)
. Responsible (string)
. Code (integer)
. id (string)
} (object) required
rm/warehouse_v1_002/get_warehousesRetorna lista completa de Locais de EstoqueAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rm/warehouse_v1_002/post_warehousesInclui um Local de EstoqueAuthorization (string) required
data (undefined) required
rm/warehouse_v1_002/get_warehouses_by_codeRetorna Local de Estoque pelo seu CódigoCode (string)
Authorization (string) required
rm/warehouse_v1_002/put_warehouses_by_codeAtualiza cadastro de Locais de Estoque conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data (undefined) required
rm/warehouse_v1_002/delete_warehouses_by_codeExclui Local de Estoque cadastrado conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
rm/workaccidentoccurrence_v1_000/get_workaccidentoccurrence_by_idRetorna dados de tabela da medição de risco especificadaid (string)
Authorization (string) required
rm/workaccidentoccurrence_v1_000/delete_workaccidentoccurrence_by_idExclui uma medição de riscoid (string)
Authorization (string) required
rm/workaccidentoccurrence_v1_000/put_workaccidentoccurrence_by_idAtualiza um registro existente de tabela de CAT. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data (object) required
rm/workaccidentoccurrence_v1_000/get_workaccidentoccurrenceRetorna todas as medições de riscoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Ids (string)
rm/workaccidentoccurrence_v1_000/post_workaccidentoccurrenceInclui um novo registro na tabela de medições de riscoAuthorization (string) required
data: {
. CompanyCode (string)
. OccurenceCode (string)
. DateTime (string)
. Description (string)
. EmployeeId (string)
. BodyPartCode (string)
. WorkPlaceCode (string)
. TypeOfOccurrenceCode (string)
. TimeWorked (integer)
. PoliceRegistration (integer)
. Decease (integer)
. Issuer (string)
. Type (string)
. DeceaseDate (string)
. Parentage (string)
. DaysBeforeAccident (string)
. ThereWasLeaveDays (string)
. AccidentLocation (string)
. AccidentLocationCity (string)
. AccidentLocationState (string)
. WhereHasAccidentOccured (string)
. InssRegistrationCode (string)
. InssAccidentLocation (string)
. NatureCatCode (string)
. MedicalConsultationUnit (string)
. Diagnosis (string)
. MedicalDate (string)
. Hospitalization (integer)
. TreatmentDuration (integer)
. Cid (string)
. SourceCode (string)
. OccupationalActivity (integer)
. TreatmentLeave (string)
. MedicalObservation (string)
. HazardItemCode (string)
. SituationGeneratorCode (string)
. AccidentAddress (string)
. AccidentNumber (string)
. Cnes (string)
. AccidentCityCode (string)
. DoctorCode (string)
. IssuerRegistrationType (integer)
. EsocialAccidentType (string)
. AccidentLocationCep (string)
. RegistrationType (string)
. RegistrationNRO (string)
. WorkEnvironmentCode (string)
. AccidentAdressComplement (string)
. AccidentNeighborhood (string)
. AccidentAdressType (string)
. AccidentLocationCGC (string)
} (object) required
rm/workenvironments_v1_000/get_workenvironmentsRetorna todos os Ambientes de TrabalhoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
workEnvironmentIds (string)
rm/workenvironments_v1_000/post_workenvironmentsInclui um novo registro na tabela de Ambientes de TrabalhoAuthorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. WorkEnvironmentCode (string)
. Description (string)
. Type (integer)
. WorkEnvironmentTypeESocial (smallint)
. FunctionCode (string)
. SectionCode (string)
. WorkStationCode (string)
. WorkPlaceCode (string)
. TributaryOccupancyCode (string)
. RegistrationType (string)
. RegistrationNumber (string)
} (object) required
rm/workenvironments_v1_000/get_workenvironments_by_idRetorna dados de tabela do Ambiente de Trabalho especificadoid (string)
Authorization (string) required
rm/workenvironments_v1_000/delete_workenvironments_by_idExclui Ambiente de Trabalhoid (string)
Authorization (string) required
rm/workenvironments_v1_000/put_workenvironments_by_idAtualiza um registro existente de tabela de Ambientes de Trabalho. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. CompanyCode (string)
. CompanyCodeInternalId (string)
. WorkEnvironmentCode (string)
. Description (string)
. Type (integer)
. WorkEnvironmentTypeESocial (smallint)
. FunctionCode (string)
. SectionCode (string)
. WorkStationCode (string)
. WorkPlaceCode (string)
. TributaryOccupancyCode (string)
. RegistrationType (string)
. RegistrationNumber (string)
} (object) required
datasul/accountpayabledocument_v1_000/post_account_payable_batchCria um novo lote de contas a pagar com documentos associados.No parameters
datasul/accountpayabledocument_v1_000/post_account_payable_advanceCria um novo registro de adiantamento de contas a pagarNo parameters
datasul/accountpayabledocument_v1_000/post_paymentCria lote de pagamento ou borderôNo parameters
datasul/accountpayabledocument_v1_000/put_reversalEstorna um título de contas a pagarNo parameters
datasul/accountpayabledocument_v1_000/putAtualiza um título de contas a pagarNo parameters
datasul/approvers_v1_000/get_approversRetorna todos Aprovadores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/approvers_v1_000/post_approversInclui Aprovadores passado na requisição.Authorization (string) required
data: {
. companyInternalId (string)
. branchId (string)
. code (string)
. userCode (object)
. userName (object)
. higherApprover (object)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. currencyApprove (number)
. approveLimitApprover (number)
. typeLimitApprove (string)
. limitedOrder (number)
. userLogin
. Company (string)
. lotation (string)
. viewPendingValue (boolean)
. conversionDatePendingValue (string)
. lotationDestiny (string)
. masterApprover (boolean)
. sendEmail (boolean)
. receiveEmail (boolean)
. receiveHTMLEmail (boolean)
. automaticApproval (boolean)
. email (string)
} (object) required
datasul/approvers_v1_000/get_approvers_by_codeRetorna o usuário do sistema indicado.code (string)
Authorization (string) required
datasul/approvers_v1_000/put_approvers_by_codeAltera o Aprovador passado na requisição.code (string)
Authorization (string) required
data: {
. companyInternalId (string)
. branchId (string)
. code (string)
. userCode (object)
. userName (object)
. higherApprover (object)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. currencyApprove (number)
. approveLimitApprover (number)
. typeLimitApprove (string)
. limitedOrder (number)
. userLogin
. Company (string)
. lotation (string)
. viewPendingValue (boolean)
. conversionDatePendingValue (string)
. lotationDestiny (string)
. masterApprover (boolean)
. sendEmail (boolean)
. receiveEmail (boolean)
. receiveHTMLEmail (boolean)
. automaticApproval (boolean)
. email (string)
} (object) required
datasul/approvers_v1_000/delete_approvers_by_codeExclusão do Aprovador.code (string)
Authorization (string) required
datasul/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipationRetorna todos os registros de Coparticipações dos Beneficiários e seus dependentes.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string) required
companyid (string) required
datasul/beneficiariesdatacontent_v1_000/get_beneficiaries_data_contentRetorna todos os registros de beneficiários.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
branchId (string)
datasul/buyers_v1_000/get_buyersRetorna todos os Compradores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/buyers_v1_000/post_buyersAdiciona Comprador passado na requisiçãoAuthorization (string) required
data (object) required
datasul/buyers_v1_000/get_buyers_by_buyer_idRetorna o Comprador do sistema através de seu códigoBuyerId (string)
fields (string)
Authorization (string) required
datasul/buyers_v1_000/put_buyers_by_buyer_idAltera o comprador passado na requisiçãoBuyerId (string)
Authorization (string) required
data (undefined) required
datasul/buyers_v1_000/delete_buyers_by_buyer_idExclusão de Comprador da baseBuyerId (string)
Authorization (string) required
datasul/campaigntypes_v1_000/get_campaign_typesRetorna os tipos de campanhas cadastradosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/campaigntypes_v1_000/post_campaign_typesInclui um novo tipo de campanhaAuthorization (string) required
fields (string)
data: {
. InternalId (string)
. Code (string)
. Name (string)
. Classification (string)
} (object) required
datasul/campaigntypes_v1_000/get_campaign_types_by_codeRetorna as informações do tipo de campanhaCode (string)
Authorization (string) required
fields (string)
datasul/campaigntypes_v1_000/put_campaign_types_by_codeAltera o tipo de campanhaCode (string)
Authorization (string) required
fields (string)
data: {
. InternalId (string)
. Code (string)
. Name (string)
. Classification (string)
} (object) required
datasul/campaigntypes_v1_000/delete_campaign_types_by_codeExclui o tipo de campanhaCode (string)
Authorization (string) required
datasul/campaigns_v1_000/get_campaignsRetorna as campanhas cadastradasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/campaigns_v1_000/post_campaignsInclui uma nova campanhaAuthorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Type (string)
. CampaingDescription (string)
. InitDate (string)
. EndDate (string)
. Objective (string)
. Attendance (string)
. ExpectedPorcentage (number)
. BlockedRecord (string)
. Campaign_Evolution_Status (string)
. CampaingType (string)
. ListOfCampaigns (object)
} (object) required
datasul/campaigns_v1_000/get_campaigns_by_codeRetorna as informações da campanha informadaCode (string)
Authorization (string) required
fields (string)
datasul/campaigns_v1_000/put_campaigns_by_codeAltera a camapnha informadaCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. InternalId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. Type (string)
. CampaingDescription (string)
. InitDate (string)
. EndDate (string)
. Objective (string)
. Attendance (string)
. ExpectedPorcentage (number)
. BlockedRecord (string)
. Campaign_Evolution_Status (string)
. CampaingType (string)
. ListOfCampaigns (object)
} (object) required
datasul/campaigns_v1_000/delete_campaigns_by_codeExclui a campanha informadaCode (string)
Authorization (string) required
datasul/candidates_v2_000/get_candidates_by_idRetorna dados de tabela da Candidato especificadaid (string)
Authorization (string) required
datasul/candidates_v2_000/delete_candidates_by_idExclui Candidatoid (string)
Authorization (string) required
datasul/candidates_v2_000/put_candidates_by_idAtualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula.id (string)
Authorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
datasul/candidates_v2_000/get_candidatesRetorna todos as CandidatosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
personsIds (string)
datasul/candidates_v2_000/post_candidatesInclui um novo registro na tabela de CandidatosAuthorization (string) required
data: {
. id (string)
. companyId (string)
. roleId (string)
. departmentId (string)
. branchId (string)
. name (string)
. birth (date)
. homeState (string)
. naturalness (string)
. nickName (string)
. sex (string)
. nationality (string)
. educationalLevel (string)
. street (string)
. number (string)
. district (string)
. state (string)
. city (string)
. cep (string)
. country (string)
. professionalRegistrationNumber (string)
. cpf (string)
. imageId (integer)
. phoneNumber1 (string)
. phoneNumber2 (string)
. identityNumber (string)
. identityNumberEmitterState (string)
. identityNumberEmitterAgency (string)
. identityNumberEmissionDate (date)
. electoralCard (string)
. electoralWard (string)
. electoralSection (string)
. workCard (string)
. workCardSerialNumber (string)
. workCardEmitterState (string)
. workCardEmissionDate (date)
. nit (boolean)
. driversLicense (string)
. driversLicenseType (string)
. driversLicenseExpirationDate (date)
. militaryDischargeCertificate (string)
. militaryGrade (string)
. brazilConsort (boolean)
. naturalized (boolean)
. brazilianChildren (boolean)
. brazilianChildrenNumber (integer)
. email (string)
. previousTrainingInvestment (double)
. shadeRace (integer)
. disabled (boolean)
. userCode (string)
. phoneNumber3 (string)
. company (string)
. occupationCode (string)
. rehabilitated (boolean)
. smoker (boolean)
. adjustsImageSize (boolean)
. deafPerson (boolean)
. mutePerson (boolean)
. blindPerson (boolean)
. mentallyImpairedPerson (boolean)
. curriculumApprovalDate (date)
. student (boolean)
. teacher (boolean)
. candidate (boolean)
. bibliosUser (boolean)
. employee (boolean)
. formerEmployee (boolean)
. intellectualImpairedPerson (boolean)
. deceased (boolean)
. age (integer)
. registryDate (date)
. wageExpectation (number)
. areaOfInterestCode1 (integer)
. areaOfInterestCode2 (integer)
. wageExpectationTradable (integer)
. workExperienceTime (integer)
. workExperienceTimeArea1 (integer)
. workExperienceTimeArea2 (integer)
. contraIndicated (integer)
. contraindicationReason (string)
. available (integer)
. formOfRecruitment (string)
. resumeSkillsId (integer)
. hierarchyLevelCode (integer)
. professionalProfileDescription (string)
. areaOfInterestDescription1 (string)
. areaOfInterestDescription2 (string)
. hierarchyLevelDescription (string)
. professionalSkillsResumeDescription (string)
. employee1 (string)
. personalEmail (string)
. maritalState (string)
. complement (string)
. arrivalDate (date)
. letterModel19 (string)
. rne (string)
. immigrationDecree (string)
. rneExpirationDate (date)
. workCardExpirationDate (date)
. visaType (string)
. passportNumber (string)
. nativeCountry (string)
. passportExpirationDate (date)
. accessibilityFeaturesForJobLocal (string)
. militaryDivision (string)
. militaryCertificateEmissionDate (date)
. militaryCertificateEmitterAgency (string)
. militaryRegion (string)
. militarySituation (string)
. electoralCardEmitterState (string)
. bloodType (string)
. image (string)
. neighborhoodTypeCode (integer)
. naturalnessCode (string)
. naturalisationDate (date)
. driversLicenseEmitterAgency (string)
. rneEmitterAgency (string)
. countryId (integer)
. deceaseDate (date)
. deathCertificateNumber (string)
. naturalisationGatehouse (string)
. brazilConditionClassification (string)
. driversLicenseFirstEmissionDate (date)
. firstJobYear (integer)
} (object) required
datasul/commercialfamily_v2_000/get_commercialfamiliesRetorna lista completa das famílias comerciaisAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/commercialfamily_v2_000/post_commercialfamiliesInclui uma família comercial conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. UnitOfMeasureCode (string)
. SuperiorCode (string)
. CompleteDescription (string)
. SortOrder (string)
. Situation (string)
. HideSection (string)
} (object) required
datasul/commercialfamily_v2_000/get_commercialfamilies_by_internal_idRetorna a família comercial pelo Código internoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/commercialfamily_v2_000/put_commercialfamilies_by_internal_idAtualiza a família comercial conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. UnitOfMeasureCode (string)
. SuperiorCode (string)
. CompleteDescription (string)
. SortOrder (string)
. Situation (string)
. HideSection (string)
} (object) required
datasul/commercialfamily_v2_000/delete_commercialfamilies_by_internal_idExclui a família comercial conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
datasul/customerpublic_v1_000/get_customer_publicRetorna lista de ClientesAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
expand (string)
totalCount (boolean)
$filter (string)
lastUpdate (string)
datasul/customerpublic_v1_000/post_customer_publicInclui um Cliente conforme dados enviados na requisição.Authorization (string) required
data: {
. ActivityBranch (string)
. AdditionalCredit (number)
. Address (string)
. Bank (integer)
. BankBranch (string)
. BillingAddress (string)
. BillingCity (string)
. BillingCompleteAddress (string)
. BillingCountry (string)
. BillingIbgeCode (integer)
. BillingNeighborhood (string)
. BillingPersonalId (string)
. BillingState (string)
. BillingZipCode (string)
. birthdate (string)
. Category (string)
. CheckingAccount (string)
. City (string)
. Comments (string)
. CompleteAddress (string)
. Country (string)
. Credit (integer)
. CreditLimit (number)
. CreditLimitCurrency (integer)
. CreditLimitDate (string)
. CreditLimitEnd (string)
. CreditSuspendedCustomer (boolean)
. CustomerClassification (integer)
. CustomerBalance (integer)
. CustomerCode (integer)
. CustomerGroup (integer)
. CustomerName (string)
. DefaultHolder (integer)
. DefaultModality (integer)
. DeliveryCode (string)
. Email (string)
. EntityType (integer)
. Extension1 (string)
. Extension2 (string)
. Holder (integer)
. HomePage (string)
. IbgeCode (integer)
. ICMSTaxpayer (boolean)
. ImplementationDate (string)
. InterstateTransactionType (string)
. LastSale (string)
. Modality (integer)
. MonthsInactive (integer)
. MunicipalRegistration (string)
. Neighborhood (string)
. NFeEmail (string)
. ParentName (string)
. PartialInvoicing (boolean)
. PaymentTerms (integer)
. PersonalId (string)
. Phone1 (string)
. Phone2 (string)
. PriceTable (string)
. ProductLine (string)
. registrationINSS (string)
. RegionCode (string)
. RepresentativeCode (integer)
. salesChannel (integer)
. ShortName (string)
. ShortRegion (string)
. StandardCarrierCode (integer)
. State (string)
. StateRegistration (string)
. SupplierGroup (integer)
. TradeName (string)
. TransactionType (string)
. Type (integer)
. UpdateDate (string)
. UpdateTime (string)
. ZipCode (string)
. Telefax (string)
. Telex (string)
. LastUpdate (string)
. BillingCustomer (integer)
. StandardRevenue (integer)
. MailingAddressCountry (object)
. BillingAddressCountry (object)
. CustomerContacts (array)
. DeliveryPlaces (array)
. CustomFields (array)
} (object) required
datasul/customerpublic_v1_000/put_customer_public_by_customer_idAltera um Cliente conforme dados enviados na requisição.customerID (integer)
Authorization (string) required
data: {
. ActivityBranch (string)
. AdditionalCredit (number)
. Address (string)
. Bank (integer)
. BankBranch (string)
. BillingAddress (string)
. BillingCity (string)
. BillingCompleteAddress (string)
. BillingCountry (string)
. BillingIbgeCode (integer)
. BillingNeighborhood (string)
. BillingPersonalId (string)
. BillingState (string)
. BillingZipCode (string)
. birthdate (string)
. Category (string)
. CheckingAccount (string)
. City (string)
. Comments (string)
. CompleteAddress (string)
. Country (string)
. Credit (integer)
. CreditLimit (number)
. CreditLimitCurrency (integer)
. CreditLimitDate (string)
. CreditLimitEnd (string)
. CreditSuspendedCustomer (boolean)
. CustomerClassification (integer)
. CustomerBalance (integer)
. CustomerCode (integer)
. CustomerGroup (integer)
. CustomerName (string)
. DefaultHolder (integer)
. DefaultModality (integer)
. DeliveryCode (string)
. Email (string)
. EntityType (integer)
. Extension1 (string)
. Extension2 (string)
. Holder (integer)
. HomePage (string)
. IbgeCode (integer)
. ICMSTaxpayer (boolean)
. ImplementationDate (string)
. InterstateTransactionType (string)
. LastSale (string)
. Modality (integer)
. MonthsInactive (integer)
. MunicipalRegistration (string)
. Neighborhood (string)
. NFeEmail (string)
. ParentName (string)
. PartialInvoicing (boolean)
. PaymentTerms (integer)
. PersonalId (string)
. Phone1 (string)
. Phone2 (string)
. PriceTable (string)
. ProductLine (string)
. registrationINSS (string)
. RegionCode (string)
. RepresentativeCode (integer)
. salesChannel (integer)
. ShortName (string)
. ShortRegion (string)
. StandardCarrierCode (integer)
. State (string)
. StateRegistration (string)
. SupplierGroup (integer)
. TradeName (string)
. TransactionType (string)
. Type (integer)
. UpdateDate (string)
. UpdateTime (string)
. ZipCode (string)
. Telefax (string)
. Telex (string)
. LastUpdate (string)
. BillingCustomer (integer)
. StandardRevenue (integer)
. MailingAddressCountry (object)
. BillingAddressCountry (object)
. CustomerContacts (array)
. DeliveryPlaces (array)
. CustomFields (array)
} (object) required
datasul/customerpublic_v1_000/patch_customer_public_by_customer_idAltera um Cliente conforme dados enviados na requisição.customerID (integer)
Authorization (string) required
data: {
. ActivityBranch (string)
. AdditionalCredit (number)
. Address (string)
. Bank (integer)
. BankBranch (string)
. BillingAddress (string)
. BillingCity (string)
. BillingCompleteAddress (string)
. BillingCountry (string)
. BillingIbgeCode (integer)
. BillingNeighborhood (string)
. BillingPersonalId (string)
. BillingState (string)
. BillingZipCode (string)
. birthdate (string)
. Category (string)
. CheckingAccount (string)
. City (string)
. Comments (string)
. CompleteAddress (string)
. Country (string)
. Credit (integer)
. CreditLimit (number)
. CreditLimitCurrency (integer)
. CreditLimitDate (string)
. CreditLimitEnd (string)
. CreditSuspendedCustomer (boolean)
. CustomerClassification (integer)
. CustomerBalance (integer)
. CustomerCode (integer)
. CustomerGroup (integer)
. CustomerName (string)
. DefaultHolder (integer)
. DefaultModality (integer)
. DeliveryCode (string)
. Email (string)
. EntityType (integer)
. Extension1 (string)
. Extension2 (string)
. Holder (integer)
. HomePage (string)
. IbgeCode (integer)
. ICMSTaxpayer (boolean)
. ImplementationDate (string)
. InterstateTransactionType (string)
. LastSale (string)
. Modality (integer)
. MonthsInactive (integer)
. MunicipalRegistration (string)
. Neighborhood (string)
. NFeEmail (string)
. ParentName (string)
. PartialInvoicing (boolean)
. PaymentTerms (integer)
. PersonalId (string)
. Phone1 (string)
. Phone2 (string)
. PriceTable (string)
. ProductLine (string)
. registrationINSS (string)
. RegionCode (string)
. RepresentativeCode (integer)
. salesChannel (integer)
. ShortName (string)
. ShortRegion (string)
. StandardCarrierCode (integer)
. State (string)
. StateRegistration (string)
. SupplierGroup (integer)
. TradeName (string)
. TransactionType (string)
. Type (integer)
. UpdateDate (string)
. UpdateTime (string)
. ZipCode (string)
. Telefax (string)
. Telex (string)
. LastUpdate (string)
. BillingCustomer (integer)
. StandardRevenue (integer)
. MailingAddressCountry (object)
. BillingAddressCountry (object)
. CustomerContacts (array)
. DeliveryPlaces (array)
. CustomFields (array)
} (object) required
datasul/customerpublic_v1_000/delete_customer_public_by_customer_idRemove um ClientecustomerID (integer)
Authorization (string) required
datasul/employeedatacontent_v1_000/get_employee_data_contentRetorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações.Authorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
dateModified (string)
companyid (string) required
datasul/employeepayrollinfo_v1_000/post_employee_payroll_infoConsulta funcionário para avaliação de concessão de empréstimo consignadoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
data: {
. companyInternalId (string)
. companyFederalIdentification (string)
. employeeInternalId (string)
. employeeFederalIdentification (string)
. employeeCode (string)
} (object) required
datasul/esocialaudit_v1_000/post_esocial_auditInclui a entidade evento passado na requisiçãocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
data (object) required
datasul/esocialaudit_v1_000/get_esocial_audit_statusRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
datasul/esocialaudit_v1_000/get_esocial_audit_audit_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
status (string)
page (integer)
pageSize (integer)
datasul/esocialaudit_v1_000/get_esocial_audit_chart_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
datasul/esocialbranches_v1_000/get_esocial_branchesRetorna o código da empresa e código da filial no TAFcompanyId (string) required
order (array)
page (integer)
pageSize (integer)
datasul/esocialestablishment_v1_000/get_esocial_establishmentRetorna lista completa com os Estabelecimentos CadastradoscompanyId (string) required
order (array)
page (integer)
pageSize (integer)
datasul/esocialevents_v1_000/get_esocial_eventsRetorna a lista de eventos do TAFcompanyId (string) required
eventsCheckPermissions (string)
datasul/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_processCarrega registros do evento S-5503, filtrados ou não, ordenados ou não.No parameters
datasul/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_processExclui eventos S-5503 conforme coleção de ID's informados.data: {
. companyId (string)
. id (array)
} (object) required
datasul/fgtsperworkerinlaborprocess_v1_000/post_fgtsper_worker_in_labor_process_xmlRetorna XML's do evento S-5503 encodados em base64data: {
. companyId (string)
. id (array)
} (object) required
datasul/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_categoryCarrega informações relativas a Matrícula e Categoria de trabalhador específico do evento S-5503, ordenadas ou não.No parameters
datasul/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_payment_and_amountsCarrega informações relativas a Identificação do estabelecimento responsável pelo pagamento a trabalhador específico dos valores informados do evento S-5503, ordenadas ou nãoNo parameters
datasul/freightmode_v1_000/get_freightmodesRetorna lista completa das modalidades de freteAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/freightmode_v1_000/post_freightmodesInclui uma modalide de frete conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. FreightModeCodeNfe (string)
. FreightModeCodeSped (string)
} (object) required
datasul/freightmode_v1_000/get_freightmodes_by_internal_idRetorna a modalidade de frete pelo Código internoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/freightmode_v1_000/put_freightmodes_by_internal_idAtualiza a modalidade de frete conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. FreightModeCodeNfe (string)
. FreightModeCodeSped (string)
} (object) required
datasul/freightmode_v1_000/delete_freightmodes_by_internal_idExclui a modalidade de frete conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
datasul/gpeesocialmotives_v1_000/get_esocial_motivesRetorna lista completa com os motivos de afastamentocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
datasul/inventorycounts_v1_000/get_inventory_countsRetorna uma ou mais de fichas de inventário conforme parâmetros recebidoscompanyCode (string)
sequenceCountingSheetNumber (integer)
countingSheetNumber (integer)
inventoryDate (string)
inventoryTime (string)
itemCode (string)
groupingCode (number)
lecturerUser1 (string)
lecturerUser2 (string)
lecturerUser3 (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/inventorycounts_v1_000/post_inventory_countsGeração de ficha de inventário. Informar a quantidade apurada na primeira contagem. A atualização da segunda/terceira contagem deve ser enviado via método PUTdata: {
. internalId (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. warehouseCode (string)
. companyCode (string)
. locationCode (string)
. sublocationCode (string)
. referenceCode (string)
. inventoryDate (string)
. inventoryTime (string)
. itemCode (string)
. lotCode (string)
. lotExpirationDate (date)
. statusItem (string)
. countedValue (number)
. groupingCode (number)
. lecturerUser (string)
} (object) required
datasul/inventorycounts_v1_000/get_inventory_counts_by_internal_idRetorna uma ficha de inventário correspondente ao número informadointernalId (string)
fields (string)
datasul/inventorycounts_v1_000/put_inventory_counts_by_internal_idMétodo responsável pela atualização das quantidades apuradas na ficha de inventário. Caso ainda não exista a ficha no sistema, deve ser previamente criada por meio do método POSTinternalId (string)
data: {
. internalId (string)
. companyCode (string)
. inventoryDate (string)
. inventoryTime (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. numOfCount (number)
. countedValue (number)
. lecturerUser (string)
} (object) required
datasul/inventorycounts_v1_000/delete_inventory_counts_by_internal_idElimina a ficha de inventário pelo número e data de saldointernalId (string)
datasul/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_countsMétodo responsável pela eliminação das contagens. Contagens voltam ao estado inicialinternalId (string)
datasul/itemscript_v1_000/get_item_scriptsRetorna todas as operações do item/roteiro informadoossearch (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/itemscript_v1_000/post_item_scriptsAdiciona uma ou mais operações para o item ou roteirodata: {
. ItemCode (string)
. ItemInternalID (string)
. ItemDescription (string)
. ScriptCode (string)
. ScriptDescription (string)
. ScriptAlternative (string)
. ListOfActivity (array)
. ListOfPertOrders (array)
} (object) required
datasul/itemscript_v1_000/get_item_scripts_by_item_codeRetorna as operações existentes para o item ou roteiro. Nessa operação não se deve passar o código do roteiro, apenas do item. Caso o item possua roteiros, eles serão trazidos normalmente.ItemCode (string)
datasul/itemscript_v1_000/put_item_scripts_script_by_script_codeAtualiza as operações de um roteiro pré-existenteScriptCode (string)
data: {
. ItemCode (string)
. ItemInternalID (string)
. ItemDescription (string)
. ScriptCode (string)
. ScriptDescription (string)
. ScriptAlternative (string)
. ListOfActivity (array)
. ListOfPertOrders (array)
} (object) required
datasul/itemscript_v1_000/delete_item_scripts_script_by_script_codeA propriedade 'ListOfActivity' deve conter a lista de operações a serem apagadas. Caso ela seja enviada em branco, todas as operações serão excluídas.ScriptCode (string)
data: {
. ItemCode (string)
. ItemInternalID (string)
. ItemDescription (string)
. ScriptCode (string)
. ScriptDescription (string)
. ScriptAlternative (string)
. ListOfActivity (array)
. ListOfPertOrders (array)
} (object) required
datasul/itemscript_v1_000/put_item_scripts_item_by_item_codeAtualiza as operações de um item pré-existenteItemCode (string)
data: {
. ItemCode (string)
. ItemInternalID (string)
. ItemDescription (string)
. ScriptCode (string)
. ScriptDescription (string)
. ScriptAlternative (string)
. ListOfActivity (array)
. ListOfPertOrders (array)
} (object) required
datasul/itemscript_v1_000/delete_item_scripts_item_by_item_codeA propriedade 'ListOfActivity' deve conter a lista de operações a serem apagadas. Caso ela seja enviada em branco, todas as operações serão excluídas.ItemCode (string)
data: {
. ItemCode (string)
. ItemInternalID (string)
. ItemDescription (string)
. ScriptCode (string)
. ScriptDescription (string)
. ScriptAlternative (string)
. ListOfActivity (array)
. ListOfPertOrders (array)
} (object) required
datasul/itemstructures_v1_000/get_item_structuresRetorna o primeiro nível da estrutura dos itens selecionadossearch (string)
code (string)
itemReference (string)
itemComponentCode (string)
expired (boolean)
pageSize (integer)
page (integer)
fields (string)
order (array)
datasul/itemstructures_v1_000/post_item_structuresAdiciona um ou mais componentes na estruturadata: {
. CompanyInternalId (string)
. CompanyCode (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemAmount (number)
. ListOfItensStructure (array)
} (object) required
datasul/itemstructures_v1_000/put_item_structures_by_item_internal_idAtualiza uma estrutura existenteItemInternalId (string)
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemAmount (number)
. ListOfItensStructure (array)
} (object) required
datasul/itemstructures_v1_000/get_item_structures_by_item_internal_idRetorna o primeiro nível da estrutura do item informadoItemInternalId (string)
datasul/itemstructures_v1_000/delete_item_structures_by_item_internal_idDeleta completamente a estrutura de um itemItemInternalId (string)
datasul/itemstructures_v1_000/delete_item_structures_by_item_internal_id_componentExclui um ou mais componentes na estruturaItemInternalId (string)
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemAmount (number)
. ListOfItensStructure (array)
} (object) required
datasul/jobscheduler_v1_001/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
datasul/jobscheduler_v1_001/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
datasul/jobscheduler_v1_001/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
datasul/jobscheduler_v1_001/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
datasul/jobscheduler_v1_001/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
datasul/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
} (object) required
datasul/jobscheduler_v1_001/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
datasul/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
datasul/jobscheduler_v1_100/get_job_executionRetorna todas as execuções de agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
datasul/jobscheduler_v1_100/get_job_execution_by_execution_idRetorna todos os agendamentosexecutionID (string)
datasul/jobscheduler_v1_100/get_job_schedulerRetorna todos os agendamentosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
datasul/jobscheduler_v1_100/post_job_schedulerCria agendamento de processodata: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
datasul/jobscheduler_v1_100/get_job_scheduler_by_job_schedule_idRetorna todos JobschedulerjobScheduleID (string)
Authorization (string) required
datasul/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
data: {
. jobScheduleID (string)
. status (string)
. lastModified (string)
. processID (string)
. firstExecution (string)
. user (string)
. recurrent (boolean)
. executionParameter (object)
. daily
. weekly
. monthly
. rangeExecutions
. execs (integer)
. enddate (date)
. discard (boolean)
. interval (string)
} (object) required
datasul/jobscheduler_v1_100/delete_job_scheduler_by_job_schedule_idInclui JobschedulerjobScheduleID (string)
Authorization (string) required
datasul/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_triggerDispara a execução um agendamento de processojobScheduleID (string)
Authorization (string) required
datasul/machine_v1_000/get_machinesRecupera um conjunto de registros com base nos filtros via QuerystringAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
search (string)
datasul/machine_v1_000/post_machinesAdicionar nova máquinaAccept-Language (string)
data: {
. Code (string)
. Description (string)
. WorkCenterCode (string)
. WorkCenterDescription (string)
. ProcessorType (string)
. LaborType (string)
. VolumeMachineQuantity (number)
. EfficiencyMachineValue (number)
. OperatorMachineQuantity (integer)
. SimultaneousActivityQuantity (integer)
. IsSetup (boolean)
. IsControlPert (boolean)
. IsReportEvent (boolean)
. IsOverlapReport (boolean)
. CostCenterCode (string)
. ProductionAreaCode (string)
. InitialValidateDate (string)
. FinalValidateDate (string)
. TypeMachine (string)
. ListOfResources (array)
. ListOfResourcesSec (array)
. ListOfDomain (array)
. ListOfProductionShifts (array)
. ListOfControlItems (array)
. CompanyId (string)
. BranchId (string)
. StandardRotation (number)
. UnitType (string)
. Active (string)
} (object) required
datasul/machine_v1_000/put_machinesAtualizar uma máquina existenteAccept-Language (string)
data: {
. Code (string)
. Description (string)
. WorkCenterCode (string)
. WorkCenterDescription (string)
. ProcessorType (string)
. LaborType (string)
. VolumeMachineQuantity (number)
. EfficiencyMachineValue (number)
. OperatorMachineQuantity (integer)
. SimultaneousActivityQuantity (integer)
. IsSetup (boolean)
. IsControlPert (boolean)
. IsReportEvent (boolean)
. IsOverlapReport (boolean)
. CostCenterCode (string)
. ProductionAreaCode (string)
. InitialValidateDate (string)
. FinalValidateDate (string)
. TypeMachine (string)
. ListOfResources (array)
. ListOfResourcesSec (array)
. ListOfDomain (array)
. ListOfProductionShifts (array)
. ListOfControlItems (array)
. CompanyId (string)
. BranchId (string)
. StandardRotation (number)
. UnitType (string)
. Active (string)
} (object) required
datasul/machine_v1_000/get_machines_by_codeRetorna uma única máquina com ID informado.Code (string)
Accept-Language (string)
datasul/machine_v1_000/delete_machines_by_codeExclui o registro de máquina existenteCode (string)
Accept-Language (string)
datasul/machine_v1_000/delete_machines_by_code_relationExclui uma ou mais relações da máquinaCode (string)
Accept-Language (string)
data: {
. Code (string)
. Description (string)
. WorkCenterCode (string)
. WorkCenterDescription (string)
. ProcessorType (string)
. LaborType (string)
. VolumeMachineQuantity (number)
. EfficiencyMachineValue (number)
. OperatorMachineQuantity (integer)
. SimultaneousActivityQuantity (integer)
. IsSetup (boolean)
. IsControlPert (boolean)
. IsReportEvent (boolean)
. IsOverlapReport (boolean)
. CostCenterCode (string)
. ProductionAreaCode (string)
. InitialValidateDate (string)
. FinalValidateDate (string)
. TypeMachine (string)
. ListOfResources (array)
. ListOfResourcesSec (array)
. ListOfDomain (array)
. ListOfProductionShifts (array)
. ListOfControlItems (array)
. CompanyId (string)
. BranchId (string)
. StandardRotation (number)
. UnitType (string)
. Active (string)
} (object) required
datasul/marks_v1_000/get_marksRetorna um conjunto de marcassearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
datasul/marks_v1_000/post_marksAdiciona uma nova marcadata (object) required
datasul/marks_v1_000/get_marks_by_codeRetorna uma única marcaCode (string)
datasul/marks_v1_000/put_marks_by_codeAtualiza uma marca existenteCode (string)
data (object) required
datasul/marks_v1_000/delete_marks_by_codeDeleta uma marcaCode (string)
datasul/materialfamilies_v1_000/post_material_familiesAdiciona nova família de materialdata: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. WarehouseCode (string)
. UnitOfMeasureCode (string)
. FamilyType (string)
. FamilyClassificationCode (string)
. TourismType (string)
. Conciliation (string)
. SegmentType (string)
. Corporate (string)
. Event (string)
. Recreation (string)
. Situation (string)
. ListOfPaymentForm (array)
} (object) required
datasul/materialfamilies_v1_000/get_material_familiesRetorna lista de famílias de materiaisorder (array)
pageSize (integer)
page (integer)
datasul/materialfamilies_v1_000/get_material_families_by_codeRetorna uma única famíliaid (string)
Code (string)
datasul/materialfamilies_v1_000/put_material_families_by_codeAtualiza uma família de materialCode (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. WarehouseCode (string)
. UnitOfMeasureCode (string)
. FamilyType (string)
. FamilyClassificationCode (string)
. TourismType (string)
. Conciliation (string)
. SegmentType (string)
. Corporate (string)
. Event (string)
. Recreation (string)
. Situation (string)
. ListOfPaymentForm (array)
} (object) required
datasul/materialfamilies_v1_000/delete_material_families_by_codeRemove uma família de materialid (string)
Code (string)
datasul/menus_v1_001/get_menusRetorna todas os resourcesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
datasul/menus_v1_001/get_menus_by_parent_idRetorna todas os resourcesparentId (string)
Authorization (string) required
datasul/models_v1_000/get_modelsRetorna um conjunto de modelossearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
datasul/models_v1_000/post_modelsAdiciona um novo modelodata: {
. Code (string)
. InternalId (string)
. Description (string)
. MarkCode (string)
. MarkInternalId (string)
. PowerClassCode (string)
. PowerClassInternalId (string)
. OperativeGroupCode (string)
. OperativeGroupInternalId (string)
} (object) required
datasul/models_v1_000/get_models_by_codeRetorna um único modeloCode (string)
datasul/models_v1_000/put_models_by_codeAtualiza um modelo existenteCode (string)
data: {
. Code (string)
. InternalId (string)
. Description (string)
. MarkCode (string)
. MarkInternalId (string)
. PowerClassCode (string)
. PowerClassInternalId (string)
. OperativeGroupCode (string)
. OperativeGroupInternalId (string)
} (object) required
datasul/models_v1_000/delete_models_by_codeDeleta um modeloid (string)
Code (string)
datasul/operationalcategory_v1_000/get_operational_categorysRetorna um conjunto de Categorias Operacionaissearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
datasul/operationalcategory_v1_000/post_operational_categorysAdiciona uma nova categoria operacionaldata: {
. Code (string)
. Description (string)
. ShortName (string)
. UnitOfMeasureCode (string)
} (object) required
datasul/operationalcategory_v1_000/get_operational_categorys_by_codeRetorna uma única categoria operacionalCode (string)
datasul/operationalcategory_v1_000/put_operational_categorys_by_codeAtualiza uma categoria operacional existenteCode (string)
data: {
. Code (string)
. Description (string)
. ShortName (string)
. UnitOfMeasureCode (string)
} (object) required
datasul/operationalcategory_v1_000/delete_operational_categorys_by_codeDeleta uma categoria operacionalCode (string)
datasul/opportunity_v1_000/get_opportunitiesRetorna lista completa das oportunidades de VendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/opportunity_v1_000/post_opportunitiesInclui uma oportunidade de venda conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Review (string)
. Description (string)
. Seller (string)
. SellerName (string)
. ListofConsumer (array)
. StartDate (string)
. ClosingDate (string)
. Process (string)
. Stage (string)
. Notes (string)
. Currency (number)
. Priority (string)
. SuccessFactor (string)
. FailureFactor (string)
. Status (string)
. Ending (string)
. Reason (string)
. DateSignature (string)
. Comments (string)
. ListOfContacts (array)
} (object) required
datasul/opportunity_v1_000/get_opportunities_by_internal_idRetorna a oportunidade de venda pelo códigoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/opportunity_v1_000/put_opportunities_by_internal_idAtualiza a oportunidade de venda conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. BranchId (string)
. CompanyInternalId (string)
. InternalId (string)
. Code (string)
. Review (string)
. Description (string)
. Seller (string)
. SellerName (string)
. ListofConsumer (array)
. StartDate (string)
. ClosingDate (string)
. Process (string)
. Stage (string)
. Notes (string)
. Currency (number)
. Priority (string)
. SuccessFactor (string)
. FailureFactor (string)
. Status (string)
. Ending (string)
. Reason (string)
. DateSignature (string)
. Comments (string)
. ListOfContacts (array)
} (object) required
datasul/opportunity_v1_000/delete_opportunities_by_internal_idExclui a oportunidade de venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
datasul/orderspublic_v1_000/get_orders_publicRetorna lista de Pedido de VendaAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
expand (string)
totalCount (boolean)
$filter (string)
lastUpdate (string)
printDateFirst (string)
printDateLast (string)
storeCode (string)
datasul/orderspublic_v1_000/post_orders_publicInclui um Pedido de Venda conforme dados enviados na requisição.Authorization (string) required
data: {
. AllocationSituation (integer)
. BranchId (string)
. CampaignId (string)
. CancellationDate (string)
. CancellationReason (string)
. CarrierName (string)
. CifCity (string)
. CodeCarrier (integer)
. CodeReshipmentTransp (integer)
. CollectorCode (integer)
. Comments (string)
. CommercialSituation (integer)
. CompleteAddress (string)
. CreditApprovalDate (string)
. CreditLockReason (string)
. CurrencyBillingCode (integer)
. CurrencyCode (integer)
. CustomerCode (integer)
. CustomerDiscount (decimal)
. CustomerOrderId (string)
. CustomerOrderType (string)
. DateUpdatedSituation (string)
. DeliveryCity (string)
. DeliveryCode (string)
. DeliveryCountry (string)
. DeliveryDate (string)
. DeliveryNeighborhood (string)
. DeliveryPlace (string)
. DeliveryState (string)
. DeliveryZipCode (string)
. DiscountAmt (decimal)
. DiscountPercentage (decimal)
. Email (string)
. EmissionDate (string)
. EvaluationSituation (integer)
. FinancingTable (integer)
. FinancingTableSequence (integer)
. ForcedApprover (string)
. ForcedReleaseReason (string)
. FreightMode (string)
. ImplantationDate (string)
. LimitBillingDate (string)
. MerchandiseDescription (integer)
. MinimumBillingDate (string)
. Modality (integer)
. OpenAmount (decimal)
. OperationTypeCode (integer)
. OperationTypeDetail (string)
. OrderAmount (decimal)
. OrderCompleted (boolean)
. OrderId (integer)
. OrderSituation (integer)
. OrderType (integer)
. Origin (integer)
. OriginalDeliveryDate (string)
. PaymentTerms (integer)
. PaymentTermsDetail (string)
. PercentageFreight (decimal)
. PercentageInsurance (decimal)
. PercentagePacking (decimal)
. PriceOrderType (integer)
. PriceReason (string)
. PriceSituation (integer)
. PriceTableDiscPerc (decimal)
. PriceTableOrder (string)
. PriceTableOrderDetail (string)
. PersonalId (string)
. PriorityCode (integer)
. ReactivationDate (string)
. ReactivationReason (string)
. RepresentativeName (string)
. RepresentativeOrderId (string)
. RepresentativeShortName (string)
. ReshipmentTransp (string)
. SalesChannel (integer)
. ShortName (string)
. SuspensionDate (string)
. SuspensionReason (string)
. TotalDiscount (decimal)
. TotalDiscountPercentage (decimal)
. TotalDiscountValue (decimal)
. TotalOrderAmount (decimal)
. TransactionType (string)
. UnitBusinessCod (string)
. UseBillingAddress (boolean)
. UseDiscountTable (boolean)
. UserApprover (string)
. UserCancel (string)
. UserCreditApprover (string)
. UserLastChange (string)
. UserUpdatedSituation (string)
. ValueFreight (decimal)
. ValueInsurance (decimal)
. ValuePacking (decimal)
. OrderRepresentatives (array)
. PreInvoicing (array)
. OrderItems (array)
. CustomFields (array)
} (object) required
datasul/orderspublic_v1_000/put_orders_public_by_order_idAltera um Pedido de Venda conforme dados enviados na requisição.orderId (integer)
Authorization (string) required
data: {
. AllocationSituation (integer)
. BranchId (string)
. CampaignId (string)
. CancellationDate (string)
. CancellationReason (string)
. CarrierName (string)
. CifCity (string)
. CodeCarrier (integer)
. CodeReshipmentTransp (integer)
. CollectorCode (integer)
. Comments (string)
. CommercialSituation (integer)
. CompleteAddress (string)
. CreditApprovalDate (string)
. CreditLockReason (string)
. CurrencyBillingCode (integer)
. CurrencyCode (integer)
. CustomerCode (integer)
. CustomerDiscount (decimal)
. CustomerOrderId (string)
. CustomerOrderType (string)
. DateUpdatedSituation (string)
. DeliveryCity (string)
. DeliveryCode (string)
. DeliveryCountry (string)
. DeliveryDate (string)
. DeliveryNeighborhood (string)
. DeliveryPlace (string)
. DeliveryState (string)
. DeliveryZipCode (string)
. DiscountAmt (decimal)
. DiscountPercentage (decimal)
. Email (string)
. EmissionDate (string)
. EvaluationSituation (integer)
. FinancingTable (integer)
. FinancingTableSequence (integer)
. ForcedApprover (string)
. ForcedReleaseReason (string)
. FreightMode (string)
. ImplantationDate (string)
. LimitBillingDate (string)
. MerchandiseDescription (integer)
. MinimumBillingDate (string)
. Modality (integer)
. OpenAmount (decimal)
. OperationTypeCode (integer)
. OperationTypeDetail (string)
. OrderAmount (decimal)
. OrderCompleted (boolean)
. OrderId (integer)
. OrderSituation (integer)
. OrderType (integer)
. Origin (integer)
. OriginalDeliveryDate (string)
. PaymentTerms (integer)
. PaymentTermsDetail (string)
. PercentageFreight (decimal)
. PercentageInsurance (decimal)
. PercentagePacking (decimal)
. PriceOrderType (integer)
. PriceReason (string)
. PriceSituation (integer)
. PriceTableDiscPerc (decimal)
. PriceTableOrder (string)
. PriceTableOrderDetail (string)
. PersonalId (string)
. PriorityCode (integer)
. ReactivationDate (string)
. ReactivationReason (string)
. RepresentativeName (string)
. RepresentativeOrderId (string)
. RepresentativeShortName (string)
. ReshipmentTransp (string)
. SalesChannel (integer)
. ShortName (string)
. SuspensionDate (string)
. SuspensionReason (string)
. TotalDiscount (decimal)
. TotalDiscountPercentage (decimal)
. TotalDiscountValue (decimal)
. TotalOrderAmount (decimal)
. TransactionType (string)
. UnitBusinessCod (string)
. UseBillingAddress (boolean)
. UseDiscountTable (boolean)
. UserApprover (string)
. UserCancel (string)
. UserCreditApprover (string)
. UserLastChange (string)
. UserUpdatedSituation (string)
. ValueFreight (decimal)
. ValueInsurance (decimal)
. ValuePacking (decimal)
. OrderRepresentatives (array)
. PreInvoicing (array)
. OrderItems (array)
. CustomFields (array)
} (object) required
datasul/orderspublic_v1_000/patch_orders_public_by_order_idAltera um Pedido de Venda conforme dados enviados na requisição.orderId (integer)
Authorization (string) required
data: {
. AllocationSituation (integer)
. BranchId (string)
. CampaignId (string)
. CancellationDate (string)
. CancellationReason (string)
. CarrierName (string)
. CifCity (string)
. CodeCarrier (integer)
. CodeReshipmentTransp (integer)
. CollectorCode (integer)
. Comments (string)
. CommercialSituation (integer)
. CompleteAddress (string)
. CreditApprovalDate (string)
. CreditLockReason (string)
. CurrencyBillingCode (integer)
. CurrencyCode (integer)
. CustomerCode (integer)
. CustomerDiscount (decimal)
. CustomerOrderId (string)
. CustomerOrderType (string)
. DateUpdatedSituation (string)
. DeliveryCity (string)
. DeliveryCode (string)
. DeliveryCountry (string)
. DeliveryDate (string)
. DeliveryNeighborhood (string)
. DeliveryPlace (string)
. DeliveryState (string)
. DeliveryZipCode (string)
. DiscountAmt (decimal)
. DiscountPercentage (decimal)
. Email (string)
. EmissionDate (string)
. EvaluationSituation (integer)
. FinancingTable (integer)
. FinancingTableSequence (integer)
. ForcedApprover (string)
. ForcedReleaseReason (string)
. FreightMode (string)
. ImplantationDate (string)
. LimitBillingDate (string)
. MerchandiseDescription (integer)
. MinimumBillingDate (string)
. Modality (integer)
. OpenAmount (decimal)
. OperationTypeCode (integer)
. OperationTypeDetail (string)
. OrderAmount (decimal)
. OrderCompleted (boolean)
. OrderId (integer)
. OrderSituation (integer)
. OrderType (integer)
. Origin (integer)
. OriginalDeliveryDate (string)
. PaymentTerms (integer)
. PaymentTermsDetail (string)
. PercentageFreight (decimal)
. PercentageInsurance (decimal)
. PercentagePacking (decimal)
. PriceOrderType (integer)
. PriceReason (string)
. PriceSituation (integer)
. PriceTableDiscPerc (decimal)
. PriceTableOrder (string)
. PriceTableOrderDetail (string)
. PersonalId (string)
. PriorityCode (integer)
. ReactivationDate (string)
. ReactivationReason (string)
. RepresentativeName (string)
. RepresentativeOrderId (string)
. RepresentativeShortName (string)
. ReshipmentTransp (string)
. SalesChannel (integer)
. ShortName (string)
. SuspensionDate (string)
. SuspensionReason (string)
. TotalDiscount (decimal)
. TotalDiscountPercentage (decimal)
. TotalDiscountValue (decimal)
. TotalOrderAmount (decimal)
. TransactionType (string)
. UnitBusinessCod (string)
. UseBillingAddress (boolean)
. UseDiscountTable (boolean)
. UserApprover (string)
. UserCancel (string)
. UserCreditApprover (string)
. UserLastChange (string)
. UserUpdatedSituation (string)
. ValueFreight (decimal)
. ValueInsurance (decimal)
. ValuePacking (decimal)
. OrderRepresentatives (array)
. PreInvoicing (array)
. OrderItems (array)
. CustomFields (array)
} (object) required
datasul/orderspublic_v1_000/put_orders_public_complete_by_order_idCompleta o Pedido de VendaorderId (integer)
Authorization (string) required
datasul/orderspublic_v1_000/put_orders_public_cancel_by_order_idCancela o Pedido de VendaorderId (integer)
Authorization (string) required
data: {
. CancellationDate (string)
. TypeReason (integer)
. CancellationReason (string)
} (object) required
datasul/payrollcontrol_v1_000/get_payroll_controlRetorna os dados da folha de pagamento de benefíciosAssitência Médica e OdontológicaAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
product (string) required
datemodified (string)
providerType (string) required
companyid (string) required
datasul/pricelistheaderitem_v2_005/get_price_list_header_itemsRetorna lista de Tabela de PreçoAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/pricelistheaderitem_v2_005/post_price_list_header_itemsInclui uma tabela de preço conforme dados enviados na requisição.Authorization (string) required
data (object) required
datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_codeRetorna a tabela de preço e todos os seus itens de acordo com o seu códigocode (string)
Authorization (string) required
order (array)
fields (string)
datasul/pricelistheaderitem_v2_005/put_price_list_header_items_by_codeAtualiza o cadastro da tabela de preço conforme dados enviados na requisiçãocode (string)
Authorization (string) required
data (object) required
datasul/pricelistheaderitem_v2_005/delete_price_list_header_items_by_codeExclui a tabela de preço conforme dados enviados na requisição.code (string)
Authorization (string) required
datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_priceRetorna os itens da tabela de preço de acordo com o seu códigocode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/pricelistheaderitem_v2_005/post_price_list_header_items_by_code_itens_table_priceInclui um novo item na tabela de preço conforme dados enviados.code (string)
Authorization (string) required
data: {
. items
} (object) required
datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price_by_item_listRetorna um item específico de preço de acordo com o seu códigocode (string)
itemList (undefined)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/pricelistheaderitem_v2_005/put_price_list_header_items_by_code_itens_table_price_by_item_listAtualiza um item da tabela de preço conforme dados enviados na requisiçãocode (string)
itemList (undefined)
Authorization (string) required
fields (string)
data: {
. items
} (object) required
datasul/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code_itens_table_price_by_item_listExclui um item da tabela de preço conforme dados enviados na requisição.code (string)
itemList (undefined)
Authorization (string) required
datasul/prospects_v1_000/get_prospectsRetorna lista completa de prospectsAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/prospects_v1_000/post_prospectsInclui um prospect conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. ProspectSituation (string)
. GovernmentalInformation (array)
} (object) required
datasul/prospects_v1_000/get_prospects_by_codeRetorna prospect pelo seu CódigoCode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/prospects_v1_000/put_prospects_by_codeAtualiza cadastro de prospect conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. ProspectSituation (string)
. GovernmentalInformation (array)
} (object) required
datasul/prospects_v1_000/delete_prospects_by_codeExclui cadastro de Prospect conforme dados enviados na requisição.Code (string)
Authorization (string) required
datasul/saleschannel_v2_000/get_saleschannelsRetorna lista completa dos canais de vendaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/saleschannel_v2_000/post_saleschannelsInclui um canal de venda conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. InternalId (string)
. Code (string)
. Description (string)
. Observation (string)
. StartDateQuotaControl (string)
} (object) required
datasul/saleschannel_v2_000/get_saleschannels_by_internal_idRetorna o canal de venda pelo Código internoInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
datasul/saleschannel_v2_000/put_saleschannels_by_internal_idAtualiza ocanal de venda conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. InternalId (string)
. Code (string)
. Description (string)
. Observation (string)
. StartDateQuotaControl (string)
} (object) required
datasul/saleschannel_v2_000/delete_saleschannels_by_internal_idExclui o canal de venda conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
datasul/suspects_v1_000/get_suspectsRetorna lista completa de SuspectsAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/suspects_v1_000/post_suspectsInclui um Suspect conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. SuspectSituation (string)
. GovernmentalInformation (array)
} (object) required
datasul/suspects_v1_000/get_suspects_by_codeRetorna Suspect pelo seu CódigoCode (string)
Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
datasul/suspects_v1_000/put_suspects_by_codeAtualiza cadastro de Suspect conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. StoreId (string)
. InternalId (string)
. ShortName (string)
. Name (string)
. EntityType (string)
. StrategicType (string)
. Origin (string)
. OriginEntity (string)
. ContactInformation (object)
. Address (array)
. CompanyInfo (object)
. InternalInformation (object)
. MarketSegment (object)
. RegisterSituation (string)
. SuspectSituation (string)
. GovernmentalInformation (array)
} (object) required
datasul/suspects_v1_000/delete_suspects_by_codeExclui cadastro de Suspect conforme dados enviados na requisição.Code (string)
Authorization (string) required
datasul/unitymeasurespublic_v1_000/get_unity_measures_publicRetorna lista de Unidades de MedidaAuthorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
totalCount (boolean)
$filter (string)
datasul/unitymeasurespublic_v1_000/post_unity_measures_publicInclui uma Unidade de Medida conforme dados enviados na requisição.Authorization (string) required
data: {
. Code (string)
. Description (string)
. DimensionCode (integer)
. FiscalAcronym (string)
} (object) required
datasul/unitymeasurespublic_v1_000/put_unity_measures_publicAltera uma Unidade de Medida conforme dados enviados na requisição.Authorization (string) required
data: {
. Code (string)
. Description (string)
. DimensionCode (integer)
. FiscalAcronym (string)
} (object) required
datasul/unitymeasurespublic_v1_000/delete_unity_measures_public_by_codeRemove uma Unidade de Medidacode (integer)
Authorization (string) required
datasul/urbanocoletor_v1_000/post_coletor_urbanoInclui informações do coletor na prestação de contasdata (object) required
datasul/user_v1_000/get_usersRetorna todos usuários do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
userIds (string)
name (string)
datasul/user_v1_000/post_usersInclui usuário passado na requisiçãoAuthorization (string) required
data (object) required
datasul/user_v1_000/get_users_by_idRetorna o usuário do sistema indicadoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
datasul/user_v1_000/put_users_by_idAltera o usuário passado na requisiçãoid (string)
Authorization (string) required
foundBy (string)
domainId (string)
data (undefined) required
datasul/user_v1_000/delete_users_by_idExclusão de usuário da baseid (string)
Authorization (string) required
foundBy (string)
domainId (string)
datasul/workcenters_v1_000/get_work_centersRetorna um conjunto de centro de trabalhosearch (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
Description (string)
ProductionAreaCode (string)
CostCenterCode (string)
datasul/workcenters_v1_000/post_work_centersAdiciona um novo centro de trabalhodata: {
. code (string)
. description (string)
. type (string)
. unitsPerHour (number)
. calendarCode (string)
. calendarDescription (string)
. productionAreaCode (string)
. productionAreaDescript (string)
. processorType (string)
. capacityUnit (string)
. modReportType (string)
. isSetup (boolean)
. usesExtraHour (boolean)
. reportOperationTime (boolean)
. qualityControlReport (integer)
. operationOverlap (boolean)
. hasAlternative (boolean)
. timeTreatmentType (string)
. loadQuantity (number)
. costCenterCode (string)
. responsibleEmail (string)
. usefulDayHour (number)
. standardCapacity (number)
. isReported (boolean)
} (object) required
datasul/workcenters_v1_000/get_work_centers_by_codeRetorna um único centro de trabalhocode (string)
datasul/workcenters_v1_000/put_work_centers_by_codeAtualiza um centro de trabalho existentecode (string)
data: {
. code (string)
. description (string)
. type (string)
. unitsPerHour (number)
. calendarCode (string)
. calendarDescription (string)
. productionAreaCode (string)
. productionAreaDescript (string)
. processorType (string)
. capacityUnit (string)
. modReportType (string)
. isSetup (boolean)
. usesExtraHour (boolean)
. reportOperationTime (boolean)
. qualityControlReport (integer)
. operationOverlap (boolean)
. hasAlternative (boolean)
. timeTreatmentType (string)
. loadQuantity (number)
. costCenterCode (string)
. responsibleEmail (string)
. usefulDayHour (number)
. standardCapacity (number)
. isReported (boolean)
} (object) required
datasul/workcenters_v1_000/delete_work_centers_by_codeDeleta um centro de trabalhocode (string)
central_de_obrigacoes___diops/activebalanceage_v1_100/get_active_balance_ageRetorna uma mensagem com a coleção de objetos do serviço Idade Do Saldo Ativo da entidade B8FT10financialDueDate (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
debWPortfAcquis (string)
mktOnOperations (string)
debitsWithOperators (string)
benefDepContrapIns (string)
eventClaimNetPres (string)
eventClaimNetSus (string)
otherDebOprWPlan (string)
otherDebitsToPay (string)
trimester (string)
hthCareServProv (string)
status (string)
billsChargesCollect (string)
central_de_obrigacoes___diops/activebalanceage_v1_100/post_active_balance_ageInclui o dado referente ao serviço Idade Do Saldo Ativo. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.financialDueDate (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. commitmentYear (string)
. financialDueDate (string)
. debWPortfAcquis (string)
. mktOnOperations (string)
. debitsWithOperators (string)
. benefDepContrapIns (string)
. eventClaimNetPres (string)
. eventClaimNetSus (string)
. otherDebOprWPlan (string)
. otherDebitsToPay (string)
. trimester (string)
. hthCareServProv (string)
. status (string)
. billsChargesCollect (string)
} (object) required
central_de_obrigacoes___diops/activebalanceage_v1_100/get_active_balance_age_by_financial_due_dateRetorna uma mensagem com o objeto do serviço Idade Do Saldo Ativo da entidade B8FT10financialDueDate (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/activebalanceage_v1_100/put_active_balance_age_by_financial_due_dateAltera o dado referente ao serviço Idade Do Saldo Ativo. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.financialDueDate (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. commitmentYear (string)
. financialDueDate (string)
. debWPortfAcquis (string)
. mktOnOperations (string)
. debitsWithOperators (string)
. benefDepContrapIns (string)
. eventClaimNetPres (string)
. eventClaimNetSus (string)
. otherDebOprWPlan (string)
. otherDebitsToPay (string)
. trimester (string)
. hthCareServProv (string)
. status (string)
. billsChargesCollect (string)
} (object) required
central_de_obrigacoes___diops/activebalanceage_v1_100/delete_active_balance_age_by_financial_due_dateExclui um registro referente ao serviço Idade Do Saldo Ativo. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.financialDueDate (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/ansaccountplan_v1_100/get_ans_account_planRetorna uma mensagem com a coleção de objetos do serviço Plano Contas Ans da entidade B8BT10accountCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
validityEndDate (string) required
validityStartDate (string) required
accountDescription (string)
central_de_obrigacoes___diops/ansaccountplan_v1_100/post_ans_account_planInclui o dado referente ao serviço Plano Contas Ans. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
providerRegister (string) required
validityEndDate (string) required
validityStartDate (string) required
data: {
. providerRegister (string)
. accountCode (string)
. validityEndDate (string)
. validityStartDate (string)
. accountDescription (string)
} (object) required
central_de_obrigacoes___diops/ansaccountplan_v1_100/get_ans_account_plan_by_account_codeRetorna uma mensagem com o objeto do serviço Plano Contas Ans da entidade B8BT10accountCode (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
validityEndDate (string) required
validityStartDate (string) required
central_de_obrigacoes___diops/ansaccountplan_v1_100/put_ans_account_plan_by_account_codeAltera o dado referente ao serviço Plano Contas Ans. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
providerRegister (string) required
validityEndDate (string) required
validityStartDate (string) required
data: {
. providerRegister (string)
. accountCode (string)
. validityEndDate (string)
. validityStartDate (string)
. accountDescription (string)
} (object) required
central_de_obrigacoes___diops/ansaccountplan_v1_100/delete_ans_account_plan_by_account_codeExclui um registro referente ao serviço Plano Contas Ans. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.accountCode (string)
Authorization (string) required
providerRegister (string) required
validityEndDate (string) required
validityStartDate (string) required
central_de_obrigacoes___diops/assistancecoverage_v1_100/get_assistance_coverageRetorna uma mensagem com a coleção de objetos do serviço Cobertura Assistencial da entidade B8IT10typeOfPlan (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
paymentOrigin (string) required
otherPayments (string)
trimester (string)
status (string)
therapies (string)
medicalAppointment (string)
otherExpenses (string)
examinations (string)
hospitalizations (string)
central_de_obrigacoes___diops/assistancecoverage_v1_100/post_assistance_coverageInclui o dado referente ao serviço Cobertura Assistencial. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.typeOfPlan (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
paymentOrigin (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. typeOfPlan (string)
. paymentOrigin (string)
. otherPayments (string)
. trimester (string)
. status (string)
. therapies (string)
. medicalAppointment (string)
. otherExpenses (string)
. examinations (string)
. hospitalizations (string)
} (object) required
central_de_obrigacoes___diops/assistancecoverage_v1_100/get_assistance_coverage_by_type_of_planRetorna uma mensagem com o objeto do serviço Cobertura Assistencial da entidade B8IT10typeOfPlan (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
paymentOrigin (string) required
central_de_obrigacoes___diops/assistancecoverage_v1_100/put_assistance_coverage_by_type_of_planAltera o dado referente ao serviço Cobertura Assistencial. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.typeOfPlan (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
paymentOrigin (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. typeOfPlan (string)
. paymentOrigin (string)
. otherPayments (string)
. trimester (string)
. status (string)
. therapies (string)
. medicalAppointment (string)
. otherExpenses (string)
. examinations (string)
. hospitalizations (string)
} (object) required
central_de_obrigacoes___diops/assistancecoverage_v1_100/delete_assistance_coverage_by_type_of_planExclui um registro referente ao serviço Cobertura Assistencial. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.typeOfPlan (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
paymentOrigin (string) required
central_de_obrigacoes___diops/capitalstandardmodel_v1_100/get_capital_standard_modelRetorna uma mensagem com a coleção de objetos do serviço Modelo Padrão De Capital da entidade B82T10commitmentCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
obligationCode (string) required
providerRegister (string) required
tempRemidNumber (string)
vitRemidNumber (string)
trimester (string)
tempExpSom (string)
vitExpSom (string)
tempRemisSom (string)
vitRemisSom (string)
status (string)
central_de_obrigacoes___diops/capitalstandardmodel_v1_100/post_capital_standard_modelInclui o dado referente ao serviço Modelo Padrão De Capital. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentCode (string)
Authorization (string) required
commitmentYear (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. tempRemidNumber (string)
. vitRemidNumber (string)
. trimester (string)
. tempExpSom (string)
. vitExpSom (string)
. tempRemisSom (string)
. vitRemisSom (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/capitalstandardmodel_v1_100/get_capital_standard_model_by_commitment_codeRetorna uma mensagem com o objeto do serviço Modelo Padrão De Capital da entidade B82T10commitmentCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/capitalstandardmodel_v1_100/put_capital_standard_model_by_commitment_codeAltera o dado referente ao serviço Modelo Padrão De Capital. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentCode (string)
Authorization (string) required
commitmentYear (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. tempRemidNumber (string)
. vitRemidNumber (string)
. trimester (string)
. tempExpSom (string)
. vitExpSom (string)
. tempRemisSom (string)
. vitRemisSom (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/capitalstandardmodel_v1_100/delete_capital_standard_model_by_commitment_codeExclui um registro referente ao serviço Modelo Padrão De Capital. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.commitmentCode (string)
Authorization (string) required
commitmentYear (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/cashflow_v1_100/get_cash_flowRetorna uma mensagem com a coleção de objetos do serviço Fluxo De Caixa da entidade B8HT10cashFlowCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
status (string) required
value (string)
trimester (string)
central_de_obrigacoes___diops/cashflow_v1_100/post_cash_flowInclui o dado referente ao serviço Fluxo De Caixa. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.cashFlowCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
status (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. cashFlowCode (string)
. obligationCode (string)
. providerRegister (string)
. status (string)
. value (string)
. trimester (string)
} (object) required
central_de_obrigacoes___diops/cashflow_v1_100/get_cash_flow_by_cash_flow_codeRetorna uma mensagem com o objeto do serviço Fluxo De Caixa da entidade B8HT10cashFlowCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
status (string) required
central_de_obrigacoes___diops/cashflow_v1_100/put_cash_flow_by_cash_flow_codeAltera o dado referente ao serviço Fluxo De Caixa. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.cashFlowCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
status (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. cashFlowCode (string)
. obligationCode (string)
. providerRegister (string)
. status (string)
. value (string)
. trimester (string)
} (object) required
central_de_obrigacoes___diops/cashflow_v1_100/delete_cash_flow_by_cash_flow_codeExclui um registro referente ao serviço Fluxo De Caixa. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.cashFlowCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
status (string) required
central_de_obrigacoes___diops/charts_v1_100/get_chartsRetorna uma mensagem com a coleção de objetos do serviço Quadros da entidade B8XT10diopsChart (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
chartReceived (string)
validateChart (string)
central_de_obrigacoes___diops/charts_v1_100/post_chartsInclui o dado referente ao serviço Quadros. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.diopsChart (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. diopsChart (string)
. chartReceived (string)
. validateChart (string)
} (object) required
central_de_obrigacoes___diops/charts_v1_100/get_charts_by_diops_chartRetorna uma mensagem com o objeto do serviço Quadros da entidade B8XT10diopsChart (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/charts_v1_100/put_charts_by_diops_chartAltera o dado referente ao serviço Quadros. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.diopsChart (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. diopsChart (string)
. chartReceived (string)
. validateChart (string)
} (object) required
central_de_obrigacoes___diops/charts_v1_100/delete_charts_by_diops_chartExclui um registro referente ao serviço Quadros. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.diopsChart (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/commitment_v1_100/get_commitmentRetorna uma mensagem com a coleção de objetos do serviço Compromissos da entidade B3DT10commitmentCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
obligationCode (string) required
providerRegister (string) required
referenceYear (string) required
obligationType (string) required
commitmentDueDate (string)
dueDateNotification (string)
trimester (string)
synthetizesBenefit (string)
status (string)
central_de_obrigacoes___diops/commitment_v1_100/post_commitmentInclui o dado referente ao serviço Compromissos. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentCode (string)
Authorization (string) required
obligationCode (string) required
providerRegister (string) required
referenceYear (string) required
obligationType (string) required
data: {
. obligationCode (string)
. commitmentCode (string)
. providerRegister (string)
. referenceYear (string)
. obligationType (string)
. commitmentDueDate (string)
. dueDateNotification (string)
. trimester (string)
. synthetizesBenefit (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/commitment_v1_100/get_commitment_by_commitment_codeRetorna uma mensagem com o objeto do serviço Compromissos da entidade B3DT10commitmentCode (string)
Authorization (string) required
expand (string)
fields (string)
obligationCode (string) required
providerRegister (string) required
referenceYear (string) required
obligationType (string) required
central_de_obrigacoes___diops/commitment_v1_100/put_commitment_by_commitment_codeAltera o dado referente ao serviço Compromissos. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentCode (string)
Authorization (string) required
obligationCode (string) required
providerRegister (string) required
referenceYear (string) required
obligationType (string) required
data: {
. obligationCode (string)
. commitmentCode (string)
. providerRegister (string)
. referenceYear (string)
. obligationType (string)
. commitmentDueDate (string)
. dueDateNotification (string)
. trimester (string)
. synthetizesBenefit (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/commitment_v1_100/delete_commitment_by_commitment_codeExclui um registro referente ao serviço Compromissos. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.commitmentCode (string)
Authorization (string) required
obligationCode (string) required
providerRegister (string) required
referenceYear (string) required
obligationType (string) required
central_de_obrigacoes___diops/commonfunds_v1_100/get_common_fundsRetorna uma mensagem com a coleção de objetos do serviço Fundos Comuns da entidade B6RT10fundType (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
cnpjOrFundAnsRec (string) required
obligationCode (string) required
providerRegister (string) required
fundName (string)
trimester (string)
creditBalanceOfFund (string)
debitorBalanceOfFund (string)
status (string)
central_de_obrigacoes___diops/commonfunds_v1_100/post_common_fundsInclui o dado referente ao serviço Fundos Comuns. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.fundType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
cnpjOrFundAnsRec (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. cnpjOrFundAnsRec (string)
. obligationCode (string)
. providerRegister (string)
. fundType (string)
. fundName (string)
. trimester (string)
. creditBalanceOfFund (string)
. debitorBalanceOfFund (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/commonfunds_v1_100/get_common_funds_by_fund_typeRetorna uma mensagem com o objeto do serviço Fundos Comuns da entidade B6RT10fundType (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
cnpjOrFundAnsRec (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/commonfunds_v1_100/put_common_funds_by_fund_typeAltera o dado referente ao serviço Fundos Comuns. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.fundType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
cnpjOrFundAnsRec (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. cnpjOrFundAnsRec (string)
. obligationCode (string)
. providerRegister (string)
. fundType (string)
. fundName (string)
. trimester (string)
. creditBalanceOfFund (string)
. debitorBalanceOfFund (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/commonfunds_v1_100/delete_common_funds_by_fund_typeExclui um registro referente ao serviço Fundos Comuns. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.fundType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
cnpjOrFundAnsRec (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/contractconsolidation_v1_100/get_contract_consolidationRetorna uma mensagem com a coleção de objetos do serviço Agrupamento Contratos da entidade B8KT10riskPool (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
pceCorresponGranted (string)
pceIssuedCounterprov (string)
eveClaimsKnownPce (string)
plaCorresponGranted (string)
issuedConsiderationsPla (string)
plaKnowlLossEvents (string)
trimester (string)
status (string)
central_de_obrigacoes___diops/contractconsolidation_v1_100/post_contract_consolidationInclui o dado referente ao serviço Agrupamento Contratos. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.riskPool (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. riskPool (string)
. pceCorresponGranted (string)
. pceIssuedCounterprov (string)
. eveClaimsKnownPce (string)
. plaCorresponGranted (string)
. issuedConsiderationsPla (string)
. plaKnowlLossEvents (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/contractconsolidation_v1_100/get_contract_consolidation_by_risk_poolRetorna uma mensagem com o objeto do serviço Agrupamento Contratos da entidade B8KT10riskPool (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/contractconsolidation_v1_100/put_contract_consolidation_by_risk_poolAltera o dado referente ao serviço Agrupamento Contratos. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.riskPool (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. riskPool (string)
. pceCorresponGranted (string)
. pceIssuedCounterprov (string)
. eveClaimsKnownPce (string)
. plaCorresponGranted (string)
. issuedConsiderationsPla (string)
. plaKnowlLossEvents (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/contractconsolidation_v1_100/delete_contract_consolidation_by_risk_poolExclui um registro referente ao serviço Agrupamento Contratos. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.riskPool (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/controlledaffiliates_v1_100/get_controlled_affiliatesRetorna uma mensagem com a coleção de objetos do serviço Controladas Coligadas da entidade B8TT10legalEntityNatRegister (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
quantityOfActions (string)
companyName (string)
totalOfActionsOrQuota (string)
typeOfShare (string)
companyClassification (string)
central_de_obrigacoes___diops/controlledaffiliates_v1_100/post_controlled_affiliatesInclui o dado referente ao serviço Controladas Coligadas. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
data: {
. legalEntityNatRegister (string)
. providerRegister (string)
. quantityOfActions (string)
. companyName (string)
. totalOfActionsOrQuota (string)
. typeOfShare (string)
. companyClassification (string)
} (object) required
central_de_obrigacoes___diops/controlledaffiliates_v1_100/get_controlled_affiliates_by_legal_entity_nat_registerRetorna uma mensagem com o objeto do serviço Controladas Coligadas da entidade B8TT10legalEntityNatRegister (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/controlledaffiliates_v1_100/put_controlled_affiliates_by_legal_entity_nat_registerAltera o dado referente ao serviço Controladas Coligadas. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
data: {
. legalEntityNatRegister (string)
. providerRegister (string)
. quantityOfActions (string)
. companyName (string)
. totalOfActionsOrQuota (string)
. typeOfShare (string)
. companyClassification (string)
} (object) required
central_de_obrigacoes___diops/controlledaffiliates_v1_100/delete_controlled_affiliates_by_legal_entity_nat_registerExclui um registro referente ao serviço Controladas Coligadas. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/coopercheckaccnt_v1_100/get_cooper_check_accntRetorna uma mensagem com a coleção de objetos do serviço Conta Corrente Cooperado da entidade BUWT10taxType (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
taxName (string) required
periodDate (string) required
commitmentYear (string) required
monetaryUpdate (string)
amtPaidTrimester (string)
totalAmtFinanced (string)
totalAmtPaid (string)
dateAdhesionToRefis (string)
numberOfInstallments (string)
numbDueInstallments (string)
numbOfPaidInstallm (string)
trimester (string)
trimesterFinalBalance (string)
trimesterInitialBalance (string)
status (string)
central_de_obrigacoes___diops/coopercheckaccnt_v1_100/post_cooper_check_accntInclui o dado referente ao serviço Conta Corrente Cooperado. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.taxType (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
taxName (string) required
periodDate (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. taxName (string)
. periodDate (string)
. taxType (string)
. commitmentYear (string)
. monetaryUpdate (string)
. amtPaidTrimester (string)
. totalAmtFinanced (string)
. totalAmtPaid (string)
. dateAdhesionToRefis (string)
. numberOfInstallments (string)
. numbDueInstallments (string)
. numbOfPaidInstallm (string)
. trimester (string)
. trimesterFinalBalance (string)
. trimesterInitialBalance (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/coopercheckaccnt_v1_100/get_cooper_check_accnt_by_tax_typeRetorna uma mensagem com o objeto do serviço Conta Corrente Cooperado da entidade BUWT10taxType (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
taxName (string) required
periodDate (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/coopercheckaccnt_v1_100/put_cooper_check_accnt_by_tax_typeAltera o dado referente ao serviço Conta Corrente Cooperado. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.taxType (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
taxName (string) required
periodDate (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. taxName (string)
. periodDate (string)
. taxType (string)
. commitmentYear (string)
. monetaryUpdate (string)
. amtPaidTrimester (string)
. totalAmtFinanced (string)
. totalAmtPaid (string)
. dateAdhesionToRefis (string)
. numberOfInstallments (string)
. numbDueInstallments (string)
. numbOfPaidInstallm (string)
. trimester (string)
. trimesterFinalBalance (string)
. trimesterInitialBalance (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/coopercheckaccnt_v1_100/delete_cooper_check_accnt_by_tax_typeExclui um registro referente ao serviço Conta Corrente Cooperado. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.taxType (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
taxName (string) required
periodDate (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/coresponsibilitygranted_v1_100/get_coresponsibility_grantedRetorna uma mensagem com a coleção de objetos do serviço Contrap Corresp Cedida da entidade B36T10ansEventCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string)
status (string)
amt1StMthTrimester (string)
amt2NdMthTrimester (string)
amt3RdMthTrimester (string)
central_de_obrigacoes___diops/coresponsibilitygranted_v1_100/post_coresponsibility_grantedInclui o dado referente ao serviço Contrap Corresp Cedida. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.ansEventCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. ansEventCode (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. amt1StMthTrimester (string)
. amt2NdMthTrimester (string)
. amt3RdMthTrimester (string)
} (object) required
central_de_obrigacoes___diops/coresponsibilitygranted_v1_100/get_coresponsibility_granted_by_ans_event_codeRetorna uma mensagem com o objeto do serviço Contrap Corresp Cedida da entidade B36T10ansEventCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/coresponsibilitygranted_v1_100/put_coresponsibility_granted_by_ans_event_codeAltera o dado referente ao serviço Contrap Corresp Cedida. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.ansEventCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. ansEventCode (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. amt1StMthTrimester (string)
. amt2NdMthTrimester (string)
. amt3RdMthTrimester (string)
} (object) required
central_de_obrigacoes___diops/coresponsibilitygranted_v1_100/delete_coresponsibility_granted_by_ans_event_codeExclui um registro referente ao serviço Contrap Corresp Cedida. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.ansEventCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/indemnifiableevents_v1_100/get_indemnifiable_eventsRetorna uma mensagem com a coleção de objetos do serviço Eventos Indenizaveis da entidade B8LT10eventCodeAns (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string)
status (string)
quarterMthFirstValue (string)
quarterMthSecValue (string)
quarterMthThirdValue (string)
central_de_obrigacoes___diops/indemnifiableevents_v1_100/post_indemnifiable_eventsInclui o dado referente ao serviço Eventos Indenizaveis. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.eventCodeAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. eventCodeAns (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. quarterMthFirstValue (string)
. quarterMthSecValue (string)
. quarterMthThirdValue (string)
} (object) required
central_de_obrigacoes___diops/indemnifiableevents_v1_100/get_indemnifiable_events_by_event_code_ansRetorna uma mensagem com o objeto do serviço Eventos Indenizaveis da entidade B8LT10eventCodeAns (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/indemnifiableevents_v1_100/put_indemnifiable_events_by_event_code_ansAltera o dado referente ao serviço Eventos Indenizaveis. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.eventCodeAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. eventCodeAns (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. quarterMthFirstValue (string)
. quarterMthSecValue (string)
. quarterMthThirdValue (string)
} (object) required
central_de_obrigacoes___diops/indemnifiableevents_v1_100/delete_indemnifiable_events_by_event_code_ansExclui um registro referente ao serviço Eventos Indenizaveis. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.eventCodeAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/liabilityadequationtest_v1_100/get_liability_adequation_testRetorna uma mensagem com a coleção de objetos do serviço Teste De Adequação Do Passivo da entidade B89T10planType (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
contractCancelRate (string)
biomTabAdjustment (string)
cashFlowAdjEstimation (string)
utiOfRangesRn632003 (string)
estimatedMedicalInflati (string)
ettjInterMethod (string)
averageAdjustmentPerVa (string)
estimatedMaximumAdjustm (string)
trimester (string)
status (string)
central_de_obrigacoes___diops/liabilityadequationtest_v1_100/post_liability_adequation_testInclui o dado referente ao serviço Teste De Adequação Do Passivo. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.planType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. planType (string)
. contractCancelRate (string)
. biomTabAdjustment (string)
. cashFlowAdjEstimation (string)
. utiOfRangesRn632003 (string)
. estimatedMedicalInflati (string)
. ettjInterMethod (string)
. averageAdjustmentPerVa (string)
. estimatedMaximumAdjustm (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/liabilityadequationtest_v1_100/get_liability_adequation_test_by_plan_typeRetorna uma mensagem com o objeto do serviço Teste De Adequação Do Passivo da entidade B89T10planType (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/liabilityadequationtest_v1_100/put_liability_adequation_test_by_plan_typeAltera o dado referente ao serviço Teste De Adequação Do Passivo. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.planType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. planType (string)
. contractCancelRate (string)
. biomTabAdjustment (string)
. cashFlowAdjEstimation (string)
. utiOfRangesRn632003 (string)
. estimatedMedicalInflati (string)
. ettjInterMethod (string)
. averageAdjustmentPerVa (string)
. estimatedMaximumAdjustm (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/liabilityadequationtest_v1_100/delete_liability_adequation_test_by_plan_typeExclui um registro referente ao serviço Teste De Adequação Do Passivo. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.planType (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/liabilitybalanceage_v1_100/get_liability_balance_ageRetorna uma mensagem com a coleção de objetos do serviço Idade Do Saldo Passivo da entidade B8GT10financialDueDate (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
collectiveFloating (string)
collectiveFixed (string)
beneficiariesOperationC (string)
postPaymentOperCredit (string)
individualFloating (string)
individualFixed (string)
prePaymentOperatorsCre (string)
otherCreditsWithPlan (string)
otherCredNotRelatPlan (string)
partBenefInEveClaim (string)
trimester (string)
status (string)
central_de_obrigacoes___diops/liabilitybalanceage_v1_100/post_liability_balance_ageInclui o dado referente ao serviço Idade Do Saldo Passivo. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.financialDueDate (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. financialDueDate (string)
. collectiveFloating (string)
. collectiveFixed (string)
. beneficiariesOperationC (string)
. postPaymentOperCredit (string)
. individualFloating (string)
. individualFixed (string)
. prePaymentOperatorsCre (string)
. otherCreditsWithPlan (string)
. otherCredNotRelatPlan (string)
. partBenefInEveClaim (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/liabilitybalanceage_v1_100/get_liability_balance_age_by_financial_due_dateRetorna uma mensagem com o objeto do serviço Idade Do Saldo Passivo da entidade B8GT10financialDueDate (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/liabilitybalanceage_v1_100/put_liability_balance_age_by_financial_due_dateAltera o dado referente ao serviço Idade Do Saldo Passivo. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.financialDueDate (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. financialDueDate (string)
. collectiveFloating (string)
. collectiveFixed (string)
. beneficiariesOperationC (string)
. postPaymentOperCredit (string)
. individualFloating (string)
. individualFixed (string)
. prePaymentOperatorsCre (string)
. otherCreditsWithPlan (string)
. otherCredNotRelatPlan (string)
. partBenefInEveClaim (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/liabilitybalanceage_v1_100/delete_liability_balance_age_by_financial_due_dateExclui um registro referente ao serviço Idade Do Saldo Passivo. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.financialDueDate (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/get_liability_tax_accntRetorna uma mensagem com a coleção de objetos do serviço Conta Tributo Passivo da entidade BUYT10accountCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
monetaryUpdate (string)
competenceDate (string)
trimester (string)
balanceAtTheEndOfThe (string)
status (string)
initialValue (string)
valuePaid (string)
central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/post_liability_tax_accntInclui o dado referente ao serviço Conta Tributo Passivo. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. commitmentYear (string)
. monetaryUpdate (string)
. competenceDate (string)
. trimester (string)
. balanceAtTheEndOfThe (string)
. status (string)
. initialValue (string)
. valuePaid (string)
} (object) required
central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/get_liability_tax_accnt_by_account_codeRetorna uma mensagem com o objeto do serviço Conta Tributo Passivo da entidade BUYT10accountCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/put_liability_tax_accnt_by_account_codeAltera o dado referente ao serviço Conta Tributo Passivo. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. commitmentYear (string)
. monetaryUpdate (string)
. competenceDate (string)
. trimester (string)
. balanceAtTheEndOfThe (string)
. status (string)
. initialValue (string)
. valuePaid (string)
} (object) required
central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/delete_liability_tax_accnt_by_account_codeExclui um registro referente ao serviço Conta Tributo Passivo. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.accountCode (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/listofcities_v1_100/get_list_of_citiesRetorna uma mensagem com a coleção de objetos do serviço Lista De Municipios da entidade B8WT10stateAcronym (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
ibgeCityCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/listofcities_v1_100/post_list_of_citiesInclui o dado referente ao serviço Lista De Municipios. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.stateAcronym (string)
Authorization (string) required
ibgeCityCode (string) required
providerRegister (string) required
data: {
. ibgeCityCode (string)
. providerRegister (string)
. stateAcronym (string)
} (object) required
central_de_obrigacoes___diops/listofcities_v1_100/get_list_of_cities_by_state_acronymRetorna uma mensagem com o objeto do serviço Lista De Municipios da entidade B8WT10stateAcronym (string)
Authorization (string) required
expand (string)
fields (string)
ibgeCityCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/listofcities_v1_100/put_list_of_cities_by_state_acronymAltera o dado referente ao serviço Lista De Municipios. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.stateAcronym (string)
Authorization (string) required
ibgeCityCode (string) required
providerRegister (string) required
data: {
. ibgeCityCode (string)
. providerRegister (string)
. stateAcronym (string)
} (object) required
central_de_obrigacoes___diops/listofcities_v1_100/delete_list_of_cities_by_state_acronymExclui um registro referente ao serviço Lista De Municipios. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.stateAcronym (string)
Authorization (string) required
ibgeCityCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/obligations_v1_100/get_obligationsRetorna uma mensagem com a coleção de objetos do serviço Obrigacoes da entidade B3AT10obligationCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
obligationDescription (string)
seasonality (string)
obligationType (string)
activeInactive (string)
dueDateNotification (string)
central_de_obrigacoes___diops/obligations_v1_100/post_obligationsInclui o dado referente ao serviço Obrigacoes. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.obligationCode (string)
Authorization (string) required
providerRegister (string) required
data: {
. obligationCode (string)
. providerRegister (string)
. obligationDescription (string)
. seasonality (string)
. obligationType (string)
. activeInactive (string)
. dueDateNotification (string)
} (object) required
central_de_obrigacoes___diops/obligations_v1_100/get_obligations_by_obligation_codeRetorna uma mensagem com o objeto do serviço Obrigacoes da entidade B3AT10obligationCode (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/obligations_v1_100/put_obligations_by_obligation_codeAltera o dado referente ao serviço Obrigacoes. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.obligationCode (string)
Authorization (string) required
providerRegister (string) required
data: {
. obligationCode (string)
. providerRegister (string)
. obligationDescription (string)
. seasonality (string)
. obligationType (string)
. activeInactive (string)
. dueDateNotification (string)
} (object) required
central_de_obrigacoes___diops/obligations_v1_100/delete_obligations_by_obligation_codeExclui um registro referente ao serviço Obrigacoes. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.obligationCode (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/operators_v1_100/get_operatorsRetorna uma mensagem com a coleção de objetos do serviço Operadoras da entidade B8MT10operatorCnpj (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
operatorMode (string)
legalNature (string)
tradeName (string)
corporateName (string)
operatorSegmentation (string)
central_de_obrigacoes___diops/operators_v1_100/post_operatorsInclui o dado referente ao serviço Operadoras. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.operatorCnpj (string)
Authorization (string) required
providerRegister (string) required
data: {
. operatorCnpj (string)
. providerRegister (string)
. operatorMode (string)
. legalNature (string)
. tradeName (string)
. corporateName (string)
. operatorSegmentation (string)
} (object) required
central_de_obrigacoes___diops/operators_v1_100/get_operators_by_operator_cnpjRetorna uma mensagem com o objeto do serviço Operadoras da entidade B8MT10operatorCnpj (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/operators_v1_100/put_operators_by_operator_cnpjAltera o dado referente ao serviço Operadoras. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.operatorCnpj (string)
Authorization (string) required
providerRegister (string) required
data: {
. operatorCnpj (string)
. providerRegister (string)
. operatorMode (string)
. legalNature (string)
. tradeName (string)
. corporateName (string)
. operatorSegmentation (string)
} (object) required
central_de_obrigacoes___diops/operators_v1_100/delete_operators_by_operator_cnpjExclui um registro referente ao serviço Operadoras. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.operatorCnpj (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/get_pecuniary_considerationRetorna uma mensagem com a coleção de objetos do serviço Contraprestaes Pecunirias da entidade B37T10counterpartCoveragePeri (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
planType (string) required
commitmentYear (string) required
valueToExpire (string)
receivedValue (string)
trimester (string)
status (string)
dueValueInArrears (string)
netIssuedValue (string)
central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/post_pecuniary_considerationInclui o dado referente ao serviço Contraprestaes Pecunirias. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.counterpartCoveragePeri (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
planType (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. counterpartCoveragePeri (string)
. planType (string)
. commitmentYear (string)
. valueToExpire (string)
. receivedValue (string)
. trimester (string)
. status (string)
. dueValueInArrears (string)
. netIssuedValue (string)
} (object) required
central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/get_pecuniary_consideration_by_counterpart_coverage_periRetorna uma mensagem com o objeto do serviço Contraprestaes Pecunirias da entidade B37T10counterpartCoveragePeri (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
planType (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/put_pecuniary_consideration_by_counterpart_coverage_periAltera o dado referente ao serviço Contraprestaes Pecunirias. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.counterpartCoveragePeri (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
planType (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. counterpartCoveragePeri (string)
. planType (string)
. commitmentYear (string)
. valueToExpire (string)
. receivedValue (string)
. trimester (string)
. status (string)
. dueValueInArrears (string)
. netIssuedValue (string)
} (object) required
central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/delete_pecuniary_consideration_by_counterpart_coverage_periExclui um registro referente ao serviço Contraprestaes Pecunirias. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.counterpartCoveragePeri (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
planType (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/personsresponsible_v1_100/get_persons_responsibleRetorna uma mensagem com a coleção de objetos do serviço Responsaveis da entidade B8YT10responsibilityType (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
cpfCnpj (string) required
responsibleLeOrIndivid (string) required
nameCorporateName (string)
recordNumber (string)
central_de_obrigacoes___diops/personsresponsible_v1_100/post_persons_responsibleInclui o dado referente ao serviço Responsaveis. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.responsibilityType (string)
Authorization (string) required
providerRegister (string) required
cpfCnpj (string) required
responsibleLeOrIndivid (string) required
data: {
. providerRegister (string)
. cpfCnpj (string)
. responsibleLeOrIndivid (string)
. responsibilityType (string)
. nameCorporateName (string)
. recordNumber (string)
} (object) required
central_de_obrigacoes___diops/personsresponsible_v1_100/get_persons_responsible_by_responsibility_typeRetorna uma mensagem com o objeto do serviço Responsaveis da entidade B8YT10responsibilityType (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
cpfCnpj (string) required
responsibleLeOrIndivid (string) required
central_de_obrigacoes___diops/personsresponsible_v1_100/put_persons_responsible_by_responsibility_typeAltera o dado referente ao serviço Responsaveis. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.responsibilityType (string)
Authorization (string) required
providerRegister (string) required
cpfCnpj (string) required
responsibleLeOrIndivid (string) required
data: {
. providerRegister (string)
. cpfCnpj (string)
. responsibleLeOrIndivid (string)
. responsibilityType (string)
. nameCorporateName (string)
. recordNumber (string)
} (object) required
central_de_obrigacoes___diops/personsresponsible_v1_100/delete_persons_responsible_by_responsibility_typeExclui um registro referente ao serviço Responsaveis. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.responsibilityType (string)
Authorization (string) required
providerRegister (string) required
cpfCnpj (string) required
responsibleLeOrIndivid (string) required
central_de_obrigacoes___diops/premises_v1_100/get_premisesRetorna uma mensagem com a coleção de objetos do serviço Dependencias da entidade B8ZT10legalEntityNatRegister (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
postAddrCode (string)
longDistanceCode (string)
internationalCallinfCd (string)
district (string)
ibgeCityCode (string)
addressComplement (string)
eMail (string)
addressName (string)
corporateName (string)
addressNumber (string)
extensionLine (string)
stateAcronym (string)
telephoneNumber (string)
dependenceType (string)
central_de_obrigacoes___diops/premises_v1_100/post_premisesInclui o dado referente ao serviço Dependencias. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
data: {
. providerRegister (string)
. legalEntityNatRegister (string)
. postAddrCode (string)
. longDistanceCode (string)
. internationalCallinfCd (string)
. district (string)
. ibgeCityCode (string)
. addressComplement (string)
. eMail (string)
. addressName (string)
. corporateName (string)
. addressNumber (string)
. extensionLine (string)
. stateAcronym (string)
. telephoneNumber (string)
. dependenceType (string)
} (object) required
central_de_obrigacoes___diops/premises_v1_100/get_premises_by_legal_entity_nat_registerRetorna uma mensagem com o objeto do serviço Dependencias da entidade B8ZT10legalEntityNatRegister (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/premises_v1_100/put_premises_by_legal_entity_nat_registerAltera o dado referente ao serviço Dependencias. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
data: {
. providerRegister (string)
. legalEntityNatRegister (string)
. postAddrCode (string)
. longDistanceCode (string)
. internationalCallinfCd (string)
. district (string)
. ibgeCityCode (string)
. addressComplement (string)
. eMail (string)
. addressName (string)
. corporateName (string)
. addressNumber (string)
. extensionLine (string)
. stateAcronym (string)
. telephoneNumber (string)
. dependenceType (string)
} (object) required
central_de_obrigacoes___diops/premises_v1_100/delete_premises_by_legal_entity_nat_registerExclui um registro referente ao serviço Dependencias. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.legalEntityNatRegister (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/profitsandlosses_v1_100/get_profits_and_lossesRetorna uma mensagem com a coleção de objetos do serviço Lucros E Prejuizos da entidade B8ET10accountCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
description (string)
trimester (string)
status (string)
accountingValue (string)
central_de_obrigacoes___diops/profitsandlosses_v1_100/post_profits_and_lossesInclui o dado referente ao serviço Lucros E Prejuizos. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. description (string)
. trimester (string)
. status (string)
. accountingValue (string)
} (object) required
central_de_obrigacoes___diops/profitsandlosses_v1_100/get_profits_and_losses_by_account_codeRetorna uma mensagem com o objeto do serviço Lucros E Prejuizos da entidade B8ET10accountCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/profitsandlosses_v1_100/put_profits_and_losses_by_account_codeAltera o dado referente ao serviço Lucros E Prejuizos. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. description (string)
. trimester (string)
. status (string)
. accountingValue (string)
} (object) required
central_de_obrigacoes___diops/profitsandlosses_v1_100/delete_profits_and_losses_by_account_codeExclui um registro referente ao serviço Lucros E Prejuizos. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/provnetsinevpesl_v1_100/get_prov_net_sin_ev_peslRetorna uma mensagem com a coleção de objetos do serviço Prov Eventos Sinistros a Liq da entidade B8JT10commitmentYear (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
evCorrAssumMajorPer (string)
lastDaysAssumCorrEv (string)
greaterDangerLossEvent (string)
latestDaysEvents (string)
noOfBeneficiaries (string)
trimester (string)
status (string)
central_de_obrigacoes___diops/provnetsinevpesl_v1_100/post_prov_net_sin_ev_peslInclui o dado referente ao serviço Prov Eventos Sinistros a Liq. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentYear (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. commitmentYear (string)
. evCorrAssumMajorPer (string)
. lastDaysAssumCorrEv (string)
. greaterDangerLossEvent (string)
. latestDaysEvents (string)
. noOfBeneficiaries (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/provnetsinevpesl_v1_100/get_prov_net_sin_ev_pesl_by_commitment_yearRetorna uma mensagem com o objeto do serviço Prov Eventos Sinistros a Liq da entidade B8JT10commitmentYear (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/provnetsinevpesl_v1_100/put_prov_net_sin_ev_pesl_by_commitment_yearAltera o dado referente ao serviço Prov Eventos Sinistros a Liq. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.commitmentYear (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. commitmentYear (string)
. evCorrAssumMajorPer (string)
. lastDaysAssumCorrEv (string)
. greaterDangerLossEvent (string)
. latestDaysEvents (string)
. noOfBeneficiaries (string)
. trimester (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/provnetsinevpesl_v1_100/delete_prov_net_sin_ev_pesl_by_commitment_yearExclui um registro referente ao serviço Prov Eventos Sinistros a Liq. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.commitmentYear (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/realestgarasset_v1_100/get_real_est_gar_assetRetorna uma mensagem com a coleção de objetos do serviço Atv Gar Imobiliario da entidade B8CT10providerRegister (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
realEstateGeneralRegis (string) required
commitmentYear (string) required
assitance (string)
ownNetwork (string)
trimester (string)
status (string)
validityEndDate (string)
validityStartDate (string)
accountingValue (string)
central_de_obrigacoes___diops/realestgarasset_v1_100/post_real_est_gar_assetInclui o dado referente ao serviço Atv Gar Imobiliario. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.providerRegister (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
realEstateGeneralRegis (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. realEstateGeneralRegis (string)
. commitmentYear (string)
. assitance (string)
. ownNetwork (string)
. trimester (string)
. status (string)
. validityEndDate (string)
. validityStartDate (string)
. accountingValue (string)
} (object) required
central_de_obrigacoes___diops/realestgarasset_v1_100/get_real_est_gar_asset_by_provider_registerRetorna uma mensagem com o objeto do serviço Atv Gar Imobiliario da entidade B8CT10providerRegister (string)
Authorization (string) required
expand (string)
fields (string)
commitmentCode (string) required
obligationCode (string) required
realEstateGeneralRegis (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/realestgarasset_v1_100/put_real_est_gar_asset_by_provider_registerAltera o dado referente ao serviço Atv Gar Imobiliario. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.providerRegister (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
realEstateGeneralRegis (string) required
commitmentYear (string) required
data: {
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. realEstateGeneralRegis (string)
. commitmentYear (string)
. assitance (string)
. ownNetwork (string)
. trimester (string)
. status (string)
. validityEndDate (string)
. validityStartDate (string)
. accountingValue (string)
} (object) required
central_de_obrigacoes___diops/realestgarasset_v1_100/delete_real_est_gar_asset_by_provider_registerExclui um registro referente ao serviço Atv Gar Imobiliario. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.providerRegister (string)
Authorization (string) required
commitmentCode (string) required
obligationCode (string) required
realEstateGeneralRegis (string) required
commitmentYear (string) required
central_de_obrigacoes___diops/representatives_v1_100/get_representativesRetorna uma mensagem com a coleção de objetos do serviço Representatives da entidade B8NT10registrationOfIndividua (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
addressComplement (string)
district (string)
representativeSPosition (string)
ibgeCityCode (string)
postAddrCode (string)
nationalCallingCd (string)
internationalCallinfCd (string)
idIssueDate (string)
addressName (string)
representativeSName (string)
idNumber (string)
addressNumber (string)
idIssuingBody (string)
country (string)
extension (string)
stateAcronym (string)
telephoneNumber (string)
central_de_obrigacoes___diops/representatives_v1_100/post_representativesInclui o dado referente ao serviço Representantes. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.registrationOfIndividua (string)
Authorization (string) required
providerRegister (string) required
data: {
. registrationOfIndividua (string)
. providerRegister (string)
. addressComplement (string)
. district (string)
. representativeSPosition (string)
. ibgeCityCode (string)
. postAddrCode (string)
. nationalCallingCd (string)
. internationalCallinfCd (string)
. idIssueDate (string)
. addressName (string)
. representativeSName (string)
. idNumber (string)
. addressNumber (string)
. idIssuingBody (string)
. country (string)
. extension (string)
. stateAcronym (string)
. telephoneNumber (string)
} (object) required
central_de_obrigacoes___diops/representatives_v1_100/get_representatives_by_registration_of_individuaRetorna uma mensagem com o objeto do serviço Representantes da entidade B8NT10registrationOfIndividua (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/representatives_v1_100/put_representatives_by_registration_of_individuaAltera o dado referente ao serviço Representantes. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.registrationOfIndividua (string)
Authorization (string) required
providerRegister (string) required
data: {
. registrationOfIndividua (string)
. providerRegister (string)
. addressComplement (string)
. district (string)
. representativeSPosition (string)
. ibgeCityCode (string)
. postAddrCode (string)
. nationalCallingCd (string)
. internationalCallinfCd (string)
. idIssueDate (string)
. addressName (string)
. representativeSName (string)
. idNumber (string)
. addressNumber (string)
. idIssuingBody (string)
. country (string)
. extension (string)
. stateAcronym (string)
. telephoneNumber (string)
} (object) required
central_de_obrigacoes___diops/representatives_v1_100/delete_representatives_by_registration_of_individuaExclui um registro referente ao serviço Representantes. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.registrationOfIndividua (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/shareholders_v1_100/get_shareholdersRetorna uma mensagem com a coleção de objetos do serviço Acionistas Quotistas da entidade B8ST10shareholderSCpfCnpj (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
providerRegister (string) required
corporateName (string)
numberOfShares (string)
shareholderType (string)
central_de_obrigacoes___diops/shareholders_v1_100/post_shareholdersInclui o dado referente ao serviço Acionistas Quotistas. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.shareholderSCpfCnpj (string)
Authorization (string) required
providerRegister (string) required
data: {
. providerRegister (string)
. shareholderSCpfCnpj (string)
. corporateName (string)
. numberOfShares (string)
. shareholderType (string)
} (object) required
central_de_obrigacoes___diops/shareholders_v1_100/get_shareholders_by_shareholder_scpf_cnpjRetorna uma mensagem com o objeto do serviço Acionistas Quotistas da entidade B8ST10shareholderSCpfCnpj (string)
Authorization (string) required
expand (string)
fields (string)
providerRegister (string) required
central_de_obrigacoes___diops/shareholders_v1_100/put_shareholders_by_shareholder_scpf_cnpjAltera o dado referente ao serviço Acionistas Quotistas. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.shareholderSCpfCnpj (string)
Authorization (string) required
providerRegister (string) required
data: {
. providerRegister (string)
. shareholderSCpfCnpj (string)
. corporateName (string)
. numberOfShares (string)
. shareholderType (string)
} (object) required
central_de_obrigacoes___diops/shareholders_v1_100/delete_shareholders_by_shareholder_scpf_cnpjExclui um registro referente ao serviço Acionistas Quotistas. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.shareholderSCpfCnpj (string)
Authorization (string) required
providerRegister (string) required
central_de_obrigacoes___diops/stipulatedcontracts_v1_100/get_stipulated_contractsRetorna uma mensagem com a coleção de objetos do serviço Contratos Estipulados da entidade BUPT10operatorRecordInAns (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string) required
status (string)
billingValue (string)
central_de_obrigacoes___diops/stipulatedcontracts_v1_100/post_stipulated_contractsInclui o dado referente ao serviço Contratos Estipulados. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.operatorRecordInAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. operatorRecordInAns (string)
. trimester (string)
. status (string)
. billingValue (string)
} (object) required
central_de_obrigacoes___diops/stipulatedcontracts_v1_100/get_stipulated_contracts_by_operator_record_in_ansRetorna uma mensagem com o objeto do serviço Contratos Estipulados da entidade BUPT10operatorRecordInAns (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string) required
central_de_obrigacoes___diops/stipulatedcontracts_v1_100/put_stipulated_contracts_by_operator_record_in_ansAltera o dado referente ao serviço Contratos Estipulados. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.operatorRecordInAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. operatorRecordInAns (string)
. trimester (string)
. status (string)
. billingValue (string)
} (object) required
central_de_obrigacoes___diops/stipulatedcontracts_v1_100/delete_stipulated_contracts_by_operator_record_in_ansExclui um registro referente ao serviço Contratos Estipulados. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.operatorRecordInAns (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string) required
central_de_obrigacoes___diops/transcontramtsegr_v1_100/get_trans_contr_amt_segrRetorna uma mensagem com a coleção de objetos do serviço Segregação do Montante de Contraprestações a Repassar da entidade BVST10benefitAdmOperCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
trimester (string)
status (string)
amt1StMthTrimester (string)
amt2NdMthTrimester (string)
amt3RdMthTrimester (string)
central_de_obrigacoes___diops/transcontramtsegr_v1_100/post_trans_contr_amt_segrInclui o dado referente ao serviço Segregação do Montante de Contraprestações a Repassar. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.benefitAdmOperCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. benefitAdmOperCode (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. amt1StMthTrimester (string)
. amt2NdMthTrimester (string)
. amt3RdMthTrimester (string)
} (object) required
central_de_obrigacoes___diops/transcontramtsegr_v1_100/get_trans_contr_amt_segr_by_benefit_adm_oper_codeRetorna uma mensagem com o objeto do serviço Segregação do Montante de Contraprestações a Repassar da entidade BVST10benefitAdmOperCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/transcontramtsegr_v1_100/put_trans_contr_amt_segr_by_benefit_adm_oper_codeAltera o dado referente ao serviço Segregação do Montante de Contraprestações a Repassar. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.benefitAdmOperCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. benefitAdmOperCode (string)
. obligationCode (string)
. providerRegister (string)
. trimester (string)
. status (string)
. amt1StMthTrimester (string)
. amt2NdMthTrimester (string)
. amt3RdMthTrimester (string)
} (object) required
central_de_obrigacoes___diops/transcontramtsegr_v1_100/delete_trans_contr_amt_segr_by_benefit_adm_oper_codeExclui um registro referente ao serviço Segregação do Montante de Contraprestações a Repassar. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.benefitAdmOperCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/get_trimester_balance_sheetRetorna uma mensagem com a coleção de objetos do serviço Balancete Trimestral da entidade B8AT10accountCode (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
credits (string)
debits (string)
trimester (string)
previousBalance (string)
finalBalance (string)
status (string)
central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/post_trimester_balance_sheetInclui o dado referente ao serviço Balancete Trimestral. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. credits (string)
. debits (string)
. trimester (string)
. previousBalance (string)
. finalBalance (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/get_trimester_balance_sheet_by_account_codeRetorna uma mensagem com o objeto do serviço Balancete Trimestral da entidade B8AT10accountCode (string)
Authorization (string) required
expand (string)
fields (string)
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/put_trimester_balance_sheet_by_account_codeAltera o dado referente ao serviço Balancete Trimestral. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
data: {
. commitmentYear (string)
. commitmentCode (string)
. obligationCode (string)
. providerRegister (string)
. accountCode (string)
. credits (string)
. debits (string)
. trimester (string)
. previousBalance (string)
. finalBalance (string)
. status (string)
} (object) required
central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/delete_trimester_balance_sheet_by_account_codeExclui um registro referente ao serviço Balancete Trimestral. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.accountCode (string)
Authorization (string) required
commitmentYear (string) required
commitmentCode (string) required
obligationCode (string) required
providerRegister (string) required
central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/get_analytic_dmed_expensesRetorna uma mensagem com a coleção de objetos do serviço Analytic Dmed Expenses da entidade Analytic Dmed ExpensesexpenseKey (string)
page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
healthInsurerCode (string) required
ssnHolder (string) required
titleHolderEnrollment (string) required
holderName (string) required
dependentSsn (string) required
dependentEnrollment (string) required
dependentName (string) required
dependentBirthDate (string) required
dependenceRelationships (string) required
expenseAmount (string) required
refundAmount (string) required
previousYearRefundAmt (string) required
expenseType (string) required
period (string) required
providerSsnEin (string) required
central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/post_analytic_dmed_expensesInclui o dado referente ao serviço Analytic Dmed Expenses. Ao realizar a inclusao de um registro, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada, e um Body com o objeto Json.expenseKey (string)
Authorization (string) required
healthInsurerCode (string) required
ssnHolder (string) required
titleHolderEnrollment (string) required
dependentSsn (string) required
dependentEnrollment (string) required
period (string) required
data: {
. healthInsurerCode (string)
. ssnHolder (string)
. titleHolderEnrollment (string)
. holderName (string)
. dependentSsn (string)
. dependentEnrollment (string)
. dependentName (string)
. dependentBirthDate (string)
. dependenceRelationships (string)
. expenseKey (string)
. expenseAmount (string)
. refundAmount (string)
. previousYearRefundAmt (string)
. expenseType (string)
. period (string)
. providerSsnEin (string)
} (object) required
central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/get_analytic_dmed_expenses_by_expense_keyRetorna uma mensagem com o objeto do serviço Analytic Dmed Expenses da entidade Analytic Dmed ExpensesexpenseKey (string)
Authorization (string) required
expand (string)
fields (string)
healthInsurerCode (string) required
ssnHolder (string) required
titleHolderEnrollment (string) required
dependentSsn (string) required
dependentEnrollment (string) required
period (string) required
central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/put_analytic_dmed_expenses_by_expense_keyAltera o dado referente ao serviço Analytic Dmed Expenses. Ao realizar a alteracao de um registro, o endpoint irá responder com codigo 200 indicando que a requisicao foi adicionada, e um Body com o objeto Json.expenseKey (string)
Authorization (string) required
healthInsurerCode (string) required
ssnHolder (string) required
titleHolderEnrollment (string) required
dependentSsn (string) required
dependentEnrollment (string) required
period (string) required
data: {
. healthInsurerCode (string)
. ssnHolder (string)
. titleHolderEnrollment (string)
. holderName (string)
. dependentSsn (string)
. dependentEnrollment (string)
. dependentName (string)
. dependentBirthDate (string)
. dependenceRelationships (string)
. expenseKey (string)
. expenseAmount (string)
. refundAmount (string)
. previousYearRefundAmt (string)
. expenseType (string)
. period (string)
. providerSsnEin (string)
} (object) required
central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/delete_analytic_dmed_expenses_by_expense_keyExclui um registro referente ao serviço Analytic Dmed Expenses. Ao realizar a deleção de um registro, o endpoint irá responder com codigo 204 indicando que a requisicao foi processada corretamente.expenseKey (string)
Authorization (string) required
healthInsurerCode (string) required
ssnHolder (string) required
titleHolderEnrollment (string) required
dependentSsn (string) required
dependentEnrollment (string) required
period (string) required
logix/approvalprofile_v1_000/get_supply_approval_profile_infoRetorna lista completa de Perfis de Aprovação.Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
logix/approvalprofile_v1_000/post_supply_approval_profile_infoInclui um Perfil de Aprovador conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. companyInternalId (string)
. branchId (string)
. InternalId (string)
. code (string)
. descriptionProfile (string)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. approveLimitApprover (number)
. typeProfile (string)
. currencyProfileApprove (number)
. expenseTypeInitial (number)
. expenseTypeEnd (number)
. version (number)
. situation (string)
} (object) required
logix/approvalprofile_v1_000/get_supply_approval_profile_info_by_codeRetorna um Perfil de Aprovadorcode (string)
Authorization (string) required
order (array)
fields (string)
logix/approvalprofile_v1_000/put_supply_approval_profile_info_by_codeAtualiza o Vlr. Minimo e Vlr. Maximo do Perfil de Aprovador conforme dados enviados na requisição.code (string)
Authorization (string) required
fields (string)
data: {
. companyInternalId (string)
. branchId (string)
. InternalId (string)
. code (string)
. descriptionProfile (string)
. approveValueLimitMin (number)
. approveValueLimitMax (number)
. approveLimitApprover (number)
. typeProfile (string)
. currencyProfileApprove (number)
. expenseTypeInitial (number)
. expenseTypeEnd (number)
. version (number)
. situation (string)
} (object) required
logix/approvalprofile_v1_000/delete_supply_approval_profile_info_by_codeExclui um Perfil de Aprovação conforme dados enviados na requisição.code (string)
Authorization (string) required
logix/approvalprofile_v2_000/get_approval_profileRetorna lista completa de Perfis de Aprovação.Authorization (string) required
order (array)
fields (string)
page (integer)
pageSize (integer)
companyInternalId (string)
approveValueLimitMin (number)
approveValueLimitMax (number)
currencyProfileApprove (number)
expenseTypeInitial (number)
expenseTypeEnd (number)
version (number)
situation (string)
logix/approvalprofile_v2_000/post_approval_profileInclui um Perfil de Aprovador conforme dados enviados na requisição.Authorization (string) required
fields (string)
data (object) required
logix/approvalprofile_v2_000/get_approval_profile_by_codeRetorna um Perfil de Aprovadorcode (string)
Authorization (string) required
order (array)
fields (string)
logix/approvalprofile_v2_000/put_approval_profile_by_codeAltera o Perfil de Aprovaçãocode (string)
Authorization (string) required
fields (string)
data (object) required
logix/approvalprofile_v2_000/delete_approval_profile_by_codeExclui um Perfil de Aprovação conforme dados enviados na requisição.code (string)
Authorization (string) required
logix/buyers_v1_000/get_buyersRetorna todos os Compradores do sistemaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/buyers_v1_000/post_buyersAdiciona Comprador passado na requisiçãoAuthorization (string) required
data (object) required
logix/buyers_v1_000/get_buyers_by_buyer_idRetorna o Comprador do sistema através de seu códigoBuyerId (string)
fields (string)
Authorization (string) required
logix/buyers_v1_000/put_buyers_by_buyer_idAltera o comprador passado na requisiçãoBuyerId (string)
Authorization (string) required
data (undefined) required
logix/buyers_v1_000/delete_buyers_by_buyer_idExclusão de Comprador da baseBuyerId (string)
Authorization (string) required
logix/city_v1_000/get_cityRetorna lista completa de cidadesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
logix/city_v1_000/post_cityInclui uma cidade conforme dados enviados na requisição.Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Type (string)
. OfficialCode (string)
. Description (string)
. IATANumber (string)
. FederalUnit (string)
. CountryCode (string)
. Situation (string)
} (object) required
logix/city_v1_000/get_city_by_internal_idRetorna os dados da cidade conforme o código informado na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
logix/city_v1_000/put_city_by_internal_idAtualiza cadastro da cidade conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Type (string)
. OfficialCode (string)
. Description (string)
. IATANumber (string)
. FederalUnit (string)
. CountryCode (string)
. Situation (string)
} (object) required
logix/city_v1_000/delete_city_by_internal_idExclui cadastro de cidade conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
logix/country_v1_000/get_countriesRetorna lista completa de paísesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
logix/country_v1_000/post_countriesInclui um novo País conforme dados enviados na requisição.Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
} (object) required
logix/country_v1_000/get_countries_by_internal_idRetorna os dados do País conforme o código informado na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
logix/country_v1_000/put_countries_by_internal_idAtualiza cadastro do País conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
} (object) required
logix/country_v1_000/delete_countries_by_internal_idExclui cadastro do País conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
logix/currency_v1_000/get_currencyRetorna lista completa de moedaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/currency_v1_000/post_currencyInclui MoedaAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Symbol (string)
. DecimalPlaces (integer)
. Situation (string)
} (object) required
logix/currency_v1_000/get_currency_by_codeRetorna Moeda pelo seu códigoCode (string)
Authorization (string) required
logix/currency_v1_000/put_currency_by_codeAtualiza cadastro de Moeda conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. Symbol (string)
. DecimalPlaces (integer)
. Situation (string)
} (object) required
logix/currency_v1_000/delete_currency_by_codeExclui Moeda conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
logix/esocialaudit_v1_000/post_esocial_auditInclui a entidade evento passado na requisiçãocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
data (object) required
logix/esocialaudit_v1_000/get_esocial_audit_statusRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
logix/esocialaudit_v1_000/get_esocial_audit_audit_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
status (string)
page (integer)
pageSize (integer)
logix/esocialaudit_v1_000/get_esocial_audit_chart_valuesRetorna lista de eventos dentro/fora do prazo para transmissão do governocompanyId (string) required
requestId (string) required
logix/esocialbranches_v1_000/get_esocial_branchesRetorna o código da empresa e código da filial no TAFcompanyId (string) required
order (array)
page (integer)
pageSize (integer)
logix/esocialestablishment_v1_000/get_esocial_establishmentRetorna lista completa com os Estabelecimentos CadastradoscompanyId (string) required
order (array)
page (integer)
pageSize (integer)
logix/esocialevents_v1_000/get_esocial_eventsRetorna a lista de eventos do TAFcompanyId (string) required
eventsCheckPermissions (string)
logix/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_processCarrega registros do evento S-5503, filtrados ou não, ordenados ou não.No parameters
logix/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_processExclui eventos S-5503 conforme coleção de ID's informados.data: {
. companyId (string)
. id (array)
} (object) required
logix/fgtsperworkerinlaborprocess_v1_000/post_fgtsper_worker_in_labor_process_xmlRetorna XML's do evento S-5503 encodados em base64data: {
. companyId (string)
. id (array)
} (object) required
logix/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_categoryCarrega informações relativas a Matrícula e Categoria de trabalhador específico do evento S-5503, ordenadas ou não.No parameters
logix/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_payment_and_amountsCarrega informações relativas a Identificação do estabelecimento responsável pelo pagamento a trabalhador específico dos valores informados do evento S-5503, ordenadas ou nãoNo parameters
logix/gpeesocialmotives_v1_000/get_esocial_motivesRetorna lista completa com os motivos de afastamentocompanyId (string) required
order (array)
page (integer)
pageSize (integer)
logix/inventorycounts_v1_000/get_inventory_countsRetorna uma ou mais de fichas de inventário conforme parâmetros recebidoscompanyCode (string)
sequenceCountingSheetNumber (integer)
countingSheetNumber (integer)
inventoryDate (string)
inventoryTime (string)
itemCode (string)
groupingCode (number)
lecturerUser1 (string)
lecturerUser2 (string)
lecturerUser3 (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/inventorycounts_v1_000/post_inventory_countsGeração de ficha de inventário. Informar a quantidade apurada na primeira contagem. A atualização da segunda/terceira contagem deve ser enviado via método PUTdata: {
. internalId (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. warehouseCode (string)
. companyCode (string)
. locationCode (string)
. sublocationCode (string)
. referenceCode (string)
. inventoryDate (string)
. inventoryTime (string)
. itemCode (string)
. lotCode (string)
. lotExpirationDate (date)
. statusItem (string)
. countedValue (number)
. groupingCode (number)
. lecturerUser (string)
} (object) required
logix/inventorycounts_v1_000/get_inventory_counts_by_internal_idRetorna uma ficha de inventário correspondente ao número informadointernalId (string)
fields (string)
logix/inventorycounts_v1_000/put_inventory_counts_by_internal_idMétodo responsável pela atualização das quantidades apuradas na ficha de inventário. Caso ainda não exista a ficha no sistema, deve ser previamente criada por meio do método POSTinternalId (string)
data: {
. internalId (string)
. companyCode (string)
. inventoryDate (string)
. inventoryTime (string)
. countingSheetNumber (number)
. sequenceCountingSheetNumber (number)
. numOfCount (number)
. countedValue (number)
. lecturerUser (string)
} (object) required
logix/inventorycounts_v1_000/delete_inventory_counts_by_internal_idElimina a ficha de inventário pelo número e data de saldointernalId (string)
logix/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_countsMétodo responsável pela eliminação das contagens. Contagens voltam ao estado inicialinternalId (string)
logix/itemsku_v2_000/post_item_skuInclui um Item e seus respectivos SKUsAuthorization (string) required
data: {
. CompanyId (string)
. Depositor (string)
. ItemDepositorCode (string)
. ItemDescription (string)
. ItemShortDescription (string)
. FiscalClassificationId (string)
. PctIPI (number)
. NetWeight (number)
. Trail (string)
. Active (string)
. UnityOfMeasure (string)
. Origin (string)
. ICMSIncidenceType (string)
. Onu (string)
. OutputID (string)
. ItemCategory (string)
. ProductionDate (string)
. Piece (string)
. AbcRating (string)
. ShelfLife (integer)
. ShortValidity (integer)
. AllowMixedPallet (string)
. AllowsShipmentWithoutRegularization (string)
. FractionalUnityOfMeasure (string)
. AllowPicking (string)
. PermanentClassification (string)
. ControlIDPicking (string)
. MaximumReceivingTime (integer)
. ExpirationDate (string)
. DaysOfExpirationDate (number)
. TermAlarmValidity (integer)
. ArmyControl (string)
. CivilPoliceControl (string)
. FederalPoliceControl (string)
. TargetUnityOfMeasure (string)
. ConversionFactor (number)
. ListOfSKU (array)
} (object) required
logix/itemsku_v2_000/put_item_sku_by_codeAltera o Item/SKUCode (string)
code (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. Depositor (string)
. ItemDepositorCode (string)
. ItemDescription (string)
. ItemShortDescription (string)
. FiscalClassificationId (string)
. PctIPI (number)
. NetWeight (number)
. Trail (string)
. Active (string)
. UnityOfMeasure (string)
. Origin (string)
. ICMSIncidenceType (string)
. Onu (string)
. OutputID (string)
. ItemCategory (string)
. ProductionDate (string)
. Piece (string)
. AbcRating (string)
. ShelfLife (integer)
. ShortValidity (integer)
. AllowMixedPallet (string)
. AllowsShipmentWithoutRegularization (string)
. FractionalUnityOfMeasure (string)
. AllowPicking (string)
. PermanentClassification (string)
. ControlIDPicking (string)
. MaximumReceivingTime (integer)
. ExpirationDate (string)
. DaysOfExpirationDate (number)
. TermAlarmValidity (integer)
. ArmyControl (string)
. CivilPoliceControl (string)
. FederalPoliceControl (string)
. TargetUnityOfMeasure (string)
. ConversionFactor (number)
. ListOfSKU (array)
} (object) required
logix/mobileforms_v2_000/get_mobile_formsRetorna lista completa formulários do Apontamento de Produção MobileAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
CompanyId (string)
code (string)
appointmentType (string)
user (string)
userGroup (string)
logix/mobileforms_v2_000/post_mobile_formsInclui um formulário de Apontamento de Produção MobileAuthorization (string) required
data: {
. CompanyId (string)
. code (string)
. description (string)
. appointmentType (string)
. iconName (string)
. ListOfFormFields (array)
. ListOfFormUsers (array)
} (object) required
logix/mobileforms_v2_000/delete_mobile_forms_by_company_id_by_codeExclui formulário do Apontamento de Produção Mobile cadastrado conforme dados enviados na requisiçãocompanyId (string)
code (string)
Authorization (string) required
logix/mobileforms_v2_000/put_mobile_forms_by_company_id_by_codeAtualiza cadastro de formulário do Apontamento de Produção Mobile conforme dados enviados na requisiçãocompanyId (string)
code (string)
Authorization (string) required
data: {
. CompanyId (string)
. code (string)
. description (string)
. appointmentType (string)
. iconName (string)
. ListOfFormFields (array)
. ListOfFormUsers (array)
} (object) required
logix/paymentcondition_v1_00/get_paymentconditionRetorna lista completa das condições de pagamentoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/paymentcondition_v1_00/post_paymentconditionInclui uma condição de pagamento conforme dados enviados na requisição.Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. MeanTime (integer)
. DaysFirstDue (integer)
. QuantityPlots (integer)
. RangePlots (integer)
. WeekDayFixed (String)
. DayMonthFixed (integer)
. DaysCondition (String)
. FinancialDiscountDays (integer)
. PercentageDiscountDays (number)
. PercentageIncrease
. DaysCountWay (integer)
. PaymentSituation (integer)
. StartCounting (varchar)
. Plots (object)
} (object) required
logix/paymentcondition_v1_00/get_paymentcondition_by_internal_idRetorna a condição de pagamento pelo InternalIdInternalId (string)
Authorization (string) required
fields (string)
logix/paymentcondition_v1_00/put_paymentcondition_by_internal_idAtualiza a condição de pagamento conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Description (string)
. MeanTime (integer)
. DaysFirstDue (integer)
. QuantityPlots (integer)
. RangePlots (integer)
. WeekDayFixed (String)
. DayMonthFixed (integer)
. DaysCondition (String)
. FinancialDiscountDays (integer)
. PercentageDiscountDays (number)
. PercentageIncrease
. DaysCountWay (integer)
. PaymentSituation (integer)
. StartCounting (varchar)
. Plots (object)
} (object) required
logix/paymentcondition_v1_00/delete_paymentcondition_by_internal_idExclui a condição de pagamento conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
logix/productsupplierrelationship_v1_000/get_product_supplier_relationshipRetorna lista completa de relacionamentos entre Produtos e FornecedoresAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/productsupplierrelationship_v1_000/post_product_supplier_relationshipInclui um relacionamento entre Produto e FornecedorAuthorization (string) required
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. VendorCode (string)
. CustomerVendorInternalId (string)
. InternalId (string)
. VendorName (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemName (string)
. Situation (integer)
. UnitOfMeasureInternalId (string)
. FornecUnitOfMeasureCode (string)
. ConversionFactor (string)
. ItemVendorCode (string)
} (object) required
logix/productsupplierrelationship_v1_000/get_product_supplier_relationship_by_internal_idRetorna um registro de relacionamento de Produto e FornecedorInternalId (string)
Authorization (string) required
logix/productsupplierrelationship_v1_000/put_product_supplier_relationship_by_internal_idAtualiza um registro de relacionamento de Produto e FornecedorInternalId (string)
Authorization (string) required
data: {
. CompanyInternalId (string)
. CompanyCode (string)
. VendorCode (string)
. CustomerVendorInternalId (string)
. InternalId (string)
. VendorName (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemName (string)
. Situation (integer)
. UnitOfMeasureInternalId (string)
. FornecUnitOfMeasureCode (string)
. ConversionFactor (string)
. ItemVendorCode (string)
} (object) required
logix/productsupplierrelationship_v1_000/delete_product_supplier_relationship_by_internal_idExclui um registro de relacionamento de produto e Fornecedor conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
logix/productionappointment_v2_000/get_productionappointmentRetorna o Apontamento de ProduçãoAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
company (string) required
productionordernumber (string) required
appointmenttype (string) required
logix/productionappointment_v2_000/post_productionappointmentInclui um formulário de Apontamento de Produção MobileAuthorization (string) required
data: {
. MachineCode (string)
. MachineDescription (string)
. ProductionOrderNumber (string)
. ActivityID (string)
. Split (string)
. ExternalSplit (string)
. ActivityCode (string)
. ItemCode (string)
. ItemDescription (string)
. ReportQuantity (number)
. ApprovedQuantity (number)
. ScrapQuantity (number)
. ReworkQuantity (number)
. StartSetupDateTime (string)
. StartCentSetupTime (number)
. EndSetupDateTime (string)
. EndCentSetupTime (number)
. StartReportDateTime (string)
. StartCentReportTime (number)
. EndReportDateTime (string)
. EndCentReportTime (number)
. OpTimeDec (number)
. OpTimeInt (integer)
. ExtraTime (integer)
. StopTime (integer)
. MODTime (integer)
. IsProductionControlReport (boolean)
. CQLiberated (boolean)
. ReversedReport (boolean)
. ReversalDate (string)
. UpdateReport (boolean)
. ProductionShiftCode (string)
. ProductionShiftDescription (string)
. ProductionShiftNumber (string)
. ReportDateTime (string)
. ReportCentlTime (number)
. DocumentCode (string)
. DocumentSeries (string)
. WarehouseCode (string)
. LotCode (string)
. LotDueDate (string)
. ReferenceCode (string)
. LocationCode (string)
. SingleOutflowLocation (boolean)
. OutflowLocationCode (string)
. OutflowWarehouseCode (string)
. WasteWarehouseCode (string)
. WasteLocationCode (string)
. ReportSequence (string)
. ListOfReversalAppointments (array)
. ToolCode (string)
. ToolDescription (string)
. SetupCode (string)
. SetupDescription (string)
. CounterStart (integer)
. FinalAccountant (integer)
. CloseOperation (boolean)
. ListOfWasteAppointments (array)
. ListOfResourceAppointments (array)
. ListOfSupplyOrders (array)
. ListOfReportToolActivities (array)
. ListOfReportOverheads (array)
. CompanyId (string)
. BranchId (string)
. CostCenterCode (string)
. SubCostCenterCode (string)
. MovementType (string)
} (object) required
logix/productionorder_v1_000/post_production_orderInclui ou atualiza uma ordem de produçãoAuthorization (string) required
data (undefined) required
logix/quotation_v1_000/get_quotationBuscas as cotaçõespage (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/post_quotationInclui uma cotação para uma ordem de compraAccept-Language (string)
Authorization (string) required
data: {
. _expandables (array)
. InternalId (string)
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. ExternalCode (string)
. Code (string)
. Text (string)
. ValidityStartDate (string)
. ValidityEndDate (string)
. CurrencyInternalId (string)
. CurrencyCode (string)
. UserInternalId (string)
. PriceType (string)
. ListOfQuotationItem (array)
} (object) required
logix/quotation_v1_000/get_quotation_by_internal_idPesquisa as cotações de uma determinada ordem de compraInternalId (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
expand (string)
logix/quotation_v1_000/put_quotation_by_internal_idModifica a cotação de uma determinada ordem de compraInternalId (string)
Authorization (string) required
Accept-Language (string)
data: {
. _expandables (array)
. InternalId (string)
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. ExternalCode (string)
. Code (string)
. Text (string)
. ValidityStartDate (string)
. ValidityEndDate (string)
. CurrencyInternalId (string)
. CurrencyCode (string)
. UserInternalId (string)
. PriceType (string)
. ListOfQuotationItem (array)
} (object) required
logix/quotation_v1_000/delete_quotation_by_internal_idExclui a cotação de uma determinada ordem de compraInternalId (string)
Authorization (string) required
logix/quotation_v1_000/get_quotation_by_internal_id_quotation_item_type_by_item_codePesquisa a cotação de um determinado item.InternalId (string)
ItemCode (string)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/put_quotation_by_internal_id_quotation_item_type_by_item_codeModifica os dados de um item da cotação de CompraInternalId (string)
ItemCode (string)
Authorization (string) required
Accept-Language (string)
data: {
. _expandables (array)
. ExternalItemCode (string)
. ItemCode (string)
. RequestInternalId (string)
. RequestCode (string)
. ListOfQuotationProposal (array)
} (object) required
logix/quotation_v1_000/delete_quotation_by_internal_id_quotation_item_type_by_item_codeExclui os dados do item de uma cotação de CompraInternalId (string)
ItemCode (string)
Authorization (string) required
logix/quotation_v1_000/put_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_idModifica uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
Authorization (string) required
Accept-Language (string)
data: {
. ProposalInternalId (string)
. RegistrationDate (string)
. ExternalCode (string)
. CustomerVendorCode (string)
. Code (string)
. Winner (string)
. CurrencyInternalId (string)
. CurrencyCode (string)
. PaymentTermCode (string)
. FreightType (string)
. UserCode (integer)
. UserInternalId (string)
. Observation (string)
. UnitPrice (number)
. DeliveryPlace (string)
. ChargingPlace (string)
. BillingPlace (string)
. FreightValue (number)
. CarrierCode (string)
. ListOfDeliveries (array)
. LISTOFTAXESDOCUMENT (array)
} (object) required
logix/quotation_v1_000/delete_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_idExclui uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
Authorization (string) required
logix/quotation_v1_000/get_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_documentPesquisa as taxas de desconto/acrescimos de uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/post_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_documentInclui taxas desconto/acrescimos de uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
Authorization (string) required
Accept-Language (string)
data (array) required
logix/quotation_v1_000/put_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_document_by_taxes_internal_idModifica uma taxa desconto ou acrescimo de uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
taxesInternalId (string)
Authorization (string) required
Accept-Language (string)
data: {
. taxesInternalId (integer)
. tpvalue (object)
. tpreasondescandtax (object)
. percdescandtaxes (object)
. valuedescandtaxes (object)
} (object) required
logix/quotation_v1_000/delete_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_document_by_taxes_internal_idExclui uma taxa desconto ou acrescimo de uma cotação de uma ordem de compraInternalId (string)
ProposalInternalId (string)
taxesInternalId (string)
Authorization (string) required
logix/quotation_v1_000/get_quotation_by_internal_id_deliverys_schedulePesquisa as programações de entrega de uma ordem de compraInternalId (string)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/post_quotation_by_internal_id_deliverys_scheduleInclui a programação de entrega de uma ordem de compraInternalId (string)
Authorization (string) required
Accept-Language (string)
data (array) required
logix/quotation_v1_000/get_quotation_by_internal_id_deliverys_schedule_by_delivery_idPesquisa uma programação de entrega de uma ordem de compraInternalId (string)
DeliveryID (number)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/put_quotation_by_internal_id_deliverys_schedule_by_delivery_idModifica uma programação de entrega de uma ordem de compraInternalId (string)
DeliveryID (number)
Authorization (string) required
Accept-Language (string)
data: {
. DeliveryID (integer)
. Quantity (number)
. DeliveryDate (string)
} (object) required
logix/quotation_v1_000/delete_quotation_by_internal_id_deliverys_schedule_by_delivery_idExclui uma programação de entrega de uma ordem de compraInternalId (string)
DeliveryID (number)
Authorization (string) required
logix/quotation_v1_000/get_quotation_by_item_by_item_code_quotation_proposal_typePesquisa as cotações de um determinado itemItemCode (string)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/post_quotation_by_item_by_item_code_quotation_proposal_typeInclui uma cotação para um determinado itemItemCode (string)
Authorization (string) required
Accept-Language (string)
data: {
. ProposalInternalId (string)
. RegistrationDate (string)
. ExternalCode (string)
. CustomerVendorCode (string)
. Code (string)
. Winner (string)
. CurrencyInternalId (string)
. CurrencyCode (string)
. PaymentTermCode (string)
. FreightType (string)
. UserCode (integer)
. UserInternalId (string)
. Observation (string)
. UnitPrice (number)
. DeliveryPlace (string)
. ChargingPlace (string)
. BillingPlace (string)
. FreightValue (number)
. CarrierCode (string)
. ListOfDeliveries (array)
. LISTOFTAXESDOCUMENT (array)
} (object) required
logix/quotation_v1_000/get_quotation_by_item_by_item_code_quotation_proposal_type_by_proposal_internal_idPesquisa uma cotação de um determinado itemItemCode (string)
ProposalInternalId (string)
Authorization (string) required
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/quotation_v1_000/put_quotation_by_item_by_item_code_quotation_proposal_type_by_proposal_internal_idModifica a cotação de uma determinada ordem de compraItemCode (string)
ProposalInternalId (string)
Authorization (string) required
Accept-Language (string)
data: {
. ProposalInternalId (string)
. RegistrationDate (string)
. ExternalCode (string)
. CustomerVendorCode (string)
. Code (string)
. Winner (string)
. CurrencyInternalId (string)
. CurrencyCode (string)
. PaymentTermCode (string)
. FreightType (string)
. UserCode (integer)
. UserInternalId (string)
. Observation (string)
. UnitPrice (number)
. DeliveryPlace (string)
. ChargingPlace (string)
. BillingPlace (string)
. FreightValue (number)
. CarrierCode (string)
. ListOfDeliveries (array)
. LISTOFTAXESDOCUMENT (array)
} (object) required
logix/quotation_v1_000/delete_quotation_by_item_by_item_code_quotation_proposal_type_by_proposal_internal_idExclui a cotação de uma determinada ordem de compraItemCode (string)
ProposalInternalId (string)
Authorization (string) required
logix/quotation_v1_000/put_quotation_by_item_by_item_code_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_document_by_taxes_internal_idModifica uma taxa desconto ou acrescimo de uma cotação de um itemItemCode (string)
ProposalInternalId (string)
taxesInternalId (string)
Authorization (string) required
Accept-Language (string)
data: {
. taxesInternalId (integer)
. tpvalue (object)
. tpreasondescandtax (object)
. percdescandtaxes (object)
. valuedescandtaxes (object)
} (object) required
logix/quotation_v1_000/delete_quotation_by_item_by_item_code_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_document_by_taxes_internal_idExclui uma taxa desconto ou acrescimo de uma cotação de um itemItemCode (string)
ProposalInternalId (string)
taxesInternalId (string)
Authorization (string) required
logix/request_v1_000/get_requestPesquisa as Solicitações de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
CompanyId (string)
logix/request_v1_000/post_requestInclui uma Solicitação de CompraAccept-Language (string)
data: {
. _expandables (array)
. CompanyId (string)
. BranchId
. CompanyInternalId
. RequestInternalId (string)
. Code
. Origin (string)
. Number (string)
. Type (string)
. RequestNumberUniqueID (string)
. UserRequesterInternalId (string)
. RequesterUserCode (number)
. BuyerUserCode (number)
. Series (string)
. RegisterDateTime (string)
. DeliveryDateTime (string)
. AbatementDateTime (string)
. PaymentConditionInternalId (string)
. PaymentConditionCode (number)
. ProjectInternalId (string)
. ProjectCode (string)
. MainOrderInternalId (string)
. MainOrderCode (string)
. EquipmentInternalId (string)
. EquipmentCode (string)
. Observation (string)
. ListOfRequestItem (array)
. ListOfApportionRequest (array)
} (object) required
logix/request_v1_000/get_request_by_request_internal_idPesquisa uma Solicitação de CompraRequestInternalId (string)
fields (string)
expand (string)
logix/request_v1_000/put_request_by_request_internal_idModifica uma Solicitação de CompraRequestInternalId (string)
Accept-Language (string)
fields (string)
data: {
. _expandables (array)
. CompanyId (string)
. BranchId
. CompanyInternalId
. RequestInternalId (string)
. Code
. Origin (string)
. Number (string)
. Type (string)
. RequestNumberUniqueID (string)
. UserRequesterInternalId (string)
. RequesterUserCode (number)
. BuyerUserCode (number)
. Series (string)
. RegisterDateTime (string)
. DeliveryDateTime (string)
. AbatementDateTime (string)
. PaymentConditionInternalId (string)
. PaymentConditionCode (number)
. ProjectInternalId (string)
. ProjectCode (string)
. MainOrderInternalId (string)
. MainOrderCode (string)
. EquipmentInternalId (string)
. EquipmentCode (string)
. Observation (string)
. ListOfRequestItem (array)
. ListOfApportionRequest (array)
} (object) required
logix/request_v1_000/delete_request_by_request_internal_idExclui uma Solicitação de CompraRequestInternalId (string)
logix/request_v1_000/get_request_by_request_internal_id_request_itemPesquisa os dados de vários itens de uma Solicitação de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/request_v1_000/get_request_by_request_internal_id_request_item_by_item_internal_idPesquisa os dados de um item de uma Solicitação de CompraRequestInternalId (string)
ItemInternalId (string)
fields (string)
expand (string)
logix/request_v1_000/put_request_by_request_internal_id_request_item_by_item_internal_idModifica os dados de um Item da Solicitação de CompraRequestInternalId (string)
ItemInternalId (string)
Accept-Language (string)
fields (string)
data: {
. _expandables (array)
. InternalId (string)
. Code (integer)
. Text (string)
. Application (string)
. ExpenseControlGroup
. InputTarget (string)
. ItemInternalId (string)
. ItemCode (string)
. ItemReferenceCode (string)
. StockControl (string)
. UnitPrice
. TotalPrice
. Quantity
. QuantityReached
. UnitOfMeasureInternalId (string)
. UnitOfMeasureCode (string)
. WarehouseInternalId (string)
. WarehouseCode (string)
. DeliveryDateTime (string)
. CostCenterInternalId (string)
. CostCenterCode (string)
. ReceiverSectionCode (string)
. AccountantAcountInternalId (string)
. AccountantAcountCode (string)
. MainOrderInternalId (string)
. MainOrderCode (string)
. ProjectInternalId (string)
. ProjectCode (string)
. TaskInternalId (string)
. TaskCode (string)
. Observation (string)
. OTHER (object)
. ListOfApportionRequestItem (array)
. ListOfItemGrids (array)
. ListOfMaterialOrder (array)
. ListOfDeliverySchedule (array)
} (object) required
logix/request_v1_000/delete_request_by_request_internal_id_request_item_by_item_internal_idExclui os dados do item de uma Solicitação de CompraItemInternalId (string)
RequestInternalId (string)
logix/request_v1_000/get_request_by_request_internal_id_delivery_schedulePesquisa as Programações de Entrega da Solicitação de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/request_v1_000/post_request_by_request_internal_id_delivery_scheduleInclui as Programações de Entrega da Solicitação de CompraRequestInternalId (string)
Accept-Language (string)
data: {
. DeliveryID (integer)
. EstimatedDeliveryDate (string)
. QuantityRequested (number)
. AmountReceived (number)
. Observation (string)
} (object) required
logix/request_v1_000/get_request_by_request_internal_id_delivery_schedule_by_delivery_idBusca os dados de uma programação de entrega de uma Solicitação de CompraRequestInternalId (string)
DeliveryID (integer)
fields (string)
expand (string)
logix/request_v1_000/put_request_by_request_internal_id_delivery_schedule_by_delivery_idModifica uma programação de entrega de uma Solicitação de CompraRequestInternalId (string)
DeliveryID (integer)
Accept-Language (string)
fields (string)
data: {
. DeliveryID (integer)
. EstimatedDeliveryDate (string)
. QuantityRequested (number)
. AmountReceived (number)
. Observation (string)
} (object) required
logix/request_v1_000/delete_request_by_request_internal_id_delivery_schedule_by_delivery_idExclui os dados de uma programação de entrega da Solicitação de CompraRequestInternalId (string)
DeliveryID (integer)
logix/request_v1_000/get_request_by_request_internal_id_apportion_request_itemPesquisa os dados do rateio contábil da Solicitação de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/request_v1_000/post_request_by_request_internal_id_apportion_request_itemInclui o Rateio contábil da Solicitação de CompraRequestInternalId (string)
Accept-Language (string)
data (array) required
logix/request_v1_000/get_request_by_request_internal_id_apportion_request_item_by_internal_idBusca os dados de um rateio contábil de uma Solicitação de CompraRequestInternalId (string)
InternalId (string)
fields (string)
expand (string)
logix/request_v1_000/put_request_by_request_internal_id_apportion_request_item_by_internal_idModifica um rateio contábil de uma Solicitação de CompraRequestInternalId (string)
InternalId (string)
Accept-Language (string)
fields (string)
data: {
. InternalId (string)
. DepartamentCode (string)
. CostCenterCode (string)
. AccountantAcount (string)
. BusinessAreaCode (number)
. BusinessLineCode (number)
. MarketSegmentCode (number)
. ClassUseCode (number)
. Quantity (number)
. Percentual (number)
. Value (number)
. DocumentNumber (string)
. Observation (string)
} (object) required
logix/request_v1_000/delete_request_by_request_internal_id_apportion_request_item_by_internal_idExclui os dados de um rateio contábil da Solicitação de CompraRequestInternalId (string)
InternalId (string)
logix/request_v1_000/get_request_by_request_internal_id_list_by_item_gridsPesquisa os dados da grade do item da Solicitação de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/request_v1_000/get_request_by_request_internal_id_list_by_material_orderPesquisa os dados dos componentes do item da Solicitação de CompraRequestInternalId (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
logix/state_v1_000/get_statesRetorna lista completa de estadosAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
logix/state_v1_000/post_statesInclui um novo Estado conforme dados enviados na requisição.Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
. Country (string)
} (object) required
logix/state_v1_000/get_states_by_internal_idRetorna os dados do Estado conforme o código informado na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
logix/state_v1_000/put_states_by_internal_idAtualiza cadastro do Estado conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
. Country (string)
} (object) required
logix/state_v1_000/delete_states_by_internal_idExclui cadastro do Estado conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
logix/unitmeasurementconversion_v2_000/get_unit_measurement_conversionsRecovers a list of entitiespage (integer)
pageSize (integer)
fields (string)
order (array)
logix/unitmeasurementconversion_v2_000/post_unit_measurement_conversionsInserts a list of entitiesAccept-Language (string)
data (array) required
logix/unitmeasurementconversion_v2_000/post_unit_measurement_conversions_convertPerforms conversion of value between units of measurementAccept-Language (string)
expand (string)
value (number) required
scale (integer)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
logix/unitmeasurementconversion_v2_000/get_measurement_v1_unit_measurement_conversions_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
logix/unitmeasurementconversion_v2_000/put_measurement_v1_unit_measurement_conversions_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
logix/unitmeasurementconversion_v2_000/delete_measurement_v1_unit_measurement_conversions_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
logix/unitmeasurementconversion_v2_000/get_unit_measurement_conversions_by_internal_idRetorna uma lista de fatores de conversão do iteminternalId (string)
fields (string)
order (array)
logix/unitmeasurementconversion_v2_000/put_unit_measurement_conversions_by_internal_idAtualiza fatores de conversão do item.internalId (string)
Authorization (string) required
fields (string)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
logix/unitmeasurementconversion_v2_000/delete_unit_measurement_conversions_by_internal_idExclui fatores de conversão do item.internalId (string)
Authorization (string) required
logix/unitofmeasure_v2_000/get_unit_of_measuresRetorna lista completa de Unidade de MedidaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
logix/unitofmeasure_v2_000/post_unit_of_measuresInclui uma Unidade de MedidaAuthorization (string) required
data: {
. Code (string)
. InternalId (string)
. Description (string)
. ShortName (string)
} (object) required
logix/unitofmeasure_v2_000/get_unit_of_measures_by_codeRetorna Unidade de Medida pelo seu CódigoCode (string)
Authorization (string) required
logix/unitofmeasure_v2_000/put_unit_of_measures_by_codeAtualiza cadastro de Unidade de Medida conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
data: {
. Code (string)
. InternalId (string)
. Description (string)
. ShortName (string)
} (object) required
logix/unitofmeasure_v2_000/delete_unit_of_measures_by_codeExclui Unidade de Medida cadastrada conforme dados enviados na requisiçãoCode (string)
Authorization (string) required
logix/urbanocoletor_v1_000/post_coletor_urbanoInclui informações do coletor na prestação de contasdata (object) required
sara/armazenagemcarganaodesunitizada_v1_000/get_carga_nao_desunitizadaConforme ADE parágrafo 2.2.3 - 1.5 Armazenagem de Carga não Desunitizada.order (array)
page (integer)
pageSize (integer)
idLoteConhecimento (string)
isConhecimentoInternacional (boolean) required
idLote (string)
idCnt (string)
sara/armazenagemcarganaodesunitizada_v1_000/get_carga_nao_desunitizada_xlsGeração de arquivo .xls - Armazenagem de Carga não Desunitizada.order (array)
page (integer)
pageSize (integer)
idLoteConhecimento (string)
isConhecimentoInternacional (boolean) required
idLote (string)
idCnt (string)
sara/caixamensagensrfb_v2_000/get_caixa_mensagens_rfbRetorna informações do caixa de mensagens trocadas entre o estabelecimento e a RFBorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/consolidacaodesconsolidacaolotecarga_v1_000/get_consolidacao_desconsolidacao_lote_cargaConforme ADE parágrafo 2.2.3 - 1.8 Consolidação e Desconsolidação de lote cargaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
NumeroConhecimento (string)
idLote (string)
sara/consolidacaodesconsolidacaolotecarga_v1_000/get_consolidacao_desconsolidacao_lote_carga_xlsGeração de arquivo .xls - Consolidação e Desconsolidação de Lote de Carga.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
idLote (string)
NumeroConhecimento (string)
sara/conteudonotafiscal_v1_000/get_conteudo_nota_fiscalADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.4 - Conteúdo de Nota FiscalAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroNotaFiscal (string)
idTipoNotaFiscal (integer)
sara/conteudonotafiscal_v1_000/get_conteudo_nota_fiscal_xlsConforme ADE parágrafo 2.2.4 - conteúdo de nota fiscal referida a qualquer operação registrada nos termos do item 1, identificada pelo seu número e correspondente CNPJ emissor; http://normas.receita.fazenda.gov.br/sijut2consulta/link.action?visao=anotado and idAto=3193Authorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroNotaFiscal (string)
idTipoNotaFiscal (integer)
sara/desunitizacaocarga_v2_000/get_desunitizacao_cargaConforme ADE parágrafo 2.2.3 - 1.6 Desunitização de cargaorder (array)
page (integer)
pageSize (integer)
idLoteConhecimento (string)
idLote (string)
sara/desunitizacaocarga_v2_000/get_desunitizacao_carga_xlsGeração de arquivo .xls - Desunitização de cargaorder (array)
page (integer)
pageSize (integer)
idLoteConhecimento (string)
idLote (string)
sara/desunitizacaoobjetodesunitizacao_v2_000/get_historico_desunitizacao_loteADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 - 2.2.8 - Anexo 1.3 - Histórico Desunitização de LotesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string)
dataFinal (string)
tipoHistorico (integer)
sara/desunitizacaoobjetodesunitizacao_v2_000/get_historico_desunitizacao_lote_xlsGeração de arquivo .xls - Histórico Desunitização LotesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string)
dataFinal (string)
tipoHistorico (integer)
sara/entradasaidalotecarga_v2_000/get_entrada_saida_lote_cargaConforme ADE parágrafo 2.2.3 - Anexo 1.3 - Entrada e saída de lote de cargaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroConhecimento (string)
nomeTransportadora (string)
idConsignatario (string)
uCR (string)
numeroDocumentoSaida (string)
dataInicio (string)
dataFinal (string)
sara/entradasaidalotecarga_v2_000/get_entrada_saida_lote_carga_xlsGeração de arquivo .xls - Entrada e saída de Lote de Carga.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroConhecimento (string)
nomeTransportadora (string)
idConsignatario (string)
uCR (string)
numeroDocumentoSaida (string)
dataInicio (string)
dataFinal (string)
sara/entradasaidapessoas_v2_000/get_entrada_saida_pessoasConforme ADE parágrafo 2.2.3 - Anexo 1.1 - Entrada e Saída de Pessoas.order (array)
page (integer)
pageSize (integer)
idTipoDocumento (integer)
documento (string)
dataInicial (string)
dataFinal (string)
idPessoa (integer)
idDirecaoOperacao (integer)
sara/entradasaidapessoas_v2_000/get_entrada_saida_pessoas_xlsGeração de arquivo .xls - Entrada ou Saída de Pessoas.order (array)
page (integer)
pageSize (integer)
idTipoDocumento (integer)
documento (string)
dataInicial (string)
dataFinal (string)
idPessoa (integer)
idDirecaoOperacao (integer)
sara/entradasaidaveiculos_v2_000/get_entrada_saida_veiculosConforme ADE parágrafo 2.2.3 - Anexo 1.2 - Entrada e saída de veículos de Cargaorder (array)
page (integer)
pageSize (integer)
idVeiculo (string)
idTransportadora (string)
idBeneficiario (string)
idConhecimento (integer)
idCEMercante (string)
idUCR (integer)
dataInicial (string)
dataFinal (string)
sara/entradasaidaveiculos_v2_000/get_entrada_saida_veiculos_xlsGeração de arquivo .xls - Entrada ou Saída de Veículos de Carga.order (array)
page (integer)
pageSize (integer)
idVeiculo (string)
idTransportadora (string)
idBeneficiario (string)
idConhecimento (integer)
idCEMercante (string)
idUCR (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_aConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Aorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idVeiculo (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_bConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Border (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idTransportadora (integer)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_cConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idPessoa (integer)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_dConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idPais (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_eConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_fConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_gConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_hConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idConteiner (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_iConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_jConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_lConsulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta Lorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idAgrupador (integer)
sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_aConsulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / a Lotes que entraram por período.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string) required
dataFim (string) required
sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_bConsulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / b Lotes que sairam por período.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string) required
dataFim (string) required
sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_cConsulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / c Lotes que entraram por período e consignatário.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string) required
dataFim (string) required
benId (string)
sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_dConsulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas - d Lotes que sairam por período e remetente.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string) required
dataFim (string) required
benId (string)
sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_eConsulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / e Lotes que entraram por período, regime e consignatário.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicio (string) required
dataFim (string) required
idRegime (integer)
benId (string)
sara/historicomovimentacaopessoas_v2_000/get_historico_movimentacao_pessoasADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.5 - Histórico de movimentação de pessoas operationId: RestHistoricoMovimentacaoPessoas.getAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
nomePessoa (string)
tipoDocumento (integer)
numeroDocumento (string)
cPFPessoa (string)
cNHPessoa (string)
idPessoa (integer)
sara/historicomovimentacaopessoas_v2_000/get_historico_movimentacao_historico_movimentacao_pessoas_xlsGeração de arquivo .xls - Histórico de movimentação de pessoas.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
nomePessoa (string)
tipoDocumento (integer)
numeroDocumento (string)
cPFPessoa (string)
cNHPessoa (string)
idPessoa (integer)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_aConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Aorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idLote (integer)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_bConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Border (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idDocSai (integer)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_cConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
numeroConhec (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_dConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Dorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idLote (integer)
tipoDocConhec (string)
numeroConhec (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_eConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Eorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idBen (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_fConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Forder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idVeiculo (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_gConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Gorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_hConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Horder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
idConteiner (integer)
idVeiculo (string)
sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_iConsulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta Iorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
dataFinal (string)
numeroConhec (string)
sara/mudancasituacaoaduaneiralotecarga_v2_000/get_mudanca_situacao_aduaneira_loteADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.3 - Inteiro conteúdo de Registro e Documento - 1.10 - Mudança de Situação Aduaneira de Lote de Cargaorder (array)
page (integer)
pageSize (integer)
idLote (string)
numeroConhecimento (string)
sara/mudancasituacaoaduaneiralotecarga_v2_000/get_mudanca_situacao_aduaneira_lote_xlsGeração de arquivo .xls - Mudanca Situação Aduaneira Lote.order (array)
page (integer)
pageSize (integer)
idLote (string)
numeroConhecimento (string)
sara/prazopermanencia_v2_000/get_prazo_permanencia_aADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta Aorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
sara/prazopermanencia_v2_000/get_prazo_permanencia_bADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta Border (array)
page (integer)
pageSize (integer)
dataInicial (string)
sara/prazopermanencia_v2_000/get_prazo_permanencia_cADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta Corder (array)
page (integer)
pageSize (integer)
dataInicial (string)
sara/prazopermanencia_v2_000/get_prazo_permanencia_dADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta Dorder (array)
page (integer)
pageSize (integer)
dataInicial (string)
sara/registroavariasperdasfurtosroubosoutrasocorrencias_v2_000/get_registro_avarias_perdas_furtos_roubos_outras_ocorrenciasADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.3 - Inteiro conteúdo de Registro e Documento - 1.23 - Registro de avarias, perdas,furtos, roubos e outras ocorrênciasAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroConhecimento (string)
idLote (string)
sara/registroavariasperdasfurtosroubosoutrasocorrencias_v2_000/get_restregistro_avarias_perdas_furtos_roubos_outras_ocorrencias_xlsGeração de arquivo .xls - Registro de avarias, perdas, furtos, roubos e outras ocorrências.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
numeroConhecimento (string)
idLote (string)
sara/registromudancaregimeaduaneiro_v2_000/get_registro_mudanca_regime_aduaneiroADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.3 - Inteiro conteúdo de Registro e Documento - 1.20 - Registro de mudança de regime aduaneiroorder (array)
page (integer)
pageSize (integer)
idLote (string)
dataInicial (string)
dataFinal (string)
sara/registromudancaregimeaduaneiro_v2_000/get_registro_mudanca_regime_aduaneiro_xlsGeração de arquivo .xls - Registro de mudança de regime aduaneiro.order (array)
page (integer)
pageSize (integer)
idLote (string)
dataInicial (string)
dataFinal (string)
sara/relacaonotasfiscais_v2_000/get_relacao_nota_fiscalConforme ADE parágrafo 2.2.3 - Anexo 1.4 - Relação Nota Fiscal.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
ConhecimentoLote (string)
RelacaoNotaFiscal (string)
notaFiscal (string)
sara/relacaonotasfiscais_v2_000/get_relacao_nota_fisca_l_xlsGeração de arquivo .xls - Relação de Nota Fiscal.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
ConhecimentoLote (string)
RelacaoNotaFiscal (string)
notaFiscal (string)
sara/relacaotransferenciamercadorias_v2_000/get_relacao_transferencia_mercadoriasADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.3 - Inteiro conteúdo de Registro e Documento - 1.11 Relação de Transferência de Mercadorias RTM.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
idConhecimentoLote (string) required
idLote (string) required
sara/relacaotransferenciamercadorias_v2_000/get_relacao_transferencia_mercadorias_xlsGeração de arquivo .xls - Relação de Transferência de Mercadorias RTM.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
idConhecimentoLote (string) required
idLote (string) required
sara/situacaolotecargaverificacao_v2_000/get_situacao_lote_carga_verificacaoADE COANA/COTEC N°2 DE 26 de setembro de 2003 Anexo Único, seção 2.2 Consulta Estruturada, item 2.2.3 - Inteiro conteúdo de Registro e Documento - 1.10A - Situação de lote de carga para verificação física.order (array)
page (integer)
pageSize (integer)
idConhecimentoLote (string) required
idLote (string) required
sara/situacaolotecargaverificacao_v2_000/get_situacao_lote_carga_verificacao_xlsGeração de arquivo .xls - Entrada e Saída de Lote de Carga.order (array)
page (integer)
pageSize (integer)
idConhecimentoLote (string) required
idLote (string) required
sara/transferencialocalarmazenagem_v2_000/get_transferencia_local_armazenagemConforme ADE parágrafo 2.2.3 - Anexo 1.9 - Transferência de local de armazenagem.order (array)
page (integer)
pageSize (integer)
idLote (string) required
lote_conhec (string) required
sara/transferencialocalarmazenagem_v2_000/get_transferencia_local_armazenagem_xlsGeração de arquivo .xls - Transferência de Local de Armazenagem.order (array)
page (integer)
pageSize (integer)
idLote (string) required
lote_conhec (string) required
sara/unitizacaolotecarga_v1_000/get_unitizacao_lote_cargaConforme ADE parágrafo 2.2.3 - Anexo 1.7 - Unitização de lote de cargaAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
idLote (string)
NumeroConhecimento (string)
sara/unitizacaolotecarga_v1_000/get_unitizacao_lote_carga_xlsGeração de arquivo .xls - Unitização de Lote de Carga.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
idLote (string)
NumeroConhecimento (string)
hat/attendancelocation_v1_100/post_attendance_locationsPermite a inclusão e alteração de locais de atendimento de prestadores da operadora.Authorization (string) required
Expires_at (string) required
healthInsurerId (string) required
data: {
. healthInsurerId (string)
. ansRegistry (string)
. locations (array)
} (object) required
hat/auditing_v1_100/post_auditingRecebe a resposta do processo de auditoria e atualiza as guias de atendimento. Pode ser enviado um lote de guias.Authorization (string) required
Expires_at (string) required
data (undefined) required
hat/authorization_v1_100/get_authorizationsRetorna uma mensagem do tipo colecao com as guias de atendimento realizados no autorizador. brOs resultados podem ser filtrados através dos parametros bauthStatus/b, bauthType/b, bdateFrom/b, bdateTo/b, bhealthProviderId/b, battendanceLocation/b e bidOnHealthInsurer/bpage (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
Expires_at (string) required
authStatus (string)
authType (number) required
dateFrom (string)
dateTo (string)
healthProviderId (string)
attendanceLocation (string)
authNumber (string)
hat/authorization_v1_100/post_authorizationsInsere uma guia na fila de processamento. Ao realizar uma requisicão, o endpoint irá responder com codigo 202 indicando que a requisicao foi adicionada a fila de processamento retornando um token de identificação, em seguida esse token deve ser utilizado nos parâmetros de URL para retornar a resposta de codigo 200 assim que o processamento for concluídoAuthorization (string) required
Expires_at (string) required
authType (number) required
tokenId (string)
data: {
. authorizationStatus (string)
. newbornAttendance (string)
. rejectionCauses (array)
. consultationType (string)
. ansRegistry (string)
. authorizationDate (string)
. attendanceProtocol (string)
. accidentIndication (string)
. locationCode (string)
. attendanceLocation (string)
. beneficiary
. healthProvider
. procedures
. professional
} (object) required
hat/authorization_v1_100/get_authorizations_by_id_on_health_insurerRetorna uma mensagem com a guia de atendimento informada no parametro idOnHealthInsureridOnHealthInsurer (integer)
Authorization (string) required
Expires_at (string) required
expand (string)
fields (string)
hat/authorization_v1_100/post_authorizations_by_id_on_health_insurer_cancelEfetua o cancelamento de uma guia incluída pelo prestador.idOnHealthInsurer (integer)
data: {
. authorizationsToCancel (array)
} (object) required
hat/healthcareuser_v1_000/get_health_care_usersRetorna um lote de usuário de acordo com os parametros enviados. É possivel filtrar o resultado através de todas as propriedades com excessão do CBOSpage (integer)
pageSize (integer)
order (array)
fields (string)
Authorization (string) required
Expires_at (string) required
hat/healthcareuser_v1_000/post_health_care_usersRealiza a inclusão de um usuário conforme body da requisição.Authorization (string) required
Expires_at (string) required
data: {
. username (string)
. email (string)
. name (string)
. document (number)
. profile (string)
. type (string)
. tenantData (array)
} (object) required
hat/healthcareuser_v1_000/get_health_care_users_by_idRetorna um usuário de acordo com o código informadoid (string)
Authorization (string) required
expand (string)
Expires_at (string) required
hat/healthcareuser_v1_000/put_health_care_users_by_idAltera informações do usuário de acordo com o ID informadoid (string)
Authorization (string) required
Expires_at (string) required
data: {
. id (number)
. authId (number)
. username (string)
. email (string)
. name (string)
. document (number)
. profile (string)
. type (string)
. active (number)
. deleted (number)
. tenantData
. userInfo
} (object) required
hat/healthinsurer_v1_100/get_health_insurers_by_health_insurer_id_form_fieldsRetorna os campos obrigatorios de um formulario de acordo com o tipo de atendimentohealthInsurerId (integer)
page (integer)
pageSize (integer)
order (array)
Authorization (string) required
Expires_at (string) required
formType (string)
hat/healthinsurer_v1_100/post_health_insurers_by_health_insurer_id_generate_protocolGera um numero de protocolo de atendimentohealthInsurerId (integer)
Authorization (string) required
Expires_at (string) required
hat/healthproviderspecialty_v1_100/post_health_provider_specialtiesPermite a inclusão e alteração de especialidades dos locais de atendimento de prestadores da operadora. Caso não seja informado o código do local de atendimento, será incluído no nível do prestador RDA.Authorization (string) required
Expires_at (string) required
data: {
. healthInsurerId (string)
. ansRegistry (string)
. specialties (array)
} (object) required
hat/healthproviderstatus_v1_100/post_health_provider_statusPermite o bloqueio e desbloqueio de prestadores da operadora.Authorization (string) required
Expires_at (string) required
data: {
. healthInsurerId (string)
. ansRegistry (string)
. providers (array)
} (object) required
hat/healthprovider_v1_100/get_health_provider_by_health_provider_id_health_provider_specialtiesRetorna as especialidades que o prestador informado pode atenderhealthProviderId (integer)
page (integer)
pageSize (integer)
order (array)
Authorization (string) required
Expires_at (string) required
hat/healthprovider_v1_100/post_health_providersPermite a inclusão e alteração de prestadores da operadora.Authorization (string) required
Expires_at (string) required
data: {
. healthInsurerId (string)
. ansRegistry (string)
. providers (array)
} (object) required
hat/preexistingdisease_v2_000/post_pre_existing_diseasesPermite a inclusao de doencas pre-existentes para o beneficiario informado no cabecalho da integração.Authorization (string) required
Expires_at (string) required
data: {
. healthInsurerId (string)
. ansRegistry (string)
. diseases (array)
} (object) required
hat/procedure_v1_100/get_proceduresRetorna uma mensagem do tipo cole com os procedimentos. Os resultados podem ser filtrados atraves dos parametros procedureId e tableCodepage (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Authorization (string) required
Expires_at (string) required
procedureId (string)
tableCode (string)
procedureCode (string)
hat/procedure_v1_100/get_procedures_by_procedure_idRetorna uma mensagem com os dados de um procedimentosprocedureId (string)
hat/procedure_v1_100/post_procedures_by_procedure_id_check_coverageO processamento de autorização de procedimentos é controlado por uma fila de processamento. Ao realizar uma requisição, o endpoint irá responder com codigo 202 indicando que a requisição foi adicionada a fila de processamento retornando um token de identificação, em seguida esse token deve ser utilizado nos parâmetros de URL para retornar a resposta de codigo 200 assim que o processamento for concluidoprocedureId (string)
authType (string) required
tokenId (string)
data: {
. ansRegistry (string)
. newbornAttendance (string)
. attendanceProtocol (string)
. authorizationStatus (string)
. locationCode (string)
. attendanceLocation (string)
. beneficiary
. healthProvider
. professional
. rejectionCauses (array)
. accidentIndication (string)
. authorizationDate (string)
. procedures
. targetProcedure
} (object) required
hat/professional_v1_000/get_professionalsRetorna um lote de profissional de acordo com os parametros enviados. É possivel filtrar o resultado através de todas as propriedades com excessão do CBOSAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
expand (string)
expires_at (string)
hat/professional_v1_000/post_professionalsRealiza a inclusão de um profissional conforme body da requisição.Authorization (string) required
expand (string)
fields (string)
expires_at (string)
data (undefined) required
hat/professional_v1_000/get_professionals_by_id_on_health_insurerRetorna um profissional de acordo com o ID informadoidOnHealthInsurer (string)
Authorization (string) required
fields (string)
expand (string)
expires_at (string)
hat/professional_v1_000/put_professionals_by_id_on_health_insurerAltera informações do profissional de acordo com o ID informadoidOnHealthInsurer (string)
Authorization (string) required
fields (string)
expand (string)
expires_at (string)
data: {
. idOnHealthInsurer (string)
. professionalIdentifier (string)
. professionalCouncil (string)
. name (string)
. professionalCouncilNumber (string)
. stateAbbreviation (string)
. cbos
} (object) required
hat/professional_v1_000/delete_professionals_by_id_on_health_insurerDeleta um profissional conforme ID enviado.idOnHealthInsurer (string)
Authorization (string) required
expires_at (string)
healthInsurerCode (integer)
agriapi/basequantity_v1_000/get_base_quantitiesRecovers a list of enumeration valuesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Accept-Language (string)
agriapi/baseunitmeasurement_v1_000/get_base_unit_measurementsRecovers a list of entitiesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Accept-Language (string)
code (string)
description (string)
agriapi/baseunitmeasurement_v1_000/post_base_unit_measurementsInserts a list of entitiesAccept-Language (string)
data (undefined) required
agriapi/baseunitmeasurement_v1_000/get_base_unit_measurements_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/baseunitmeasurement_v1_000/put_base_unit_measurements_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. baseQuantity (string)
. code (string)
. definition (string)
. description (string)
. id (string)
. internalId (string)
. isDerived (boolean)
. symbol (string)
} (object) required
agriapi/baseunitmeasurement_v1_000/delete_base_unit_measurements_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/biome_v1_000/get_biomesRecovers a list of entitiesAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
Accept-Language (string)
fields (string)
expand (string)
code (string)
description (string)
agriapi/biome_v1_000/post_biomesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/biome_v1_000/get_biomes_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/biome_v1_000/put_biomes_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. geojson (string)
. id (string)
. internalId (string)
} (object) required
agriapi/biome_v1_000/delete_biomes_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/climateelement_v1_000/get_climate_elementsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/climateelement_v1_000/post_climate_elementsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/climateelement_v1_000/get_climate_elements_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/climateelement_v1_000/put_climate_elements_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. classifications (array)
. code (string)
. dataType (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
. unitMeasurement
} (object) required
agriapi/climateelement_v1_000/delete_climate_elements_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/climatefactor_v1_000/get_climate_factorsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/climatefactor_v1_000/post_climate_factorsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/climatefactor_v1_000/get_climate_factors_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/climatefactor_v1_000/put_climate_factors_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. classifications (array)
. code (string)
. dataType (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
. unitMeasurement
} (object) required
agriapi/climatefactor_v1_000/delete_climate_factors_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/climatezone_v1_000/get_climate_zonesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/climatezone_v1_000/post_climate_zonesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/climatezone_v1_000/get_climate_zones_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/climatezone_v1_000/put_climate_zones_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. definition (string)
. description (string)
. geojson (string)
. id (string)
. internalId (string)
} (object) required
agriapi/climatezone_v1_000/delete_climate_zones_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/climate_v1_000/get_climatesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/climate_v1_000/post_climatesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/climate_v1_000/get_climates_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/climate_v1_000/put_climates_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. classifications (array)
. code (string)
. definition (string)
. description (string)
. geojson (string)
. humidityClassification
. humidityDistributionClassification
. id (string)
. internalId (string)
. maximumTemperature (number)
. minimumTemperature (number)
. thermalAmplitude (number)
. zone
} (object) required
agriapi/climate_v1_000/delete_climates_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/costcentertype_v1_000/get_cost_center_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/costcentertype_v1_000/post_cost_center_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/costcentertype_v1_000/get_cost_center_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/costcentertype_v1_000/put_cost_center_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. isAuxiliary (boolean)
. isOther (boolean)
. isProductive (boolean)
} (object) required
agriapi/costcentertype_v1_000/delete_cost_center_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentavailabilitytype_v1_000/get_equipment_availability_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmentavailabilitytype_v1_000/post_equipment_availability_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmentavailabilitytype_v1_000/get_equipment_availability_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentavailabilitytype_v1_000/put_equipment_availability_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. isAvailable (boolean)
. labelColor (string)
} (object) required
agriapi/equipmentavailabilitytype_v1_000/delete_equipment_availability_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentbrand_v1_000/get_equipment_brandsRetorna dados de situação do beneficiárioAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
order (array)
expand (string)
code (string)
description (string)
agriapi/equipmentbrand_v1_000/post_equipment_brandsEntities to be insertedAccept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/equipmentbrand_v1_000/get_equipment_brands_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentbrand_v1_000/put_equipment_brands_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/equipmentbrand_v1_000/delete_equipment_brands_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentidentificationtype_v1_000/get_equipment_identification_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmentidentificationtype_v1_000/post_equipment_identification_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmentidentificationtype_v1_000/get_equipment_identification_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentidentificationtype_v1_000/put_equipment_identification_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
} (object) required
agriapi/equipmentidentificationtype_v1_000/delete_equipment_identification_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentmodality_v1_000/get_equipment_modalitiesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmentmodality_v1_000/post_equipment_modalitiesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmentmodality_v1_000/get_equipment_modalities_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentmodality_v1_000/put_equipment_modalities_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/equipmentmodality_v1_000/delete_equipment_modalities_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentmodel_v1_000/get_equipment_modelsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmentmodel_v1_000/post_equipment_modelsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmentmodel_v1_000/get_equipment_models_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentmodel_v1_000/put_equipment_models_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. brand
. code (string)
. description (string)
. id (string)
. internalId (string)
. maximumTare (number)
. minimumTare (number)
. operativeGroup
. powerClass
. svgContent (string)
. tareWeight (number)
. unitMeasurementTare
. unitMeasurementUsefulVolume
. usefulVolume (number)
} (object) required
agriapi/equipmentmodel_v1_000/delete_equipment_models_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmentresourcetype_v1_000/get_equipment_resource_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmentresourcetype_v1_000/post_equipment_resource_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmentresourcetype_v1_000/get_equipment_resource_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmentresourcetype_v1_000/put_equipment_resource_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. machineryClassification
. svgContent (string)
} (object) required
agriapi/equipmentresourcetype_v1_000/delete_equipment_resource_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/equipmenttype_v1_000/get_equipment_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/equipmenttype_v1_000/post_equipment_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/equipmenttype_v1_000/get_equipment_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/equipmenttype_v1_000/put_equipment_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
} (object) required
agriapi/equipmenttype_v1_000/delete_equipment_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/fueltype_v2_000/get_fuel_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/fueltype_v2_000/post_fuel_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/fueltype_v2_000/get_fuel_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/fueltype_v2_000/put_fuel_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/fueltype_v2_000/delete_fuel_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/geoservice_v1_000/post_geo_servicesPerforms a geodata serviceAccept-Language (string)
service (string) required
data (string) required
agriapi/humidityclassification_v1_000/get_humidity_classificationsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/humidityclassification_v1_000/post_humidity_classificationsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/humidityclassification_v1_000/get_humidity_classifications_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/humidityclassification_v1_000/put_humidity_classifications_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. definition (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/humidityclassification_v1_000/delete_humidity_classifications_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/humiditydistributionclassification_v1_000/get_humidity_distribution_classificationsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/humiditydistributionclassification_v1_000/post_humidity_distribution_classificationsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/humiditydistributionclassification_v1_000/get_humidity_distribution_classifications_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/humiditydistributionclassification_v1_000/put_humidity_distribution_classifications_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. definition (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/humiditydistributionclassification_v1_000/delete_humidity_distribution_classifications_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/machineryclassification_v1_000/get_machinery_classificationsRecupera um conjunto de registros de classificação de máquinasAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/machineryclassification_v1_000/post_machinery_classificationsAdicionar lista de classificação de máquinasAccept-Language (string)
data (array) required
agriapi/machineryclassification_v1_000/get_machinery_classifications_by_idRetorna classificação de máquinas de acordo com o Id informado.id (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/machineryclassification_v1_000/put_machinery_classifications_by_idAtualiza uma classificação de máquina existente, identificada a partir do Id informado.id (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/machineryclassification_v1_000/delete_machinery_classifications_by_idExclui o registro de classificação de máquina existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
agriapi/operationclass_v1_000/get_operation_classesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operationclass_v1_000/post_operation_classesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operationclass_v1_000/get_operation_classes_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operationclass_v1_000/put_operation_classes_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data (object) required
agriapi/operationclass_v1_000/delete_operation_classes_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operationgroup_v1_000/get_operation_groupsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operationgroup_v1_000/post_operation_groupsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operationgroup_v1_000/get_operation_groups_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operationgroup_v1_000/put_operation_groups_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
} (object) required
agriapi/operationgroup_v1_000/delete_operation_groups_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operationtype_v1_000/get_operation_typesRecovers a list of entitiesAccept-Language (string)
order (array)
page (integer)
pageSize (integer)
fields (string)
expand (string)
code (string)
description (string)
agriapi/operationtype_v1_000/post_operation_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operationtype_v1_000/get_operation_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operationtype_v1_000/put_operation_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
} (object) required
agriapi/operationtype_v1_000/delete_operation_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operation_v1_000/get_operationsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operation_v1_000/post_operationsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operation_v1_000/get_operation_v1_operations_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operation_v1_000/put_operation_v1_operations_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. indicateDistances (boolean)
. indicateHours (boolean)
. indicateLocations (boolean)
. internalId (string)
. operationClass
. operationGroup
. operationType
. timeFormat (string)
. unitMeasurement
. usesImplement (boolean)
} (object) required
agriapi/operation_v1_000/delete_operation_v1_operations_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operationalcategory_v2_000/get_operational_categoriesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operationalcategory_v2_000/post_operational_categoriesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operationalcategory_v2_000/get_operational_categories_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operationalcategory_v2_000/put_operational_categories_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. svgContent (string)
. unitMeasurement
} (object) required
agriapi/operationalcategory_v2_000/delete_operational_categories_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operativegroup_v1_000/get_operative_groupsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
Code (string)
description (string)
agriapi/operativegroup_v1_000/post_operative_groupsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operativegroup_v1_000/get_operative_groups_by_codeRecovers a specific entity with identifierCode (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operativegroup_v1_000/put_operative_groups_by_codeUpdates a entity with identifierCode (string)
Accept-Language (string)
data: {
. Code (string)
. Name (string)
. ShortName (string)
. GroupType (string)
. UnitOfMeasureCode (string)
} (object) required
agriapi/operativegroup_v1_000/delete_operative_groups_by_codeRemoves a entity with identifierCode (string)
Accept-Language (string)
agriapi/operativegroup_v2_000/get_operative_groupsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operativegroup_v2_000/post_operative_groupsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/operativegroup_v2_000/get_operative_groups_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operativegroup_v2_000/put_operative_groups_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. equipmentType
. id (string)
. internalId (string)
. svgContent (string)
. unitMeasurement
} (object) required
agriapi/operativegroup_v2_000/delete_operative_groups_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/operatortype_v1_000/get_prioritization_classesRecupera um conjunto de registrosAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/operatortype_v1_000/post_prioritization_classesAdicionar lista de registros.Accept-Language (string)
data (array) required
agriapi/operatortype_v1_000/get_prioritization_classes_by_idRetorna registro de acordo com o Id informado.id (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/operatortype_v1_000/put_prioritization_classes_by_idAtualiza um registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. isAll (boolean)
} (object) required
agriapi/operatortype_v1_000/delete_prioritization_classes_by_idExclui o registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
agriapi/plantevent_v1_000/get_plant_eventsRecupera um conjunto de registrosAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/plantevent_v1_000/post_plant_eventsAdicionar lista de registros.Accept-Language (string)
data (array) required
agriapi/plantevent_v1_000/get_plant_events_by_idRetorna registro de acordo com o Id informado.id (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/plantevent_v1_000/put_plant_events_by_idAtualiza um registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. isEnable (boolean)
. plantSituation
. previousEvents (array)
} (object) required
agriapi/plantevent_v1_000/delete_plant_events_by_idExclui o registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
agriapi/plantsituation_v1_000/get_plant_situationsRecupera um conjunto de registrosAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/plantsituation_v1_000/post_plant_situationsAdicionar lista de registros.Accept-Language (string)
data (array) required
agriapi/plantsituation_v1_000/get_plant_situations_by_idRetorna registro de acordo com o Id informado.id (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/plantsituation_v1_000/put_plant_situations_by_idAtualiza um registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. isEnable (boolean)
} (object) required
agriapi/plantsituation_v1_000/delete_plant_situations_by_idExclui o registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
agriapi/powerclass_v1_000/get_power_classesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/powerclass_v1_000/post_power_classesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/powerclass_v1_000/get_power_classes_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/powerclass_v1_000/put_power_classes_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. maximumValue (number)
. minimumValue (number)
. unitMeasurement
} (object) required
agriapi/powerclass_v1_000/delete_power_classes_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/prioritizationclass_v1_000/get_prioritization_classesRecupera um conjunto de registrosAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/prioritizationclass_v1_000/post_prioritization_classesAdicionar lista de registros.Accept-Language (string)
data (array) required
agriapi/prioritizationclass_v1_000/get_prioritization_classes_by_idRetorna registro de acordo com o Id informado.id (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/prioritizationclass_v1_000/put_prioritization_classes_by_idAtualiza um registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. id (string)
. internalId (string)
. index (integer)
. svgContent (string)
} (object) required
agriapi/prioritizationclass_v1_000/delete_prioritization_classes_by_idExclui o registro existente, identificado a partir do Id informado.id (string)
Accept-Language (string)
agriapi/relieftype_v1_000/get_relief_typesRecovers a list of entitiesorder (array)
page (integer)
pageSize (integer)
Accept-Language (string)
fields (string)
expand (string)
code (string)
description (string)
agriapi/relieftype_v1_000/post_relief_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/relieftype_v1_000/get_relief_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/relieftype_v1_000/put_relief_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. geojson (string)
. id (string)
. internalId (string)
} (object) required
agriapi/relieftype_v1_000/delete_relief_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/soiltexture_v1_000/get_soil_texturesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/soiltexture_v1_000/post_soil_texturesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/soiltexture_v1_000/get_soil_textures_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/soiltexture_v1_000/put_soil_textures_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. geojson (string)
. id (string)
. internalId (string)
. percentClay (number)
. percentSand (number)
. percentSilt (number)
} (object) required
agriapi/soiltexture_v1_000/delete_soil_textures_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/soiltype_v1_000/get_soil_typesRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/soiltype_v1_000/post_soil_typesInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/soiltype_v1_000/get_soil_types_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/soiltype_v1_000/put_soil_types_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. geojson (string)
. id (string)
. internalId (string)
} (object) required
agriapi/soiltype_v1_000/delete_soil_types_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/unitmeasurementconversion_v1_000/get_unit_measurement_conversionsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/unitmeasurementconversion_v1_000/post_unit_measurement_conversionsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/unitmeasurementconversion_v1_000/post_unit_measurement_conversions_convertPerforms conversion of value between units of measurementAccept-Language (string)
expand (string)
value (number) required
scale (integer)
data: {
. _expandables (array)
. factor (number)
. from
. id (string)
. internalId (string)
. to
} (object) required
agriapi/unitmeasurementconversion_v1_000/get_measurement_v1_unit_measurement_conversions_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/unitmeasurementconversion_v1_000/put_measurement_v1_unit_measurement_conversions_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. factor (number)
. from
. id (string)
. internalId (string)
. to
} (object) required
agriapi/unitmeasurementconversion_v1_000/delete_measurement_v1_unit_measurement_conversions_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/unitmeasurementconversion_v2_000/get_unit_measurement_conversionsRecovers a list of entitiespage (integer)
pageSize (integer)
fields (string)
order (array)
agriapi/unitmeasurementconversion_v2_000/post_unit_measurement_conversionsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/unitmeasurementconversion_v2_000/post_unit_measurement_conversions_convertPerforms conversion of value between units of measurementAccept-Language (string)
expand (string)
value (number) required
scale (integer)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
agriapi/unitmeasurementconversion_v2_000/get_measurement_v1_unit_measurement_conversions_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/unitmeasurementconversion_v2_000/put_measurement_v1_unit_measurement_conversions_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
agriapi/unitmeasurementconversion_v2_000/delete_measurement_v1_unit_measurement_conversions_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/unitmeasurementconversion_v2_000/get_unit_measurement_conversions_by_internal_idRetorna uma lista de fatores de conversão do iteminternalId (string)
fields (string)
order (array)
agriapi/unitmeasurementconversion_v2_000/put_unit_measurement_conversions_by_internal_idAtualiza fatores de conversão do item.internalId (string)
Authorization (string) required
fields (string)
data: {
. expandables (array)
. factor (number)
. from
. id (string)
. internalId
. to
. companyInternalId
. itemCode
} (object) required
agriapi/unitmeasurementconversion_v2_000/delete_unit_measurement_conversions_by_internal_idExclui fatores de conversão do item.internalId (string)
Authorization (string) required
agriapi/unitmeasurement_v1_000/get_unit_measurementsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/unitmeasurement_v1_000/post_unit_measurementsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/unitmeasurement_v1_000/get_unit_measurements_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/unitmeasurement_v1_000/put_unit_measurements_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. baseUnitMeasurement
. code (string)
. conversions (array)
. definition (string)
. description (string)
. id (string)
. internalId (string)
. symbol (string)
} (object) required
agriapi/unitmeasurement_v1_000/delete_unit_measurements_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/wheatherclassification_v1_000/get_weather_classificationsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/wheatherclassification_v1_000/post_weather_classificationsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/wheatherclassification_v1_000/get_weather_classifications_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/wheatherclassification_v1_000/put_weather_classifications_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. climateElement
. climateFactor
. code (string)
. definition (string)
. description (string)
. id (string)
. internalId (string)
. labelColor (string)
. maximumValue (number)
. minimumValue (number)
. unitMeasurement
. value (string)
} (object) required
agriapi/wheatherclassification_v1_000/delete_weather_classifications_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
agriapi/wheathercondition_v1_000/get_weather_conditionsRecovers a list of entitiesAccept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
code (string)
description (string)
agriapi/wheathercondition_v1_000/post_weather_conditionsInserts a list of entitiesAccept-Language (string)
data (array) required
agriapi/wheathercondition_v1_000/get_weather_conditions_by_idRecovers a specific entity with identifierid (string)
Accept-Language (string)
fields (string)
expand (string)
agriapi/wheathercondition_v1_000/put_weather_conditions_by_idUpdates a entity with identifierid (string)
Accept-Language (string)
data: {
. _expandables (array)
. code (string)
. description (string)
. icon (string)
. id (string)
. internalId (string)
. svgContent (string)
} (object) required
agriapi/wheathercondition_v1_000/delete_weather_conditions_by_idRemoves a entity with identifierid (string)
Accept-Language (string)
central_de_obrigacoes___sib/beneficiary_v1_000/get_beneficiariesRetorna um lote de beneficiario de acordo com os parametros enviadosAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
healthInsurerCode (integer)
central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiariesInsere e/ou gera uma movimentação de inclusão para o SIB, através de um body.Authorization (string) required
data: {
. address (string)
. addressComplement (string)
. birthdate (string)
. blockDate (string)
. blockingReason (string)
. caepf (string)
. cityCode (string)
. cityCodeResidence (string)
. codeCco (string)
. codeSCPA (string)
. codeSusep (string)
. declarationOfLiveBirth (string)
. district (string)
. effectiveDate (string)
. excludedItems (string)
. gender (string)
. guarantorCEI (string)
. guarantorCNPJ (string)
. healthInsuranceCode (string)
. healthInsurerCode (string)
. holderCPF (string)
. holderRelationship (string)
. holderSubscriberId (string)
. houseNumbering (string)
. motherCPF (string)
. mothersName (string)
. name (string)
. nationalHealthCard (string)
. notifyANS (string)
. oldSubscriberId (string)
. partialCoverage (string)
. pisPasep (string)
. portabilityPlanCode (string)
. residentAbroad (string)
. skipRuleMothersName (string)
. skipRuleName (string)
. sponsorCPF (string)
. stateAbbreviation (string)
. statusAns (string)
. subscriberId (string)
. typeOfAddress (string)
. ZIPCode (string)
} (object) required
central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_batchInsere e/ou gera uma movimentção de inclusão para o SIB, através de um body que pode ser um array, inserindo até 100 beneficiarios.Authorization (string) required
data: {
. address (string)
. addressComplement (string)
. birthdate (string)
. blockDate (string)
. blockingReason (string)
. caepf (string)
. cityCode (string)
. cityCodeResidence (string)
. codeCco (string)
. codeSCPA (string)
. codeSusep (string)
. declarationOfLiveBirth (string)
. district (string)
. effectiveDate (string)
. excludedItems (string)
. gender (string)
. guarantorCEI (string)
. guarantorCNPJ (string)
. healthInsuranceCode (string)
. healthInsurerCode (string)
. holderCPF (string)
. holderRelationship (string)
. holderSubscriberId (string)
. houseNumbering (string)
. motherCPF (string)
. mothersName (string)
. name (string)
. nationalHealthCard (string)
. notifyANS (string)
. oldSubscriberId (string)
. partialCoverage (string)
. pisPasep (string)
. portabilityPlanCode (string)
. residentAbroad (string)
. skipRuleMothersName (string)
. skipRuleName (string)
. sponsorCPF (string)
. stateAbbreviation (string)
. statusAns (string)
. subscriberId (string)
. typeOfAddress (string)
. ZIPCode (string)
} (object) required
central_de_obrigacoes___sib/beneficiary_v1_000/get_beneficiaries_by_subscriber_idRetorna um beneficiario de acordo com o ID informadosubscriberId (string)
Authorization (string) required
fields (string)
healthInsurerCode (integer) required
codeCco (integer)
central_de_obrigacoes___sib/beneficiary_v1_000/put_beneficiaries_by_subscriber_idAltera e/ou gera uma movimentação de retificação para o SIB, de acordo com o ID informado.subscriberId (string)
Authorization (string) required
healthInsurerCode (integer) required
codeCco (integer)
data: {
. address (string)
. addressComplement (string)
. birthdate (string)
. blockDate (string)
. blockingReason (string)
. caepf (string)
. cityCode (string)
. cityCodeResidence (string)
. codeCco (string)
. codeSCPA (string)
. codeSusep (string)
. declarationOfLiveBirth (string)
. district (string)
. effectiveDate (string)
. excludedItems (string)
. gender (string)
. guarantorCEI (string)
. guarantorCNPJ (string)
. healthInsuranceCode (string)
. healthInsurerCode (string)
. holderCPF (string)
. holderRelationship (string)
. holderSubscriberId (string)
. houseNumbering (string)
. motherCPF (string)
. mothersName (string)
. name (string)
. nationalHealthCard (string)
. notifyANS (string)
. oldSubscriberId (string)
. partialCoverage (string)
. pisPasep (string)
. portabilityPlanCode (string)
. residentAbroad (string)
. skipRuleMothersName (string)
. skipRuleName (string)
. sponsorCPF (string)
. stateAbbreviation (string)
. statusAns (string)
. subscriberId (string)
. typeOfAddress (string)
. ZIPCode (string)
} (object) required
central_de_obrigacoes___sib/beneficiary_v1_000/delete_beneficiaries_by_subscriber_idDeleta um beneficiario.subscriberId (string)
Authorization (string) required
healthInsurerCode (integer) required
codeCco (integer)
central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_by_subscriber_id_blockGera uma movimanetação da action de bloqueio de um beneficiario.subscriberId (string)
Authorization (string) required
data: {
. healthInsurerCode (string)
. subscriberId (string)
. codeCco (string)
. blockingDate (string)
. blockingReason (string)
} (object) required
central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_by_subscriber_id_unblockGera uma movimanetação da action de desbloqueio de um beneficiario.subscriberId (string)
Authorization (string) required
data: {
. healthInsurerCode (string)
. subscriberId (string)
. codeCco (string)
. reactivationDate (string)
} (object) required
central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_by_subscriber_id_changer_contractGera uma movimanetação da action de mudança contratual de um beneficiario.subscriberId (string)
Authorization (string) required
data: {
. healthInsurerCode (string)
. subscriberId (string)
. codeCco (string)
. holderRelationship (string)
. holderSubscriberId (string)
. effectiveDate (string)
. insurancePlanCode (string)
. portabilityPlanCode (string)
. partialCoverage (string)
. excludedItems (string)
. guarantorCNPJ (string)
. guarantorCEI (string)
} (object) required
central_de_obrigacoes___sib/files_v1_000/get_files_by_year_month_referRetorna os arquivos de uma competênciayearMonthRefer (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
healthInsurerCode (string)
central_de_obrigacoes___sib/files_v1_000/get_files_ccos_by_file_nameRetorna os CCOs de um arquivofileName (string)
Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
healthInsurerCode (string)
central_de_obrigacoes___sib/product_v1_000/get_productsRetorna um lote de produtos.Authorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
healthInsurerCode (string)
central_de_obrigacoes___sib/product_v1_000/post_productsRealiza a inclusão de um produto.Authorization (string) required
data: {
. healthInsurerCode (string)
. code (string)
. description (string)
. wayOfHiring (string)
. marketSegmentation (string)
. coverageArea (string)
} (object) required
central_de_obrigacoes___sib/product_v1_000/get_products_by_codeRetorna um produto.code (string)
Authorization (string) required
central_de_obrigacoes___sib/product_v1_000/put_products_by_codeAltera informações do produto.code (string)
Authorization (string) required
data: {
. healthInsurerCode (string)
. code (string)
. description (string)
. wayOfHiring (string)
. marketSegmentation (string)
. coverageArea (string)
} (object) required
central_de_obrigacoes___sib/product_v1_000/delete_products_by_codeDeleta um produto.healthInsurerCode (string)
code (string)
Authorization (string) required
rms/branch_v1_000/get_branchesRetorna todas as Filiais da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
EnterpriseGroup (string)
rms/branch_v1_000/post_branchesInclui a Filial passada na requisiçãoAuthorization (string) required
data: {
. BranchInternalId (string)
. CompanyCode (string)
. UnitOfBusiness (string)
. ParentCode (string)
. Description (string)
. EnterpriseGroup (string)
. Code (string)
. Title (string)
. CGC (string)
. StateRegistration (string)
. DDD (string)
. Phone (string)
. Street (string)
. Complement (string)
. Neighborhood (string)
. State (string)
. City (string)
. ZipCode (string)
. CityCode (string)
. CNAECode (string)
. NatureCode (string)
. BillingAddress (string)
. BillingZipCode (string)
. BillingComplement (string)
. BillingNeighborhood (string)
. BillingCity (string)
. BillingState (string)
. NIRE (string)
. DTRE (string)
. Suframa (string)
. SubscriptionType (string)
. CityRegistration (string)
} (object) required
rms/branch_v1_000/get_branches_by_branch_internal_idRetorna todas as Filiais da baseBranchInternalId (string)
Authorization (string) required
rms/branch_v1_000/put_branches_by_branch_internal_idInclui a Filial passada na requisiçãoBranchInternalId (string)
Authorization (string) required
data: {
. BranchInternalId (string)
. CompanyCode (string)
. UnitOfBusiness (string)
. ParentCode (string)
. Description (string)
. EnterpriseGroup (string)
. Code (string)
. Title (string)
. CGC (string)
. StateRegistration (string)
. DDD (string)
. Phone (string)
. Street (string)
. Complement (string)
. Neighborhood (string)
. State (string)
. City (string)
. ZipCode (string)
. CityCode (string)
. CNAECode (string)
. NatureCode (string)
. BillingAddress (string)
. BillingZipCode (string)
. BillingComplement (string)
. BillingNeighborhood (string)
. BillingCity (string)
. BillingState (string)
. NIRE (string)
. DTRE (string)
. Suframa (string)
. SubscriptionType (string)
. CityRegistration (string)
} (object) required
rms/branch_v1_000/delete_branches_by_branch_internal_idNão é permitida a deleção da Filial por API, por motivos de segurançaBranchInternalId (string)
rms/city_v1_000/get_cityRetorna lista completa de cidadesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rms/city_v1_000/post_cityInclui uma cidade conforme dados enviados na requisição.Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Type (string)
. OfficialCode (string)
. Description (string)
. IATANumber (string)
. FederalUnit (string)
. CountryCode (string)
. Situation (string)
} (object) required
rms/city_v1_000/get_city_by_internal_idRetorna os dados da cidade conforme o código informado na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
rms/city_v1_000/put_city_by_internal_idAtualiza cadastro da cidade conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Type (string)
. OfficialCode (string)
. Description (string)
. IATANumber (string)
. FederalUnit (string)
. CountryCode (string)
. Situation (string)
} (object) required
rms/city_v1_000/delete_city_by_internal_idExclui cadastro de cidade conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
rms/company_v1_000/get_companiesRetorna todas as empresas da baseAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
rms/company_v1_000/post_companiesInclui a Empresa passada na requisiçãoAuthorization (string) required
data: {
. Code (string)
. InternalId (string)
. CorporateName (string)
. FancyName (string)
. ShortName (string)
. GovernmentalInformation (object)
. Address (object)
. ContactInformation (object)
. Layout (string)
. BranchLength (string)
. CommunicationInformation (object)
} (object) required
rms/company_v1_000/get_companies_by_codeRetorna todas as Empresas da baseCode (string)
Authorization (string) required
rms/company_v1_000/put_companies_by_codeInclui a Empresa passada na requisiçãoCode (string)
Authorization (string) required
data: {
. Code (string)
. InternalId (string)
. CorporateName (string)
. FancyName (string)
. ShortName (string)
. GovernmentalInformation (object)
. Address (object)
. ContactInformation (object)
. Layout (string)
. BranchLength (string)
. CommunicationInformation (object)
} (object) required
rms/company_v1_000/delete_companies_by_codeNão é permitida a deleção da Empresa por API, por motivos de segurançaCode (string)
rms/country_v1_000/get_countriesRetorna lista completa de paísesAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rms/country_v1_000/post_countriesInclui um novo País conforme dados enviados na requisição.Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
} (object) required
rms/country_v1_000/get_countries_by_internal_idRetorna os dados do País conforme o código informado na requisiçãoInternalId (string)
Authorization (string) required
fields (string)
rms/country_v1_000/put_countries_by_internal_idAtualiza cadastro do País conforme dados enviados na requisiçãoInternalId (string)
Authorization (string) required
data: {
. InternalId (string)
. Code (string)
. Description (string)
. OfficialCode (number)
} (object) required
rms/country_v1_000/delete_countries_by_internal_idExclui cadastro do País conforme dados enviados na requisição.InternalId (string)
Authorization (string) required
rms/sellers_v1_000/get_sellersRetorna todos os vendedoresAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
rms/sellers_v1_000/post_sellersInclui o vendedor passado na requisiçãoAuthorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Name (string)
. ShortName (string)
. PersonalIdentification (string)
. SellerPassword (string)
. SellerPhoneDDD (string)
. SellerPhone (string)
. SellerEmail (string)
. Address (object)
. SalesChargeInformation (object)
. Active (boolean)
. RepresentativeType (string)
} (object) required
rms/sellers_v1_000/get_sellers_by_internal_idRetorna um vendedor com base no código informadoInternalId (string)
Authorization (string) required
fields (string)
rms/sellers_v1_000/put_sellers_by_internal_idAtualiza um vendedor com base no código informadoInternalId (string)
Authorization (string) required
data: {
. CompanyId (string)
. BranchId (string)
. CompanyInternalId (string)
. Code (string)
. InternalId (string)
. Name (string)
. ShortName (string)
. PersonalIdentification (string)
. SellerPassword (string)
. SellerPhoneDDD (string)
. SellerPhone (string)
. SellerEmail (string)
. Address (object)
. SalesChargeInformation (object)
. Active (boolean)
. RepresentativeType (string)
} (object) required
rms/sellers_v1_000/delete_sellers_by_internal_idExclui um vendedor com base no código informadoInternalId (string)
Authorization (string) required
rms/withdrawals_v1_000/get_withdrawalsRetorna todas as sangrias cadastradasAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
rms/withdrawals_v1_000/post_withdrawalsInclui a entidade sangria passada na requisiçãoAuthorization (string) required
data: {
. internalId (string)
. storeId (string)
. movementDate (string)
. stationSalePointCode (string)
. movementType (string)
. movementNumber (string)
. paymentMethodCode (string)
. coupon (string)
. cashierCode (string)
. shift (string)
. inspector (string)
. withdrawalValue (number)
. updateUser (string)
. updateDate (string)
} (object) required
rms/withdrawals_v1_000/get_withdrawals_by_internal_idRetorna a sangria com base no identificador passadointernalId (string)
Authorization (string) required
fields (string)
rms/withdrawals_v1_000/put_withdrawals_by_internal_idAtualiza a sangria com base no identificador passadointernalId (string)
Authorization (string) required
data: {
. internalId (string)
. storeId (string)
. movementDate (string)
. stationSalePointCode (string)
. movementType (string)
. movementNumber (string)
. paymentMethodCode (string)
. coupon (string)
. cashierCode (string)
. shift (string)
. inspector (string)
. withdrawalValue (number)
. updateUser (string)
. updateDate (string)
} (object) required
rms/withdrawals_v1_000/delete_withdrawals_by_internal_idExclui a sangria com base no identificador passadointernalId (string)
Authorization (string) required
winthor/distribution_v1_000/get_distributionsRetorna todas as praças disponíveisorder (array)
page (integer)
pageSize (integer)
fields (string)
winthor/distribution_v1_000/post_distributionsInsere a praça passada na requisiçãodata: {
. id (integer)
. description (string)
. regionId (integer)
. routeId (integer)
. mainDistributionId (integer)
. routeSequence (integer)
. population (integer)
. distance (number)
. minLoadValue (number)
. minLoadPercentage (number)
. activeDistribution (boolean)
. initialZipCode (string)
. finalZipCode (string)
. deliveryPriority (boolean)
} (object) required
winthor/distribution_v1_000/get_distributions_by_idRetorna uma praça a partir do código informadoid (integer)
winthor/distribution_v1_000/put_distributions_by_idAltera a praça passada na requisiçãoid (integer)
data: {
. id (integer)
. description (string)
. regionId (integer)
. routeId (integer)
. mainDistributionId (integer)
. routeSequence (integer)
. population (integer)
. distance (number)
. minLoadValue (number)
. minLoadPercentage (number)
. activeDistribution (boolean)
. initialZipCode (string)
. finalZipCode (string)
. deliveryPriority (boolean)
} (object) required
winthor/distribution_v1_000/delete_distributions_by_idRemove uma praça a partir do código informadoid (integer)
winthor/paymentticket_v1_000/post_incoming_bills_digitablelineGera a linha digitável para a transaçãodata: {
. barCode (string)
. bankCode (integer)
. sellTransactionNumber (integer)
. installmentsNumber (string)
} (object) required
winthor/paymentticket_v1_000/get_layoutsPesquisar layouts de códigos de barra, baseado nos dados informados que servirão como filtros e de maneira paginada.name (string)
status (string) required
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/paymentticket_v1_000/post_layoutsSalva um Layout de boletodata: {
. id (integer)
. name (string)
. size (integer)
. correspondingOurNumber
. layoutVariables (array)
. digitableLineVariable
. status (string)
} (object) required
winthor/paymentticket_v1_000/post_layouts_buildGera e persiste o código de barras, nosso número e linha digitaveldata: {
. sellTransactionNumber (integer)
. bankCode (integer)
. installment (string)
. branchCode (string)
. usesGrossValue (boolean)
} (object) required
winthor/paymentticket_v1_000/post_layouts_parameters_validateValidar parâmetro de uma variáveldata: {
. id (integer)
. name (string)
. formula (string)
} (object) required
winthor/paymentticket_v1_000/get_layouts_parameters_variables_by_idListar parâmetros de uma variávelid (integer)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/paymentticket_v1_000/get_layouts_by_idConsultar layouts de códigos de barraid (integer)
winthor/paymentticket_v1_000/delete_layouts_by_idExclui o registro de um layoutid (integer)
winthor/paymentticket_v1_000/get_variablesListar todas as variáveis cadastradasstatus (string)
dataType (string)
variableType (string)
contentType (string)
ourNumber (string)
name (string)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/paymentticket_v1_000/post_variablesSalvar uma variável que pode vim a compor um código de barrasdata: {
. id (integer)
. name (string)
. description (string)
. variableType (string)
. dataType (string)
. contentType (string)
. ourNumberVariable (string)
. parameters (array)
. content (string)
. status (string)
} (object) required
winthor/paymentticket_v1_000/get_variables_compatiblesPesquisar se as variáveis compatíveis com cada tipo de conteúdoFórmula, Função e Sql. Exemplo: Somente variáveis do tipo de dados númerico, são compatíveis comvariáveis do tipo de conteúdo Fórmula.id (integer)
entity (string)
contentType (string)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/paymentticket_v1_000/post_variables_validateValidar conteúdo de uma variáveldata: {
. id (integer)
. name (string)
. description (string)
. variableType (string)
. dataType (string)
. contentType (string)
. ourNumberVariable (string)
. parameters (array)
. content (string)
. status (string)
} (object) required
winthor/paymentticket_v1_000/get_variables_by_idConsultar variável por códigoid (integer)
winthor/paymentticket_v1_000/delete_variables_by_idExcluir variável por códigoid (integer)
winthor/paymentticket_v1_000/get_variables_by_id_linksConsulta os layouts vinculados à variávelid (integer)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/productdepartment_v1_000/get_product_departmentsReturns an list of all departmentsAuthorization (string) required
order (array)
page (integer)
pageSize (integer)
fields (string)
description (string)
typeMerchandise (string)
winthor/productdepartment_v1_000/post_product_departmentsReturns a department insertedAuthorization (string) required
data: {
. id (integer)
. description (string)
. updateStockGeneral (boolean)
. typeMerchandise (string)
} (object) required
winthor/productdepartment_v1_000/delete_product_departments_by_idRemoves a department informedid (integer)
Authorization (string) required
winthor/productdepartment_v1_000/get_product_departments_by_idReturns an informed departmentid (integer)
Authorization (string) required
winthor/productdepartment_v1_000/put_product_departments_by_idReturns a department updatedid (integer)
Authorization (string) required
data: {
. id (integer)
. description (string)
. updateStockGeneral (boolean)
. typeMerchandise (string)
} (object) required
winthor/route_v1_000/get_routesRetorna todas as rotas disponíveisorder (array)
page (integer)
pageSize (integer)
fields (string)
winthor/route_v1_000/post_routesInclui rota passada na requisiçãodata: {
. id (integer)
. description (string)
. aidPercentage (number)
. aidValue (number)
. deliveryTime (integer)
. crawledRoute (boolean)
. commissionType (string)
. kilometers (integer)
. numberOfNights (integer)
. dailyValue (number)
. deliverySequence (integer)
. minChargingValue (number)
. mainRouteId (integer)
. driversComission
. ChargingDays
. SalesNumbersType14
. Freight
} (object) required
winthor/route_v1_000/put_routes_by_idAltera a rota passada na requisiçãoid (integer)
data: {
. id (integer)
. description (string)
. aidPercentage (number)
. aidValue (number)
. deliveryTime (integer)
. crawledRoute (boolean)
. commissionType (string)
. kilometers (integer)
. numberOfNights (integer)
. dailyValue (number)
. deliverySequence (integer)
. minChargingValue (number)
. mainRouteId (integer)
. driversComission
. ChargingDays
. SalesNumbersType14
. Freight
} (object) required
winthor/route_v1_000/get_routes_by_idRetorna uma rota a partir de um códigoid (integer)
winthor/route_v1_000/delete_routes_by_idRemove uma rota a partir de um código informadoid (integer)
winthor/stock_v1_000/post_curves_consolidateConsolidação dos dados de Curva ABC para giro customizadoAuthorization (string) required
winthor/stock_v1_000/get_curves_tablesApresenta a tabela de Curva ABC disponivel para o giro dia customizadosubsidiary (string)
type (string)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/stock_v1_000/get_curves_by_curve_key_subcurves_by_sub_curve_key_frequencies_by_keyLista de frequencia de compras para o conjunto de curva, sub-curva e frequenciacurveKey (string)
subCurveKey (string)
key (string)
subsidiary (string)
type (string)
Authorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/stock_v1_000/get_curves_by_curve_key_subsidiaries_by_subsidiaryObtem uma Curva ABC do giro customizado por identificador unico e filialcurveKey (string)
subsidiary (string)
Authorization (string) required
winthor/stock_v1_000/get_figuresListagem de figuras disponiveis para giro dia customizadoAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/stock_v1_000/get_figures_by_idObtem os dados de uma figura de acordo com o identificador unicoid (integer)
Authorization (string) required
fields (string)
winthor/stock_v1_000/get_scenariosLista os cenários para giro dia customizadoAuthorization (string) required
page (integer)
pageSize (integer)
order (array)
fields (string)
winthor/stock_v1_000/get_scenarios_products_by_product_id_subsidiaries_by_subsidiaryObtem um cenários através do codigo do produto e filialproductId (integer)
subsidiary (string)
Authorization (string) required
fields (string)
winthor/stock_v1_000/get_scenarios_by_idObtem um cenários por identificador unicoid (integer)
Authorization (string) required
fields (string)
winthor/stock_v1_000/post_turnover_day_consolidateRealiza o processo de calculo de giro dia customizado, consolidando os valores de giro para cada produto.Authorization (string) required
winthor/stock_v1_000/get_turnover_day_memories_products_by_product_id_subsidiaries_by_subsidiaryObtem a memoria de calculo do giro dia customizado, por produto e filialproductId (integer)
subsidiary (string)
Authorization (string) required
fields (string)
winthor/stock_v1_000/post_turnover_day_sales_consolidateRealiza a consolidação de dados de vendas falta, transferencia, kits para o giro dia customizado de acordo com o intervalo de dadas informado.Authorization (string) required
data: {
. dateStart (string)
. dateFinal (string)
} (object) required
winthor/wholesalebilling_v1_000/get_ordersRetorna todos os Pedidos de Venda disponíveisorder (array)
page (integer)
pageSize (integer)
fields (string)
saleType (string)
status (string)
winthor/wholesalebilling_v1_000/post_ordersInicia o processo de faturamento da venda passada na requisiçãodata: {
. _expandables (array)
. id (integer)
. saleType (integer)
. date (date)
. branchId (string)
. branchInvoiceId (string)
. client
. paymentMethod (string)
. paymentPlanId (integer)
. salesPerson
. amount (number)
. doWarehouseBranchTransfer (boolean)
. doInvoiceBranchTransfer (boolean)
. status (string)
. origin (string)
. shipmentId (integer)
. taxDocumentType (string)
. listOfAction (array)
. kind (string)
} (object) required
winthor/wholesalebilling_v1_000/put_orders_by_idInicia o processo de faturamento da venda passada na requisiçãoid (integer)
data: {
. _expandables (array)
. id (integer)
. saleType (integer)
. date (date)
. branchId (string)
. branchInvoiceId (string)
. client
. paymentMethod (string)
. paymentPlanId (integer)
. salesPerson
. amount (number)
. doWarehouseBranchTransfer (boolean)
. doInvoiceBranchTransfer (boolean)
. status (string)
. origin (string)
. shipmentId (integer)
. taxDocumentType (string)
. listOfAction (array)
. kind (string)
} (object) required
winthor/wholesalebilling_v1_000/get_orders_by_idRetorna um Pedido de Venda a partir de um códigoid (integer)
winthor/wholesalebilling_v1_000/get_shipmentsRetorna todos os Carregamentos disponíveisorder (array)
page (integer)
pageSize (integer)
fields (string)
status (string)
winthor/wholesalebilling_v1_000/post_shipmentsInicia o processo de faturamento da venda passada na requisiçãodata: {
. _expandables (array)
. id (integer)
. departureDate (date)
. status (string)
. orderCount (integer)
. destination (string)
. weight (date)
. value (number)
. driver
. vehicle
. billingDate (date)
. cancellationDate (date)
. isWmsPending (boolean)
. listOfOrder (array)
. listOfAction (array)
. kind (string)
} (object) required
winthor/wholesalebilling_v1_000/put_shipments_by_idInicia o processo de faturamento da venda passada na requisiçãoid (integer)
data: {
. _expandables (array)
. id (integer)
. departureDate (date)
. status (string)
. orderCount (integer)
. destination (string)
. weight (date)
. value (number)
. driver
. vehicle
. billingDate (date)
. cancellationDate (date)
. isWmsPending (boolean)
. listOfOrder (array)
. listOfAction (array)
. kind (string)
} (object) required
winthor/wholesalebilling_v1_000/get_shipments_by_idRetorna um Carregamento a partir de um códigoid (integer)
winthor/wholesaleordercancel_v1_000/delete_ordersCancela um pedido de venda não faturadoAuthorization (string) required
id (integer) required
productCode (integer)
sequence (integer)
sendMessageRca (boolean) required
reasonCancellation (string) required
prosaude/extract_v1_000/get_extractsRetorna uma mensagem do tipo coleção com todos os gastos com o plano de saúde. Os resultados podem ser filtrados através dos parâmetros bholderholderSubscriberId/b, byearMonth/b, e byear/b.page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
holderholderSubscriberId (string)
yearMonth (string)
year (string)
prosaude/healthcareuser_v1_000/get_health_care_usersRetorna um lote de usuário de acordo com os parametros enviados. É possivel filtrar o resultado através de todas as propriedades com excessão do CBOSpage (integer)
pageSize (integer)
order (array)
fields (string)
Authorization (string) required
Expires_at (string) required
prosaude/healthcareuser_v1_000/post_health_care_usersRealiza a inclusão de um usuário conforme body da requisição.Authorization (string) required
Expires_at (string) required
data: {
. username (string)
. email (string)
. name (string)
. document (number)
. profile (string)
. type (string)
. tenantData (array)
} (object) required
prosaude/healthcareuser_v1_000/get_health_care_users_by_idRetorna um usuário de acordo com o código informadoid (string)
Authorization (string) required
expand (string)
Expires_at (string) required
prosaude/healthcareuser_v1_000/put_health_care_users_by_idAltera informações do usuário de acordo com o ID informadoid (string)
Authorization (string) required
Expires_at (string) required
data: {
. id (number)
. authId (number)
. username (string)
. email (string)
. name (string)
. document (number)
. profile (string)
. type (string)
. active (number)
. deleted (number)
. tenantData
. userInfo
} (object) required
prosaude/procedureclass_v1_000/get_procedures_classesRetorna uma mensagem do tipo coleção com todas as classes de procedimentos. Os resultados podem ser filtrados através dos parâmetros bclassType/b e btypeDrug/b.page (integer)
pageSize (integer)
order (array)
fields (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
classType (string)
typeDrug (string)
prosaude/procedureclass_v1_000/get_procedures_classes_by_procedure_class_codeRetorna a classe de procedimento de saúde do código especificadoprocedureClassCode (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
prosaude/procedureclass_v1_000/get_procedures_classes_by_procedure_class_code_proceduresRetorna uma mensagem do tipo coleção com todos os procedimentos da classe de procedimento. Os resultados podem ser filtrados através dos parâmetros btableCode/b, beventType/b, bactive/b, ballowedGender/b e ballowRefund/b. E ordenados pelos campos btableCode/b, bprocedureCode/b, beventType/b e bactive/b.procedureClassCode (string)
page (integer)
pageSize (integer)
order (array)
fields (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
tableCode (string)
eventType (string)
active (string)
allowedGender (string)
allowRefund (string)
prosaude/refund_v1_000/get_refundsRetorna uma mensagem do tipo coleção com todas as solicitações de reembolso. Os resultados podem ser filtrados através dos parâmetros bholderSubscriberId/b, bunrelatedHealthProvider/b, bcpfCnpj/b e bstatus/b.page (integer)
pageSize (integer)
order (array)
expand (string)
fields (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
holderSubscriberId (string)
unrelatedHealthProvider (string)
cpfCnpj (string)
status (string)
prosaude/refund_v1_000/post_refundsRealiza solicitação de reembolso de um serviço médico prestado por uma rede não referenciadaContent-Type (string) required
Authorization (string) required
Expires_at (string) required
data: {
. holderSubscriberId (string)
. cpfCnpj (string)
. unrelatedHealthProviderName (string)
. voucherType (string)
. voucherNumber (string)
. voucherDate (string)
. voucherPhoto (string)
. refundItems (array)
} (object) required
prosaude/refund_v1_000/get_refunds_by_protocol_numberRetorna a solicitação de reembolso do protocolo especificadoprotocolNumber (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
fields (string)
expand (string)
prosaude/unrelatedhealthprovider_v1_000/get_unrelated_health_providersRetorna uma mensagem do tipo coleção com todos os prestadores de serviços de saúde não referenciados da operadora. Os resultados podem ser filtrados através dos parâmetros bcpfCnpj/b, bstate/b e bcity/b.page (integer)
pageSize (integer)
order (array)
fields (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
cpfCnpj (string)
state (string)
city (string)
prosaude/unrelatedhealthprovider_v1_000/post_unrelated_health_providersCadastra um prestador de serviço de saúde não referenciado.Content-Type (string) required
Authorization (string) required
Expires_at (string) required
data: {
. name (string)
. cpfCnpj (string)
. state (string)
. cityCode (string)
} (object) required
prosaude/unrelatedhealthprovider_v1_000/get_unrelated_health_providers_by_unrelated_health_provider_codeRetorna um prestador de serviço de saúde não referenciado.unrelatedHealthProviderCode (string)
Content-Type (string) required
Authorization (string) required
Expires_at (string) required
totvschecklist/inspectionobject_v2_000/get_inspection_objectsMétodo responsável por retornar todos os objetos de inspeção respeitando os filtros de requisiçãoInspectionObjectCustomId (string)
Description (string)
order (array)
page (integer)
pageSize (integer)
totvschecklist/inspectionobject_v2_000/post_inspection_objectsMétodo responsável por criar um objeto de inspeçãodata: {
. id (integer)
. InspectionObjectCustomId (string)
. inspectionObjectType
. description (string)
. _expandables (array)
. internalId (string)
} (object) required
totvschecklist/inspectionobject_v2_000/put_inspection_objects_by_idMétodo responsável por alterar a descrição de um objeto de inspeçãoid (integer)
data: {
. id (integer)
. InspectionObjectCustomId (string)
. inspectionObjectType
. description (string)
. _expandables (array)
. internalId (string)
} (object) required
totvschecklist/inspectionobject_v2_000/delete_inspection_objects_by_idMétodo responsável por remover um objeto de inspeçãoid (integer)
totvschecklist/inspectionobject_v2_000/get_inspection_objects_by_idMétodo responsável por retornar o objeto de inspeção que possui o id passado como parâmetroid (integer)
fields (string)
expand (string)
totvschecklist/inspectionscript_v1_000/get_inspection_scripts_by_inspection_script_id_draft_versionMétodo responsável por retornar as informações detalhadas da versão de rascunhoinspectionScriptId (integer)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_draft_versionMétodo responsável por alterar as informações do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
data: {
. title (string)
. description (string)
. executionStyleId (integer)
} (object) required
totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_versionMétodo responsável por adicionar uma categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
data: {
. name (string)
. description (string)
. iconId (integer)
} (object) required
totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_idMétodo responsável por alterar a categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
Authorization (string) required
data: {
. customCategoryId (integer)
. name (string)
. description (string)
. iconId (integer)
} (object) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_idMétodo responsável por remover uma categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_version_vehicular_categoryMétodo responsável por adicionar uma categoria veicular na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_draft_version_vehicular_categoryMétodo responsável por remover a categoria veicular na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_itemMétodo responsável por adicionar um item em uma categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
Authorization (string) required
data: {
. questionTypeId (integer)
. name (string)
. hasObservation (boolean)
. helpPhrase (string)
. defineEvidence
. nonComplianceSuggestions (array)
} (object) required
totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_item_by_item_idMétodo responsável por alterar um item da categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
itemId (integer)
Authorization (string) required
data: {
. itemId (integer)
. questionType
. hasObservation (boolean)
. name (string)
. helpPhrase (string)
. evidence
. nonComplianceSuggestions (array)
} (object) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_item_by_item_idMétodo responsável por remover um item de uma categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
itemId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_item_by_item_id_non_compliance_suggestion_by_non_compliance_suggestion_idMétodo responsável por alterar a criticidade de uma sugestão de não conformidade de um item da categoria na versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
customCategoryId (integer)
itemId (integer)
nonComplianceSuggestionId (integer)
Authorization (string) required
data: {
. inspectionScriptId (integer)
. customCategoryId (integer)
. itemId (integer)
. nonComplianceSuggestionId (integer)
. criticalityId (integer)
} (object) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_item_by_item_id_non_compliance_suggestion_by_non_compliance_suggestion_idMétodo responsável por remover uma sugestão de não conformidade de um item de uma categoriainspectionScriptId (integer)
customCategoryId (integer)
itemId (integer)
nonComplianceSuggestionId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/get_inspection_scriptsMétodo responsável por retornar todos os roteiros de inspeção com a ùltima versãoTitle (string)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
expand (string)
totvschecklist/inspectionscript_v1_000/post_inspection_scriptsMétodo responsável por criar um roteiro de inspeção com uma versão de rascunhodata: {
. versionTitle (string)
. versionDescription (string)
. versionInspectionObjectTypeId (integer)
. versionExecutionStyleId (integer)
} (object) required
totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_publish_draft_versionMétodo responsável por publicar uma versão de rascunho de um roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_discard_draft_versionMétodo responsável por descartar uma versão de rascunho do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_idMétodo responsável por remover um roteiro de inspeção junto com sua versão de rascunhoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_new_draft_version_from_current_versionMétodo responsável por criar uma versão de rascunho a partir da versão corrente do roteiro de inspeçãoinspectionScriptId (integer)
Authorization (string) required
totvschecklist/inspectionscript_v1_000/get_inspection_scripts_by_inspection_script_id_versionMétodo responsável por retornar ums lista das versões do roteiro de inspeção informadoinspectionScriptId (integer)
Authorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
expand (string)
totvschecklist/inspectionscript_v1_000/get_inspection_scripts_version_by_version_idMétodo responsável por retornar a versão completa, com todos os registros filhosversionId (integer)
Authorization (string) required
fields (string)
expand (string)
totvschecklist/locality_v1_000/get_localitiesMétodo responsável por retornar todas as localidades respeitando os filtros da requisiçãoAuthorization (string) required
fields (string)
order (array)
page (integer)
pageSize (integer)
expand (string)
totvschecklist/locality_v1_000/post_localitiesMétodo responsável por criar uma localidade com suas localizações e limitada ao usuáriodata: {
. name (string)
. description (string)
. locations (array)
. limitedToUsers (array)
} (object) required
totvschecklist/locality_v1_000/put_localities_by_locality_idMétodo responsável por atualizar uma localidade com suas localizaçõeslocalityId (integer)
Authorization (string) required
data: {
. name (string)
. description (string)
. localityId (integer)
. locations (array)
} (object) required
totvschecklist/locality_v1_000/delete_localities_by_locality_idMétodo responsável por eliminar uma localidadelocalityId (integer)
Authorization (string) required
totvschecklist/locality_v1_000/get_localities_by_locality_idMétodo responsável por retornar a localidade que possui o id passado como parâmetrolocalityId (integer)
Authorization (string) required
fields (string)
expand (string)
totvschecklist/locality_v1_000/post_localities_by_locality_id_limit_to_usersMétodo responsável por atualizar os usuários limitados à localidadelocalityId (integer)
Authorization (string) required
data: {
. localityId (integer)
. limitedToUsers (array)
} (object) required
proxima_pims/marks_v1_000/get_marksRetorna um conjunto de marcassearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
proxima_pims/marks_v1_000/post_marksAdiciona uma nova marcadata (object) required
proxima_pims/marks_v1_000/get_marks_by_codeRetorna uma única marcaCode (string)
proxima_pims/marks_v1_000/put_marks_by_codeAtualiza uma marca existenteCode (string)
data (object) required
proxima_pims/marks_v1_000/delete_marks_by_codeDeleta uma marcaCode (string)
proxima_pims/models_v1_000/get_modelsRetorna um conjunto de modelossearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
proxima_pims/models_v1_000/post_modelsAdiciona um novo modelodata: {
. Code (string)
. InternalId (string)
. Description (string)
. MarkCode (string)
. MarkInternalId (string)
. PowerClassCode (string)
. PowerClassInternalId (string)
. OperativeGroupCode (string)
. OperativeGroupInternalId (string)
} (object) required
proxima_pims/models_v1_000/get_models_by_codeRetorna um único modeloCode (string)
proxima_pims/models_v1_000/put_models_by_codeAtualiza um modelo existenteCode (string)
data: {
. Code (string)
. InternalId (string)
. Description (string)
. MarkCode (string)
. MarkInternalId (string)
. PowerClassCode (string)
. PowerClassInternalId (string)
. OperativeGroupCode (string)
. OperativeGroupInternalId (string)
} (object) required
proxima_pims/models_v1_000/delete_models_by_codeDeleta um modeloid (string)
Code (string)
proxima_pims/operationalcategory_v1_000/get_operational_categorysRetorna um conjunto de Categorias Operacionaissearch (string)
order (array)
pageSize (integer)
page (integer)
fields (string)
proxima_pims/operationalcategory_v1_000/post_operational_categorysAdiciona uma nova categoria operacionaldata: {
. Code (string)
. Description (string)
. ShortName (string)
. UnitOfMeasureCode (string)
} (object) required
proxima_pims/operationalcategory_v1_000/get_operational_categorys_by_codeRetorna uma única categoria operacionalCode (string)
proxima_pims/operationalcategory_v1_000/put_operational_categorys_by_codeAtualiza uma categoria operacional existenteCode (string)
data: {
. Code (string)
. Description (string)
. ShortName (string)
. UnitOfMeasureCode (string)
} (object) required
proxima_pims/operationalcategory_v1_000/delete_operational_categorys_by_codeDeleta uma categoria operacionalCode (string)
proxima_pims/reasonoccurrence_v1_000/get_reason_occurrencesReturns a list of occurrences reasons.fields (string)
expand (string)
order (array)
page (integer)
pageSize (integer)
cdReasonOccurrence (integer)
cdControlTypeOccurrence (integer)
proxima_pims/reasonoccurrence_v1_000/post_reason_occurrencesAdds a new occurrence reason.data: {
. _expandables (array)
. cdControlTypeOccurrence (integer)
. cdReasonOccurrence (integer)
. deReasonOccurrence (string)
} (object) required
proxima_pims/reasonoccurrence_v1_000/get_reason_occurrences_by_cd_reason_occurrence_by_cd_control_type_occurrenceReturns an occurrence reason by primary key.cdReasonOccurrence (integer)
cdControlTypeOccurrence (integer)
proxima_pims/reasonoccurrence_v1_000/put_reason_occurrences_by_cd_reason_occurrence_by_cd_control_type_occurrenceUpdates an occurrence reason.cdReasonOccurrence (integer)
cdControlTypeOccurrence (integer)
data: {
. _expandables (array)
. cdControlTypeOccurrence (integer)
. cdReasonOccurrence (integer)
. deReasonOccurrence (string)
} (object) required
proxima_pims/reasonoccurrence_v1_000/delete_reason_occurrences_by_cd_reason_occurrence_by_cd_control_type_occurrenceDeletes an occurrence reason.cdReasonOccurrence (integer)
cdControlTypeOccurrence (integer)
central_de_obrigacoes___monitoramento/monitoring_v1_000/post_monit_formInsere e/ou gera movimentações referentes a guia de monitoramentoAuthorization (string) required
data: {
. admissionType (string)
. aEventType (string)
. ansRecordNumber (string)
. appointmentType (string)
. authorizationDate (string)
. cboSCode (string)
. cnes (string)
. collectionProtocolDate (string)
. escortDailyRates (string)
. eventOrigin (string)
. exclusionId (string)
. executingCityCode (string)
. executionDate (string)
. executerId (string)
. formProcDt (string)
. hospitalizationRequest (string)
. hospRegime (string)
. hospTp (string)
. icdDiagnosis1 (string)
. icdDiagnosis2 (string)
. icdDiagnosis3 (string)
. icdDiagnosis4 (string)
. icuDailyRates (string)
. indicAccident (string)
. invoicingEndDate (string)
. invoicingStartDate (string)
. invoicingTp (string)
. mainFormNumb (string)
. newborn (string)
. operatorFormNumber (string)
. operatorRecord (string)
. outflowType (string)
. paymentDt (string)
. presetValueIdent (string)
. providerCpfCnpj (string)
. providerFormNumber (string)
. requestDate (string)
. refundId (string)
. registration (string)
. roboId (string)
. serviceType (string)
. submissionMethod (string)
. tissProviderVersion (string)
. monitFormCertificates (array)
. monitFormEvents (array)
} (object) required
central_de_obrigacoes___monitoramento/monitoring_v1_000/post_monit_preset_valueInsere e/ou gera movimentações prestabelecidas referentes a guia de monitoramentoAuthorization (string) required
data: {
. ansRecordNumber (string)
. cityOfProvider (string)
. cnes (string)
. exclusionId (string)
. operatorRecord (string)
. presetValue (string)
. presetValueIdent (string)
. periodCover (string)
. providerCpfCnpj (string)
. providerIdentifier (string)
. roboId (string)
} (object) required
central_de_obrigacoes___monitoramento/monitoring_v1_000/post_monit_other_remunerationInsere e/ou gera movimentações referentes à outras remuneraçõesAuthorization (string) required
data: {
. exclusionId (string)
. identReceipt (string)
. formProcDt (string)
. operatorRecord (string)
. providerCpfCnpj (string)
. totalDisallowValue (string)
. totalValueEntered (string)
. totalValuePaid (string)
} (object) required
central_de_obrigacoes___monitoramento/monitoring_v1_000/post_monit_direct_supplyInsere e/ou gera movimentações de Fornecimento Direto.Authorization (string) required
data: {
. exclusionId (string)
. formProcDt (string)
. operatorRecord (string)
. providerFormNumber (string)
. registration (string)
. roboId (string)
. monitDirectSupplyEvents (array)
} (object) required
pims/weighingtype_v1_000/get_weighing_typesReturns a list of weighing types.Accept-Language (string)
page (integer)
pageSize (integer)
fields (string)
expand (string)
order (array)
instance (string)
weighingType (integer)
pims/weighingtype_v1_000/post_weighing_typesAdds a new weighing type.data: {
. _expandables (array)
. deWeighingType (string)
. goBack (string)
. instance (string)
. numberWeighings (integer)
. platformSize (integer)
. process (string)
. vehicle (string)
. volumes (integer)
. weighingScheme (string)
. weighingType (integer)
. weighings (array)
} (object) required
pims/weighingtype_v1_000/get_weighing_types_by_instance_by_weighing_typeReturns a weighing type by primary key.instance (string)
weighingType (integer)
pims/weighingtype_v1_000/put_weighing_types_by_instance_by_weighing_typeUpdates a weighing type.instance (string)
weighingType (integer)
data (undefined) required
pims/weighingtype_v1_000/delete_weighing_types_by_instance_by_weighing_typeDeletes a weighing type.instance (string)
weighingType (integer)
data (undefined) required