Totvs
Connect with Totvs standard message API.
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 2301 actions:
| Action | Purpose | Parameters |
|---|---|---|
| ecommercecustomer_v1_000/get_customers | Retorna uma lista com todos os clientes E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommerceorder_v1_000/get_orders | Retorna uma lista com todos os pedidos de E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) branchId (string) lastChange (string) |
| ecommerceproductbrand_v1_000/get_productbrands | Retorna uma lista com todas as Marcas de Produto E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommerceproductcategory_v1_000/get_productcategories | Retorna uma lista com todas as Categorias de Produto E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommerceproductroot_v1_000/get_productroots | Retorna uma lista com todos Produtos Raiz E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommerceproductskuspecification_v1_000/get_productskuspecifications | Retorna uma lista com todas as Especificações de Produto SKU E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommerceproductsku_v1_000/get_productskus | Retorna uma lista com todos os Produtos SKU E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommercestockproduct_v1_000/get_stockproducts | Retorna uma lista com todos os Estoque de Produto SKU E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| ecommercetraceabilitydocuments_v1_000/get_documents | Retorna uma lista com todos os Documentos de rastreio de Pedidos E-Commerce | order (array) fields (string) page (integer) pageSize (integer) companyId (string) required branchId (string) required lastChange (string) |
| representative_v1_000/get_representative | Retorna lista completa dos Representantes. | order (array) page (integer) pageSize (integer) fields (string) |
| representative_v1_000/post_representative | Método não implementado. | data (undefined) required |
| representative_v1_000/get_representative_by_internal_id | Retorna o Representante pelo InternalId. | InternalId (string) fields (string) |
| representative_v1_000/put_representative_by_internal_id | Método não implementado. | InternalId (string) fields (string) data (undefined) required |
| representative_v1_000/delete_representative_by_internal_id | Método não implementado. | InternalId (string) |
| gps/accommodationtype_v1_000/get_accommodation_types_by_code | Retorna dados de classe hospitalar | code (integer) |
| gps/accommodationtype_v1_000/delete_accommodation_types_by_code | Exclui classe hospitalar | code (integer) |
| gps/accommodationtype_v1_000/put_accommodation_types_by_code | Atualiza um registro existente de classe hospitalar | code (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_types | Busca dados de classe hospitalar existentes | codeInitial (integer) codeFinal (integer) hierarchicalLevelInitial (integer) hierarchicalLevelFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/accommodationtype_v1_000/post_accommodation_types | Inclui um novo registro de classe hospitalar | data: { . 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_code | Retorna dados de tipo de documentos | code (integer) |
| gps/attachmenttype_v1_000/delete_attachment_types_by_code | Exclui tipo de documentos | code (integer) |
| gps/attachmenttype_v1_000/put_attachment_types_by_code | Atualiza um registro existente de tipo de documentos | code (integer) data: { . code (integer) . description (string) . firedRetired (boolean) . updateDate (string) . updateUser (string) } (object) required |
| gps/attachmenttype_v1_000/get_attachment_types | Busca dados de tipo de documentos existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/attachmenttype_v1_000/post_attachment_types | Inclui um novo registro de tipo de documentos | data: { . code (integer) . description (string) . firedRetired (boolean) . updateDate (string) . updateUser (string) } (object) required |
| gps/beneficiarycardnumberstatus_v1_000/get_beneficiary_card_number_status_by_code | Retorna dados de situação do documento de identificação do beneficiário | code (integer) |
| gps/beneficiarycardnumberstatus_v1_000/delete_beneficiary_card_number_status_by_code | Exclui situação do documento de identificação do beneficiário | code (integer) |
| gps/beneficiarycardnumberstatus_v1_000/put_beneficiary_card_number_status_by_code | Atualiza um registro existente de situação do documento de identificação do beneficiário | code (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_status | Busca dados de situação do documento de identificação do beneficiário existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/beneficiarycardnumberstatus_v1_000/post_beneficiary_card_number_status | Inclui um novo registro de situação do documento de identificação do beneficiário | data: { . code (integer) . description (string) . status (boolean) . chargeNewCopy (boolean) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/beneficiarystatus_v1_000/get_beneficiary_status_by_code | Retorna dados de situação do beneficiário | code (integer) |
| gps/beneficiarystatus_v1_000/delete_beneficiary_status_by_code | Exclui situação do beneficiário | code (integer) |
| gps/beneficiarystatus_v1_000/put_beneficiary_status_by_code | Atualiza um registro existente de situação do beneficiário | code (integer) data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/beneficiarystatus_v1_000/get_beneficiary_status | Busca dados de situação do beneficiário existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/beneficiarystatus_v1_000/post_beneficiary_status | Inclui um novo registro de situação do beneficiário | data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/contractstatus_v1_000/get_contract_status_by_code | Retorna dados de situação do contrato | code (integer) |
| gps/contractstatus_v1_000/delete_contract_status_by_code | Exclui situação do contrato | code (integer) |
| gps/contractstatus_v1_000/put_contract_status_by_code | Atualiza um registro existente de situação do contrato | code (integer) data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/contractstatus_v1_000/get_contract_status | Busca dados de situação do contrato existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/contractstatus_v1_000/post_contract_status | Inclui um novo registro de situação do contrato | data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/copaymenttype_v1_000/get_copayment_types_by_code | Retorna dados de tipo de participação | code (integer) |
| gps/copaymenttype_v1_000/delete_copayment_types_by_code | Exclui tipo de participação | code (integer) |
| gps/copaymenttype_v1_000/put_copayment_types_by_code | Atualiza um registro existente de tipo de participação | code (integer) data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/copaymenttype_v1_000/get_copayment_types | Busca dados de tipo de participação existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/copaymenttype_v1_000/post_copayment_types | Inclui um novo registro de tipo de participação | data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/coveragemodulegroup_v1_000/get_coverage_module_groups_by_code | Retorna dados de grupo de módulos | code (integer) |
| gps/coveragemodulegroup_v1_000/delete_coverage_module_groups_by_code | Exclui grupo de módulos | code (integer) |
| gps/coveragemodulegroup_v1_000/put_coverage_module_groups_by_code | Atualiza um registro existente de grupo de módulos | code (integer) data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/coveragemodulegroup_v1_000/get_coverage_module_groups | Busca dados de grupo de módulos existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/coveragemodulegroup_v1_000/post_coverage_module_groups | Inclui um novo registro de grupo de módulos | data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/coveragemodule_v1_000/get_coverage_modules_by_code | Retorna dados de módulos de cobertura | code (integer) |
| gps/coveragemodule_v1_000/delete_coverage_modules_by_code | Exclui módulos de cobertura | code (integer) |
| gps/coveragemodule_v1_000/put_coverage_modules_by_code | Atualiza um registro existente de módulos de cobertura | code (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_modules | Busca dados de módulos de cobertura existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/coveragemodule_v1_000/post_coverage_modules | Inclui um novo registro de módulos de cobertura | 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/creditstatus_v1_000/get_credit_status_by_code | Retorna dados de situação da análise de crédito | code (integer) |
| gps/creditstatus_v1_000/delete_credit_status_by_code | Exclui situação da análise de crédito | code (integer) |
| gps/creditstatus_v1_000/put_credit_status_by_code | Atualiza um registro existente de situação da análise de crédito | code (integer) data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/creditstatus_v1_000/get_credit_status | Busca dados de situação da análise de crédito existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/creditstatus_v1_000/post_credit_status | Inclui um novo registro de situação da análise de crédito | data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/fingerprints_v1_000/get_fingerprints_by_card_number_by_position | Retorna a biometria cadastrada para o beneficiário na posição dedo indicada | cardNumber (integer) position (integer) |
| gps/fingerprints_v1_000/get_fingerprints_by_card_number | Retorna todas as biometrias cadastradas para o beneficiário | cardNumber (integer) |
| gps/fingerprints_v1_000/post_fingerprints | Cria um novo registro de biometria para o beneficiário. Será atualizado caso já exista para a posição dedo indicada | data: { . cardNumber (integer) . finger (integer) . fingerprint (string) } (object) required |
| gps/healthcondition_v1_000/get_health_conditions_by_code | Retorna dados de condição de saúde | code (integer) |
| gps/healthcondition_v1_000/delete_health_conditions_by_code | Exclui condição de saúde | code (integer) |
| gps/healthcondition_v1_000/put_health_conditions_by_code | Atualiza um registro existente de condição de saúde | code (integer) data: { . code (integer) . description (string) . isCid (boolean) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/healthcondition_v1_000/get_health_conditions | Busca dados de condição de saúde existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/healthcondition_v1_000/post_health_conditions | Inclui um novo registro de condição de saúde | data: { . code (integer) . description (string) . isCid (boolean) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/healthprovidergroup_v1_000/get_health_provider_groups_by_code | Retorna dados de grupo de prestadores | code (integer) |
| gps/healthprovidergroup_v1_000/delete_health_provider_groups_by_code | Exclui grupo de prestadores | code (integer) |
| gps/healthprovidergroup_v1_000/put_health_provider_groups_by_code | Atualiza um registro existente de grupo de prestadores | code (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_groups | Busca dados de grupo de prestadores existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/healthprovidergroup_v1_000/post_health_provider_groups | Inclui um novo registro de grupo de prestadores | data: { . 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_code | Retorna dados de tipo de vinculos dos prestadores | code (integer) |
| gps/healthproviderrelationtype_v1_000/delete_health_provider_relation_types_by_code | Exclui tipo de vinculos dos prestadores | code (integer) |
| gps/healthproviderrelationtype_v1_000/put_health_provider_relation_types_by_code | Atualiza um registro existente de tipo de vinculos dos prestadores | code (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_types | Busca dados de tipo de vinculos dos prestadores existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/healthproviderrelationtype_v1_000/post_health_provider_relation_types | Inclui um novo registro de tipo de vinculos dos prestadores | data: { . 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_code | Retorna dados de tabela de manutenção cid-10 | code (string) |
| gps/icd10_v1_000/delete_icd10_by_code | Exclui tabela de manutenção cid-10 | code (string) |
| gps/icd10_v1_000/put_icd10_by_code | Atualiza um registro existente de tabela de manutenção cid-10 | code (string) data: { . code (string) . description (string) . shortDescription (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/icd10_v1_000/get_icd10 | Busca dados de tabela de manutenção cid-10 existentes | codeInitial (string) codeFinal (string) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/icd10_v1_000/post_icd10 | Inclui um novo registro de tabela de manutenção cid-10 | data: { . code (string) . description (string) . shortDescription (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/indexincreasetype_v1_000/get_index_increase_types_by_code | Retorna dados de tipo de índice de reajuste | code (integer) |
| gps/indexincreasetype_v1_000/delete_index_increase_types_by_code | Exclui tipo de índice de reajuste | code (integer) |
| gps/indexincreasetype_v1_000/put_index_increase_types_by_code | Atualiza um registro existente de tipo de índice de reajuste | code (integer) data: { . code (integer) . description (string) . defaultPercentage (boolean) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/indexincreasetype_v1_000/get_index_increase_types | Busca dados de tipo de índice de reajuste existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/indexincreasetype_v1_000/post_index_increase_types | Inclui um novo registro de tipo de índice de reajuste | data: { . code (integer) . description (string) . defaultPercentage (boolean) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/medicalspecialty_v1_000/get_medical_specialties_by_code | Retorna dados de tabela de especialidades medicas | code (integer) |
| gps/medicalspecialty_v1_000/delete_medical_specialties_by_code | Exclui tabela de especialidades medicas | code (integer) |
| gps/medicalspecialty_v1_000/put_medical_specialties_by_code | Atualiza um registro existente de tabela de especialidades medicas | code (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_specialties | Busca dados de tabela de especialidades medicas existentes | order (array) codeFinal (integer) description (string) page (integer) pageSize (integer) fields (string) |
| gps/medicalspecialty_v1_000/post_medical_specialties | Inclui um novo registro de tabela de especialidades medicas | data: { . 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_code | Retorna dados de tipo de medicina | code (integer) |
| gps/medicinebranch_v1_000/delete_medicine_branches_by_code | Exclui tipo de medicina | code (integer) |
| gps/medicinebranch_v1_000/put_medicine_branches_by_code | Atualiza um registro existente de tipo de medicina | code (integer) data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/medicinebranch_v1_000/get_medicine_branches | Busca dados de tipo de medicina existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/medicinebranch_v1_000/post_medicine_branches | Inclui um novo registro de tipo de medicina | data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/proposalstatus_v1_000/get_proposal_status_by_code | Retorna dados de situação da proposta | code (integer) |
| gps/proposalstatus_v1_000/delete_proposal_status_by_code | Exclui situação da proposta | code (integer) |
| gps/proposalstatus_v1_000/put_proposal_status_by_code | Atualiza um registro existente de situação da proposta | code (integer) data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/proposalstatus_v1_000/get_proposal_status | Busca dados de situação da proposta existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/proposalstatus_v1_000/post_proposal_status | Inclui um novo registro de situação da proposta | data: { . code (integer) . description (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/proposaltype_v1_000/get_proposal_types_by_code | Retorna dados de tipo de proposta | code (integer) |
| gps/proposaltype_v1_000/delete_proposal_types_by_code | Exclui tipo de proposta | code (integer) |
| gps/proposaltype_v1_000/put_proposal_types_by_code | Atualiza um registro existente de tipo de proposta | code (integer) data: { . code (integer) . description (string) . monthlyPaymentFactor (number) . enrollmentFactor (number) . active (boolean) . updateDate (string) . updateUser (string) } (object) required |
| gps/proposaltype_v1_000/get_proposal_types | Busca dados de tipo de proposta existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/proposaltype_v1_000/post_proposal_types | Inclui um novo registro de tipo de proposta | data: { . code (integer) . description (string) . monthlyPaymentFactor (number) . enrollmentFactor (number) . active (boolean) . updateDate (string) . updateUser (string) } (object) required |
| gps/registerstatus_v1_000/get_register_status_by_code | Retorna dados de situação de cadastros | code (integer) |
| gps/registerstatus_v1_000/delete_register_status_by_code | Exclui situação de cadastros | code (integer) |
| gps/registerstatus_v1_000/put_register_status_by_code | Atualiza um registro existente de situação de cadastros | code (integer) data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/registerstatus_v1_000/get_register_status | Busca dados de situação de cadastros existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/registerstatus_v1_000/post_register_status | Inclui um novo registro de situação de cadastros | data: { . code (integer) . description (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/secondcopyreason_v1_000/get_second_copy_reasons_by_code | Retorna dados de motivo solicitação segunda via de cartão | code (integer) |
| gps/secondcopyreason_v1_000/delete_second_copy_reasons_by_code | Exclui motivo solicitação segunda via de cartão | code (integer) |
| gps/secondcopyreason_v1_000/put_second_copy_reasons_by_code | Atualiza um registro existente de motivo solicitação segunda via de cartão | code (integer) data: { . code (integer) . description (string) . detailedMessage (string) . status (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/secondcopyreason_v1_000/get_second_copy_reasons | Busca dados de motivo solicitação segunda via de cartão existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/secondcopyreason_v1_000/post_second_copy_reasons | Inclui um novo registro de motivo solicitação segunda via de cartão | data: { . code (integer) . description (string) . detailedMessage (string) . status (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/textpattern_v1_000/get_text_patterns_by_code | Retorna dados de texto padrão | code (integer) |
| gps/textpattern_v1_000/delete_text_patterns_by_code | Exclui texto padrão | code (integer) |
| gps/textpattern_v1_000/put_text_patterns_by_code | Atualiza um registro existente de texto padrão | code (integer) data: { . code (integer) . description (string) . text (string) . updateDate (string) . updateUser (string) } (object) required |
| gps/textpattern_v1_000/get_text_patterns | Busca dados de texto padrão existentes | codeInitial (integer) codeFinal (integer) description (string) order (array) page (integer) pageSize (integer) fields (string) |
| gps/textpattern_v1_000/post_text_patterns | Inclui um novo registro de texto padrão | data: { . code (integer) . description (string) . text (string) . updateDate (string) . updateUser (string) } (object) required |
| protheus/accountingcalendar_v1_000/get_accounting_calendar | Retorna Cadastro do Calendário Contábil | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/accountingcalendar_v1_000/post_accounting_calendar | Incluir um Calendário Contábil conforme dados enviados na requisição. | 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_id | Retorna a Calendário Contábil de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/accountingcalendar_v1_000/put_accounting_calendar_by_internal_id | Atualiza o Calendário Contábil conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Calendário Contábil conforme dados enviados na requisição. | InternalId (string) |
| protheus/accountingitems_v1_000/get_accounting_items | Retorna lista completa de itens contábeis | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/accountingitems_v1_000/post_accounting_items | Inclui um item contábil conforme dados enviados na requisição. | 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_id | Retorna o item contábil de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/accountingitems_v1_000/put_accounting_items_by_internal_id | Atualiza o item contábil conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Item Contábil conforme dados enviados na requisição. | InternalId (string) |
| protheus/addressstock_v1_000/get_address_stocks | Retorna lista completa de Grupo de Produto | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/addressstock_v1_000/post_address_stocks | Inclui um Endereço | data (undefined) required |
| protheus/addressstock_v1_000/get_address_stocks_by_warehouse_code | Retorna os Endereços de um Local de Estoque específico | WarehouseCode (string) |
| protheus/addressstock_v1_000/get_address_stocks_by_warehouse_code_by_location_code | Retorna os Endereços de um Local de Estoque específico | LocationCode (string) WarehouseCode (string) |
| protheus/addressstock_v1_000/put_address_stocks_by_warehouse_code_by_location_code | Atualiza cadastro de Endereço conforme dados enviados na requisição | LocationCode (string) WarehouseCode (string) data (undefined) required |
| protheus/addressstock_v1_000/delete_address_stocks_by_warehouse_code_by_location_code | Exclui Local de Estoque cadastrado conforme dados enviados na requisição | LocationCode (string) WarehouseCode (string) |
| protheus/annotation_v1_000/get_annotations | Retorna lista completa dos apontamentos de visita | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/annotation_v1_000/post_annotations | Inclui um apontamento de visita conforme dados enviados na requisição. | 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_id | Retorna o apontamento de visita pelo InternalId | InternalId (string) fields (string) |
| protheus/annotation_v1_000/put_annotations_by_internal_id | Atualiza o apontamento de visita conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a apontamento de visita conforme dados enviados na requisição. | InternalId (string) |
| protheus/approvalprofile_v1_000/get_supply_approval_profile_info | Retorna lista completa de Perfis de Aprovação. | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/approvalprofile_v1_000/post_supply_approval_profile_info | Inclui um Perfil de Aprovador conforme dados enviados na requisição. | 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_code | Retorna um Perfil de Aprovador | code (string) order (array) fields (string) |
| protheus/approvalprofile_v1_000/put_supply_approval_profile_info_by_code | Atualiza o Vlr. Minimo e Vlr. Maximo do Perfil de Aprovador conforme dados enviados na requisição. | code (string) 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_code | Exclui um Perfil de Aprovação conforme dados enviados na requisição. | code (string) |
| protheus/approvalprofile_v2_000/get_approval_profile | Retorna lista completa de Perfis de Aprovação. | 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_profile | Inclui um Perfil de Aprovador conforme dados enviados na requisição. | fields (string) data (object) required |
| protheus/approvalprofile_v2_000/get_approval_profile_by_code | Retorna um Perfil de Aprovador | code (string) order (array) fields (string) |
| protheus/approvalprofile_v2_000/put_approval_profile_by_code | Altera o Perfil de Aprovação | code (string) fields (string) data (object) required |
| protheus/approvalprofile_v2_000/delete_approval_profile_by_code | Exclui um Perfil de Aprovação conforme dados enviados na requisição. | code (string) |
| protheus/approvers_v1_000/get_approvers | Retorna todos Aprovadores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/approvers_v1_000/post_approvers | Inclui Aprovadores passado na requisição. | 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_code | Retorna o usuário do sistema indicado. | code (string) |
| protheus/approvers_v1_000/put_approvers_by_code | Altera o Aprovador passado na requisição. | code (string) 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_code | Exclusão do Aprovador. | code (string) |
| protheus/auditchecklist_v1_000/get_audit_checklist_by_internal_id | Retorna uma ficha de checklist pelo Número | internalId (integer) order (array) fields (string) |
| protheus/auditchecklist_v1_000/put_audit_checklist_by_internal_id | Altera o cadastro de Checklist de auditoria conforme dados enviados na requisição | internalId (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_id | Exclui um checklist pelo código | internalId (integer) order (array) fields (string) |
| protheus/auditchecklist_v1_000/get_audit_checklist | Retorna uma lista com Checklist de auditorias pendentes | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/auditchecklist_v1_000/post_audit_checklist | insere | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/auditpanel_v1_000/get_painel_auditoria_period | Retorna os períodos de apuração disponíveis no sistema. | No parameters |
| protheus/auditpanel_v1_000/get_painel_auditoria_big_numbers | Retorna os indicadores principais Big Numbers para o dashboard. | No parameters |
| protheus/auditpanel_v1_000/get_painel_auditoria_employees | Lista os funcionários vinculados ao processo de auditoria. | No parameters |
| protheus/auditpanel_v1_000/post_painel_auditoria_update_feedback | Envia uma atualização de feedback para um registro de auditoria. | No parameters |
| protheus/auditpanel_v1_000/get_painel_auditoria_conformities | Lista 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_branches | Retorna 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_update | Informa 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_history | Retorna 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_questionnaire | Retorna uma lista com questionário de auditorias | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/auditquestionnaire_v1_000/post_audit_questionnaire | Insere um questionário de auditoria | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/auditquestionnaire_v1_000/get_audit_questionnaire_by_internal_id | Retorna um questionário de auditoria pelo ID | internalId (string) order (array) fields (string) |
| protheus/auditquestionnaire_v1_000/put_audit_questionnaire_by_internal_id | Altera o cadastro de questionário de auditoria conforme dados enviados na requisição | internalId (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_id | Exclui um questionário pelo código | internalId (string) order (array) fields (string) |
| protheus/audittopic_v1_000/put_audit_topic_by_internal_id | Altera o cadastro de Topico de auditoria | internalId (string) itemId (string) data (object) required |
| protheus/audittopic_v1_000/get_audit_topic_by_internal_id | Retorna um único registro Topico de Auditoria | internalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/audittopic_v1_000/delete_audit_topic_by_internal_id | Deleta | internalId (string) |
| protheus/audittopic_v1_000/post_audit_topic | Cadastra um Topico de Auditoria | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/audittopic_v1_000/get_audit_topic | Retorna uma ficha de auditoria pelo número | internalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/audittopic_v1_000/put_audit_topic_by_internal_id_itens_table_topic_by_item_id | Altera o cadastro de Topico de auditoria | internalId (string) itemId (string) data (array) required |
| protheus/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipation | Retorna todos os registros de Coparticipações dos Beneficiários e seus dependentes. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) required companyid (string) required |
| protheus/beneficiariesdatacontent_v1_000/get_beneficiaries_data_content | Retorna todos os registros de beneficiários. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required branchId (string) |
| protheus/budgetbalancetype_v1_000/get_budget_balance_type | Retorna Cadastro de Tipo de Saldo Orçamentário | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/budgetbalancetype_v1_000/post_budget_balance_type | Incluir um Tipo de Saldo Orçamentário conforme dados enviados na requisição. | 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_id | Retorna o Tipo de Saldo Orçamentário de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/budgetbalancetype_v1_000/put_budget_balance_type_by_internal_id | Atualiza o Tipo de Saldo Orçamentário conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Tipo de Saldo Orçamentário conforme dados enviados na requisição. | InternalId (string) |
| protheus/buyers_v1_000/get_buyers | Retorna todos os Compradores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/buyers_v1_000/post_buyers | Adiciona Comprador passado na requisição | data (object) required |
| protheus/buyers_v1_000/get_buyers_by_buyer_id | Retorna o Comprador do sistema através de seu código | BuyerId (string) fields (string) |
| protheus/buyers_v1_000/put_buyers_by_buyer_id | Altera o comprador passado na requisição | BuyerId (string) data (undefined) required |
| protheus/buyers_v1_000/delete_buyers_by_buyer_id | Exclusão de Comprador da base | BuyerId (string) |
| protheus/campaigns_v1_000/get_campaigns | Retorna as campanhas cadastradas | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/campaigns_v1_000/post_campaigns | Inclui uma nova campanha | 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_code | Retorna as informações da campanha informada | Code (string) fields (string) |
| protheus/campaigns_v1_000/put_campaigns_by_code | Altera a camapnha informada | Code (string) 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_code | Exclui a campanha informada | Code (string) |
| protheus/candidates_v2_000/get_candidates_by_id | Retorna dados de tabela da Candidato especificada | id (string) |
| protheus/candidates_v2_000/delete_candidates_by_id | Exclui Candidato | id (string) |
| protheus/candidates_v2_000/put_candidates_by_id | Atualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_candidates | Retorna todos as Candidatos | order (array) page (integer) pageSize (integer) personsIds (string) |
| protheus/candidates_v2_000/post_candidates | Inclui um novo registro na tabela de Candidatos | 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_carrier | Retorna lista completa de Transportadoras | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/carrier_v1_000/post_carrier | Inclui uma Transportadora conforme dados enviados na requisição. | 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_id | Retorna a Transportadora conforme dados enviados na requisição | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/carrier_v1_000/put_carrier_by_internal_id | Atualiza cadastro de Transportadoras conforme dados enviados na requisição | InternalId (string) 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_id | Exclui cadastro de Transportadora conforme dados enviados na requisição. | InternalId (string) |
| protheus/cashieroperator_v1_000/get_cashier_operators | Retorna todos os operadores de caixa | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/cashieroperator_v1_000/post_cashier_operators | Inclui operador de caixa passado na requisição | 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_id | Retorna os dados do operador de caixa de acordo com a filial e código do operador passados por parametro | InternalId (string) |
| protheus/cashieroperator_v1_000/put_cashier_operators_by_internal_id | Atualiza a entidade operador de caixa passado na requisição | InternalId (string) 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_id | Deleta a entidade CashierOperator passado na requisição | InternalId (string) |
| protheus/catreport_v1_000/post_cat_report | Inicia o processamento do Painel de Impressão da CAT | data (object) required |
| protheus/catreport_v1_000/get_cat_report_status | Retorna o percentual de execução do Painel de Impressão da CAT | data (object) required |
| protheus/catreport_v1_000/post_cat_report_cat_values | Retorna o resultado do Painel de Impressão da CAT | page (integer) pageSize (integer) data (object) required |
| protheus/catreport_v1_000/post_cat_report_cat_monitor_values | Retorna o resultado do Painel do e-Social para impressão PDF | data (object) required |
| protheus/classvalue_v1_000/get_classvalue | Retorna Cadastro de Classe de Valor | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/classvalue_v1_000/post_classvalue | Incluir uma Classe de Valor conforme dados enviados na requisição. | 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_id | Retorna a Classe de Valor de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/classvalue_v1_000/put_classvalue_by_internal_id | Atualiza a Classe de Valor conforme dados enviados na requisição | InternalId (string) 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_id | Exclui uma Classe de Valor conforme dados enviados na requisição. | InternalId (string) |
| protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposal | Retorna uma lista de Propostas Comerciais relacionadas a uma Oportunidade de Venda pelo OpportunityId | OpportunityId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/commercialproposal_v1_000/post_opportunities_by_opportunity_id_commercialproposal | Inclui uma Proposta Comercial relacionada a uma Oportunidade de Venda pelo OpportunityId | OpportunityId (string) 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_id | Retorna uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de Venda | InternalId (string) OpportunityId (string) fields (string) |
| protheus/commercialproposal_v1_000/put_opportunities_by_opportunity_id_commercialproposal_by_internal_id | Altera uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de Venda | InternalId (string) OpportunityId (string) 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_id | Exclui uma Proposta Comercial pelo InternalId relacionada a uma Oportunidade de Venda | InternalId (string) OpportunityId (string) |
| protheus/commercialproposal_v1_000/get_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products | Retorna uma lista de Itens de uma Proposta Comercial relacionados pelo InternalId | InternalId (string) OpportunityId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/commercialproposal_v1_000/post_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products | Inclui um item em uma Proposta Comercial relacionada a uma Oportunidade de Venda pelo OpportunityId | InternalId (string) OpportunityId (string) 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_id | Retorna um item de uma Proposta Comercial pelo ItemId | InternalId (string) ItemId (string) OpportunityId (string) fields (string) |
| protheus/commercialproposal_v1_000/put_opportunities_by_opportunity_id_commercialproposal_by_internal_id_listof_products_by_item_id | Altera uma Proposta Comercial pelo ItemId | InternalId (string) ItemId (string) OpportunityId (string) 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_id | Exclui uma Proposta Comercial pelo ItemId | InternalId (string) ItemId (string) OpportunityId (string) |
| protheus/contactrelationship_v1_000/get_contactrelationship | Retorna uma lista completa de Relacionamentos de Contato x Entidade | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/contactrelationship_v1_000/post_contactrelationship | Inclui uma Relacionamento de Contato conforme dados enviados na requisição. | 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_id | Retorna um Relacionamento de Contato x Entidade pelo InternalId | InternalId (string) fields (string) |
| protheus/contactrelationship_v1_000/put_contactrelationship_by_internal_id | Altera um Relacionamento de Contato x Entidade pelo InternalId | InternalId (string) 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_id | Exclui um Relacionamento de Contato de Entidade pelo InternalId | InternalId (string) |
| protheus/contactrelationship_v1_000/get_contactrelationship_by_internal_id_listofcontact | Retorna uma lista completa de items de todos Relacionamentos de Contato x Entidade | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/contactrelationship_v1_000/post_contactrelationship_by_internal_id_listofcontact | Inclui um Item em um Relacionamento de Contato especifico conforme dados enviados na requisição. | InternalId (string) fields (string) data: { . ContactCode (string) . ContactInternalId (string) } (object) required |
| protheus/contactrelationship_v1_000/get_contactrelationship_by_internal_id_listofcontact_by_contact_code | Retorna um Item Especifico pelo ContactCode de Relacionamento de Contato | InternalId (string) ContactCode (string) fields (string) |
| protheus/contactrelationship_v1_000/put_contactrelationship_by_internal_id_listofcontact_by_contact_code | Altera um Item especifico pelo ContactCode de Relacionamento de Contato x Entidade | InternalId (string) ContactCode (string) fields (string) data: { . ContactCode (string) . ContactInternalId (string) } (object) required |
| protheus/contactrelationship_v1_000/delete_contactrelationship_by_internal_id_listofcontact_by_contact_code | Exclui um Item especifico pelo ContactCode de Relacionamento de Contato x Entidade | InternalId (string) ContactCode (string) |
| protheus/contact_v1_000/get_contacts | Retorna lista completa de Contatos | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/contact_v1_000/post_contacts | Inclui um Contato conforme dados enviados na requisição. | 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_id | Retorna o contato conforme dados enviados na requisição | contactId (string) fields (string) |
| protheus/contact_v1_000/put_contacts_by_contact_id | Atualiza cadastro do Contato conforme dados enviados na requisição | contactId (string) 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_id | Exclui cadastro do Contato conforme dados enviados na requisição. | contactId (string) |
| protheus/contaminants_v1_000/get_contaminants | Retorna todos os contaminantes da base | order (array) page (integer) pageSize (integer) |
| protheus/contaminants_v1_000/post_contaminants | Inclui um contaminante passado na requisição | 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_id | Retorna o contaminante correspondente ao parametro informado | InternalId (string) |
| protheus/contaminants_v1_000/put_contaminants_by_internal_id | Altera o contaminante passado na requisição | InternalId (string) 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_id | Deleção do contaminante informado. | InternalId (string) |
| protheus/costcenter_v1_000/get_costcenters | Retorna lista completa dos Centro de Custos | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/costcenter_v1_000/post_costcenters | Inclui um Centro de Custo conforme dados enviados na requisição. | 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_id | Retorna um centro de custo de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/costcenter_v1_000/patch_costcenters_by_internal_id | Atualiza centro de custo somente com os dados enviados na requisição | InternalId (string) 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_id | Atualiza centro de custo conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Centro de Custo conforme dados enviados na requisição. | InternalId (string) |
| protheus/cottonbalesontreadmills_v1_000/get_cotton_bales_on_treadmills | Retorna todos os vinculos de esteira x fardão da base | order (array) page (integer) pageSize (integer) |
| protheus/cottonbalesontreadmills_v1_000/post_cotton_bales_on_treadmills | Nã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_id | Retorna os fardões vinculados à esteira correspondente ao parâmetro informado | InternalId (string) |
| protheus/cottonbalesontreadmills_v1_000/put_cotton_bales_on_treadmills_by_internal_id | Vincula um fardão a esteira passada na requisição | InternalId (string) 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_id | Deleção do fardão informado da fila a qual pertence. | InternalId (string) |
| protheus/cottonbales_v1_000/get_cotton_bales | Retorna todos os fardões da base | order (array) page (integer) pageSize (integer) |
| protheus/cottonbales_v1_000/post_cotton_bales | Inclui um fardão passado na requisição | 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_id | Retorna o fardão correspondente ao código único informado | InternalId (string) |
| protheus/cottonbales_v1_000/put_cotton_bales_by_internal_id | Altera a Filial passado na requisição | InternalId (string) 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_id | Deleção do fardão informado | InternalId (string) |
| protheus/cottoncolorgrades_v1_000/get_cotton_color_grades | Retorna todos os tipos de classificação do algodão cadastrados. | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/cottoncolorgrades_v1_000/post_cotton_color_grades | Inclui o tipo de classificação passado na requisição. | No parameters |
| protheus/cottoncolorgrades_v1_000/get_cotton_color_grades_by_internal_id | Retorna o tipo de classificação informado pelo parâmetro | InternalId (string) fields (string) |
| protheus/cottoncolorgrades_v1_000/put_cotton_color_grades_by_internal_id | Altera o tipo de classificação informado. | InternalId (string) 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_id | Deleção do tipo de classificação dos registros. | InternalId (string) |
| protheus/cottonginbreakpointings_v1_000/get_cotton_gin_break_pointings | Retorna todos os Motivo de Parada da beneficiadora. | order (array) page (integer) pageSize (integer) |
| protheus/cottonginbreakpointings_v1_000/post_cotton_gin_break_pointings | Inclui 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_id | Retorna os apontamentos de parada da beneficiadora informada pelo parâmetro | InternalId (string) |
| protheus/cottonginbreakpointings_v1_000/put_cotton_gin_break_pointings_by_internal_id | Altera o apontamento de motivo de parada da beneficiadora informada. | InternalId (string) 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_id | Deleção do apontamento de parada da beneficiadora dos registros. | InternalId (string) |
| protheus/cottonginbreaks_v1_000/get_cotton_gin_breaks | Retorna todos os Motivo de Parada da beneficiadora cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/cottonginbreaks_v1_000/post_cotton_gin_breaks | Inclui o motivo de parada da beneficiadora passado na requisição. | No parameters |
| protheus/cottonginbreaks_v1_000/get_cotton_gin_breaks_by_internal_id | Retorna o motivo de parada da beneficiadora correspondente ao parâmetro informado | InternalId (string) |
| protheus/cottonginbreaks_v1_000/put_cotton_gin_breaks_by_internal_id | Alterada a descrição do motivo em questão. | InternalId (string) data: { . InternalId (string) . BranchId (string) . Code (string) . Description (string) } (object) required |
| protheus/cottonginbreaks_v1_000/delete_cotton_gin_breaks_by_internal_id | Deleção do motivo de parada da beneficiadora dos registros. | InternalId (string) |
| protheus/cottonginmachines_v1_000/get_cotton_gin_machines | Retorna todos os conjuntos de beneficiamento de algodão cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/cottonginmachines_v1_000/post_cotton_gin_machines | Efetua o cadastro de um conjunto de beneficiamento de algodão. | No parameters |
| protheus/cottonginmachines_v1_000/get_cotton_gin_machines_by_internal_id | Retorna o conjunto de beneficiamento requerido. | InternalId (string) |
| protheus/cottonginmachines_v1_000/put_cotton_gin_machines_by_internal_id | Altera o conjunto de benficiamento informado. | InternalId (string) 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_id | Exclui o conjunto de beneficiamento informado. | InternalId (string) |
| protheus/cottongins_v1_000/get_cotton_gins | Retorna todas as unidades de beneficamento da base | order (array) page (integer) pageSize (integer) |
| protheus/cottongins_v1_000/post_cotton_gins | Inclui uma unidade de beneficamento passada na requisição | data: { . InternalId (string) . SourceBranch (string) . Code (string) . Description (string) } (object) required |
| protheus/cottongins_v1_000/get_cotton_gins_by_internal_id | Retorna a unidade de beneficamento correspondente ao parametro informado | InternalId (string) |
| protheus/cottongins_v1_000/put_cotton_gins_by_internal_id | Altera a unidade de beneficamento passada na requisição | InternalId (string) data: { . InternalId (string) . SourceBranch (string) . Code (string) . Description (string) } (object) required |
| protheus/cottongins_v1_000/delete_cotton_gins_by_internal_id | Deleção da unidade de beneficamento informada | InternalId (string) |
| protheus/cottonpoisoningpointings_v1_000/get_cotton_poisoning_pointings | Retorna todos os lançamentos de contaminantes em algodão cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/cottonpoisoningpointings_v1_000/post_cotton_poisoning_pointings | Efetua o lançamento de contaminante para algodão. | No parameters |
| protheus/cottonpoisoningpointings_v1_000/get_cotton_poisoning_pointings_by_internal_id | Retorna o lançamento requerido. | InternalId (string) |
| protheus/cottonpoisoningpointings_v1_000/put_cotton_poisoning_pointings_by_internal_id | Altera o lançamento informado. | InternalId (string) 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_id | Exclui o lançamento informado. | InternalId (string) |
| protheus/currencyquote_v1_000/get_currency_quotes | Retorna lista completa das Cotações de Moedas | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/currencyquote_v1_000/post_currency_quotes | Inclui cotações de moedas conforme dados enviados na requisição. | fields (string) data: { . CompanyId (string) . BranchId (string) . CompanyInternalId (string) . Date (string) . ListOfCurrency (array) } (object) required |
| protheus/currencyquote_v1_000/get_currency_quotes_by_date | Retorna cotações de uma Data de acordo com o ID de pesquisa | Date (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/currencyquote_v1_000/put_currency_quotes_by_date | Atualiza as cotações por Data conforme dados enviados na requisição | Date (string) fields (string) data: { . CompanyId (string) . BranchId (string) . CompanyInternalId (string) . Date (string) . ListOfCurrency (array) } (object) required |
| protheus/currencyquote_v1_000/delete_currency_quotes_by_date | Exclui as cotações por Data conforme dados enviados na requisição. | Date (string) |
| protheus/currency_v1_000/get_currency | Retorna lista completa de moeda | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/currency_v1_000/post_currency | Inclui Moeda | 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_code | Retorna Moeda pelo seu código | Code (string) |
| protheus/currency_v1_000/put_currency_by_code | Atualiza cadastro de Moeda conforme dados enviados na requisição | Code (string) 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_code | Exclui Moeda conforme dados enviados na requisição | Code (string) |
| protheus/customercreditlimit_v1_000/get_customer_credit_limit | Retorna uma lista com o Limite de credito de todos os Clientes | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/customercreditlimit_v1_000/get_customer_credit_limit_by_customer_internal_id | Retorna o Limite de credito de um Cliente | CustomerInternalId (string) fields (string) |
| protheus/customershippingaddress_v1_000/get_customer_shipping_address | Retorna lista completa do Endereço de Entrega do Cliente | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/customershippingaddress_v1_000/post_customer_shipping_address | Inclui um Endereço de Entrega do Cliente conforme dados enviados na requisição. | 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_id | Retorna o Endereço de Entrega do Cliente de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/customershippingaddress_v1_000/put_customer_shipping_address_by_internal_id | Atualiza o Endereço de Entrega do Cliente conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Endereço de Entrega do Cliente conforme dados enviados na requisição. | InternalId (string) |
| protheus/customervendor_v1_000/get_customer_vendor | Retorna todos clientes e/ou fornecedores | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/customervendor_v1_000/post_customer_vendor | Inclui a entidade Cliente/Fornecedor passada na requisição | 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_type | Retorna todos os registros de uma entidade específica - Customer ou Vendor | entityType (array) fields (string) order (array) page (integer) pageSize (integer) |
| protheus/customervendor_v1_000/get_customer_vendor_by_entity_type_by_customer_vendor_id | Retorna Cliente ou Fornecedor com base no código da entidade | customerVendorId (string) entityType (array) fields (string) |
| protheus/customervendor_v1_000/put_customer_vendor_by_entity_type_by_customer_vendor_id | Atualiza a entidade Cliente/Fornecedor informada na requisição | customerVendorId (string) entityType (array) 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/delete_customer_vendor_by_entity_type_by_customer_vendor_id | Exclui a entidade Cliente/Fornecedor passada na requisição | customerVendorId (string) entityType (array) |
| protheus/discoveryenvironments_v1_000/get_discovery_environments | Retorna todos os ambientes cadastrados | order (array) page (integer) pageSize (integer) |
| protheus/discoveryenvironments_v1_000/post_discovery_environments | Inclui a ambiente passada na requisição | data: { . discoveryenvironmentid (string) . stage (string) . descriptionstage (string) } (object) required |
| protheus/discoveryenvironments_v1_000/get_discovery_environments_by_discoveryenvironmentid | Retorna o ambiente específico. | discoveryenvironmentid (string) |
| protheus/discoveryenvironments_v1_000/put_discovery_environments_by_discoveryenvironmentid | Inclui o ambiente passado na requisição | discoveryenvironmentid (string) data: { . discoveryenvironmentid (string) . stage (string) . descriptionstage (string) } (object) required |
| protheus/discoveryenvironments_v1_000/delete_discovery_environments_by_discoveryenvironmentid | Exclusão de ambiente | discoveryenvironmentid (string) |
| protheus/discoverykeys_v1_000/get_discovery_keys | Retorna todos as stageKeys | order (array) page (integer) pageSize (integer) |
| protheus/discoverykeys_v1_000/get_discovery_keys_by_name | Retorna uma chave específica. | name (string) |
| protheus/discoverystages_v1_000/get_discovery_stages | Retorna todos os stages cadastrados | order (array) page (integer) pageSize (integer) |
| protheus/discoverystages_v1_000/post_discovery_stages | Inclui o stage passada na requisição | data: { . discoverystageid (string) . description (string) } (object) required |
| protheus/discoverystages_v1_000/get_discovery_stages_by_discoverystageid | Retorna o Stage específico. | discoverystageid (string) |
| protheus/discoverystages_v1_000/put_discovery_stages_by_discoverystageid | Inclui o ambiente passado na requisição | discoverystageid (string) data: { . discoverystageid (string) . description (string) } (object) required |
| protheus/discoverystages_v1_000/delete_discovery_stages_by_discoverystageid | Exclusão de ambiente | discoverystageid (string) |
| protheus/documents_v1_000/get_documents | Retorna os documentos das entidades armazenado no banco de conhecimento | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/documents_v1_000/post_documents | Inclui um novo documentos no banco de conhecimento | fields (string) tenantId (string) required data: { . items (array) } (object) required |
| protheus/documents_v1_000/get_documents_by_internal_id | Retorna o documento da entidade armazenado no banco de conhecimento | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/documents_v1_000/put_documents_by_internal_id | Altera o documento armazenado no banco de conhecimento | InternalId (string) fields (string) data: { . items (array) } (object) required |
| protheus/documents_v1_000/delete_documents_by_internal_id | Exclui os documento armazenado no banco de conhecimento | InternalId (string) |
| protheus/electronicdocuments_v1_000/post_electronic_documents | Realiza a integração dos Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço | tenantId (string) required data (array) required |
| protheus/electronicdocuments_v1_000/put_electronic_documents | Realiza a alteração de um Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço existente | tenantId (string) required data (array) required |
| protheus/electronicdocuments_v1_000/get_electronic_documents | Realiza a consulta de todos Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço de acordo com os parâmetros informados | 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_id | Realiza a exclusão do Documento Eletrônico de Entrada e Saída Mercadoria/Serviço pelo Id do documento informado | id (string) tenantId (string) required |
| protheus/electronicdocuments_v1_000/get_electronic_documents_queue_by_id | Retorna as informações da fila de processamento dos Documentos Eletrônicos de Entrada e Saída Mercadoria/Serviço pelo Id | id (string) tenantID (string) required |
| protheus/employeedatacontent_v1_000/get_employee_data_content | Retorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required |
| protheus/employeesmanagerdatacontent_v1_000/get_employees_manager_data_content | Retornar a lista dos empregados com as informações do seu respectivo líder direto. | 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_entities | Retorna todas as entidades cadastradas. | order (array) page (integer) pageSize (integer) |
| protheus/entities_v1_000/post_entities | Inclui uma entidade. | No parameters |
| protheus/entities_v1_000/get_entities_by_internal_id | Retorna a entidade requerida. | InternalId (string) |
| protheus/entities_v1_000/put_entities_by_internal_id | Altera a entidade informada. | InternalId (string) 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_id | Deleção da entidade informada. | InternalId (string) |
| protheus/esocialaudit_v1_000/post_esocial_audit | Inclui a entidade evento passado na requisição | companyId (string) required order (array) page (integer) pageSize (integer) data (object) required |
| protheus/esocialaudit_v1_000/get_esocial_audit_status | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| protheus/esocialaudit_v1_000/get_esocial_audit_audit_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required status (string) page (integer) pageSize (integer) |
| protheus/esocialaudit_v1_000/get_esocial_audit_chart_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| protheus/esocialbranches_v1_000/get_esocial_branches | Retorna o código da empresa e código da filial no TAF | companyId (string) required order (array) page (integer) pageSize (integer) |
| protheus/esocialestablishment_v1_000/get_esocial_establishment | Retorna lista completa com os Estabelecimentos Cadastrados | companyId (string) required order (array) page (integer) pageSize (integer) |
| protheus/esocialevents_v1_000/get_esocial_events | Retorna a lista de eventos do TAF | companyId (string) required eventsCheckPermissions (string) |
| protheus/events_v1_000/get_events | Retorna os eventos cadastrados | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/events_v1_000/post_events | Inclui um novo evento | 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_code | Retorna as informações do evento informado | Code (string) fields (string) |
| protheus/events_v1_000/put_events_by_code | Altera o evento informado | Code (string) 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_code | Exclui o evento informado | Code (string) |
| protheus/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process | Carrega registros do evento S-5503, filtrados ou não, ordenados ou não. | No parameters |
| protheus/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_process | Exclui 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_xml | Retorna XML's do evento S-5503 encodados em base64 | data: { . companyId (string) . id (array) } (object) required |
| protheus/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_category | Carrega 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_amounts | Carrega 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ão | No parameters |
| protheus/freightaccountingbatches_v1_000/get_freight_accounting_batches | Retorna todos os lotes de provisão cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/freightaccountingbatches_v1_000/get_freight_accounting_batches_by_internal_id | Retorna apenas um lote de provisão, requerido através da chave do registro InternalId. | InternalId (string) |
| protheus/freightaccountingbatches_v1_000/put_freight_accounting_batches_by_internal_id | Altera a situação do lote de provisão informado através da chave InternalId. | InternalId (string) 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_components | Retorna lista de componentes de frete | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/freightcomponents_v1_000/post_freight_components | Add Freight Components | 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/get_freight_components_by_internal_id | Return the Freight Components | InternalId (string) |
| protheus/freightcomponents_v1_000/put_freight_components_by_internal_id | Edit Freight Components | InternalId (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_id | Delete Freight Components | InternalId (string) |
| protheus/freightdocuments_v1_000/get_freight_documents | Retorna todos os documentos de frete cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/freightdocuments_v1_000/get_freight_documents_by_internal_id | Retorna o documento de frete requerido. | InternalId (string) |
| protheus/freightdocuments_v1_000/put_freight_documents_by_internal_id | Altera a situação do documento de frete, requerido através da chave do registro InternalId. | InternalId (string) 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_invoices | Retorna todas as faturas de frete cadastradas. | order (array) page (integer) pageSize (integer) |
| protheus/freightinvoices_v1_000/get_freight_invoices_by_internal_id | Retorna apenas uma fatura de frete, requerida através da chave do registro InternalId. | InternalId (string) |
| protheus/freightinvoices_v1_000/put_freight_invoices_by_internal_id | Altera a situação da fatura de frete informada através da chave InternalId. | InternalId (string) 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_motives | Retorna lista completa com os motivos de afastamento | companyId (string) required order (array) page (integer) pageSize (integer) |
| protheus/grainqualitytestkinds_v1_000/get_grain_quality_test_kinds | Retorna todos os tipos de desconto da classificação. | order (array) page (integer) pageSize (integer) |
| protheus/grainqualitytestkinds_v1_000/post_grain_quality_test_kinds | Inclui o tipo de desconto passado na requisição. | No parameters |
| protheus/grainqualitytestkinds_v1_000/get_grain_quality_test_kinds_by_internal_id | Retorna o tipo de desconto informado pelo parâmetro | InternalId (string) |
| protheus/grainqualitytestkinds_v1_000/put_grain_quality_test_kinds_by_internal_id | Altera o tipo de desconto informado. | InternalId (string) 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_id | Deleção do tipo de desconto dos registros. | InternalId (string) |
| protheus/itemreserve_v1_000/get_item_reserves | Retorna todas as reservas de produtos | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/itemreserve_v1_000/post_item_reserves | Inclui a entidade ItemReserve passada na requisição | 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_id | Retorna os dados da reserva de acordo com o número do documento da reserva e filial passadas por parametro | InternalId (string) |
| protheus/itemreserve_v1_000/put_item_reserves_by_internal_id | Atualiza a entidade ItemReserve passada na requisição | InternalId (string) 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_id | Deleta a entidade ItemReserve passada na requisição | InternalId (string) |
| protheus/jobscheduler_v1_001/get_job_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| protheus/jobscheduler_v1_001/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| protheus/jobscheduler_v1_001/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| protheus/jobscheduler_v1_001/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| protheus/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| protheus/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| protheus/jobscheduler_v1_100/get_job_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| protheus/jobscheduler_v1_100/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| protheus/jobscheduler_v1_100/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| protheus/jobscheduler_v1_100/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| protheus/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| protheus/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| protheus/mrpallocations_v1_000/post_mrpallocations | Inclui ou atualiza um ou mais registros de empenho da produção MRP | data (object) required |
| protheus/mrpallocations_v1_000/get_mrpallocations | Retorna lista de empenhos da produção MRP | order (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_mrpallocations | Remove um ou mais Empenho da ordem de produção do MRP | data (object) required |
| protheus/mrpallocations_v1_000/get_mrpallocations_by_branch_id_by_code | Retorna um Empenho da Ordem de Produção MRP | branchId (string) code (string) fields (string) |
| protheus/mrpallocations_v1_000/post_mrpallocations_sync | Sincroniza os registros de empenho da produção MRP | data (object) required |
| protheus/mrpbomrouting_v1_000/post_mrpbomrouting | Inclui ou atualiza uma ou mais estrutura por operação do MRP | data: { . items (array) } (object) required |
| protheus/mrpbomrouting_v1_000/get_mrpbomrouting | Retorna lista de estrutura por operação do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) product (string) routing (string) |
| protheus/mrpbomrouting_v1_000/delete_mrpbomrouting | Remove uma ou mais estruturas por operação do MRP | data: { . items (array) } (object) required |
| protheus/mrpbomrouting_v1_000/get_mrpbomrouting_by_branch_id_by_product_by_routing_by_operation | Retorna a estrutura por operação do MRP | branchId (string) product (string) routing (string) operation (string) fields (string) |
| protheus/mrpbillofmaterial_v1_000/post_mrpbillofmaterial | Inclui ou atualiza uma ou mais estruturas do MRP | data: { . items (array) } (object) required |
| protheus/mrpbillofmaterial_v1_000/get_mrpbillofmaterial | Retorna lista de estrutura do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) code (string) product (string) component (string) sequence (string) |
| protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterial | Remove uma ou mais estruturas do MRP | data: { . items (array) } (object) required |
| protheus/mrpbillofmaterial_v1_000/get_mrpbillofmaterial_by_branch_id_by_product | Retorna uma estrutura do MRP | branchId (string) product (string) fields (string) |
| protheus/mrpbillofmaterial_v1_000/post_mrpbillofmaterial_sync | Sincroniza as estruturas do MRP | data: { . items (array) } (object) required |
| protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterial_component | Remove um ou mais componentes das estruturas do MRP | data: { . items (array) } (object) required |
| protheus/mrpbillofmaterial_v1_000/delete_mrpbillofmaterial_alternative | Remove um ou mais alternativos dos componentes das estruturas do MRP | data: { . items (array) } (object) required |
| protheus/mrpcalendar_v1_000/post_mrpcalendar | Inclui ou atualiza um ou mais registros no calendário do MRP | data: { . items (array) } (object) required |
| protheus/mrpcalendar_v1_000/get_mrpcalendar | Retorna lista de calendário do MRP | order (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_mrpcalendar | Remove um ou mais período do Calendário do MRP | data: { . items (array) } (object) required |
| protheus/mrpcalendar_v1_000/get_mrpcalendar_by_branch_id_by_code | Retorna o Calendário do MRP | branchId (string) code (string) fields (string) |
| protheus/mrpcalendar_v1_000/post_mrpcalendar_sync | Inclui ou atualiza um ou mais registros no calendário do MRP | data: { . items (array) } (object) required |
| protheus/mrpdemands_v1_000/post_mrpdemands | Inclui ou atualiza uma ou mais demandas do MRP | data: { . items (array) } (object) required |
| protheus/mrpdemands_v1_000/get_mrpdemands | Retorna lista de demandas do MRP | order (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_mrpdemands | Remove uma ou mais Demandas do MRP | data: { . items (array) } (object) required |
| protheus/mrpdemands_v1_000/get_mrpdemands_by_branch_id_by_code | Retorna uma Demanda do MRP | branchId (string) code (string) fields (string) |
| protheus/mrpdemands_v1_000/post_mrpdemands_sync | Sincroniza os registros de demandas do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductindicator_v1_000/post_mrpproductindicator | Inclui ou atualiza indicadores do produto do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductindicator_v1_000/get_mrpproductindicator | Retorna lista de indicadores do produto do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) product (string) |
| protheus/mrpproductindicator_v1_000/delete_mrpproductindicator | Remove os indicadores dos produtos do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductindicator_v1_000/get_mrpproductindicator_by_branch_id_by_product | Retorna os indicadores do produto do MRP | branchId (string) product (string) fields (string) |
| protheus/mrpproductindicator_v1_000/post_mrpproductindicator_sync | Sincroniza os registros dos indicadores do produto do MRP | data: { . items (array) } (object) required |
| protheus/mrpproduct_v1_000/post_mrpproduct | Inclui ou atualiza um ou mais produto do MRP | data: { . items (array) } (object) required |
| protheus/mrpproduct_v1_000/get_mrpproduct | Retorna lista de produtos do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) product (string) |
| protheus/mrpproduct_v1_000/delete_mrpproduct | Remove um ou mais produtos do MRP | data: { . items (array) } (object) required |
| protheus/mrpproduct_v1_000/get_mrpproduct_by_branch_id_by_product | Retorna um produto do MRP | branchId (string) product (string) fields (string) |
| protheus/mrpproduct_v1_000/post_mrpproduct_sync | Sincroniza os registros do produto do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductionorders_v1_000/post_mrpproductionorders | Inclui ou atualiza uma ou mais ordens de produção do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductionorders_v1_000/get_mrpproductionorders | Retorna lista de ordens de produção do MRP | order (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_mrpproductionorders | Remove uma ou mais Ordens de produção do MRP | data: { . items (array) } (object) required |
| protheus/mrpproductionorders_v1_000/get_mrpproductionorders_by_branch_id_by_code | Retorna uma ordem de produção do MRP | branchId (string) code (string) fields (string) |
| protheus/mrpproductionorders_v1_000/post_mrpproductionorders_sync | Sincroniza as ordens de produção do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaseorder_v1_000/post_mrppurchaseorder | Inclui ou atualiza um ou mais registros da solicitação de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaseorder_v1_000/get_mrppurchaseorder | Retorna lista de solicitação de compra do MRP | order (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_mrppurchaseorder | Remove uma ou mais Solicitação de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaseorder_v1_000/get_mrppurchaseorder_by_branch_id_by_code | Retorna a Solicitação de Compra do MRP | branchId (string) code (string) fields (string) |
| protheus/mrppurchaseorder_v1_000/post_mrppurchaseorder_sync | Sincroniza registros da solicitação de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaserequest_v1_000/post_mrppurchaserequest | Inclui ou atualiza um ou mais registros do pedido de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaserequest_v1_000/get_mrppurchaserequest | Retorna lista de pedidos de compra do MRP | order (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_mrppurchaserequest | Remove um ou mais Pedido de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrppurchaserequest_v1_000/get_mrppurchaserequest_by_branch_id_by_code | Retorna o Pedido de Compra do MRP | branchId (string) code (string) fields (string) |
| protheus/mrppurchaserequest_v1_000/post_mrppurchaserequest_sync | Sincroniza registros do pedido de compra do MRP | data: { . items (array) } (object) required |
| protheus/mrprejectedinventory_v1_000/post_mrprejectedinventory | Inclui ou atualiza um ou mais registros no estoque rejeitado do MRP | data: { . items (array) } (object) required |
| protheus/mrprejectedinventory_v1_000/get_mrprejectedinventory | Retorna lista de estoques rejeitados do MRP | order (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_mrprejectedinventory | Remove um ou mais saldo rejeitado em Estoque do MRP | data: { . items (array) } (object) required |
| protheus/mrprejectedinventory_v1_000/get_mrprejectedinventory_by_branch_id_by_code | Retorna o Estoque Rejeitado do MRP | branchId (string) code (string) fields (string) |
| protheus/mrprejectedinventory_v1_000/delete_mrprejectedinventory_clear_product | Zera os saldos de um ou mais produtos em um determinado armazém | data: { . items (array) } (object) required |
| protheus/mrprejectedinventory_v1_000/post_mrprejectedinventory_sync | Sincroniza registros do estoque rejeitado do MRP | data: { . items (array) } (object) required |
| protheus/mrprouting_v1_000/post_mrprouting | Inclui ou atualiza um ou mais roteiro do MRP | data: { . items (array) } (object) required |
| protheus/mrprouting_v1_000/get_mrprouting | Retorna lista de roteiros do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) product (string) routing (string) |
| protheus/mrprouting_v1_000/delete_mrprouting | Remove um ou mais roteiro do MRP | data: { . items (array) } (object) required |
| protheus/mrprouting_v1_000/get_mrprouting_by_branch_id_by_product_by_routing | Retorna um roteiro do MRP | branchId (string) product (string) routing (string) fields (string) |
| protheus/mrprouting_v1_000/post_mrprouting_sync | Sincroniza os registros do roteiro de produção do MRP | data: { . items (array) } (object) required |
| protheus/mrpstockbalance_v1_000/post_mrpstockbalance | Inclui ou atualiza um ou mais registros no estoque do MRP | data: { . items (array) } (object) required |
| protheus/mrpstockbalance_v1_000/get_mrpstockbalance | Retorna lista de estoques do MRP | order (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_mrpstockbalance | Remove um ou mais saldo em Estoque do MRP | data: { . items (array) } (object) required |
| protheus/mrpstockbalance_v1_000/get_mrpstockbalance_by_branch_id_by_code | Retorna o Estoque do MRP | branchId (string) code (string) fields (string) |
| protheus/mrpstockbalance_v1_000/delete_mrpstockbalance_clear_product | Zera os saldos de um ou mais produtos em um determinado armazém | data: { . items (array) } (object) required |
| protheus/mrpstockbalance_v1_000/post_mrpstockbalance_sync | Sincroniza registros no estoque do MRP | data: { . items (array) } (object) required |
| protheus/mrptransportinglanes_v1_000/post_mrptransportinglanes | Inclui ou atualiza uma ou mais malha de distribuição do MRP | data: { . items (array) } (object) required |
| protheus/mrptransportinglanes_v1_000/get_mrptransportinglanes | Retorna lista de malhas de distribuição do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) code (string) startWarehouseGroup (string) branchIdDest (string) endWarehouseGroup (string) |
| protheus/mrptransportinglanes_v1_000/delete_mrptransportinglanes | Remove uma ou mais malhas de distribuição do MRP | data: { . items (array) } (object) required |
| protheus/mrptransportinglanes_v1_000/get_mrptransportinglanes_by_branch_id_by_start_warehouse_group_by_end_warehouse_group | Retorna uma malha de distribuição do MRP | branchId (string) startWarehouseGroup (string) endWarehouseGroup (string) fields (string) |
| protheus/mrptransportinglanes_v1_000/post_mrptransportinglanes_sync | Sincroniza os registros da malha da distribuição do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouseinventorypolicies_v1_000/post_mrpwarehouseinventorypolicies | Inclui ou atualiza as políticas de estoque por grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouseinventorypolicies_v1_000/get_mrpwarehouseinventorypolicies | Retorna lista de políticas de estoque por grupo de armazém do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) product (string) warehouseGroup (string) |
| protheus/mrpwarehouseinventorypolicies_v1_000/delete_mrpwarehouseinventorypolicies | Remove as políticas de estoque por grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouseinventorypolicies_v1_000/get_mrpwarehouseinventorypolicies_by_branch_id_by_product_by_warehouse_group | Retorna a política de estoque por grupo de armazém do MRP | branchId (string) product (string) warehouseGroup (string) fields (string) |
| protheus/mrpwarehouseinventorypolicies_v1_000/post_mrpwarehouseinventorypolicies_sync | Sincroniza os registros da política de estoque por grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehousegroup_v1_000/post_mrpwarehousegroup | Inclui ou atualiza um ou mais grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehousegroup_v1_000/get_mrpwarehousegroup | Retorna lista de grupos de armazéns do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) code (string) |
| protheus/mrpwarehousegroup_v1_000/delete_mrpwarehousegroup | Remove um ou mais grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehousegroup_v1_000/get_mrpwarehousegroup_by_branch_id_by_warehouse_group | Retorna um grupo de armazém do MRP | branchId (string) warehouseGroup (string) fields (string) |
| protheus/mrpwarehousegroup_v1_000/post_mrpwarehousegroup_sync | Sincroniza os registros do grupo de armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouse_v1_000/post_mrpwarehouse | Inclui ou atualiza um ou mais registros de Armazéns do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouse_v1_000/get_mrpwarehouse | Retorna lista de Armazéns do MRP | order (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_mrpwarehouse | Remove um ou mais armazéns do MRP | data: { . items (array) } (object) required |
| protheus/mrpwarehouse_v1_000/get_mrpwarehouse_by_branch_id_by_code | Retorna o Armazém do MRP | branchId (string) code (string) fields (string) |
| protheus/mrpwarehouse_v1_000/post_mrpwarehouse_sync | Inclui ou atualiza um ou mais registros no Armazém do MRP | data: { . items (array) } (object) required |
| protheus/mrpworkcenter_v1_000/post_mrpworkcenter | Inclui ou atualiza um ou mais centro do trabalho do MRP | data: { . items (array) } (object) required |
| protheus/mrpworkcenter_v1_000/get_mrpworkcenter | Retorna lista de centros de trabalho do MRP | order (array) page (integer) pageSize (integer) fields (string) branchId (string) workcenter (string) |
| protheus/mrpworkcenter_v1_000/delete_mrpworkcenter | Remove um ou mais centros de trabalho do MRP | data: { . items (array) } (object) required |
| protheus/mrpworkcenter_v1_000/get_mrpworkcenter_by_branch_id_by_workcenter | Retorna um centro de trabalho do MRP | branchId (string) workcenter (string) fields (string) |
| protheus/manifest_v1_000/get_manifest | Retorna todos os romaneios cadastrados. | order (array) page (integer) pageSize (integer) |
| protheus/manifest_v1_000/get_manifest_by_id | Retorna o romaneio requerido | Id (string) |
| protheus/manifest_v1_000/post_manifest_by_id | Inclui o romaneio. | Id (string) 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_id | Altera o romaneio informado. | Id (string) 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_segment | Retorna todos Segmentos | order (array) page (integer) pageSize (integer) |
| protheus/marketsegment_v2_000/post_market_segment | Inclui segmento passado na requisição | 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_id | Retorna Segmento com base em seu Código | marketSegmentID (string) |
| protheus/marketsegment_v2_000/put_market_segment_by_market_segment_id | Atualiza o segmento informado na requisição | marketSegmentID (string) 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_id | Exclui o cadastro de segmento passada na requisição | marketSegmentID (string) |
| protheus/menus_v1_001/get_menus | Retorna todas os resources | order (array) page (integer) pageSize (integer) |
| protheus/menus_v1_001/get_menus_by_parent_id | Retorna todas os resources | parentId (string) |
| protheus/mrpprodversion_v1_000/post_mrpproductionversion | Inclui ou atualiza um ou mais registros de versão da produção MRP | data (object) required |
| protheus/mrpprodversion_v1_000/get_mrpproductionversion | Retorna lista de versões da produção MRP | order (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_mrpproductionversion | Remove uma ou mais Versões da produção MRP | data (object) required |
| protheus/mrpprodversion_v1_000/get_mrpproductionversion_by_branch_id_by_code | Retorna uma Versão da Produção MRP | branchId (string) code (string) fields (string) |
| protheus/mrpprodversion_v1_000/post_mrpproductionversion_sync | Sincroniza os registros da versão da produção MRP | data (object) required |
| protheus/notes_v1_000/get_notes | Retorna lista completa das Anotações | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/notes_v1_000/post_notes | Inclui uma anotação conforme dados enviados na requisição. | 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_id | Retorna a anotação de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/notes_v1_000/put_notes_by_internal_id | Atualiza a anotação conforme dados enviados na requisição | InternalId (string) 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_id | Exclui uma anotação conforme dados enviados na requisição. | InternalId (string) |
| protheus/opportunity_v1_000/get_opportunities | Retorna lista completa das oportunidades de Venda | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/opportunity_v1_000/post_opportunities | Inclui uma oportunidade de venda conforme dados enviados na requisição. | 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_id | Retorna a oportunidade de venda pelo código | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/opportunity_v1_000/put_opportunities_by_internal_id | Atualiza a oportunidade de venda conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a oportunidade de venda conforme dados enviados na requisição. | InternalId (string) |
| protheus/paymentcondition_v1_00/get_paymentcondition | Retorna lista completa das condições de pagamento | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/paymentcondition_v1_00/post_paymentcondition | Inclui uma condição de pagamento conforme dados enviados na requisição. | 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_id | Retorna a condição de pagamento pelo InternalId | InternalId (string) fields (string) |
| protheus/paymentcondition_v1_00/put_paymentcondition_by_internal_id | Atualiza a condição de pagamento conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a condição de pagamento conforme dados enviados na requisição. | InternalId (string) |
| protheus/payrollcontrol_v1_000/get_payroll_control | Retorna os dados da folha de pagamento de benefíciosAssitência Médica e Odontológica | 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_items | Retorna lista de Tabela de Preço | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/pricelistheaderitem_v2_005/post_price_list_header_items | Inclui uma tabela de preço conforme dados enviados na requisição. | data (object) required |
| protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_code | Retorna a tabela de preço e todos os seus itens de acordo com o seu código | code (string) order (array) fields (string) |
| protheus/pricelistheaderitem_v2_005/put_price_list_header_items_by_code | Atualiza o cadastro da tabela de preço conforme dados enviados na requisição | code (string) data (object) required |
| protheus/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code | Exclui a tabela de preço conforme dados enviados na requisição. | code (string) |
| protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price | Retorna os itens da tabela de preço de acordo com o seu código | code (string) order (array) fields (string) page (integer) pageSize (integer) |
| protheus/pricelistheaderitem_v2_005/post_price_list_header_items_by_code_itens_table_price | Inclui um novo item na tabela de preço conforme dados enviados. | code (string) data: { . items } (object) required |
| protheus/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price_by_item_list | Retorna um item específico de preço de acordo com o seu código | code (string) itemList (undefined) order (array) fields (string) page (integer) pageSize (integer) |
| protheus/pricelistheaderitem_v2_005/put_price_list_header_items_by_code_itens_table_price_by_item_list | Atualiza um item da tabela de preço conforme dados enviados na requisição | code (string) itemList (undefined) fields (string) data: { . items } (object) required |
| protheus/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code_itens_table_price_by_item_list | Exclui um item da tabela de preço conforme dados enviados na requisição. | code (string) itemList (undefined) |
| protheus/productsupplierrelationship_v1_000/get_product_supplier_relationship | Retorna lista completa de relacionamentos entre Produtos e Fornecedores | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/productsupplierrelationship_v1_000/post_product_supplier_relationship | Inclui um relacionamento entre Produto e Fornecedor | 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_id | Retorna um registro de relacionamento de Produto e Fornecedor | InternalId (string) |
| protheus/productsupplierrelationship_v1_000/put_product_supplier_relationship_by_internal_id | Atualiza um registro de relacionamento de Produto e Fornecedor | InternalId (string) 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_id | Exclui um registro de relacionamento de produto e Fornecedor conforme dados enviados na requisição | InternalId (string) |
| protheus/prospects_v1_000/get_prospects | Retorna lista completa de prospects | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/prospects_v1_000/post_prospects | Inclui um prospect conforme dados enviados na requisição. | 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_code | Retorna prospect pelo seu Código | Code (string) order (array) fields (string) page (integer) pageSize (integer) |
| protheus/prospects_v1_000/put_prospects_by_code | Atualiza cadastro de prospect conforme dados enviados na requisição | Code (string) 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_code | Exclui cadastro de Prospect conforme dados enviados na requisição. | Code (string) |
| protheus/purchasegroups_v1_000/get_purchase_groups | Retorna todos os Grupo Compras purchaseGroups do Protheus. | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/purchasegroups_v1_000/post_purchase_groups | Inclui um Grupo de Compras purchaseGroups, com base nos dados enviados na requisição. | data: { . companyInternalId (string) . InternalId (string) . branchId (string) . code (string) . ListOfUserList (object) } (object) required |
| protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_id | Retorna um Grupo de Compras purchaseGroup, especifico com base nas informações enviadas na requisição. | InternalId (string) |
| protheus/purchasegroups_v1_000/put_purchase_groups_by_internal_id | Altera um Grupo de Compras purchaseGroup, especifico com base nos dados enviados na requisição. | InternalId (string) data: { . companyInternalId (string) . InternalId (string) . branchId (string) . code (string) . ListOfUserList (object) } (object) required |
| protheus/purchasegroups_v1_000/delete_purchase_groups_by_internal_id | Exclusão de um Grupo de Compras, baseado nas informações enviadas na requisição. | InternalId (string) |
| protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_id_purchase_groups_itens | Retorna todos os Compradores Buyers cadastrados no Grupo de Compras purchaseGroup especifico. | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/purchasegroups_v1_000/post_purchase_groups_by_internal_id_purchase_groups_itens | Inclui um Comprador Buyer em um Grupo de Compras purchaseGroup existente, baseado nos dados enviados na requisição. | InternalId (string) data (array) required |
| protheus/purchasegroups_v1_000/get_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequence | Retorna o Comprador Buyer especifico do Grupo de Compras purchaseGroup, baseado na requisição enviada. | InternalId (string) itemsequence (string) |
| protheus/purchasegroups_v1_000/put_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequence | Altera um Comprador Buyer especifico do Grupo de Compras purchaseGroup, baseando nas informações passadas na requisição. | InternalId (string) itemsequence (string) data (array) required |
| protheus/purchasegroups_v1_000/delete_purchase_groups_by_internal_id_purchase_groups_item_by_itemsequence | Exclui um Comprador Buyer em um Grupo de Compras purchaseGroups baseado nos dados enviados na requisição. | InternalId (string) itemsequence (string) |
| protheus/regiongroups_v1_000/get_regiongroups | Retorna lista completa do Grupo de Região | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/regiongroups_v1_000/post_regiongroups | Inclui um Grupo de Região conforme dados enviados na requisição. | 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_id | Retorna o Grupo de Região de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/regiongroups_v1_000/put_regiongroups_by_internal_id | Atualiza o Grupo de Região conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Grupo de Região conforme dados enviados na requisição. | InternalId (string) |
| protheus/requesters_v1_000/get_requesters | Retorna lista completa do Solicitante | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/requesters_v1_000/post_requesters | Inclui um Solicitante conforme dados enviados na requisição. | 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_id | Retorna o Solicitante de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/requesters_v1_000/put_requesters_by_internal_id | Atualiza o Solicitante conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Solicitante conforme dados enviados na requisição. | InternalId (string) |
| protheus/resource_v1_001/post_resources | Adiciona novo Recurso | 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/get_resources | Retorna lista de Recursos | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/resource_v1_001/get_resources_by_resource_id | Retorna um Recurso | ResourceId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/resource_v1_001/put_resources_by_resource_id | Atualiza um Recurso | ResourceId (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_id | Remove um Recurso | ResourceId (string) |
| protheus/retailitem_v1_000/get_retail_item | Retorna uma lista com todos os Produtos | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/retailpricelist_v1_000/get_retail_price_list | Retorna uma lista com o cabeçalho de todas as Tabelas de Preço | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/retailpricelist_v1_000/get_retail_price_list_by_internal_id | Retorna o cabeçalho de uma única Tabela de Preço a partir do internalId identificador único da Tabela de Preço | internalId (string) order (array) fields (string) |
| protheus/retailpricelist_v1_000/get_retail_price_list_by_internal_id_itens_table_price | Retorna todos os itens de uma única Tabela de Preço a partir do internalId identificador único da Tabela de Preço | internalId (string) order (array) fields (string) page (integer) pageSize (integer) |
| protheus/retailsalesorders_v1_000/get_retail_sales_orders | Lista todos os pedidos de venda do faturamento SC5 relacionados ao varejo. | No parameters |
| protheus/retailsalesorders_v1_000/get_retail_sales_orders_by_internal_id_items | Exibe os detalhes dos itens do pedido de venda SC6 para o pedido informado. | internalId (string) |
| protheus/retailsales_v1_000/post_retail_sales_by_internal_id_cancelation | Cancela 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 exista | InternalId (string) |
| protheus/retailsales_v1_000/get_retail_sales | Retorna todas as vendas varejo | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/retailsales_v1_000/post_retail_sales | Inclui a entidade RetailSales passada na requisição | 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_id | Retorna os dados da venda de acordo com o número do documento da venda e filial passadas por parametro | InternalId (string) |
| protheus/retailsales_v1_000/put_retail_sales_by_internal_id | Atualiza a entidade RetailSales passada na requisição | InternalId (string) 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_id | Deleta a entidade RetailSales passada na requisição | InternalId (string) |
| protheus/retailsales_v2_000/post_retail_sales | Inclui a entidade RetailSales passada na requisição por ExecAuto do Loja | 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_level | Retorna uma lista com todos os Produtos com saldo em estoque | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/roles_v1_000/get_roles | Retorna todas os Roles | order (array) page (integer) pageSize (integer) |
| protheus/salescharge_v1_000/get_sales_charge | Retorna todos as comissões dos vendedores | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/salescharge_v1_000/post_sales_charge | Inclui uma comissão para um determinado vendedor | 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/get_sales_charge_by_internal_id | Retorna todas as comissões do vendedor | InternalId (string) fields (string) page (integer) pageSize (integer) |
| protheus/salescharge_v1_000/get_sales_charge_by_internal_id_by_account_receivable_document_internal_id | Retorna a comissão do vendedor, com base nos parâmetros passados | AccountReceivableDocumentInternalId (string) InternalId (string) fields (string) page (integer) pageSize (integer) |
| protheus/salescharge_v1_000/put_sales_charge_by_internal_id_by_account_receivable_document_internal_id | Atualiza a comissão do vendedor, com base nos parâmetros passados | InternalId (string) AccountReceivableDocumentInternalId (string) 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_id | Exclui a comissão do vendedor, com base nos parâmetros passados | InternalId (string) AccountReceivableDocumentInternalId (string) order (array) |
| protheus/salesprocess_v1_000/get_sales_process | Retorna lista completa de Processos de Venda | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/salesprocess_v1_000/post_sales_process | Inclui um Processo de Venda conforme dados enviados na requisição. | 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_id | Retorna o Processo de Venda conforme dados enviados na requisição | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/salesprocess_v1_000/put_sales_process_by_internal_id | Atualiza cadastro de Processo de Venda conforme dados enviados na requisição | InternalId (string) 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_id | Exclui cadastro de Processo de Venda conforme dados enviados na requisição. | InternalId (string) |
| protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_stages | Retorna lista completa de Estágios do Processo de Venda | InternalId (string) fields (string) order (array) page (integer) pageSize (integer) |
| protheus/salesprocess_v1_000/post_sales_process_by_internal_id_list_of_stages | Inclui um Estágio no Processo de Venda conforme dados enviados na requisição. | InternalId (string) 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_id | Retorna o Estágio do Processo de Venda conforme dados enviados na requisição | InternalId (string) StageId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/salesprocess_v1_000/put_sales_process_by_internal_id_list_of_stages_by_stage_id | Atualiza a cadastro de um Estágio do Processo de Venda conforme dados enviados na requisição | InternalId (string) StageId (string) 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_id | Exclui cadastro de Estágio do Processo de Venda conforme dados enviados na requisição. | InternalId (string) StageId (string) |
| protheus/salesprocess_v1_000/get_sales_process_by_internal_id_list_of_rules | Retorna lista completa de Regras do Processo de Venda | InternalId (string) fields (string) order (array) page (integer) pageSize (integer) |
| protheus/salesprocess_v1_000/post_sales_process_by_internal_id_list_of_rules | Inclui uma Regra no Processo de Venda conforme dados enviados na requisição. | InternalId (string) 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_id | Retorna a Regra do Processo de Venda conforme dados enviados na requisição | InternalId (string) RuleId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/salesprocess_v1_000/put_sales_process_by_internal_id_list_of_rules_by_rule_id | Atualiza a cadastro de uma Regra do Processo de Venda conforme dados enviados na requisição | InternalId (string) RuleId (string) 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_id | Exclui cadastro da Regra do Processo de Venda conforme dados enviados na requisição. | InternalId (string) RuleId (string) |
| protheus/salestargets_v1_000/get_sales_target | Retorna uma lista completa de Metas de Vendas | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/salestargets_v1_000/post_sales_target | Inclui uma Meta de venda conforme dados enviados na requisição. | 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_id | Retorna uma Meta de Venda pelo InternalId | InternalId (string) fields (string) |
| protheus/salestargets_v1_000/put_sales_target_by_internal_id | Altera uma Meta de Venda pelo InternalId | InternalId (string) 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_id | Exclui uma Meta de Venda pelo InternalId | InternalId (string) |
| protheus/salestargets_v1_000/get_sales_target_by_internal_id_itens_sales_target | Retorna uma lista completa dos Itens das Metas de Vendas | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/salestargets_v1_000/post_sales_target_by_internal_id_itens_sales_target | Inclui um item de uma Meta de venda conforme dados enviados na requisição. | InternalId (string) fields (string) data (array) required |
| protheus/salestargets_v1_000/get_sales_target_by_internal_id_itens_sales_target_by_item_id | Retorna um item de uma Meta de Venda de venda especifica pelo ItemId | InternalId (string) ItemId (string) fields (string) |
| protheus/salestargets_v1_000/put_sales_target_by_internal_id_itens_sales_target_by_item_id | Altera um item de uma Meta de Venda de venda especifica pelo ItemId | InternalId (string) ItemId (string) fields (string) data (array) required |
| protheus/salestargets_v1_000/delete_sales_target_by_internal_id_itens_sales_target_by_item_id | Exclui um item de uma Meta de Venda de venda especifica pelo ItemId | InternalId (string) ItemId (string) |
| protheus/salestaxes_v1_000/get_sales_taxes_by_sales_order_id | Retorna uma lista com os Valores e Tributos de um Pedido de Venda gravado | SalesOrderId (string) |
| protheus/salestaxes_v1_000/post_sales_taxes | Retorna uma lista com os Valores e Tributos de uma Simulação de Pedido de Venda | 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_se2lista | Endpoint 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_selleractivity | Retorna uma lista completa de Atividades dos vendedores | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/selleractivity_v1_000/post_selleractivity | Inclui uma Atividade conforme dados enviados na requisição. | 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_id | Retorna uma Atividade pelo InternalId | InternalId (string) fields (string) |
| protheus/selleractivity_v1_000/put_selleractivity_by_internal_id | Altera uma Atividade pelo InternalId | InternalId (string) 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_id | Exclui uma Atividade pelo InternalId | InternalId (string) |
| protheus/sellers_v2_000/get_seller | Retorna lista completa de vendedores | fields (string) order (array) page (integer) pageSize (integer) |
| protheus/sellers_v2_000/post_seller | Inclui um vendedor conforme dados enviados na requisição. | 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_code | Retorna vendedor pelo seu Código | code (string) fields (string) |
| protheus/sellers_v2_000/put_seller_by_code | Atualiza cadastro de vendedor conforme dados enviados na requisição | code (string) 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_code | Exclui cadastro de vendedor conforme dados enviados na requisição. | code (string) |
| protheus/stopreason_v1_000/post_stop_reasons | Adiciona novo Motivo de Parada | data: { . Id (string) . Code (string) . Description (string) . IsEfficiency (boolean) . IsEmailEquipment (boolean) . IsServiceRequest (boolean) . IsSetup (boolean) } (object) required |
| protheus/stopreason_v1_000/get_stop_reasons | Retorna lista de motivos de parada | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/stopreason_v1_000/get_stop_reasons_by_id | Retorna um único motivo de parada | Id (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/stopreason_v1_000/put_stop_reasons_by_id | Atualiza um Motivo de Parada | Id (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_id | Remove um Motivo de Parada | Id (string) |
| protheus/stopreport_v1_003/post_stop_reports | Adiciona novo Apontamento de Parada | data: { . 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_reports | Retorna lista de Apontamentos de Parada | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/stopreport_v1_003/get_stop_reports_by_integration_report | Retorna um Apontamento de Parada | IntegrationReport (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/stopreport_v1_003/delete_stop_reports_by_integration_report_reversal | Estorna um Apontamento de Parada | IntegrationReport (string) |
| protheus/suspects_v1_000/get_suspects | Retorna lista completa de Suspects | order (array) fields (string) page (integer) pageSize (integer) |
| protheus/suspects_v1_000/post_suspects | Inclui um Suspect conforme dados enviados na requisição. | 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_code | Retorna Suspect pelo seu Código | Code (string) order (array) fields (string) page (integer) pageSize (integer) |
| protheus/suspects_v1_000/put_suspects_by_code | Atualiza cadastro de Suspect conforme dados enviados na requisição | Code (string) 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_code | Exclui cadastro de Suspect conforme dados enviados na requisição. | Code (string) |
| protheus/systemmodules_v1_000/get_system_modules | Retorna todas os SystemModules | order (array) page (integer) pageSize (integer) |
| protheus/systemmodules_v1_000/get_system_modules_by_id | Retorna todas os SystemModules | id (string) |
| protheus/systemparameter_v1_000/get_system_parameters | Retorna todos os parâmetros do sistema | order (array) page (integer) pageSize (integer) fields (string) codes (string) Accept-Language (string) description (string) |
| protheus/systemparameter_v1_000/post_system_parameters | Inclui o parâmetro passado na requisição | 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_id | Altera o parâmetro passado na requisição | systemParameterId (string) 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_id | Exclusão de parâmetro da base | systemParameterId (string) |
| protheus/tafesocialremovecompany_v1_000/delete_tafesocial_remove_company_by_company_id | Remove os dados do empregador do e-Social da base de dados do RET | companyId (string) |
| protheus/tsibranches_v1_000/get_tsibranches | Retorna as filiais do grupo informado de acordo com o parâmetro 'companyId'. | companyId (string) required |
| protheus/tsiintegrationerrors_v1_000/get_tsiintegration_errors | Consulta 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_status | Consulta o status do serviço, se está configurado e/ou ativo. | companyId (string) required |
| protheus/token_v1_000/post_token | Aplicativos realizam a requisição ao endpoint inserindo os parâmetros descritos a seguir | grant_type (string) required username (string) password (string) refresh_token (string) |
| protheus/totalinputdocument_v1_000/get_total_input_document | QueryString 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. | 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_canceled | QueryString 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. | 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 | QueryString 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. | 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_canceled | QueryString 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. | order (array) page (integer) pageSize (integer) fields (string) BrancheInternalId (string) required FromDate (string) required ToDate (string) required |
| protheus/treadmills_v1_000/get_treadmills | Retorna todos as esteiras da base | order (array) page (integer) pageSize (integer) |
| protheus/treadmills_v1_000/post_treadmills | Inclui uma esteira passada na requisição | data: { . InternalId (string) . SourceBranch (string) . Code (string) . Description (string) . CottonGin (string) } (object) required |
| protheus/treadmills_v1_000/get_treadmills_by_internal_id | Retorna a esteira correspondente ao código único informado | InternalId (string) |
| protheus/treadmills_v1_000/put_treadmills_by_internal_id | Altera a esteira passada na requisição | InternalId (string) data: { . InternalId (string) . SourceBranch (string) . Code (string) . Description (string) . CottonGin (string) } (object) required |
| protheus/treadmills_v1_000/delete_treadmills_by_internal_id | Deleção da esteira informada | InternalId (string) |
| protheus/unitofmeasure_v1_000/get_unit_of_measures | Retorna lista completa de Unidade de Medida | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/unitofmeasure_v1_000/post_unit_of_measures | Inclui uma Unidade de Medida | data (undefined) required |
| protheus/unitofmeasure_v1_000/get_unit_of_measures_by_code | Retorna Unidade de Medida pelo seu Código | Code (string) |
| protheus/unitofmeasure_v1_000/put_unit_of_measures_by_code | Atualiza cadastro de Unidade de Medida conforme dados enviados na requisição | Code (string) data (undefined) required |
| protheus/unitofmeasure_v1_000/delete_unit_of_measures_by_code | Exclui Unidade de Medida cadastrada conforme dados enviados na requisição | Code (string) |
| protheus/unitofmeasure_v2_000/get_unit_of_measures | Retorna lista completa de Unidade de Medida | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/unitofmeasure_v2_000/post_unit_of_measures | Inclui uma Unidade de Medida | data: { . Code (string) . InternalId (string) . Description (string) . ShortName (string) } (object) required |
| protheus/unitofmeasure_v2_000/get_unit_of_measures_by_code | Retorna Unidade de Medida pelo seu Código | Code (string) |
| protheus/unitofmeasure_v2_000/put_unit_of_measures_by_code | Atualiza cadastro de Unidade de Medida conforme dados enviados na requisição | Code (string) data: { . Code (string) . InternalId (string) . Description (string) . ShortName (string) } (object) required |
| protheus/unitofmeasure_v2_000/delete_unit_of_measures_by_code | Exclui Unidade de Medida cadastrada conforme dados enviados na requisição | Code (string) |
| protheus/urbanocoletor_v1_000/post_coletor_urbano | Inclui informações do coletor na prestação de contas | data (object) required |
| protheus/user_v1_000/get_users | Retorna todos usuários do sistema | order (array) page (integer) pageSize (integer) fields (string) userIds (string) name (string) |
| protheus/user_v1_000/post_users | Inclui usuário passado na requisição | data (object) required |
| protheus/user_v1_000/get_users_by_id | Retorna o usuário do sistema indicado | id (string) foundBy (string) domainId (string) |
| protheus/user_v1_000/put_users_by_id | Altera o usuário passado na requisição | id (string) foundBy (string) domainId (string) data (undefined) required |
| protheus/user_v1_000/delete_users_by_id | Exclusão de usuário da base | id (string) foundBy (string) domainId (string) |
| protheus/wastereason_v1_000/post_waste_reasons | Adiciona novo Motivo de Refugo | data: { . Code (string) . Description (string) . IsRework (boolean) . IsScrapMaterial (boolean) } (object) required |
| protheus/wastereason_v1_000/get_waste_reasons | Retorna lista de motivos de refugo | order (array) page (integer) pageSize (integer) fields (string) |
| protheus/wastereason_v1_000/get_waste_reasons_by_code | Retorna um Motivo de Refugo | Code (string) order (array) page (integer) pageSize (integer) fields (string) |
| protheus/wastereason_v1_000/put_waste_reasons_by_code | Atualiza um Motivo de Refugo | Code (string) data: { . Code (string) . Description (string) . IsRework (boolean) . IsScrapMaterial (boolean) } (object) required |
| protheus/wastereason_v1_000/delete_waste_reasons_by_code | Remove um Motivo de Refugo | Code (string) |
| rm/accountingentry_v1_000/get_accounting_entries | Retorna uma lista de Lançamentos Contábeis da Coligada | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required |
| rm/accountingentry_v1_000/post_accounting_entries | Inclui um Lançamento Contábil conforme dados enviados na requisição. | companyId (integer) required data: { . companyId (integer) . batchCode (integer) . description (string) . accountEntry (array) } (object) required |
| rm/accountingentry_v1_000/get_accounting_entries_by_id | Retorna o Lançamento Contábil da Coligada, Id Lançamento e Código do Lote | id (string) order (array) page (integer) pageSize (integer) |
| rm/accountingentry_v1_000/put_accounting_entries_by_id | Atualiza o Lançamento Contábil conforme os dados enviados na requisição | id (string) data: { . companyId (integer) . batchCode (integer) . description (string) . accountEntry (array) } (object) required |
| rm/accountingentry_v1_000/patch_accounting_entries_by_id | Atualiza o Lançamento contábil conforme os dados enviados na requisição | id (string) fields (string) data: { . companyId (integer) . batchCode (integer) . description (string) . accountEntry (array) } (object) required |
| rm/accountingentry_v1_000/delete_accounting_entries_by_id | Exclui o Lançamento Contábil conforme os dados enviados na requisição. | id (string) |
| rm/accountingplan_v1_000/get_accounting_plan | Retorna lista de Plano Contas Contábeis | order (array) page (integer) pageSize (integer) fields (string) |
| rm/accountingplan_v1_000/post_accounting_plan | Inclui um Plano de conta contábil conforme dados enviados na requisição. | fields (string) data (undefined) required |
| rm/accountingplan_v1_000/get_accounting_plan_by_id | Retorna um plano de conta contábil de acordo com o ID de pesquisa | id (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/accountingplan_v1_000/put_accounting_plan_by_id | Atualiza o plano de conta contábil conforme os dados enviados na requisição | id (string) fields (string) data (undefined) required |
| rm/accountingplan_v1_000/patch_accounting_plan_by_id | Atualiza o plano de conta contábil conforme os dados enviados na requisição | id (string) fields (string) data (undefined) required |
| rm/accountingplan_v1_000/delete_accounting_plan_by_id | Exclui um Plano de conta contábil conforme os dados enviados na requisição. | id (string) |
| rm/accountingtransactions_v1_000/get_accounting_transactions | Retorna uma lista de movimentação em Contas Contábeis. | 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_account | Retorna um único registro com a movimentação de acordo com a Conta, período e moeda informada. | 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_id | Retorna dados do tipo de abono | id (string) |
| rm/allowancetypes_v1_000/delete_allowance_types_by_id | Exclui registro de tipo de abono | id (string) |
| rm/allowancetypes_v1_000/put_allowance_types_by_id | Atualiza 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_types | Retorna todas os tipos de abonos | fields (string) order (array) page (integer) pageSize (integer) |
| rm/allowancetypes_v1_000/post_allowance_types | Inclui um novo registro na tabela de tipo de abono | data: { . 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_drcs | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/apacnephrologiesdrcs_v1_000/post_apac_nephrologies_drcs | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/apacnephrologiesdrcs_v1_000/put_apac_nephrologies_drcs_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/apacnephrologiesfistulas_v1_000/get_apac_nephrologies_fistulas | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/apacnephrologiesfistulas_v1_000/post_apac_nephrologies_fistulas | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/apacnephrologiesfistulas_v1_000/put_apac_nephrologies_fistulas_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/apacnephrologies_v1_000/get_apac_nephrologies | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/apacnephrologies_v1_000/post_apac_nephrologies | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/apacnephrologies_v1_000/put_apac_nephrologies_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/apacprocedures_v1_000/get_apac_procedures | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/apacprocedures_v1_000/post_apac_procedures | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/apacprocedures_v1_000/put_apac_procedures_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/apac_v1_000/get_apac | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/apac_v1_000/post_apac | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/apac_v1_000/put_apac_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/applicantresults_v1_000/get_applicant_results_by_id | Retorna detalhes do resultado do candidato do processo seletivo | Id (string) expand (string) |
| rm/appliedmatrix_v1_000/get_academics_by_academic_internal_id_appliedmatrixes | Retorna todas as matrizes aplicadas de uma matriz curricular | AcademicInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/appliedmatrix_v1_000/post_academics_by_academic_internal_id_appliedmatrixes | Inclui o período passado na requisição | AcademicInternalId (string) data (undefined) required |
| rm/appliedmatrix_v1_000/get_academics_by_academic_internal_id_appliedmatrixes_by_internal_id | Retorna a matriz aplicada | AcademicInternalId (string) InternalId (string) |
| rm/appliedmatrix_v1_000/put_academics_by_academic_internal_id_appliedmatrixes_by_internal_id | Altera o período passado na requisição | AcademicInternalId (string) InternalId (string) data (undefined) required |
| rm/appliedmatrix_v1_000/delete_academics_by_academic_internal_id_appliedmatrixes_by_internal_id | Exclusão de matriz aplicada da base | AcademicInternalId (string) InternalId (string) |
| rm/appointmentavailable_v1_000/get_appointment_availables | Recupera uma lista com todos os Cadastros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/appointmentavailable_v2_000/get_appointment_availables | Recupera uma lista com todos os Cadastros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/appointment_v1_000/get_appointments_by_code | Retorna um Atendimento | code (string) |
| rm/appointment_v1_000/delete_appointments_by_code | Exclui um Agendamento | code (string) |
| rm/appointment_v1_000/get_appointments | Recupera uma lista com todos os Agendamentos | order (array) page (integer) pageSize (integer) fields (string) |
| rm/appointment_v1_000/post_appointments | Insere um registro | 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_appointments | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/appointment_v2_000/post_appointments | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/appointment_v2_000/put_appointments_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/assignments_v1_000/get_professors_by_professor_internal_id_assignments | Retorna todos as provas/avaliações da turma/disciplina | ProfessorInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/assignments_v1_000/post_professors_by_professor_internal_id_assignments | Inclui a prova/avaliação passada na requisição | ProfessorInternalId (string) data (undefined) required |
| rm/assignments_v1_000/get_professors_by_professor_internal_id_assignments_by_internal_id | Retorna uma prova/avaliação | ProfessorInternalId (string) InternalId (string) |
| rm/assignments_v1_000/put_professors_by_professor_internal_id_assignments_by_internal_id | Altera a prova/avaliação passada na requisição | ProfessorInternalId (string) InternalId (string) data (undefined) required |
| rm/assignments_v1_000/delete_professors_by_professor_internal_id_assignments_by_internal_id | Exclusão de prova/avaliação | ProfessorInternalId (string) InternalId (string) |
| rm/attendanceregister_v1_000/get_attendance_register | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/attendanceregister_v1_000/get_attendance_register_by_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/auditpanel_v1_000/get_painel_auditoria_period | Retorna os períodos de apuração disponíveis no sistema. | No parameters |
| rm/auditpanel_v1_000/get_painel_auditoria_big_numbers | Retorna os indicadores principais Big Numbers para o dashboard. | No parameters |
| rm/auditpanel_v1_000/get_painel_auditoria_employees | Lista os funcionários vinculados ao processo de auditoria. | No parameters |
| rm/auditpanel_v1_000/post_painel_auditoria_update_feedback | Envia uma atualização de feedback para um registro de auditoria. | No parameters |
| rm/auditpanel_v1_000/get_painel_auditoria_conformities | Lista 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_branches | Retorna 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_update | Informa 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_history | Retorna 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_id | Retorna dados da extra autorizada | id (string) |
| rm/authorizedovertime_v1_000/get_authorized_overtime | Retorna todas as extras autorizadas | fields (string) order (array) page (integer) pageSize (integer) |
| rm/availablecourse_v1_000/get_selection_processes_by_selection_process_id_available_courses | Retorna todas as áreas ofertadas do processo seletivo | SelectionProcessId (string) order (array) page (integer) pageSize (integer) |
| rm/availablecourse_v1_000/get_selection_processes_by_selection_process_id_available_courses_by_available_course_id | Retorna somente os dados de uma área ofertada do processo seletivo | SelectionProcessId (string) AvailableCourseId (string) expand (string) |
| rm/availableofferedactivities_v1_000/get_students_by_student_internal_id_offeredactivities | Retorna todas as atividades ofertadas que o aluno pode visualizar | StudentInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/availableofferedactivities_v1_000/get_students_by_student_internal_id_offeredactivities_by_internal_id | Retorna somente a atividade ofertada | StudentInternalId (string) InternalId (string) |
| rm/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipation | Retorna todos os registros de Coparticipações dos Beneficiários e seus dependentes. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) required companyid (string) required |
| rm/beneficiariesdatacontent_v1_000/get_beneficiaries_data_content | Retorna todos os registros de beneficiários. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required branchId (string) |
| rm/biologicalmonitoringresponsible_v1_000/get_biologicalmonitoringresponsible_by_id | Retorna dados de tabela do Responsável pela Monitoração Biológica especificado | id (string) |
| rm/biologicalmonitoringresponsible_v1_000/delete_biologicalmonitoringresponsible_by_id | Exclui um Responsável pela Monitoração Biológica | id (string) |
| rm/biologicalmonitoringresponsible_v1_000/put_biologicalmonitoringresponsible_by_id | Atualiza 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) data (object) required |
| rm/biologicalmonitoringresponsible_v1_000/get_biologicalmonitoringresponsible | Retorna todos os Responsáveis pela Monitoração Biológica | order (array) page (integer) pageSize (integer) Ids (string) |
| rm/biologicalmonitoringresponsible_v1_000/post_biologicalmonitoringresponsible | Inclui um novo registro na tabela de medições de risco | data (object) required |
| rm/block_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks | Retorna todos os blocos do Educacional | ProfessorInternalId (string) BuildingInternalId (string) order (array) page (integer) pageSize (integer) |
| rm/block_v1_000/post_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks | Inclui o bloco passado na requisição | ProfessorInternalId (string) BuildingInternalId (string) data (undefined) required |
| rm/block_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_id | Retorna o bloco educacional | ProfessorInternalId (string) BuildingInternalId (string) InternalId (string) |
| rm/block_v1_000/put_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_id | Altera o bloco passado na requisição | ProfessorInternalId (string) BuildingInternalId (string) InternalId (string) data (undefined) required |
| rm/block_v1_000/delete_professors_by_professor_internal_id_buildings_by_building_internal_id_blocks_by_internal_id | Exclusão de bloco da base | ProfessorInternalId (string) BuildingInternalId (string) InternalId (string) |
| rm/bookloans_v1_000/get_bookloans_by_user_internal_id_pendingsbookloans | Retorna todos os empréstimos pendentes do usuário da biblioteca | UserInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/bookings_v1_000/post_bookings | Realiza a reserva na biblioteca | data (undefined) required |
| rm/branch_v1_000/get_branches | Retorna todas as Filiais da base | order (array) page (integer) pageSize (integer) EnterpriseGroup (string) |
| rm/branch_v1_000/post_branches | Inclui a Filial passada na requisição | 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_id | Retorna todas as Filiais da base | BranchInternalId (string) |
| rm/branch_v1_000/put_branches_by_branch_internal_id | Inclui a Filial passada na requisição | BranchInternalId (string) 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_id | Não é permitida a deleção da Filial por API, por motivos de segurança | BranchInternalId (string) |
| rm/brands_v1_000/get_brands | Retorna lista completa de Marcas | order (array) page (integer) pageSize (integer) fields (string) |
| rm/brands_v1_000/post_brands | Inclui uma Marca | 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_code | Retorna Marca pelo seu Código | Code (string) |
| rm/brands_v1_000/put_brands_by_code | Atualiza cadastro de Marca conforme dados enviados na requisição | Code (string) 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_code | Exclui Marca cadastrada conforme dados enviados na requisição | Code (string) |
| rm/breedcolor_v2_000/get_breedcolor | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/breedcolor_v2_000/get_breedcolor_by_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/building_v1_000/get_professors_by_professor_internal_id_buildings | Retorna todos os prédios educacionais | ProfessorInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/building_v1_000/post_professors_by_professor_internal_id_buildings | Inclui o prédio passado na requisição | ProfessorInternalId (string) data (undefined) required |
| rm/building_v1_000/get_professors_by_professor_internal_id_buildings_by_building_internal_id | Retorna o prédio educacional | ProfessorInternalId (string) BuildingInternalId (string) |
| rm/building_v1_000/put_professors_by_professor_internal_id_buildings_by_building_internal_id | Altera o prédio passado na requisição | ProfessorInternalId (string) BuildingInternalId (string) data (undefined) required |
| rm/building_v1_000/delete_professors_by_professor_internal_id_buildings_by_building_internal_id | Exclusão de prédio da base | ProfessorInternalId (string) BuildingInternalId (string) |
| rm/buyers_v1_000/get_buyers | Retorna todos os Compradores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/buyers_v1_000/post_buyers | Adiciona Comprador passado na requisição | data (object) required |
| rm/buyers_v1_000/get_buyers_by_buyer_id | Retorna o Comprador do sistema através de seu código | BuyerId (string) fields (string) |
| rm/buyers_v1_000/put_buyers_by_buyer_id | Altera o comprador passado na requisição | BuyerId (string) data (undefined) required |
| rm/buyers_v1_000/delete_buyers_by_buyer_id | Exclusão de Comprador da base | BuyerId (string) |
| rm/calculatedoccurrences_v1_000/get_calculated_occurrences_by_id | Retorna dados da ocorrência calculada | id (string) |
| rm/calculatedoccurrences_v1_000/get_calculated_occurrences | Retorna todas as ocorrências calculadas | fields (string) order (array) page (integer) pageSize (integer) |
| rm/calculatedwarnings_v1_000/get_calculated_warnings_by_id | Retorna dados do aviso calculado | id (string) |
| rm/calculatedwarnings_v1_000/get_calculated_warnings | Retorna todos os avisos calculados | fields (string) order (array) page (integer) pageSize (integer) |
| rm/calculationtables_v1_000/get_calculation_tables_by_id | Retorna dados da tabela de cálculo | id (string) |
| rm/calculationtables_v1_000/delete_calculation_tables_by_id | Exclui tabela de cálculo | id (string) |
| rm/calculationtables_v1_000/put_calculation_tables_by_id | Atualiza 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_tables | Retorna todas as tabelas de cálculo | fields (string) order (array) page (integer) pageSize (integer) |
| rm/calculationtables_v1_000/post_calculation_tables | Inclui um novo registro na tabela de tabela de cálculo | data: { . 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_events | Retorna todos os eventos educacionais do aluno | StudentInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/cancelbooking_v1_000/post_bookings_by_booking_internal_id_cancel_bookings | Cancela a reserva de exemplar passada na requisição | BookingInternalId (string) data (undefined) required |
| rm/candidates_v1_000/get_candidates_by_id | Retorna dados de tabela da Candidato especificada | id (string) |
| rm/candidates_v1_000/delete_candidates_by_id | Exclui Candidato | id (string) |
| rm/candidates_v1_000/put_candidates_by_id | Atualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_candidates | Retorna todos as Candidatos | order (array) page (integer) pageSize (integer) personsIds (string) |
| rm/candidates_v1_000/post_candidates | Inclui um novo registro na tabela de Candidatos | 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_id | Retorna dados de tabela da Candidato especificada | id (string) |
| rm/candidates_v2_000/delete_candidates_by_id | Exclui Candidato | id (string) |
| rm/candidates_v2_000/put_candidates_by_id | Atualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_candidates | Retorna todos as Candidatos | order (array) page (integer) pageSize (integer) personsIds (string) |
| rm/candidates_v2_000/post_candidates | Inclui um novo registro na tabela de Candidatos | 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_id | Retorna dados de tabela da turma especificada | id (string) |
| rm/classparticipants_v1_000/delete_class_participants_by_id | Exclui participantes da turma | id (string) |
| rm/classparticipants_v1_000/put_class_participants_by_id | Atualiza um registro existente de participantes da turma. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_participants | Retorna todos os participantes da turma | order (array) page (integer) pageSize (integer) classParticipantsIds (string) name (string) |
| rm/classparticipants_v1_000/post_class_participants | Inclui um novo registro na tabela de participantes de turma | 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_shifts | Retorna todos os turnos educacionais | ProfessorInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/classshifts_v1_000/get_professors_by_professor_internal_id_class_shifts_by_class_shift_internal_id | Retorna o turno educacional | ProfessorInternalId (string) ClassShiftInternalId (string) |
| rm/classes_v1_000/get_classes_by_id | Retorna dados de tabela da turma especificada | id (string) |
| rm/classes_v1_000/delete_classes_by_id | Exclui turma | id (string) |
| rm/classes_v1_000/put_classes_by_id | Atualiza um registro existente de tabela de turmas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_classes | Retorna todos as turmas | order (array) page (integer) pageSize (integer) classesIds (string) name (string) |
| rm/classes_v1_000/post_classes | Inclui um novo registro na tabela de turmas | 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_one | Retorna lista de Tabela de Classificação 1 | order (array) page (integer) pageSize (integer) |
| rm/classificationtable_v1_000/post_classification_table_one | Inclui um registro na Tabela de Classificação 1 | data (undefined) required |
| rm/classificationtable_v1_000/get_classification_table_one_by_internal_id | Retorna um registro da Tabela de Classificação 1 | InternalId (string) |
| rm/classificationtable_v1_000/put_classification_table_one_by_internal_id | Atualiza um registros da Tabela de Classificação 1 | InternalId (string) data (undefined) required |
| rm/classificationtable_v1_000/delete_classification_table_one_by_internal_id | Remove um Registro da Tabela de Classificação 1 | InternalId (string) |
| rm/classificationtable_v1_000/get_classification_table_two | Retorna lista de Tabela de Classificação 2 | order (array) page (integer) pageSize (integer) |
| rm/classificationtable_v1_000/post_classification_table_two | Inclui um registro na Tabela de Classificação 2 | data (undefined) required |
| rm/classificationtable_v1_000/get_classification_table_two_by_internal_id | Retorna a Tabela de Classificação 2 | InternalId (string) |
| rm/classificationtable_v1_000/put_classification_table_two_by_internal_id | Atualiza um registros da Tabela de Classificação 2 | InternalId (string) data (undefined) required |
| rm/classificationtable_v1_000/delete_classification_table_two_by_internal_id | Remove um Registro da Tabela de Classificação 2 | InternalId (string) |
| rm/classificationtable_v1_000/get_classification_table_three | Retorna lista de Tabela de Classificação 3 | order (array) page (integer) pageSize (integer) |
| rm/classificationtable_v1_000/post_classification_table_three | Inclui um registro na Tabela de Classificação 3 | data (undefined) required |
| rm/classificationtable_v1_000/get_classification_table_three_by_internal_id | Retorna um registro da Tabela de Classificação 3 | InternalId (string) |
| rm/classificationtable_v1_000/put_classification_table_three_by_internal_id | Atualiza um registros da Tabela de Classificação 3 | InternalId (string) data (undefined) required |
| rm/classificationtable_v1_000/delete_classification_table_three_by_internal_id | Remove um Registro da Tabela de Classificação 3 | InternalId (string) |
| rm/classificationtable_v1_000/get_classification_table_four | Retorna lista de Tabela de Classificação 4 | order (array) page (integer) pageSize (integer) |
| rm/classificationtable_v1_000/post_classification_table_four | Inclui um registro na Tabela de Classificação 4 | data (undefined) required |
| rm/classificationtable_v1_000/get_classification_table_four_by_internal_id | Retorna um registro da Tabela de Classificação 4 | InternalId (string) |
| rm/classificationtable_v1_000/put_classification_table_four_by_internal_id | Atualiza um registros da Tabela de Classificação 4 | InternalId (string) data (undefined) required |
| rm/classificationtable_v1_000/delete_classification_table_four_by_internal_id | Remove um Registro da Tabela de Classificação 4 | InternalId (string) |
| rm/classificationtable_v1_000/get_classification_table_five | Retorna lista de Tabela de Classificação 5 | order (array) page (integer) pageSize (integer) |
| rm/classificationtable_v1_000/post_classification_table_five | Inclui um registro na Tabela de Classificação 5 | data (undefined) required |
| rm/classificationtable_v1_000/get_classification_table_five_by_internal_id | Retorna um registro da Tabela de Classificação 5 | InternalId (string) |
| rm/classificationtable_v1_000/put_classification_table_five_by_internal_id | Atualiza um registros da Tabela de Classificação 5 | InternalId (string) data (undefined) required |
| rm/classificationtable_v1_000/delete_classification_table_five_by_internal_id | Remove um Registro da Tabela de Classificação 5 | InternalId (string) |
| rm/compensatorytimebalance_v1_000/get_compensatory_time_balance_by_id | Retorna dados do saldo de banco de horas do funcionário | id (string) |
| rm/compensatorytimebalance_v1_000/get_compensatory_time_balance | Retorna todas as informações de saldo de banco de horas dos funcionários | fields (string) order (array) page (integer) pageSize (integer) |
| rm/contractrestriction_v1_000/get_contract_restriction_exam | Retorna uma lista de restrições de contrato de exame | companyId (integer) required examId (integer) required insuranceId (integer) required planId (integer) required subPlanId (integer) unitAtendId (integer) required |
| rm/costcenter_v1_000/get_costcenters | Retorna lista completa dos Centro de Custos | order (array) page (integer) pageSize (integer) fields (string) |
| rm/costcenter_v1_000/post_costcenters | Inclui um Centro de Custo conforme dados enviados na requisição. | 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_id | Retorna um centro de custo de acordo com o ID de pesquisa | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/costcenter_v1_000/patch_costcenters_by_internal_id | Atualiza centro de custo somente com os dados enviados na requisição | InternalId (string) 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_id | Atualiza centro de custo conforme dados enviados na requisição | InternalId (string) 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_id | Exclui um Centro de Custo conforme dados enviados na requisição. | InternalId (string) |
| rm/course_v1_000/get_academics_by_academic_internal_id_courses | Retorna todos os cursos cadastrados no sistema | AcademicInternalID (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/course_v1_000/post_academics_by_academic_internal_id_courses | Inclui o Course passado na requisição | AcademicInternalID (string) data (undefined) required |
| rm/course_v1_000/get_academics_by_academic_internal_id_courses_by_internal_id | Retorna o curso | AcademicInternalID (string) InternalId (string) |
| rm/course_v1_000/put_academics_by_academic_internal_id_courses_by_internal_id | Altera o curso passado na requisição | AcademicInternalID (string) InternalId (string) data (undefined) required |
| rm/course_v1_000/delete_academics_by_academic_internal_id_courses_by_internal_id | Exclusão de curso da base | AcademicInternalID (string) InternalId (string) |
| rm/curriculumgrid_v1_000/get_academics_by_academic_internal_id_curriculum_grids | Retorna todas as matrizes curriculares educacionais | AcademicInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/curriculumgrid_v1_000/post_academics_by_academic_internal_id_curriculum_grids | Inclui a matriz curricular passada na requisição | AcademicInternalId (string) data (undefined) required |
| rm/curriculumgrid_v1_000/get_academics_by_academic_internal_id_curriculum_grids_by_internal_id | Retorna a matriz curricular do educacional | AcademicInternalId (string) InternalId (string) |
| rm/curriculumgrid_v1_000/put_academics_by_academic_internal_id_curriculum_grids_by_internal_id | Altera a matriz curricular passada na requisição | AcademicInternalId (string) InternalId (string) data (undefined) required |
| rm/curriculumgrid_v1_000/delete_academics_by_academic_internal_id_curriculum_grids_by_internal_id | Exclusão da matriz curricular da base | AcademicInternalId (string) InternalId (string) |
| rm/customervendor_v1_000/get_customer_vendor | Retorna todos clientes e/ou fornecedores | fields (string) order (array) page (integer) pageSize (integer) |
| rm/customervendor_v1_000/post_customer_vendor | Inclui a entidade Cliente/Fornecedor passada na requisição | 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_type | Retorna todos os registros de uma entidade específica - Customer ou Vendor | entityType (array) fields (string) order (array) page (integer) pageSize (integer) |
| rm/customervendor_v1_000/get_customer_vendor_by_entity_type_by_customer_vendor_id | Retorna Cliente ou Fornecedor com base no código da entidade | customerVendorId (string) entityType (array) fields (string) |
| rm/customervendor_v1_000/put_customer_vendor_by_entity_type_by_customer_vendor_id | Atualiza a entidade Cliente/Fornecedor informada na requisição | customerVendorId (string) entityType (array) 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/delete_customer_vendor_by_entity_type_by_customer_vendor_id | Exclui a entidade Cliente/Fornecedor passada na requisição | customerVendorId (string) entityType (array) |
| rm/departamentapi_v1_000/get_department | Retorna todos os departamentos | filter (string) fields (string) order (array) page (integer) pageSize (integer) |
| rm/discriminatedhistograms_v1_000/get_grouped_histograms | Retorna o histograma discriminado de um pedido de material um projeto. | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required requestId (integer) required |
| rm/educationalreports_v1_000/get_educational_reports | Retorna todos os relatórios educacionais | order (array) page (integer) pageSize (integer) |
| rm/employeeassociatedvalue_v1_000/get_employeeassociatedvalues | Retorna todos os registros de Valores Associados cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/employeeassociatedvalue_v1_000/post_employeeassociatedvalues | Inclui o Valor Associado passado na requisição | data: { . companyId (integer) . employeeId (string) . code (string) . date (string) . value (number) . note (string) } (object) required |
| rm/employeeassociatedvalue_v1_000/get_employeeassociatedvalues_by_id | Retorna o Valor Associado correspondente ao id | id (string) |
| rm/employeeassociatedvalue_v1_000/put_employeeassociatedvalues_by_id | Inclui/Edita o Valor Associado passado na requisição | id (string) data: { . companyId (integer) . employeeId (string) . code (string) . date (string) . value (number) . note (string) } (object) required |
| rm/employeeassociatedvalue_v1_000/delete_employeeassociatedvalues_by_id | Deleta o Valor Associado correspondente ao id | id (string) |
| rm/employeedatacontent_v1_000/get_employee_data_content | Retorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required |
| rm/employeehistorydependents_v1_000/get_employeehistorydependents | Retorna os históricos de dependentes dos funcionários cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/employeehistorydependents_v1_000/post_employeehistorydependents | Inclui o Histórico de Dependentes do Funcionário passado na requisição | data (undefined) required |
| rm/employeehistorydependents_v1_000/get_employeehistorydependents_by_id | Retorna o histórico de dependentes indicado para o funcionário | id (string) |
| rm/employeehistorydependents_v1_000/put_employeehistorydependents_by_id | Inclui/Edita o Histórico de Dependentes do Funcionário passado na requisição | id (string) data (undefined) required |
| rm/employeehistorydependents_v1_000/delete_employeehistorydependents_by_id | Deleta o Histórico de Dependentes do Funcionário correspondente ao id | id (string) |
| rm/employeehistoryrole_v1_000/get_employeehistoryroles | Retorna todos os registros de Histórico de Função de Funcionário cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/employeehistoryrole_v1_000/post_employeehistoryroles | Inclui o Histórico de Função de Funcionário passado na requisição | data (undefined) required |
| rm/employeehistoryrole_v1_000/get_employeehistoryroles_by_id | Retorna o Histórico de Função de Funcionário correspondente ao id | id (string) |
| rm/employeehistoryrole_v1_000/put_employeehistoryroles_by_id | Inclui/Edita o Histórico de Função de Funcionário passado na requisição | id (string) data (undefined) required |
| rm/employeehistoryrole_v1_000/delete_employeehistoryroles_by_id | Deleta o Histórico de Função de Funcionário correspondente ao id | id (string) |
| rm/employeehistorysection_v1_000/get_employee_history_section | Retorna os históricos de seção dos funcionários cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/employeehistorysection_v1_000/post_employee_history_section | Inclui um novo histórico de seção para o funcionário | fields (string) data (undefined) required |
| rm/employeehistorysection_v1_000/get_employee_history_section_by_id | Retorna o histórico de seção indicado para o funcionário | id (string) |
| rm/employeehistorysection_v1_000/delete_employee_history_section_by_id | Exclui histórico de seção do funcionário | id (string) |
| rm/employeehistorysection_v1_000/put_employee_history_section_by_id | Atualiza 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) data (undefined) required |
| rm/employeehistorystatus_v1_000/get_employeehistorystatus | Retorna os históricos de situação dos funcionários cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) employeeStatusIds (string) |
| rm/employeehistorystatus_v1_000/get_employeehistorystatus_by_id | Retorna o histórico de situação indicado para o funcionário | id (string) |
| rm/employeehistoryunioncontribution_v1_000/get_employeehistoryunioncontribution | Retorna os históricos de Contribuição Sindical dos funcionários cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) employeeUnionContributionIds (string) |
| rm/employeehistoryunioncontribution_v1_000/get_employeehistoryunioncontribution_by_id | Retorna o histórico de Contribuição Sindical indicado para o funcionário | id (string) |
| rm/employeepayrollinfo_v1_000/post_employee_payroll_info | Consulta funcionário para avaliação de concessão de empréstimo consignado | 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_id | Retorna dados da utilização de ponto dos funcionários | id (string) |
| rm/employeeusestimecard_v1_000/get_employee_uses_time_card | Retorna todos os funcionários e o status de utilização de ponto | fields (string) order (array) page (integer) pageSize (integer) |
| rm/esocialaudit_v1_000/post_esocial_audit | Inclui a entidade evento passado na requisição | companyId (string) required order (array) page (integer) pageSize (integer) data (object) required |
| rm/esocialaudit_v1_000/get_esocial_audit_status | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| rm/esocialaudit_v1_000/get_esocial_audit_audit_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required status (string) page (integer) pageSize (integer) |
| rm/esocialaudit_v1_000/get_esocial_audit_chart_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| rm/esocialbranches_v1_000/get_esocial_branches | Retorna o código da empresa e código da filial no TAF | companyId (string) required order (array) page (integer) pageSize (integer) |
| rm/esocialestablishment_v1_000/get_esocial_establishment | Retorna lista completa com os Estabelecimentos Cadastrados | companyId (string) required order (array) page (integer) pageSize (integer) |
| rm/esocialevents_v1_000/get_esocial_events | Retorna a lista de eventos do TAF | companyId (string) required eventsCheckPermissions (string) |
| rm/examappointment_v1_000/get_appointments_exams_exam | Retorna lista de horários disponiveis para agendamento do exame | companyId (integer) required ExamId (integer) required SearchEndDate (string) ResultPage (integer) PageSize (integer) |
| rm/examappointment_v1_000/get_appointments_exams_prep_by_tipo_exam | Retorna o preparo do exame | tipo (string) order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required ExamId (integer) required |
| rm/examappointment_v1_000/get_appointments_exams_unid | Retorna o Endereço de Unidade de Atendimento | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required CareUnitId (integer) required |
| rm/examappointment_v1_000/post_appointments_exams_appointment | Insere um registro de Agendamento para o exame informado | 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_appointment | Atualiza um agendamento de exame | 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_appointment | Exclui um agendamento de exame | companyId (integer) required AppointmentId (integer) required ExamId (integer) required |
| rm/examresult_v1_000/get_exams_results_patient_request | Lista de Resultados de Exames do Paciente Laboratorial e Imagem | companyId (integer) required patientId (integer) required serviceOrder (integer) required examDescription (string) |
| rm/examresult_v1_000/get_exams_results_patient_report | Retorna o Laudo dos Resultados de Exames do Paciente Arquivo PDF | companyId (integer) required patientId (integer) required serviceOrder (integer) required examDesexamIdcription (integer) sequential (integer) group (string) |
| rm/examresult_v1_000/get_exams_results_patient_historic | Retorna uma lista com o historico de resultados de um determinado exame | patientId (integer) required examDesexamIdcription (integer) |
| rm/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process | Carrega registros do evento S-5503, filtrados ou não, ordenados ou não. | No parameters |
| rm/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_process | Exclui 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_xml | Retorna XML's do evento S-5503 encodados em base64 | data: { . companyId (string) . id (array) } (object) required |
| rm/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_category | Carrega 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_amounts | Carrega 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ão | No parameters |
| rm/financialagreements_v1_000/get_financial_agreements | Retorna todos os lançamentos passíveis de acordo financeiro | order (array) page (integer) pageSize (integer) |
| rm/financialbudgetarynatures_v1_000/get_financial_budgetary_natures | Retorna lista completa de Naturezas Orçamentárias/Financeiras | order (array) page (integer) pageSize (integer) fields (string) |
| rm/financialbudgetarynatures_v1_000/post_financial_budgetary_natures | Inclui uma Natureza Orçamentária/Financeira | data (undefined) required |
| rm/financialbudgetarynatures_v1_000/get_financial_budgetary_natures_by_code | Retorna uma Natureza Orçamentária/Financeira a partir de seu Código | Code (string) |
| rm/financialbudgetarynatures_v1_000/put_financial_budgetary_natures_by_code | Atualiza cadastro de Natureza Orçamentária/Financeira conforme dados enviados na requisição | Code (string) data (undefined) required |
| rm/financialbudgetarynatures_v1_000/delete_financial_budgetary_natures_by_code | Exclui Natureza Orçamentária/Financeira conforme dados enviados na requisição | Code (string) |
| rm/financialpaymentlink_v1_000/post_paymenthub_by_payment_internal_id_link | Realiza solicitação de pagamento do TOTVS Pagamento Digital | PaymentInternalId (string) Content-Type (string) required data: { . amount (number) . bankBilletList (array) } (object) required |
| rm/financialpaymentlink_v1_000/get_paymenthub_by_payment_internal_id_link_by_transaction_internal_id | Retorna os dados da transação do TOTVS Pagamento Digital | PaymentInternalId (string) TransactionInternalId (string) |
| rm/financialrefund_v1_000/post_paymenthub_refund | Realiza solicitação de reembolso de uma transação com TOTVS Pagamento Digital | Content-Type (string) required data: { . transactionCode (int) . amount (number) } (object) required |
| rm/gpeesocialmotives_v1_000/get_esocial_motives | Retorna lista completa com os motivos de afastamento | companyId (string) required order (array) page (integer) pageSize (integer) |
| rm/griddiscipline_v1_000/get_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines | Retorna todas as disciplinas de um período de uma grade | AcademicInternalId (string) PeriodInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/griddiscipline_v1_000/post_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines | Inclui uma disciplina em uma grade passado na requisição | AcademicInternalId (string) PeriodInternalId (string) data (undefined) required |
| rm/griddiscipline_v1_000/get_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_id | Retorna a matriz aplicada | AcademicInternalId (string) PeriodInternalId (string) InternalId (string) |
| rm/griddiscipline_v1_000/put_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_id | Altera o período passado na requisição | AcademicInternalId (string) PeriodInternalId (string) InternalId (string) data (undefined) required |
| rm/griddiscipline_v1_000/delete_academics_by_academic_internal_id_periods_by_period_internal_id_griddisciplines_by_internal_id | Exclusão de disciplina de uma matriz aplicada da base | AcademicInternalId (string) PeriodInternalId (string) InternalId (string) |
| rm/groupedhistogramsgroupingperiods_v1_000/post_grouped_histograms_by_internal_id_grouping_periods | Agrupa períodos no histograma agrupado de um pedido de material | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) . inputIdList (array) . destinationDate (string) . dateOriginPeriodList (array) } (object) required |
| rm/groupedhistograms_v1_000/get_grouped_histograms | Retorna o histograma agrupado de um pedido de material um projeto. | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required requestId (integer) required |
| rm/hazardmeasurement_v1_000/get_hazardmeasurement_by_id | Retorna dados de tabela da medição de risco especificada | id (string) |
| rm/hazardmeasurement_v1_000/delete_hazardmeasurement_by_id | Exclui uma medição de risco | id (string) |
| rm/hazardmeasurement_v1_000/put_hazardmeasurement_by_id | Atualiza 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) data (object) required |
| rm/hazardmeasurement_v1_000/get_hazardmeasurement | Retorna todas as medições de risco | order (array) page (integer) pageSize (integer) Ids (string) |
| rm/hazardmeasurement_v1_000/post_hazardmeasurement | Inclui um novo registro na tabela de medições de risco | 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_id | Retorna dados da ausência planejada ignorada | id (string) |
| rm/ignoredplannedabsences_v1_000/delete_ignored_planned_absences_by_id | Exclui registro de ausência planejada ignorada | id (string) |
| rm/ignoredplannedabsences_v1_000/put_ignored_planned_absences_by_id | Atualiza 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_absences | Retorna todas as ausências planejadas ignoradas | fields (string) order (array) page (integer) pageSize (integer) |
| rm/ignoredplannedabsences_v1_000/post_ignored_planned_absences | Inclui um novo registro na tabela de ausência planejada ignorada | data: { . CompanyCode (integer) . EmployeeId (string) . Date (datetime) . Ignore (integer) . FinishDate (datetime) . id (string) } (object) required |
| rm/imageexamresult_v1_000/get_image_exams_results_patient | Retorna uma lista Exames / Resultados de Imagem do Paciente | companyId (integer) required PatientId (integer) required ResultPage (integer) PageSize (integer) |
| rm/indigenousethnicity_v2_000/get_indigenousethnicity | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/indigenousethnicity_v2_000/get_indigenousethnicity_by_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/inscriptionfiles_v1_000/get_applicant_registry_by_inscricao_id_inscription_files | Retorna todos os arquivos enviados pelo candidato | InscricaoId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/inscriptionfiles_v1_000/post_applicant_registry_by_inscricao_id_inscription_files | Insere um novo arquivo do candidato | InscricaoId (string) InscriptionFilesId (string) Accept-Language (string) data (object) required |
| rm/inscriptionfiles_v1_000/get_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_id | Retorna os dados de somente um arquivo enviado do candidato | InscricaoId (string) InscriptionFilesId (string) fields (string) |
| rm/inscriptionfiles_v1_000/put_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_id | Altera o registro passado na requisição | InscricaoId (string) InscriptionFilesId (string) data (object) required |
| rm/inscriptionfiles_v1_000/delete_applicant_registry_by_inscricao_id_inscription_files_by_inscription_files_id | Deleta um arquivo do candidato | InscricaoId (string) InscriptionFilesId (string) Accept-Language (string) |
| rm/insurancecompany_v1_000/get_insurance_companies | Recupera uma lista com todos os Convênios | order (array) page (integer) pageSize (integer) fields (string) |
| rm/insuranceplan_v1_000/get_insurance_plans_by_code | Retorna os dados de uma Agenda | code (string) |
| rm/insuranceplan_v1_000/get_insurance_plans | Recupera uma lista de Planos. | order (array) page (integer) pageSize (integer) fields (string) |
| rm/intermittentworkconvocation_v1_000/get_intermittentworkconvocations | Retorna todos os registros de Convocação de Funcionário para Trabalho Intermitente cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) expand (string) |
| rm/intermittentworkconvocation_v1_000/post_intermittentworkconvocations | Inclui a Convocação de Funcionário para Trabalho Intermitente passada na requisição | 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_id | Retorna a Convocação de Funcionário para Trabalho Intermitente correspondente ao id | id (string) |
| rm/intermittentworkconvocation_v1_000/put_intermittentworkconvocations_by_id | Inclui/Edita a Convocação de Funcionário para Trabalho Intermitente passada na requisição | id (string) data (object) required |
| rm/intermittentworkconvocation_v1_000/delete_intermittentworkconvocations_by_id | Deleta a Convocação de Funcionário para Trabalho Intermitente correspondente ao id | id (string) |
| rm/inventorycounts_v1_000/get_inventory_counts | Retorna uma ou mais de fichas de inventário conforme parâmetros recebidos | companyCode (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_counts | Geraçã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 PUT | data: { . 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_id | Retorna uma ficha de inventário correspondente ao número informado | internalId (string) fields (string) |
| rm/inventorycounts_v1_000/put_inventory_counts_by_internal_id | Mé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 POST | internalId (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_id | Elimina a ficha de inventário pelo número e data de saldo | internalId (string) |
| rm/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_counts | Método responsável pela eliminação das contagens. Contagens voltam ao estado inicial | internalId (string) |
| rm/jobopportunityprofiles_v1_000/get_jobopportunityprofiles_by_id | Retorna dados de tabela do perfil de vaga especificado | id (string) |
| rm/jobopportunityprofiles_v1_000/delete_jobopportunityprofiles_by_id | Exclui um perfil de vaga | id (string) |
| rm/jobopportunityprofiles_v1_000/put_jobopportunityprofiles_by_id | Atualiza um registro existente de tabela de pessoas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_persons | Retorna todos os perfís de vaga | order (array) page (integer) pageSize (integer) Ids (string) name (string) |
| rm/jobopportunityprofiles_v1_000/post_persons | Inclui um novo registro na tabela de perfil de vaga | 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_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| rm/jobscheduler_v1_001/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| rm/jobscheduler_v1_001/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| rm/jobscheduler_v1_001/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| rm/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| rm/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| rm/jobscheduler_v1_100/get_job_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| rm/jobscheduler_v1_100/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| rm/jobscheduler_v1_100/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| rm/jobscheduler_v1_100/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| rm/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| rm/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| rm/laboratoryexamitems_v1_000/get_laboratory_exam_items | Recupera uma lista de exames integrados | order (array) page (integer) pageSize (integer) fields (string) |
| rm/laboratoryexamresult_v1_000/get_laboratory_exams_results | Recupera uma lista com todos os Cadastros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/laboratoryexamresult_v1_000/post_laboratory_exams_results | Insere um Resultado de Exame | 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_patient | Retorna uma lista Exames / Resultados Laboratoriais do Paciente | companyId (integer) required PatientId (integer) required ResultPage (integer) PageSize (integer) |
| rm/lessonplan_v1_000/get_students_by_student_internal_id_lesson_plans | Retorna todos os planos aula | StudentInternalId (string) order (array) page (integer) pageSize (integer) |
| rm/lessonplan_v1_000/get_students_by_student_internal_id_lesson_plans_by_internal_id | Retorna todos os planos de aula da base | StudentInternalId (string) InternalId (string) |
| rm/major_v1_000/get_academics_by_academic_internal_id_majors | Retorna todas as habilitações educacionais | AcademicInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/major_v1_000/post_academics_by_academic_internal_id_majors | Inclui a habilitação passado na requisição | AcademicInternalId (string) data (undefined) required |
| rm/major_v1_000/get_academics_by_academic_internal_id_majors_by_internal_id | Retorna a habilitação do educacional | AcademicInternalId (string) InternalId (string) |
| rm/major_v1_000/put_academics_by_academic_internal_id_majors_by_internal_id | Altera a habilitação passado na requisição | AcademicInternalId (string) InternalId (string) data (undefined) required |
| rm/major_v1_000/delete_academics_by_academic_internal_id_majors_by_internal_id | Exclusão da habilitação da base | AcademicInternalId (string) InternalId (string) |
| rm/mandatorytimes_v1_000/get_mandatory_times_by_id | Retorna dados do horário obrigatório | id (string) |
| rm/mandatorytimes_v1_000/delete_mandatory_times_by_id | Exclui registro de horário obrigatório | id (string) |
| rm/mandatorytimes_v1_000/put_mandatory_times_by_id | Atualiza 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_times | Retorna todas os horários obrigatórios | fields (string) order (array) page (integer) pageSize (integer) |
| rm/mandatorytimes_v1_000/post_mandatory_times | Inclui um novo registro na tabela de horário obrigatório | data: { . 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_id | Retorna dados de tabela da consulta especificada | id (string) |
| rm/medicalconsultations_v1_000/delete_medicalconsultations_by_id | Exclui uma consulta médica | id (string) |
| rm/medicalconsultations_v1_000/put_medicalconsultations_by_id | Atualiza 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) 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_medicalconsultations | Retorna todos as consultas | order (array) page (integer) pageSize (integer) Ids (string) |
| rm/medicalconsultations_v1_000/post_medicalconsultations | Inclui um novo registro na tabela de consultas | 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_code | Retorna dados de tabela de especialidades medicas | code (integer) |
| rm/medicalspecialty_v1_000/delete_medical_specialties_by_code | Exclui tabela de especialidades medicas | code (integer) |
| rm/medicalspecialty_v1_000/put_medical_specialties_by_code | Atualiza um registro existente de tabela de especialidades medicas | code (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_specialties | Busca dados de tabela de especialidades medicas existentes | order (array) codeFinal (integer) description (string) page (integer) pageSize (integer) fields (string) |
| rm/medicalspecialty_v1_000/post_medical_specialties | Inclui um novo registro de tabela de especialidades medicas | data: { . code (integer) . description (string) . complementaryDescription (string) . medicalBoardCode (integer) . nationalAgencySpeciality (string) . note (string) . updateDate (string) . updateUser (string) } (object) required |
| rm/movementsseller_v1_000/get_seller | Retorna lista completa dos Vendedores. | order (array) page (integer) pageSize (integer) fields (string) |
| rm/movementsseller_v1_000/post_seller | Método não implementado. | data (undefined) required |
| rm/movementsseller_v1_000/get_seller_by_internal_id | Retorna o Vendedor pelo InternalId. | InternalId (string) fields (string) |
| rm/movementsseller_v1_000/put_seller_by_internal_id | Método não implementado. | InternalId (string) fields (string) data (undefined) required |
| rm/movementsseller_v1_000/delete_seller_by_internal_id | Método não implementado. | InternalId (string) |
| rm/movements_v1_000/get_movements | Retorna uma lista de movimentos com base no filtro enviado junto a requisição | order (array) page (integer) pageSize (integer) fields (string) |
| rm/movements_v1_000/post_movements | Inclui o movimento conforme dados enviados na requisição | data (undefined) required |
| rm/movements_v1_000/get_movements_by_internal_id | Retorna o movimento que possui o código da colgiada e identificador informados no InternalId | InternalId (string) |
| rm/movements_v1_000/put_movements_by_internal_id | Atualiza o movimento que possui o código da colgiada e identificador informados no InternalId conforme dados enviados na requisição | InternalId (string) data (undefined) required |
| rm/movements_v1_000/delete_movements_by_internal_id | Exclui o movimento que possui o código da colgiada e identificador informados no InternalId | InternalId (string) |
| rm/movements_v1_000/post_movements_cancel_by_internal_id | Cancela o movimento que possui o código da colgiada e identificador informados no InternalId | InternalId (string) |
| rm/offeredactivities_v1_000/post_offeredactivities_by_offered_activity_internal_id_inscription | Realiza a inscrição em atividade ofertada | OfferedActivityInternalId (string) data (undefined) required |
| rm/ppebatch_v1_000/get_ppebatchs | Retorna todos os Lotes de EPIs cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/ppebatch_v1_000/post_ppebatchs | Inclui o Lote de EPI passado na requisição | 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/ppebatch_v1_000/get_ppebatchs_by_id | Retorna o Lote de EPIs indicado e uma lista dos itens do Lote. | id (string) |
| rm/ppebatch_v1_000/put_ppebatchs_by_id | Altera o Lote de EPIs passado na requisição | id (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_ppes | Retorna todos os EPIs cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/ppe_v1_000/post_ppes | Inclui EPI passado na requisição | 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/ppe_v1_000/get_ppes_by_id | Retorna o EPI indicado | id (string) |
| rm/ppe_v1_000/put_ppes_by_id | Altera o EPI passado na requisição | id (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_code | Retorna os dados de um paciente | code (string) |
| rm/patient_v1_000/get_patients | Recupera uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/patient_v1_000/post_patients | Insere um registro | 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_patients | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/patient_v2_000/post_patients | Insere um registro | 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_id | Recupera um registro | code (string) id (string) expand (string) fields (string) |
| rm/patient_v2_000/put_patients_by_id | Atualiza um registro | code (string) id (string) 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_depreciation | Retorna uma lista de registros de patrimônios e detalhes de sua depreciação | order (array) page (integer) pageSize (integer) fields (string) |
| rm/patrimonydepreciation_v1_000/get_patrimony_depreciation_by_id | Recupera um item de depreciação patrimonial | id (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/paymentcondition_v1_0000/get_paymentcondition | Retorna lista completa das condições de pagamento | order (array) page (integer) pageSize (integer) fields (string) |
| rm/paymentcondition_v1_0000/post_paymentcondition | Inclui uma condição de pagamento conforme dados enviados na requisição. | 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_id | Retorna a condição de pagamento pelo InternalId | InternalId (string) fields (string) |
| rm/paymentcondition_v1_0000/put_paymentcondition_by_internal_id | Atualiza a condição de pagamento conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a condição de pagamento conforme dados enviados na requisição. | InternalId (string) |
| rm/paymentplanssimulations_v1_000/post_students_by_student_internal_id_paymentplans_by_payment_plan_internal_id_simulations | Executa 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) data (undefined) required |
| rm/payrollcontrol_v1_000/get_payroll_control | Retorna os dados da folha de pagamento de benefíciosAssitência Médica e Odontológica | 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_id | Retorna dados da avaliação de desempenho | id (string) |
| rm/performanceevaluations_v1_000/delete_performance_evaluations_by_id | Exclui avaliação de desempenho | id (string) |
| rm/performanceevaluations_v1_000/put_performance_evaluations_by_id | Atualiza uma avaliação de desempenho. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_evaluations | Retorna todos as avaliações de desempenho | order (array) page (integer) pageSize (integer) performanceEvaluationsIds (string) name (string) |
| rm/performanceevaluations_v1_000/post_performance_evaluations | Inclui um novo registro na tabela de avaliação de desempenho | 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_periods | Retorna todos os períodos de uma matriz curricular | GradeInternalID (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/period_v1_000/post_academics_by_grade_internal_id_periods | Inclui o período passado na requisição | GradeInternalID (string) data (undefined) required |
| rm/period_v1_000/get_academics_by_grade_internal_id_periods_by_internal_id | Retorna o período | GradeInternalID (string) InternalId (string) |
| rm/period_v1_000/put_academics_by_grade_internal_id_periods_by_internal_id | Altera o período passado na requisição | GradeInternalID (string) InternalId (string) data (undefined) required |
| rm/period_v1_000/delete_academics_by_grade_internal_id_periods_by_internal_id | Exclusão de período da base | GradeInternalID (string) InternalId (string) |
| rm/persons_v1_000/get_persons_by_id | Retorna dados de tabela da pessoa especificada | id (string) |
| rm/persons_v1_000/delete_persons_by_id | Exclui pessoa | id (string) |
| rm/persons_v1_000/put_persons_by_id | Atualiza um registro existente de tabela de pessoas. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_persons | Retorna todos as pessoas | order (array) page (integer) pageSize (integer) personsIds (string) name (string) |
| rm/persons_v1_000/post_persons | Inclui um novo registro na tabela de pessoas | 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_duty | Retorna todos os Especialistas em Plantão | order (array) page (integer) pageSize (integer) fields (string) |
| rm/practitioner_v1_000/get_practitioners_by_code | Retorna todos as Atividades da Agenda | code (string) |
| rm/practitioner_v1_000/get_practitioners | Recupera uma lista com todos os Cadastros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/products_v2_000/get_products | O retorno desta API possui informações do produto/serviços incluindo os grupos o qual o produto/serviços faz parte se houver. | order (array) page (integer) pageSize (integer) fields (string) |
| rm/products_v2_000/post_products | Inclui um novo Produto/Serviço | data (undefined) required |
| rm/products_v2_000/get_products_by_internal_id | Retorna um Produto/Serviço a partir de sua chave | InternalId (string) |
| rm/products_v2_000/put_products_by_internal_id | Atualiza o cadastro de um Produto/Serviço conforme dados enviados no corpo da requisição | InternalId (string) data (undefined) required |
| rm/products_v2_000/delete_products_by_internal_id | Exclui um Produto/Serviço conforme dados enviados no corpo da requisição | InternalId (string) |
| rm/professorcontext_v1_000/get_professor_contexts | Retorna todos os contextos do professor do Educacional | order (array) page (integer) pageSize (integer) |
| rm/professordisciplineclass_v1_000/get_professors_by_professor_internal_id_disciplineclasses | Retorna todas as turmas/disciplina do professor do Educacional | ProfessorInternalId (string) InternalId (string) order (array) page (integer) pageSize (integer) |
| rm/professorwarning_v1_000/get_professors_by_professor_internal_id_studentwarnings | Retorna todas as ocorrências do aluno, cadastrados pelo professor do Educacional | ProfessorInternalId (string) order (array) page (integer) pageSize (integer) |
| rm/professorwarning_v1_000/post_professors_by_professor_internal_id_studentwarnings | Inclui a ocorrência passada na requisição | ProfessorInternalId (string) |
| rm/professorwarning_v1_000/get_professors_by_professor_internal_id_studentwarning_by_internal_id | Retorna a ocorrência do aluno do educacional | ProfessorInternalId (string) InternalId (string) |
| rm/professorwarning_v1_000/put_professors_by_professor_internal_id_studentwarning_by_internal_id | Altera a ocorrência do aluno, feita pelo professor do educacional | ProfessorInternalId (string) InternalId (string) |
| rm/professorwarning_v1_000/delete_professors_by_professor_internal_id_studentwarning_by_internal_id | Exclusão da ocorrência passada na requisição | ProfessorInternalId (string) InternalId (string) |
| rm/projectapproverequest_v1_000/post_project_material_requests_extra_by_internal_id_approve_request | Aprovar um pedido de material extra | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) } (object) required |
| rm/projectcancelsupplies_v1_000/post_cancel_supplies | Cancela um movimento para um pedido de material | data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) . uniqueMov (boolean) . isMaterialRequestExtra (boolean) } (object) required |
| rm/projectcostgroups_v1_000/get_cost_groups | Retorna uma lista de grupos de custo do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectcostgroups_v1_000/post_cost_groups | Insere um novo Grupo de Custo | 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_id | Recupera um Grupo de Custo | id (string) expand (string) fields (string) |
| rm/projectcostgroups_v1_000/put_cost_groups_by_id | Atualiza um Grupo de Custo | id (string) 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_id | Exclui um Grupo de Custo | id (string) |
| rm/projectdisapproverequest_v1_000/post_project_material_requests_extra_by_internal_id_disapprove_request | Reprovar um pedido de material extra | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) } (object) required |
| rm/projectfinalizeapprovalrequest_v1_000/post_project_material_requests_extra_by_internal_id_finalize_approval | Finalizar aprovação de um pedido de material extra | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) } (object) required |
| rm/projectgeneratematerialrequest_v1_000/post_project_material_requests_by_internal_id_generate | Gera um novo pedido de material | internalId (string) 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_date | Gerar um movimento por data para um pedido de material | data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) . uniqueMov (boolean) . isMaterialRequestExtra (boolean) } (object) required |
| rm/projectgenerationsupplies_v1_000/post_generation_supplies | Gerar um movimento único para um pedido de material | data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) . uniqueMov (boolean) . isMaterialRequestExtra (boolean) } (object) required |
| rm/projectinputs_v1_000/get_inputs | Retorna uma lista de insumos do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectinputs_v1_000/post_inputs | Insere um novo insumo | 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_id | Recupera um insumo | id (string) expand (string) fields (string) |
| rm/projectinputs_v1_000/put_inputs_by_id | Atualiza um insumo | id (string) 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_id | Exclui um insumos | id (string) |
| rm/projectitemrequestcontractapportionment_v1_000/post_project_items_material_requests_by_internal_id_update_quantity | Rateia o contrato dos itens de um pedido de material | internalId (string) 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_quantity | Altera a quantidade dos itens de um pedido de material | internalId (string) 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_extra | Retorna uma lista de itens pedidos de materiais extra por projeto | 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_extra | Insere um novo item no pedido de material extra | 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_id | Recupera um item do pedido de material extra | id (string) expand (string) fields (string) |
| rm/projectitemsmaterialrequestsextra_v1_000/put_project_items_material_requests_extra_by_id | Atualiza um item do pedido de material extra | id (string) 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_id | Exclui um item do pedido de material extra | id (string) |
| rm/projectitemsmaterialrequests_v1_000/get_project_items_material_requests | Retorna uma lista dos itens de pedidos de materiais de um projeto | 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_id | Recupera um item de um pedido de material | id (string) expand (string) fields (string) |
| rm/projectitemsmaterialrequests_v1_000/put_project_items_material_requests_by_id | Atualiza um item de um pedido de material | id (string) 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_prices | Importa preços cotados de um pedido de material | internalId (string) 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_extra | Retorna uma lista de pedidos de materiais extra por projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectmaterialrequestsextra_v1_000/post_project_material_requests_extra | Insere um novo pedido de material extra | 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_id | Recupera um pedido de material extra | id (string) expand (string) fields (string) |
| rm/projectmaterialrequestsextra_v1_000/put_project_material_requests_extra_by_id | Atualiza um pedido de material extra | id (string) 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_id | Exclui um pedido de material extra | id (string) |
| rm/projectmaterialrequests_v1_000/get_project_material_requests | Retorna uma lista de pedidos de materiais de um projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectmaterialrequests_v1_000/get_project_material_requests_by_id | Recupera um pedido de material | id (string) expand (string) fields (string) |
| rm/projectmaterialrequests_v1_000/put_project_material_requests_by_id | Atualiza um pedido de material | id (string) 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_id | Exclui um pedido de material | id (string) |
| rm/projectmobilecollectorusers_v1_000/get_project_mobile_collector_users | Retorna uma lista de usuários de coletores móveis para projetos do projeto | order (array) page (integer) pageSize (integer) fields (string) |
| rm/projectmobilecollectorusers_v1_000/post_project_mobile_collector_users | Insere um novo usuários de coletores móveis para projetos | 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_id | Recupera um usuário de coletores móveis para projetos | id (string) expand (string) fields (string) |
| rm/projectmobilecollectorusers_v1_000/put_project_mobile_collector_users_by_id | Atualiza um coletores móvel para projetos | id (string) 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_id | Exclui usuário de coletores móveis para projetos | id (string) |
| rm/projectmobilecollectors_v1_000/get_project_mobile_collectors | Retorna uma lista de coletores móveis para projetos do projeto | order (array) page (integer) pageSize (integer) fields (string) |
| rm/projectmobilecollectors_v1_000/post_project_mobile_collectors | Insere um novo coletores móveis para projetos | 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_id | Recupera um coletor móvel para projetos | id (string) expand (string) fields (string) |
| rm/projectmobilecollectors_v1_000/put_project_mobile_collectors_by_id | Atualiza um coletores móvel para projetos | id (string) 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_teams | Retorna uma lista de equipes de projeto de mobilidade do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectmobilityteams_v1_000/post_mobility_project_teams | Insere uma nova Equipes de projeto de mobilidade | 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_id | Recupera uma Equipes de projeto de mobilidade | id (string) expand (string) fields (string) |
| rm/projectmobilityteams_v1_000/put_mobility_project_teams_by_id | Atualiza uma Equipes de projeto de mobilidade | id (string) 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_id | Exclui uma Equipes de projeto de mobilidade | id (string) |
| rm/projectreasonsmaterialrequestextra_v1_000/get_project_material_requests_extra | Retorna uma lista de motivos de solicitação de pedidos de materiais extra por projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectreasonsmaterialrequestextra_v1_000/post_project_material_requests_extra | Insere um novo motivo de solicitação de pedido de material extra | data: { . id (string) . companyId (integer) . projectId (integer) . reasonId (integer) . reasonDescription (string) } (object) required |
| rm/projectreasonsmaterialrequestextra_v1_000/get_project_material_requests_extra_by_id | Recupera um motivo de solicitação de pedido de material extra | id (string) expand (string) fields (string) |
| rm/projectreasonsmaterialrequestextra_v1_000/put_project_material_requests_extra_by_id | Atualiza um motivo de solicitação de pedido de material extra | id (string) data: { . id (string) . companyId (integer) . projectId (integer) . reasonId (integer) . reasonDescription (string) } (object) required |
| rm/projectreasonsmaterialrequestextra_v1_000/delete_project_material_requests_extra_by_id | Exclui um motivo de solicitação de pedido de material extra | id (string) |
| rm/projectreturncreaterequest_v1_000/post_project_material_requests_extra_by_internal_id_return_create | Retornar para criação um pedido de material extra | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) } (object) required |
| rm/projectriskteams_v1_000/get_risk_project_teams | Retorna uma lista de equipes de projeto de risco do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectriskteams_v1_000/post_risk_project_teams | Insere uma nova Equipes de projeto de risco | 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_id | Recupera uma Equipes de projeto de risco | id (string) expand (string) fields (string) |
| rm/projectriskteams_v1_000/put_risk_project_teams_by_id | Atualiza uma Equipes de projeto de risco | id (string) 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_id | Exclui uma Equipes de projeto de risco | id (string) |
| rm/projectserviceunits_v1_000/get_project_service_units | Retorna uma lista de unidades de serviço de projetos do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projectserviceunits_v1_000/post_project_service_units | Insere uma nova Unidades de serviço de projetos | 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_id | Recupera uma Unidades de serviço de projetos | id (string) expand (string) fields (string) |
| rm/projectserviceunits_v1_000/put_project_service_units_by_id | Atualiza uma Unidades de serviço de projetos | id (string) 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_id | Exclui uma Unidades de serviço de projetos | id (string) |
| rm/projectsubmitapprovalrequest_v1_000/post_project_material_requests_extra_by_internal_id_submit_approval_request | Enviar um pedido de material extra para aprovação | internalId (string) data: { . internalId (string) . companyId (integer) . projectId (integer) . requestId (integer) } (object) required |
| rm/projecttimesheetteams_v1_000/get_timesheet_project_teams | Retorna uma lista de equipes de projeto de timesheet do projeto | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/projecttimesheetteams_v1_000/post_timesheet_project_teams | Insere uma nova Equipes de projeto de timesheet | 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_id | Recupera uma Equipes de projeto de timesheet | id (string) expand (string) fields (string) |
| rm/projecttimesheetteams_v1_000/put_timesheet_project_teams_by_id | Atualiza uma Equipes de projeto de timesheet | id (string) 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_id | Exclui uma Equipes de projeto de timesheet | id (string) |
| rm/projecttraceabilitysupplies_v1_000/get_traceability_supplies_by_internal_id | Rastreabilidade de um movimento para projetos | internalId (string) |
| rm/projectunproductivereasons_v1_000/get_project_unproductive_reasons | Retorna uma lista de motivos de improdutividade | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required |
| rm/projectunproductivereasons_v1_000/post_project_unproductive_reasons | Insere um novo motivo de improdutividade | 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_id | Recupera um motivo de improdutividade | id (string) expand (string) fields (string) |
| rm/projectunproductivereasons_v1_000/put_project_unproductive_reasons_by_id | Atualiza um motivo de improdutividade | id (string) 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_id | Exclui um motivo de improdutividade | id (string) |
| rm/publication_v1_000/get_publications | Retorna todas as publicações de acordo com o filtro passado | order (array) page (integer) pageSize (integer) |
| rm/publication_v1_000/get_publications_by_publication_internal_id | Retorna detalhes da publicação | PublicationInternalId (string) |
| rm/renewbookloan_v1_000/post_bookloans_by_book_loan_internal_id_renew_book_loans | Renova o empréstimo passado na requisição | BookLoanInternalId (string) data (undefined) required |
| rm/reportinputs_v1_000/get_report_inputs_input_by_id | Recupera 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 so | id (string) |
| rm/restgroups_v1_000/get_rest_groups_by_id | Retorna dados do grupo de descanso | id (string) |
| rm/restgroups_v1_000/delete_rest_groups_by_id | Exclui grupo de descanso | id (string) |
| rm/restgroups_v1_000/put_rest_groups_by_id | Atualiza 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_groups | Retorna todos os grupos de descanso | fields (string) order (array) page (integer) pageSize (integer) |
| rm/restgroups_v1_000/post_rest_groups | Inclui um novo registro na tabela de grupo de descanso | data: { . CompanyCode (string) . RestGroupCode (string) . id (string) . Description (string) } (object) required |
| rm/roles_v1_000/get_roles | Retorna todas os Roles | 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 | Retorna todas as salas do Educacional | ProfessorInternalId (string) BuildingInternalId (string) BlockInternalId (string) 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_id | Retorna a sala educacional | ProfessorInternalId (string) BuildingInternalId (string) BlockInternalId (string) InternalId (string) |
| rm/scheduleactivity_v1_000/get_schedule_activities_by_code | Retorna todos as Atividades da Agenda | code (string) |
| rm/scheduleactivity_v1_000/put_schedule_activities_by_code | Atualiza uma Atividade de Agenda | code (string) 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_code | Exclui um Horário Agendado | code (string) |
| rm/scheduleactivity_v1_000/get_schedule_activities | Recupera uma lista com todas as Atividades de Agenda | order (array) page (integer) pageSize (integer) fields (string) |
| rm/scheduleactivity_v1_000/post_schedule_activities | Insere uma Atividade | 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_locks | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/schedulelock_v1_000/post_schedule_locks | Insere um registro | 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_code | Recupera um registro | code (string) |
| rm/schedulelock_v1_000/delete_schedule_locks_by_code | Exclui um registro | code (string) |
| rm/scheduleperiod_v1_000/get_schedule_periods_by_code | Retorna todas as Vigências de uma agenda | code (string) |
| rm/scheduleperiod_v1_000/put_schedule_periods_by_code | Atualiza as informações de uma Vigência de Agenda | code (string) 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_code | Exclui uma agenda | code (string) |
| rm/scheduleperiod_v1_000/get_schedule_periods | Recupera uma lista com todas as Vigências de Agenda | order (array) page (integer) pageSize (integer) fields (string) |
| rm/scheduleperiod_v1_000/post_schedule_periods | Insere um Bloqueio de Agenda | 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_code | Retorna todas as Especialidades de uma Agenda | code (string) |
| rm/schedulespecialty_v1_000/put_schedule_specialties_by_code | Atualiza as informações de uma Especialidade de uma Agenda | code (string) data: { . code (string) . companyId (integer) . scheduleId (integer) . scheduleCode (string) . specialtyId (string) . specialtyDescription (string) } (object) required |
| rm/schedulespecialty_v1_000/delete_schedule_specialties_by_code | Exclui uma Especialidade de uma Agenda | code (string) |
| rm/schedulespecialty_v1_000/get_schedule_specialties | Recupera uma lista com todas as Especialidades de uma Agenda | order (array) page (integer) pageSize (integer) fields (string) |
| rm/schedulespecialty_v1_000/post_schedule_specialties | Insere uma Especialidade | data: { . code (string) . companyId (integer) . scheduleId (integer) . scheduleCode (string) . specialtyId (string) . specialtyDescription (string) } (object) required |
| rm/scheduletime_v1_000/get_schedule_times_by_code | Retorna todos os Horários de Agendamento | code (string) |
| rm/scheduletime_v1_000/put_schedule_times_by_code | Atualiza as informações de um Horário de Agendamento | code (string) 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_code | Exclui um Horário Agendado | code (string) |
| rm/scheduletime_v1_000/get_schedule_times | Recupera uma lista com todos os Horários de uma Agenda | order (array) page (integer) pageSize (integer) fields (string) |
| rm/scheduletime_v1_000/post_schedule_times | Insere uma Horário | 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_code | Retorna os dados de uma Agenda | code (string) |
| rm/schedule_v1_000/put_schedules_by_code | Atualiza as informações de uma Agenda | code (string) 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_code | Exclui uma agenda | code (string) |
| rm/schedule_v1_000/get_schedules | Recupera uma lista de registros de Agendas. | order (array) page (integer) pageSize (integer) fields (string) |
| rm/schedule_v1_000/post_schedules | Insere um registro | 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_schedules | Recupera uma lista de Agendas. | order (array) page (integer) pageSize (integer) fields (string) |
| rm/schedule_v2_000/post_schedules | Insere um registro | 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_id | Retorna os dados de uma Agenda. | scheduleId (string) |
| rm/schedule_v2_000/put_schedules_by_schedule_id | Atualiza as informações de uma Agenda. | scheduleId (string) 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_id | Exclui uma agenda. | scheduleId (string) |
| rm/searchfield_v1_000/get_search_field_by_internal_id | Retorna os filtros possíveis na pesquisa pública parametrizado no Biblioteca | InternalId (string) fields (string) |
| rm/selectionprocessexplorer_v1_000/get_selection_processes_selection_process_explorer | Retorna Processos seletivos venda online de cursos | order (array) page (integer) pageSize (integer) |
| rm/shippingcompany_v1_000/get_shipping_company | Retorna lista completa de Transportadoras | fields (string) order (array) page (integer) pageSize (integer) |
| rm/shippingcompany_v1_000/post_shipping_company | Inclui uma Transportadora conforme dados enviados na requisição. | 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_id | Retorna a Transportadora conforme dados enviados na requisição | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/shippingcompany_v1_000/put_shipping_company_by_internal_id | Atualiza cadastro de Transportadoras conforme dados enviados na requisição | InternalId (string) 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_id | Exclui cadastro de Transportadora conforme dados enviados na requisição. | InternalId (string) |
| rm/specializedmedicalreportitems_v1_000/get_specialized_medical_report_items | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/specializedmedicalreportitems_v1_000/post_specialized_medical_report_items | Insere um registro | 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_code | Recupera um registro | code (string) expand (string) fields (string) |
| rm/specializedmedicalreportitems_v1_000/put_specialized_medical_report_items_by_code | Atualiza um registro | code (string) 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_code | Exclui um registro | code (string) |
| rm/specializedmedicalreport_v1_000/get_specialized_medical_report | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) |
| rm/specializedmedicalreport_v1_000/post_specialized_medical_report | Insere um registro | 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_code | Recupera um registro | code (string) expand (string) fields (string) |
| rm/specializedmedicalreport_v1_000/put_specialized_medical_report_by_code | Atualiza um registro | code (string) 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_code | Exclui um registro | code (string) |
| rm/specialty_v1_000/get_specialties | Recupera uma lista com todas as Especialidades | order (array) page (integer) pageSize (integer) fields (string) |
| rm/statefiscal_v1_000/get_state | Retorna todos os estados | fields (string) order (array) page (integer) pageSize (integer) |
| rm/stockgroup_v1_000/get_stock_groups | Retorna lista completa de Grupo de Produto | order (array) page (integer) pageSize (integer) fields (string) |
| rm/stockgroup_v1_000/post_stock_groups | Inclui a entidade Grupo de Produto passada na requisição | data (undefined) required |
| rm/stockgroup_v1_000/get_stock_groups_by_code | Retorna Grupo de Produto pelo seu Código | Code (string) |
| rm/stockgroup_v1_000/put_stock_groups_by_code | Atualiza cadastro de Grupo de Produto conforme dados enviados na requisição | Code (string) data (undefined) required |
| rm/stockgroup_v1_000/delete_stock_groups_by_code | Exclui grupo de produto cadastrado conforme dados enviados na requisição | Code (string) |
| rm/studentcontext_v1_000/get_student_contexts | Retorna todos os contextos do aluno do Educacional | order (array) page (integer) pageSize (integer) |
| rm/studentwarninggroup_v1_000/get_professors_by_professor_internal_id_student_warning_groups | Retorna todos os grupos de ocorrência do Educacional | ProfessorInternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/studentwarninggroup_v1_000/get_professors_by_professor_internal_id_student_warning_groups_by_internal_id | Retorna o grupo de ocorrência do educacional | ProfessorInternalId (string) InternalId (string) fields (string) |
| rm/studentwarning_v1_000/get_students_by_student_internal_id_studentwarnings | Retorna todas as ocorrências do aluno do Educacional | StudenteInternalId (string) StudentInternalId (string) order (array) page (integer) pageSize (integer) |
| rm/studentwarning_v1_000/get_students_by_student_internal_id_studentwarning_by_internal_id | Retorna a ocorrência do aluno do educacional | StudenteInternalId (string) InternalId (string) StudentInternalId (string) |
| rm/summaryhistogramsalterdeliverydateitems_v1_000/post_summary_histograms_by_internal_id_change_delivery_date | Altera a data de entrega dos itens de um pedido de material | internalId (string) 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_histograms | Retorna uma lista com os histogramas resumo dos pedidos de materiais do projeto | 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_id | Recupera histograma resumo de um pedido de material | id (string) expand (string) fields (string) |
| rm/summaryhistograms_v1_000/delete_summary_histograms_by_id | Exclui um histograma resumo do pedido de material | id (string) |
| rm/supplyppe_v1_000/get_supplyppes | Retorna todos os fornecimentos/devoluções/descartes cadastrados no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/supplyppe_v1_000/get_supplyppes_by_id | Retorna o fornecimento do sistema | id (string) |
| rm/supplyppe_v1_000/post_supplyppes_ppeborrow | Fornece o EPI passado por parâmetro | 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_ppereturn_by_id | Devolve o EPI passado por parâmetro | id (string) 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_id | Descarta o EPI passado por parâmetro | id (string) 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_tasksheet | Retorna informações de folhas tarefas e tarefas de mobilidade do TOTVS Obras e Projetos | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required imeiDevice (string) required currentUser (string) required appVersion (string) required |
| rm/taskcostassigments_v1_000/get_task_cost_assigments | Retorna uma lista de apropriações realizadas em um projeto. | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/taskcostassigments_v1_000/post_task_cost_assigments | Incluir uma apropriação. | 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_id | Retorna uma apropriação. | id (string) |
| rm/taskcostassigments_v1_000/put_task_cost_assigments_by_id | Atualiza uma apropriação. | id (string) 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_id | Excluir uma apropriação de custo. | id (string) |
| rm/term_v1_000/get_academics_by_academic_internal_id_terms | Retorna todos os Períodos Letivos | AcademicInternalId (string) AcademicInternalID (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/term_v1_000/post_academics_by_academic_internal_id_terms | Inclui o Período Letivo passado na requisição | AcademicInternalId (string) AcademicInternalID (string) data (undefined) required |
| rm/term_v1_000/get_academics_by_academic_internal_id_terms_by_internal_id | Retorna um Período Letivo | AcademicInternalId (string) InternalId (string) AcademicInternalID (string) |
| rm/term_v1_000/put_academics_by_academic_internal_id_terms_by_internal_id | Altera o Período Letivo passado na requisição | AcademicInternalId (string) InternalId (string) AcademicInternalID (string) data (undefined) required |
| rm/term_v1_000/delete_academics_by_academic_internal_id_terms_by_internal_id | Exclusão de Período Letivo da base | AcademicInternalId (string) InternalId (string) AcademicInternalID (string) |
| rm/ticketattachments_v1_000/get_ticket_attachments | Retorna uma lista de arquivos anexos de atendimentos do CRM | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required ticketId (integer) required locationId (integer) required |
| rm/ticketattachments_v1_000/post_ticket_attachments | Incluir arquivo anexo de um atendimento | 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_id | Retorna arquivo anexo de um atendimento. | id (string) |
| rm/ticketattachments_v1_000/put_ticket_attachments_by_id | Atualizar um arquivo anexo de atendimento | id (string) 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_id | Excluir arquivo anexo de um atendimento | id (string) |
| rm/ticketstepforward_v1_000/post_tickets_by_internal_id_step_forward | Excutar o processo de avanço de etapa de um tendimento | internalId (string) 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_id | Retornar as informações necessárias para utilização no processo de avanço de etapa de atendimento | internalId (string) |
| rm/ticketstepforward_v1_001/post_tickets_by_internal_id_step_forward | Excutar o processo de avanço de etapa de um tendimento | internalId (string) 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_tickets | Retorna uma lista de atendimentos do CRM | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required |
| rm/tickets_v1_000/post_tickets | Incluir um atendimento | 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_id | Retorna um atendimento. | id (string) |
| rm/tickets_v1_000/put_tickets_by_id | Atualizar um atendimento | id (string) 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_id | Excluir um atendimento | id (string) |
| rm/tickets_v1_001/get_tickets | Retorna uma lista de atendimentos do CRM | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required |
| rm/tickets_v1_001/post_tickets | Incluir um atendimento | 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_id | Retorna um atendimento. | id (string) |
| rm/tickets_v1_001/put_tickets_by_id | Atualizar um atendimento | id (string) 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_id | Excluir um atendimento | id (string) |
| rm/tickets_v1_001/get_tickets_by_id_request_details | Listar detalhes de solicitação um atendimentos | id (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/tickets_v1_001/post_tickets_by_id_request_details | Incluir um detalhe de solicitação de um atendimento | id (string) 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_detail | Retorna um detalhe de solicitação de atendimento | id (string) idDetail (string) |
| rm/tickets_v1_001/put_tickets_by_id_request_details_by_id_detail | Atualizar um detalhe de solicitação de um atendimento | id (string) idDetail (string) 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_detail | Excluir um detalhe de solicitação de um atendimento | id (string) idDetail (string) |
| rm/tickets_v1_002/get_tickets | Retorna uma lista de atendimentos do CRM | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required |
| rm/tickets_v1_002/post_tickets | Incluir um atendimento | 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_id | Retorna um atendimento. | id (string) |
| rm/tickets_v1_002/put_tickets_by_id | Atualizar um atendimento | id (string) 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_id | Excluir um atendimento | id (string) |
| rm/tickets_v1_002/get_tickets_by_id_request_details | Listar detalhes de solicitação um atendimentos | id (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/tickets_v1_002/post_tickets_by_id_request_details | Incluir um detalhe de solicitação de um atendimento | id (string) 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_detail | Retorna um detalhe de solicitação de atendimento | id (string) idDetail (string) |
| rm/tickets_v1_002/put_tickets_by_id_request_details_by_id_detail | Atualizar um detalhe de solicitação de um atendimento | id (string) idDetail (string) 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_detail | Excluir um detalhe de solicitação de um atendimento | id (string) idDetail (string) |
| rm/tickets_v1_002/get_tickets_by_id_discussion_details | Listar detalhes da discussão de um atendimentos | id (string) order (array) page (integer) pageSize (integer) fields (string) |
| rm/tickets_v1_002/post_tickets_by_id_discussion_details | Incluir um detalhe de discussão de um atendimento | id (string) 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_detail | Retorna um detalhe da discussão de atendimento | id (string) idDetail (string) |
| rm/tickets_v1_002/put_tickets_by_id_discussion_details_by_id_detail | Atualizar um detalhe da discussão de um atendimento | id (string) idDetail (string) 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_detail | Excluir um detalhe da discussão de um atendimento | id (string) idDetail (string) |
| rm/transportcycle_v1_000/get_transportcycle | Retorna uma lista de registros | order (array) page (integer) pageSize (integer) fields (string) companyId (integer) required projectId (integer) required |
| rm/transportcycle_v1_000/post_transportcycle | Insere um registro | 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_id | Recupera um registro | id (string) expand (string) fields (string) |
| rm/transportcycle_v1_000/put_transportcycle_by_id | Atualiza um registro | id (string) 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_id | Exclui um registro | id (string) |
| rm/transportationfare_v1_000/get_transportationfares | Retorna todas as Tarifa de Transporte cadastradas no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/transportationfare_v1_000/post_transportationfares | Inclui a Tarifa de Transporte passada na requisição | data (undefined) required |
| rm/transportationfare_v1_000/get_transportationfares_by_id | Retorna a Tarifa de Transporte correspondente ao id | id (string) |
| rm/transportationfare_v1_000/put_transportationfares_by_id | Inclui/Edita a Tarifa de Transporte passada na requisição | id (string) data (undefined) required |
| rm/transportationfare_v1_000/delete_transportationfares_by_id | Deleta a Tarifa de Transporte correspondente ao id | id (string) |
| rm/transportationline_v1_000/get_transportationlines | Retorna todas as Linhas de Transporte cadastradas no sistema | order (array) page (integer) pageSize (integer) fields (string) |
| rm/transportationline_v1_000/post_transportationlines | Inclui a Linha de Transporte passada na requisição | data (undefined) required |
| rm/transportationline_v1_000/get_transportationlines_by_id | Retorna a Linha de Transporte correspondente ao id | id (string) |
| rm/transportationline_v1_000/put_transportationlines_by_id | Inclui/Edita a Linha de Transporte passada na requisição | id (string) data (undefined) required |
| rm/transportationline_v1_000/delete_transportationlines_by_id | Deleta a Linha de Transporte correspondente ao id | id (string) |
| rm/tributarylotations_v1_000/get_tributary_lotations_by_id | Retorna dados da lotação tributária | id (string) |
| rm/tributarylotations_v1_000/delete_tributary_lotations_by_id | Exclui lotação tributária | id (string) |
| rm/tributarylotations_v1_000/put_tributary_lotations_by_id | Atualiza 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_lotations | Retorna todas as lotações tributárias | fields (string) order (array) page (integer) pageSize (integer) |
| rm/tributarylotations_v1_000/post_tributary_lotations | Inclui um novo registro na tabela de lotação tributária | 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/unitofmeasures_v1_000/get_unit_of_measures | Retorna lista completa de Unidade de Medida | order (array) page (integer) pageSize (integer) fields (string) |
| rm/unitofmeasures_v1_000/post_unit_of_measures | Inclui uma Unidade de Medida | 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_code | Retorna Unidade de Medida pelo seu Código | Code (string) |
| rm/unitofmeasures_v1_000/put_unit_of_measures_by_code | Atualiza cadastro de Unidade de Medida conforme dados enviados na requisição | Code (string) 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_code | Exclui Unidade de Medida cadastrada conforme dados enviados na requisição | Code (string) |
| rm/urbanocoletor_v1_000/post_coletor_urbano | Inclui informações do coletor na prestação de contas | data (object) required |
| rm/user_v1_000/get_users | Retorna todos usuários do sistema | order (array) page (integer) pageSize (integer) fields (string) userIds (string) name (string) |
| rm/user_v1_000/post_users | Inclui usuário passado na requisição | data (object) required |
| rm/user_v1_000/get_users_by_id | Retorna o usuário do sistema indicado | id (string) foundBy (string) domainId (string) |
| rm/user_v1_000/put_users_by_id | Altera o usuário passado na requisição | id (string) foundBy (string) domainId (string) data (undefined) required |
| rm/user_v1_000/delete_users_by_id | Exclusão de usuário da base | id (string) foundBy (string) domainId (string) |
| rm/vieweducationalreport_v1_000/post_educational_reports_by_educational_report_id_view_educational_reports | De acordo com os parâmetros passados é gerado o relatório educacional disponível ao usuário | EducationalReportId (string) 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_id | Retorna dados da batida de visitante | id (string) |
| rm/visitorpunches_v1_000/delete_visitor_punches_by_id | Exclui batida de visitante | id (string) |
| rm/visitorpunches_v1_000/put_visitor_punches_by_id | Atualiza 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_punches | Retorna todas as batidas de visitantes | fields (string) order (array) page (integer) pageSize (integer) |
| rm/visitorpunches_v1_000/post_visitor_punches | Inclui um novo registro na tabela de batidas de visitantes | data: { . 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_id | Retorna dados do visitante | id (string) |
| rm/visitors_v1_000/delete_visitors_by_id | Exclui visitante | id (string) |
| rm/visitors_v1_000/put_visitors_by_id | Atualiza 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_visitors | Retorna todos os visitantes | fields (string) order (array) page (integer) pageSize (integer) |
| rm/visitors_v1_000/post_visitors | Inclui um novo registro na tabela de visitantes | data: { . CompanyCode (integer) . EmployeeId (string) . Name (string) . Company (string) . RecordDate (date) . Responsible (string) . Code (integer) . id (string) } (object) required |
| rm/warehouse_v1_002/get_warehouses | Retorna lista completa de Locais de Estoque | order (array) page (integer) pageSize (integer) fields (string) |
| rm/warehouse_v1_002/post_warehouses | Inclui um Local de Estoque | data (undefined) required |
| rm/warehouse_v1_002/get_warehouses_by_code | Retorna Local de Estoque pelo seu Código | Code (string) |
| rm/warehouse_v1_002/put_warehouses_by_code | Atualiza cadastro de Locais de Estoque conforme dados enviados na requisição | Code (string) data (undefined) required |
| rm/warehouse_v1_002/delete_warehouses_by_code | Exclui Local de Estoque cadastrado conforme dados enviados na requisição | Code (string) |
| rm/workaccidentoccurrence_v1_000/get_workaccidentoccurrence_by_id | Retorna dados de tabela da medição de risco especificada | id (string) |
| rm/workaccidentoccurrence_v1_000/delete_workaccidentoccurrence_by_id | Exclui uma medição de risco | id (string) |
| rm/workaccidentoccurrence_v1_000/put_workaccidentoccurrence_by_id | Atualiza um registro existente de tabela de CAT. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) data (object) required |
| rm/workaccidentoccurrence_v1_000/get_workaccidentoccurrence | Retorna todas as medições de risco | order (array) page (integer) pageSize (integer) Ids (string) |
| rm/workaccidentoccurrence_v1_000/post_workaccidentoccurrence | Inclui um novo registro na tabela de medições de risco | 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_workenvironments | Retorna todos os Ambientes de Trabalho | order (array) page (integer) pageSize (integer) workEnvironmentIds (string) |
| rm/workenvironments_v1_000/post_workenvironments | Inclui um novo registro na tabela de Ambientes de Trabalho | 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_id | Retorna dados de tabela do Ambiente de Trabalho especificado | id (string) |
| rm/workenvironments_v1_000/delete_workenvironments_by_id | Exclui Ambiente de Trabalho | id (string) |
| rm/workenvironments_v1_000/put_workenvironments_by_id | Atualiza 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) 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_batch | Cria um novo lote de contas a pagar com documentos associados. | No parameters |
| datasul/accountpayabledocument_v1_000/post_account_payable_advance | Cria um novo registro de adiantamento de contas a pagar | No parameters |
| datasul/accountpayabledocument_v1_000/post_payment | Cria lote de pagamento ou borderô | No parameters |
| datasul/accountpayabledocument_v1_000/put_reversal | Estorna um título de contas a pagar | No parameters |
| datasul/accountpayabledocument_v1_000/put | Atualiza um título de contas a pagar | No parameters |
| datasul/approvers_v1_000/get_approvers | Retorna todos Aprovadores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/approvers_v1_000/post_approvers | Inclui Aprovadores passado na requisição. | 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_code | Retorna o usuário do sistema indicado. | code (string) |
| datasul/approvers_v1_000/put_approvers_by_code | Altera o Aprovador passado na requisição. | code (string) 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_code | Exclusão do Aprovador. | code (string) |
| datasul/beneficiariescoparticipation_v1_000/get_beneficiaries_coparticipation | Retorna todos os registros de Coparticipações dos Beneficiários e seus dependentes. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) required companyid (string) required |
| datasul/beneficiariesdatacontent_v1_000/get_beneficiaries_data_content | Retorna todos os registros de beneficiários. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required branchId (string) |
| datasul/buyers_v1_000/get_buyers | Retorna todos os Compradores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/buyers_v1_000/post_buyers | Adiciona Comprador passado na requisição | data (object) required |
| datasul/buyers_v1_000/get_buyers_by_buyer_id | Retorna o Comprador do sistema através de seu código | BuyerId (string) fields (string) |
| datasul/buyers_v1_000/put_buyers_by_buyer_id | Altera o comprador passado na requisição | BuyerId (string) data (undefined) required |
| datasul/buyers_v1_000/delete_buyers_by_buyer_id | Exclusão de Comprador da base | BuyerId (string) |
| datasul/campaigntypes_v1_000/get_campaign_types | Retorna os tipos de campanhas cadastrados | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/campaigntypes_v1_000/post_campaign_types | Inclui um novo tipo de campanha | fields (string) data: { . InternalId (string) . Code (string) . Name (string) . Classification (string) } (object) required |
| datasul/campaigntypes_v1_000/get_campaign_types_by_code | Retorna as informações do tipo de campanha | Code (string) fields (string) |
| datasul/campaigntypes_v1_000/put_campaign_types_by_code | Altera o tipo de campanha | Code (string) fields (string) data: { . InternalId (string) . Code (string) . Name (string) . Classification (string) } (object) required |
| datasul/campaigntypes_v1_000/delete_campaign_types_by_code | Exclui o tipo de campanha | Code (string) |
| datasul/campaigns_v1_000/get_campaigns | Retorna as campanhas cadastradas | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/campaigns_v1_000/post_campaigns | Inclui uma nova campanha | 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_code | Retorna as informações da campanha informada | Code (string) fields (string) |
| datasul/campaigns_v1_000/put_campaigns_by_code | Altera a camapnha informada | Code (string) 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_code | Exclui a campanha informada | Code (string) |
| datasul/candidates_v2_000/get_candidates_by_id | Retorna dados de tabela da Candidato especificada | id (string) |
| datasul/candidates_v2_000/delete_candidates_by_id | Exclui Candidato | id (string) |
| datasul/candidates_v2_000/put_candidates_by_id | Atualiza um registro existente de tabela de Candidatos. Caso não seja informado alguma propriedade para ser atualizada, está será considerada nula. | id (string) 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_candidates | Retorna todos as Candidatos | order (array) page (integer) pageSize (integer) personsIds (string) |
| datasul/candidates_v2_000/post_candidates | Inclui um novo registro na tabela de Candidatos | 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_commercialfamilies | Retorna lista completa das famílias comerciais | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/commercialfamily_v2_000/post_commercialfamilies | Inclui uma família comercial conforme dados enviados na requisição. | 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_id | Retorna a família comercial pelo Código interno | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| datasul/commercialfamily_v2_000/put_commercialfamilies_by_internal_id | Atualiza a família comercial conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a família comercial conforme dados enviados na requisição. | InternalId (string) |
| datasul/customerpublic_v1_000/get_customer_public | Retorna lista de Clientes | order (array) fields (string) page (integer) pageSize (integer) expand (string) totalCount (boolean) $filter (string) lastUpdate (string) |
| datasul/customerpublic_v1_000/post_customer_public | Inclui um Cliente conforme dados enviados na requisição. | 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_id | Altera um Cliente conforme dados enviados na requisição. | customerID (integer) 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_id | Altera um Cliente conforme dados enviados na requisição. | customerID (integer) 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_id | Remove um Cliente | customerID (integer) |
| datasul/employeedatacontent_v1_000/get_employee_data_content | Retorna todos os registros de funcionários e seus respectvos departamentos, centro de custos, cargos, funções e demais informações. | page (integer) pageSize (integer) order (array) product (string) required dateModified (string) companyid (string) required |
| datasul/employeepayrollinfo_v1_000/post_employee_payroll_info | Consulta funcionário para avaliação de concessão de empréstimo consignado | 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_audit | Inclui a entidade evento passado na requisição | companyId (string) required order (array) page (integer) pageSize (integer) data (object) required |
| datasul/esocialaudit_v1_000/get_esocial_audit_status | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| datasul/esocialaudit_v1_000/get_esocial_audit_audit_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required status (string) page (integer) pageSize (integer) |
| datasul/esocialaudit_v1_000/get_esocial_audit_chart_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| datasul/esocialbranches_v1_000/get_esocial_branches | Retorna o código da empresa e código da filial no TAF | companyId (string) required order (array) page (integer) pageSize (integer) |
| datasul/esocialestablishment_v1_000/get_esocial_establishment | Retorna lista completa com os Estabelecimentos Cadastrados | companyId (string) required order (array) page (integer) pageSize (integer) |
| datasul/esocialevents_v1_000/get_esocial_events | Retorna a lista de eventos do TAF | companyId (string) required eventsCheckPermissions (string) |
| datasul/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process | Carrega registros do evento S-5503, filtrados ou não, ordenados ou não. | No parameters |
| datasul/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_process | Exclui 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_xml | Retorna XML's do evento S-5503 encodados em base64 | data: { . companyId (string) . id (array) } (object) required |
| datasul/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_category | Carrega 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_amounts | Carrega 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ão | No parameters |
| datasul/freightmode_v1_000/get_freightmodes | Retorna lista completa das modalidades de frete | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/freightmode_v1_000/post_freightmodes | Inclui uma modalide de frete conforme dados enviados na requisição. | 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_id | Retorna a modalidade de frete pelo Código interno | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| datasul/freightmode_v1_000/put_freightmodes_by_internal_id | Atualiza a modalidade de frete conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a modalidade de frete conforme dados enviados na requisição. | InternalId (string) |
| datasul/gpeesocialmotives_v1_000/get_esocial_motives | Retorna lista completa com os motivos de afastamento | companyId (string) required order (array) page (integer) pageSize (integer) |
| datasul/inventorycounts_v1_000/get_inventory_counts | Retorna uma ou mais de fichas de inventário conforme parâmetros recebidos | companyCode (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_counts | Geraçã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 PUT | data: { . 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_id | Retorna uma ficha de inventário correspondente ao número informado | internalId (string) fields (string) |
| datasul/inventorycounts_v1_000/put_inventory_counts_by_internal_id | Mé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 POST | internalId (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_id | Elimina a ficha de inventário pelo número e data de saldo | internalId (string) |
| datasul/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_counts | Método responsável pela eliminação das contagens. Contagens voltam ao estado inicial | internalId (string) |
| datasul/itemscript_v1_000/get_item_scripts | Retorna todas as operações do item/roteiro informadoos | search (string) order (array) page (integer) pageSize (integer) fields (string) |
| datasul/itemscript_v1_000/post_item_scripts | Adiciona uma ou mais operações para o item ou roteiro | data: { . 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_code | Retorna 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_code | Atualiza as operações de um roteiro pré-existente | 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/delete_item_scripts_script_by_script_code | A 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_code | Atualiza as operações de um item pré-existente | ItemCode (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_code | A 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_structures | Retorna o primeiro nível da estrutura dos itens selecionados | search (string) code (string) itemReference (string) itemComponentCode (string) expired (boolean) pageSize (integer) page (integer) fields (string) order (array) |
| datasul/itemstructures_v1_000/post_item_structures | Adiciona um ou mais componentes na estrutura | data: { . CompanyInternalId (string) . CompanyCode (string) . ItemInternalId (string) . ItemCode (string) . ItemAmount (number) . ListOfItensStructure (array) } (object) required |
| datasul/itemstructures_v1_000/put_item_structures_by_item_internal_id | Atualiza uma estrutura existente | ItemInternalId (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_id | Retorna o primeiro nível da estrutura do item informado | ItemInternalId (string) |
| datasul/itemstructures_v1_000/delete_item_structures_by_item_internal_id | Deleta completamente a estrutura de um item | ItemInternalId (string) |
| datasul/itemstructures_v1_000/delete_item_structures_by_item_internal_id_component | Exclui um ou mais componentes na estrutura | ItemInternalId (string) data: { . CompanyInternalId (string) . CompanyCode (string) . ItemInternalId (string) . ItemCode (string) . ItemAmount (number) . ListOfItensStructure (array) } (object) required |
| datasul/jobscheduler_v1_001/get_job_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| datasul/jobscheduler_v1_001/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| datasul/jobscheduler_v1_001/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| datasul/jobscheduler_v1_001/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| datasul/jobscheduler_v1_001/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| datasul/jobscheduler_v1_001/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| datasul/jobscheduler_v1_100/get_job_execution | Retorna todas as execuções de agendamentos | order (array) page (integer) pageSize (integer) |
| datasul/jobscheduler_v1_100/get_job_execution_by_execution_id | Retorna todos os agendamentos | executionID (string) |
| datasul/jobscheduler_v1_100/get_job_scheduler | Retorna todos os agendamentos | order (array) page (integer) pageSize (integer) |
| datasul/jobscheduler_v1_100/post_job_scheduler | Cria agendamento de processo | 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/get_job_scheduler_by_job_schedule_id | Retorna todos Jobscheduler | jobScheduleID (string) |
| datasul/jobscheduler_v1_100/put_job_scheduler_by_job_schedule_id | Inclui Jobscheduler | jobScheduleID (string) 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_id | Inclui Jobscheduler | jobScheduleID (string) |
| datasul/jobscheduler_v1_100/post_job_scheduler_by_job_schedule_id_trigger | Dispara a execução um agendamento de processo | jobScheduleID (string) |
| datasul/machine_v1_000/get_machines | Recupera um conjunto de registros com base nos filtros via Querystring | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) search (string) |
| datasul/machine_v1_000/post_machines | Adicionar nova máquina | 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/machine_v1_000/put_machines | Atualizar uma máquina existente | 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/machine_v1_000/get_machines_by_code | Retorna uma única máquina com ID informado. | Code (string) Accept-Language (string) |
| datasul/machine_v1_000/delete_machines_by_code | Exclui o registro de máquina existente | Code (string) Accept-Language (string) |
| datasul/machine_v1_000/delete_machines_by_code_relation | Exclui uma ou mais relações da máquina | Code (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_marks | Retorna um conjunto de marcas | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| datasul/marks_v1_000/post_marks | Adiciona uma nova marca | data (object) required |
| datasul/marks_v1_000/get_marks_by_code | Retorna uma única marca | Code (string) |
| datasul/marks_v1_000/put_marks_by_code | Atualiza uma marca existente | Code (string) data (object) required |
| datasul/marks_v1_000/delete_marks_by_code | Deleta uma marca | Code (string) |
| datasul/materialfamilies_v1_000/post_material_families | Adiciona nova família de material | 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/get_material_families | Retorna lista de famílias de materiais | order (array) pageSize (integer) page (integer) |
| datasul/materialfamilies_v1_000/get_material_families_by_code | Retorna uma única família | id (string) Code (string) |
| datasul/materialfamilies_v1_000/put_material_families_by_code | Atualiza uma família de material | Code (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_code | Remove uma família de material | id (string) Code (string) |
| datasul/menus_v1_001/get_menus | Retorna todas os resources | order (array) page (integer) pageSize (integer) |
| datasul/menus_v1_001/get_menus_by_parent_id | Retorna todas os resources | parentId (string) |
| datasul/models_v1_000/get_models | Retorna um conjunto de modelos | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| datasul/models_v1_000/post_models | Adiciona um novo modelo | 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/get_models_by_code | Retorna um único modelo | Code (string) |
| datasul/models_v1_000/put_models_by_code | Atualiza um modelo existente | Code (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_code | Deleta um modelo | id (string) Code (string) |
| datasul/operationalcategory_v1_000/get_operational_categorys | Retorna um conjunto de Categorias Operacionais | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| datasul/operationalcategory_v1_000/post_operational_categorys | Adiciona uma nova categoria operacional | data: { . Code (string) . Description (string) . ShortName (string) . UnitOfMeasureCode (string) } (object) required |
| datasul/operationalcategory_v1_000/get_operational_categorys_by_code | Retorna uma única categoria operacional | Code (string) |
| datasul/operationalcategory_v1_000/put_operational_categorys_by_code | Atualiza uma categoria operacional existente | Code (string) data: { . Code (string) . Description (string) . ShortName (string) . UnitOfMeasureCode (string) } (object) required |
| datasul/operationalcategory_v1_000/delete_operational_categorys_by_code | Deleta uma categoria operacional | Code (string) |
| datasul/opportunity_v1_000/get_opportunities | Retorna lista completa das oportunidades de Venda | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/opportunity_v1_000/post_opportunities | Inclui uma oportunidade de venda conforme dados enviados na requisição. | 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_id | Retorna a oportunidade de venda pelo código | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| datasul/opportunity_v1_000/put_opportunities_by_internal_id | Atualiza a oportunidade de venda conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a oportunidade de venda conforme dados enviados na requisição. | InternalId (string) |
| datasul/orderspublic_v1_000/get_orders_public | Retorna lista de Pedido de Venda | 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_public | Inclui um Pedido de Venda conforme dados enviados na requisição. | 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_id | Altera um Pedido de Venda conforme dados enviados na requisição. | orderId (integer) 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_id | Altera um Pedido de Venda conforme dados enviados na requisição. | orderId (integer) 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_id | Completa o Pedido de Venda | orderId (integer) |
| datasul/orderspublic_v1_000/put_orders_public_cancel_by_order_id | Cancela o Pedido de Venda | orderId (integer) data: { . CancellationDate (string) . TypeReason (integer) . CancellationReason (string) } (object) required |
| datasul/payrollcontrol_v1_000/get_payroll_control | Retorna os dados da folha de pagamento de benefíciosAssitência Médica e Odontológica | 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_items | Retorna lista de Tabela de Preço | order (array) fields (string) page (integer) pageSize (integer) |
| datasul/pricelistheaderitem_v2_005/post_price_list_header_items | Inclui uma tabela de preço conforme dados enviados na requisição. | data (object) required |
| datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_code | Retorna a tabela de preço e todos os seus itens de acordo com o seu código | code (string) order (array) fields (string) |
| datasul/pricelistheaderitem_v2_005/put_price_list_header_items_by_code | Atualiza o cadastro da tabela de preço conforme dados enviados na requisição | code (string) data (object) required |
| datasul/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code | Exclui a tabela de preço conforme dados enviados na requisição. | code (string) |
| datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price | Retorna os itens da tabela de preço de acordo com o seu código | code (string) order (array) fields (string) page (integer) pageSize (integer) |
| datasul/pricelistheaderitem_v2_005/post_price_list_header_items_by_code_itens_table_price | Inclui um novo item na tabela de preço conforme dados enviados. | code (string) data: { . items } (object) required |
| datasul/pricelistheaderitem_v2_005/get_price_list_header_items_by_code_itens_table_price_by_item_list | Retorna um item específico de preço de acordo com o seu código | code (string) itemList (undefined) order (array) fields (string) page (integer) pageSize (integer) |
| datasul/pricelistheaderitem_v2_005/put_price_list_header_items_by_code_itens_table_price_by_item_list | Atualiza um item da tabela de preço conforme dados enviados na requisição | code (string) itemList (undefined) fields (string) data: { . items } (object) required |
| datasul/pricelistheaderitem_v2_005/delete_price_list_header_items_by_code_itens_table_price_by_item_list | Exclui um item da tabela de preço conforme dados enviados na requisição. | code (string) itemList (undefined) |
| datasul/prospects_v1_000/get_prospects | Retorna lista completa de prospects | order (array) fields (string) page (integer) pageSize (integer) |
| datasul/prospects_v1_000/post_prospects | Inclui um prospect conforme dados enviados na requisição. | 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_code | Retorna prospect pelo seu Código | Code (string) order (array) fields (string) page (integer) pageSize (integer) |
| datasul/prospects_v1_000/put_prospects_by_code | Atualiza cadastro de prospect conforme dados enviados na requisição | Code (string) 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_code | Exclui cadastro de Prospect conforme dados enviados na requisição. | Code (string) |
| datasul/saleschannel_v2_000/get_saleschannels | Retorna lista completa dos canais de venda | order (array) page (integer) pageSize (integer) fields (string) |
| datasul/saleschannel_v2_000/post_saleschannels | Inclui um canal de venda conforme dados enviados na requisição. | fields (string) data: { . InternalId (string) . Code (string) . Description (string) . Observation (string) . StartDateQuotaControl (string) } (object) required |
| datasul/saleschannel_v2_000/get_saleschannels_by_internal_id | Retorna o canal de venda pelo Código interno | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) |
| datasul/saleschannel_v2_000/put_saleschannels_by_internal_id | Atualiza ocanal de venda conforme dados enviados na requisição | InternalId (string) fields (string) data: { . InternalId (string) . Code (string) . Description (string) . Observation (string) . StartDateQuotaControl (string) } (object) required |
| datasul/saleschannel_v2_000/delete_saleschannels_by_internal_id | Exclui o canal de venda conforme dados enviados na requisição. | InternalId (string) |
| datasul/suspects_v1_000/get_suspects | Retorna lista completa de Suspects | order (array) fields (string) page (integer) pageSize (integer) |
| datasul/suspects_v1_000/post_suspects | Inclui um Suspect conforme dados enviados na requisição. | 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_code | Retorna Suspect pelo seu Código | Code (string) order (array) fields (string) page (integer) pageSize (integer) |
| datasul/suspects_v1_000/put_suspects_by_code | Atualiza cadastro de Suspect conforme dados enviados na requisição | Code (string) 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_code | Exclui cadastro de Suspect conforme dados enviados na requisição. | Code (string) |
| datasul/unitymeasurespublic_v1_000/get_unity_measures_public | Retorna lista de Unidades de Medida | order (array) fields (string) page (integer) pageSize (integer) totalCount (boolean) $filter (string) |
| datasul/unitymeasurespublic_v1_000/post_unity_measures_public | Inclui uma Unidade de Medida conforme dados enviados na requisição. | data: { . Code (string) . Description (string) . DimensionCode (integer) . FiscalAcronym (string) } (object) required |
| datasul/unitymeasurespublic_v1_000/put_unity_measures_public | Altera uma Unidade de Medida conforme dados enviados na requisição. | data: { . Code (string) . Description (string) . DimensionCode (integer) . FiscalAcronym (string) } (object) required |
| datasul/unitymeasurespublic_v1_000/delete_unity_measures_public_by_code | Remove uma Unidade de Medida | code (integer) |
| datasul/urbanocoletor_v1_000/post_coletor_urbano | Inclui informações do coletor na prestação de contas | data (object) required |
| datasul/user_v1_000/get_users | Retorna todos usuários do sistema | order (array) page (integer) pageSize (integer) fields (string) userIds (string) name (string) |
| datasul/user_v1_000/post_users | Inclui usuário passado na requisição | data (object) required |
| datasul/user_v1_000/get_users_by_id | Retorna o usuário do sistema indicado | id (string) foundBy (string) domainId (string) |
| datasul/user_v1_000/put_users_by_id | Altera o usuário passado na requisição | id (string) foundBy (string) domainId (string) data (undefined) required |
| datasul/user_v1_000/delete_users_by_id | Exclusão de usuário da base | id (string) foundBy (string) domainId (string) |
| datasul/workcenters_v1_000/get_work_centers | Retorna um conjunto de centro de trabalho | search (string) order (array) page (integer) pageSize (integer) fields (string) Description (string) ProductionAreaCode (string) CostCenterCode (string) |
| datasul/workcenters_v1_000/post_work_centers | Adiciona um novo centro de trabalho | 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/get_work_centers_by_code | Retorna um único centro de trabalho | code (string) |
| datasul/workcenters_v1_000/put_work_centers_by_code | Atualiza um centro de trabalho existente | code (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_code | Deleta um centro de trabalho | code (string) |
| central_de_obrigacoes___diops/activebalanceage_v1_100/get_active_balance_age | Retorna uma mensagem com a coleção de objetos do serviço Idade Do Saldo Ativo da entidade B8FT10 | financialDueDate (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_age | Inclui 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) 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_date | Retorna uma mensagem com o objeto do serviço Idade Do Saldo Ativo da entidade B8FT10 | financialDueDate (string) 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_date | Altera 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) 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_date | Exclui 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) commitmentCode (string) required obligationCode (string) required providerRegister (string) required commitmentYear (string) required |
| central_de_obrigacoes___diops/ansaccountplan_v1_100/get_ans_account_plan | Retorna uma mensagem com a coleção de objetos do serviço Plano Contas Ans da entidade B8BT10 | accountCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required validityEndDate (string) required validityStartDate (string) required accountDescription (string) |
| central_de_obrigacoes___diops/ansaccountplan_v1_100/post_ans_account_plan | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Plano Contas Ans da entidade B8BT10 | accountCode (string) 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_code | Altera 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) 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_code | Exclui 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) providerRegister (string) required validityEndDate (string) required validityStartDate (string) required |
| central_de_obrigacoes___diops/assistancecoverage_v1_100/get_assistance_coverage | Retorna uma mensagem com a coleção de objetos do serviço Cobertura Assistencial da entidade B8IT10 | typeOfPlan (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_coverage | Inclui 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) 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_plan | Retorna uma mensagem com o objeto do serviço Cobertura Assistencial da entidade B8IT10 | typeOfPlan (string) 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_plan | Altera 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) 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_plan | Exclui 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) 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_model | Retorna uma mensagem com a coleção de objetos do serviço Modelo Padrão De Capital da entidade B82T10 | commitmentCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_model | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Modelo Padrão De Capital da entidade B82T10 | commitmentCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/cashflow_v1_100/get_cash_flow | Retorna uma mensagem com a coleção de objetos do serviço Fluxo De Caixa da entidade B8HT10 | cashFlowCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_flow | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Fluxo De Caixa da entidade B8HT10 | cashFlowCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required status (string) required |
| central_de_obrigacoes___diops/charts_v1_100/get_charts | Retorna uma mensagem com a coleção de objetos do serviço Quadros da entidade B8XT10 | diopsChart (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required chartReceived (string) validateChart (string) |
| central_de_obrigacoes___diops/charts_v1_100/post_charts | Inclui 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) 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_chart | Retorna uma mensagem com o objeto do serviço Quadros da entidade B8XT10 | diopsChart (string) 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_chart | Altera 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) 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_chart | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/commitment_v1_100/get_commitment | Retorna uma mensagem com a coleção de objetos do serviço Compromissos da entidade B3DT10 | commitmentCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_commitment | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Compromissos da entidade B3DT10 | commitmentCode (string) 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_code | Altera 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) 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_code | Exclui 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) obligationCode (string) required providerRegister (string) required referenceYear (string) required obligationType (string) required |
| central_de_obrigacoes___diops/commonfunds_v1_100/get_common_funds | Retorna uma mensagem com a coleção de objetos do serviço Fundos Comuns da entidade B6RT10 | fundType (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_funds | Inclui 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) 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_type | Retorna uma mensagem com o objeto do serviço Fundos Comuns da entidade B6RT10 | fundType (string) 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_type | Altera 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) 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_type | Exclui 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) commitmentYear (string) required commitmentCode (string) required cnpjOrFundAnsRec (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/contractconsolidation_v1_100/get_contract_consolidation | Retorna uma mensagem com a coleção de objetos do serviço Agrupamento Contratos da entidade B8KT10 | riskPool (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_consolidation | Inclui 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) 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_pool | Retorna uma mensagem com o objeto do serviço Agrupamento Contratos da entidade B8KT10 | riskPool (string) 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_pool | Altera 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) 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_pool | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/controlledaffiliates_v1_100/get_controlled_affiliates | Retorna uma mensagem com a coleção de objetos do serviço Controladas Coligadas da entidade B8TT10 | legalEntityNatRegister (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required quantityOfActions (string) companyName (string) totalOfActionsOrQuota (string) typeOfShare (string) companyClassification (string) |
| central_de_obrigacoes___diops/controlledaffiliates_v1_100/post_controlled_affiliates | Inclui 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) 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_register | Retorna uma mensagem com o objeto do serviço Controladas Coligadas da entidade B8TT10 | legalEntityNatRegister (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/controlledaffiliates_v1_100/put_controlled_affiliates_by_legal_entity_nat_register | Altera 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) 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_register | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/coopercheckaccnt_v1_100/get_cooper_check_accnt | Retorna uma mensagem com a coleção de objetos do serviço Conta Corrente Cooperado da entidade BUWT10 | taxType (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_accnt | Inclui 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) 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_type | Retorna uma mensagem com o objeto do serviço Conta Corrente Cooperado da entidade BUWT10 | taxType (string) 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_type | Altera 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) 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_type | Exclui 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) 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_granted | Retorna uma mensagem com a coleção de objetos do serviço Contrap Corresp Cedida da entidade B36T10 | ansEventCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_granted | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Contrap Corresp Cedida da entidade B36T10 | ansEventCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/indemnifiableevents_v1_100/get_indemnifiable_events | Retorna uma mensagem com a coleção de objetos do serviço Eventos Indenizaveis da entidade B8LT10 | eventCodeAns (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_events | Inclui 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) 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_ans | Retorna uma mensagem com o objeto do serviço Eventos Indenizaveis da entidade B8LT10 | eventCodeAns (string) 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_ans | Altera 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) 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_ans | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/liabilityadequationtest_v1_100/get_liability_adequation_test | Retorna uma mensagem com a coleção de objetos do serviço Teste De Adequação Do Passivo da entidade B89T10 | planType (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_test | Inclui 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) 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_type | Retorna uma mensagem com o objeto do serviço Teste De Adequação Do Passivo da entidade B89T10 | planType (string) 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_type | Altera 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) 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_type | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/liabilitybalanceage_v1_100/get_liability_balance_age | Retorna uma mensagem com a coleção de objetos do serviço Idade Do Saldo Passivo da entidade B8GT10 | financialDueDate (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_age | Inclui 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) 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_date | Retorna uma mensagem com o objeto do serviço Idade Do Saldo Passivo da entidade B8GT10 | financialDueDate (string) 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_date | Altera 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) 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_date | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/liabilitytaxaccnt_v1_100/get_liability_tax_accnt | Retorna uma mensagem com a coleção de objetos do serviço Conta Tributo Passivo da entidade BUYT10 | accountCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_accnt | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Conta Tributo Passivo da entidade BUYT10 | accountCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentCode (string) required obligationCode (string) required providerRegister (string) required commitmentYear (string) required |
| central_de_obrigacoes___diops/listofcities_v1_100/get_list_of_cities | Retorna uma mensagem com a coleção de objetos do serviço Lista De Municipios da entidade B8WT10 | stateAcronym (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) ibgeCityCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/listofcities_v1_100/post_list_of_cities | Inclui 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) 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_acronym | Retorna uma mensagem com o objeto do serviço Lista De Municipios da entidade B8WT10 | stateAcronym (string) expand (string) fields (string) ibgeCityCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/listofcities_v1_100/put_list_of_cities_by_state_acronym | Altera 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) 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_acronym | Exclui 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) ibgeCityCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/obligations_v1_100/get_obligations | Retorna uma mensagem com a coleção de objetos do serviço Obrigacoes da entidade B3AT10 | obligationCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required obligationDescription (string) seasonality (string) obligationType (string) activeInactive (string) dueDateNotification (string) |
| central_de_obrigacoes___diops/obligations_v1_100/post_obligations | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Obrigacoes da entidade B3AT10 | obligationCode (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/obligations_v1_100/put_obligations_by_obligation_code | Altera 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) 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_code | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/operators_v1_100/get_operators | Retorna uma mensagem com a coleção de objetos do serviço Operadoras da entidade B8MT10 | operatorCnpj (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required operatorMode (string) legalNature (string) tradeName (string) corporateName (string) operatorSegmentation (string) |
| central_de_obrigacoes___diops/operators_v1_100/post_operators | Inclui 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) 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_cnpj | Retorna uma mensagem com o objeto do serviço Operadoras da entidade B8MT10 | operatorCnpj (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/operators_v1_100/put_operators_by_operator_cnpj | Altera 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) 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_cnpj | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/pecuniaryconsideration_v1_100/get_pecuniary_consideration | Retorna uma mensagem com a coleção de objetos do serviço Contraprestaes Pecunirias da entidade B37T10 | counterpartCoveragePeri (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_consideration | Inclui 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) 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_peri | Retorna uma mensagem com o objeto do serviço Contraprestaes Pecunirias da entidade B37T10 | counterpartCoveragePeri (string) 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_peri | Altera 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) 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_peri | Exclui 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) commitmentCode (string) required obligationCode (string) required providerRegister (string) required planType (string) required commitmentYear (string) required |
| central_de_obrigacoes___diops/personsresponsible_v1_100/get_persons_responsible | Retorna uma mensagem com a coleção de objetos do serviço Responsaveis da entidade B8YT10 | responsibilityType (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required cpfCnpj (string) required responsibleLeOrIndivid (string) required nameCorporateName (string) recordNumber (string) |
| central_de_obrigacoes___diops/personsresponsible_v1_100/post_persons_responsible | Inclui 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) 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_type | Retorna uma mensagem com o objeto do serviço Responsaveis da entidade B8YT10 | responsibilityType (string) 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_type | Altera 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) 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_type | Exclui 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) providerRegister (string) required cpfCnpj (string) required responsibleLeOrIndivid (string) required |
| central_de_obrigacoes___diops/premises_v1_100/get_premises | Retorna uma mensagem com a coleção de objetos do serviço Dependencias da entidade B8ZT10 | legalEntityNatRegister (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_premises | Inclui 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) 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_register | Retorna uma mensagem com o objeto do serviço Dependencias da entidade B8ZT10 | legalEntityNatRegister (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/premises_v1_100/put_premises_by_legal_entity_nat_register | Altera 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) 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_register | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/profitsandlosses_v1_100/get_profits_and_losses | Retorna uma mensagem com a coleção de objetos do serviço Lucros E Prejuizos da entidade B8ET10 | accountCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_losses | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Lucros E Prejuizos da entidade B8ET10 | accountCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/provnetsinevpesl_v1_100/get_prov_net_sin_ev_pesl | Retorna uma mensagem com a coleção de objetos do serviço Prov Eventos Sinistros a Liq da entidade B8JT10 | commitmentYear (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_pesl | Inclui 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) 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_year | Retorna uma mensagem com o objeto do serviço Prov Eventos Sinistros a Liq da entidade B8JT10 | commitmentYear (string) 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_year | Altera 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) 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_year | Exclui 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) commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/realestgarasset_v1_100/get_real_est_gar_asset | Retorna uma mensagem com a coleção de objetos do serviço Atv Gar Imobiliario da entidade B8CT10 | providerRegister (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_asset | Inclui 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) 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_register | Retorna uma mensagem com o objeto do serviço Atv Gar Imobiliario da entidade B8CT10 | providerRegister (string) 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_register | Altera 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) 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_register | Exclui 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) commitmentCode (string) required obligationCode (string) required realEstateGeneralRegis (string) required commitmentYear (string) required |
| central_de_obrigacoes___diops/representatives_v1_100/get_representatives | Retorna uma mensagem com a coleção de objetos do serviço Representatives da entidade B8NT10 | registrationOfIndividua (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_representatives | Inclui 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) 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_individua | Retorna uma mensagem com o objeto do serviço Representantes da entidade B8NT10 | registrationOfIndividua (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/representatives_v1_100/put_representatives_by_registration_of_individua | Altera 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) 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_individua | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/shareholders_v1_100/get_shareholders | Retorna uma mensagem com a coleção de objetos do serviço Acionistas Quotistas da entidade B8ST10 | shareholderSCpfCnpj (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) providerRegister (string) required corporateName (string) numberOfShares (string) shareholderType (string) |
| central_de_obrigacoes___diops/shareholders_v1_100/post_shareholders | Inclui 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) 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_cnpj | Retorna uma mensagem com o objeto do serviço Acionistas Quotistas da entidade B8ST10 | shareholderSCpfCnpj (string) expand (string) fields (string) providerRegister (string) required |
| central_de_obrigacoes___diops/shareholders_v1_100/put_shareholders_by_shareholder_scpf_cnpj | Altera 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) 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_cnpj | Exclui 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) providerRegister (string) required |
| central_de_obrigacoes___diops/stipulatedcontracts_v1_100/get_stipulated_contracts | Retorna uma mensagem com a coleção de objetos do serviço Contratos Estipulados da entidade BUPT10 | operatorRecordInAns (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_contracts | Inclui 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) 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_ans | Retorna uma mensagem com o objeto do serviço Contratos Estipulados da entidade BUPT10 | operatorRecordInAns (string) 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_ans | Altera 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) 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_ans | Exclui 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) 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_segr | Retorna uma mensagem com a coleção de objetos do serviço Segregação do Montante de Contraprestações a Repassar da entidade BVST10 | benefitAdmOperCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_segr | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Segregação do Montante de Contraprestações a Repassar da entidade BVST10 | benefitAdmOperCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___diops/trimesterbalancesheet_v1_100/get_trimester_balance_sheet | Retorna uma mensagem com a coleção de objetos do serviço Balancete Trimestral da entidade B8AT10 | accountCode (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_sheet | Inclui 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) 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_code | Retorna uma mensagem com o objeto do serviço Balancete Trimestral da entidade B8AT10 | accountCode (string) 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_code | Altera 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) 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_code | Exclui 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) commitmentYear (string) required commitmentCode (string) required obligationCode (string) required providerRegister (string) required |
| central_de_obrigacoes___dmed/analyticdmedexpenses_v1_100/get_analytic_dmed_expenses | Retorna uma mensagem com a coleção de objetos do serviço Analytic Dmed Expenses da entidade Analytic Dmed Expenses | expenseKey (string) page (integer) pageSize (integer) order (array) expand (string) fields (string) 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_expenses | Inclui 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) 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_key | Retorna uma mensagem com o objeto do serviço Analytic Dmed Expenses da entidade Analytic Dmed Expenses | expenseKey (string) 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_key | Altera 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) 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_key | Exclui 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) 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_info | Retorna lista completa de Perfis de Aprovação. | order (array) fields (string) page (integer) pageSize (integer) |
| logix/approvalprofile_v1_000/post_supply_approval_profile_info | Inclui um Perfil de Aprovador conforme dados enviados na requisição. | 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_code | Retorna um Perfil de Aprovador | code (string) order (array) fields (string) |
| logix/approvalprofile_v1_000/put_supply_approval_profile_info_by_code | Atualiza o Vlr. Minimo e Vlr. Maximo do Perfil de Aprovador conforme dados enviados na requisição. | code (string) 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_code | Exclui um Perfil de Aprovação conforme dados enviados na requisição. | code (string) |
| logix/approvalprofile_v2_000/get_approval_profile | Retorna lista completa de Perfis de Aprovação. | 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_profile | Inclui um Perfil de Aprovador conforme dados enviados na requisição. | fields (string) data (object) required |
| logix/approvalprofile_v2_000/get_approval_profile_by_code | Retorna um Perfil de Aprovador | code (string) order (array) fields (string) |
| logix/approvalprofile_v2_000/put_approval_profile_by_code | Altera o Perfil de Aprovação | code (string) fields (string) data (object) required |
| logix/approvalprofile_v2_000/delete_approval_profile_by_code | Exclui um Perfil de Aprovação conforme dados enviados na requisição. | code (string) |
| logix/buyers_v1_000/get_buyers | Retorna todos os Compradores do sistema | order (array) page (integer) pageSize (integer) fields (string) |
| logix/buyers_v1_000/post_buyers | Adiciona Comprador passado na requisição | data (object) required |
| logix/buyers_v1_000/get_buyers_by_buyer_id | Retorna o Comprador do sistema através de seu código | BuyerId (string) fields (string) |
| logix/buyers_v1_000/put_buyers_by_buyer_id | Altera o comprador passado na requisição | BuyerId (string) data (undefined) required |
| logix/buyers_v1_000/delete_buyers_by_buyer_id | Exclusão de Comprador da base | BuyerId (string) |
| logix/city_v1_000/get_city | Retorna lista completa de cidades | fields (string) order (array) page (integer) pageSize (integer) |
| logix/city_v1_000/post_city | Inclui uma cidade conforme dados enviados na requisição. | 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_id | Retorna os dados da cidade conforme o código informado na requisição | InternalId (string) fields (string) |
| logix/city_v1_000/put_city_by_internal_id | Atualiza cadastro da cidade conforme dados enviados na requisição | InternalId (string) 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_id | Exclui cadastro de cidade conforme dados enviados na requisição. | InternalId (string) |
| logix/country_v1_000/get_countries | Retorna lista completa de países | fields (string) order (array) page (integer) pageSize (integer) |
| logix/country_v1_000/post_countries | Inclui um novo País conforme dados enviados na requisição. | data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) } (object) required |
| logix/country_v1_000/get_countries_by_internal_id | Retorna os dados do País conforme o código informado na requisição | InternalId (string) fields (string) |
| logix/country_v1_000/put_countries_by_internal_id | Atualiza cadastro do País conforme dados enviados na requisição | InternalId (string) data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) } (object) required |
| logix/country_v1_000/delete_countries_by_internal_id | Exclui cadastro do País conforme dados enviados na requisição. | InternalId (string) |
| logix/currency_v1_000/get_currency | Retorna lista completa de moeda | order (array) page (integer) pageSize (integer) fields (string) |
| logix/currency_v1_000/post_currency | Inclui Moeda | 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_code | Retorna Moeda pelo seu código | Code (string) |
| logix/currency_v1_000/put_currency_by_code | Atualiza cadastro de Moeda conforme dados enviados na requisição | Code (string) 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_code | Exclui Moeda conforme dados enviados na requisição | Code (string) |
| logix/esocialaudit_v1_000/post_esocial_audit | Inclui a entidade evento passado na requisição | companyId (string) required order (array) page (integer) pageSize (integer) data (object) required |
| logix/esocialaudit_v1_000/get_esocial_audit_status | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| logix/esocialaudit_v1_000/get_esocial_audit_audit_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required status (string) page (integer) pageSize (integer) |
| logix/esocialaudit_v1_000/get_esocial_audit_chart_values | Retorna lista de eventos dentro/fora do prazo para transmissão do governo | companyId (string) required requestId (string) required |
| logix/esocialbranches_v1_000/get_esocial_branches | Retorna o código da empresa e código da filial no TAF | companyId (string) required order (array) page (integer) pageSize (integer) |
| logix/esocialestablishment_v1_000/get_esocial_establishment | Retorna lista completa com os Estabelecimentos Cadastrados | companyId (string) required order (array) page (integer) pageSize (integer) |
| logix/esocialevents_v1_000/get_esocial_events | Retorna a lista de eventos do TAF | companyId (string) required eventsCheckPermissions (string) |
| logix/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process | Carrega registros do evento S-5503, filtrados ou não, ordenados ou não. | No parameters |
| logix/fgtsperworkerinlaborprocess_v1_000/delete_fgtsper_worker_in_labor_process | Exclui 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_xml | Retorna XML's do evento S-5503 encodados em base64 | data: { . companyId (string) . id (array) } (object) required |
| logix/fgtsperworkerinlaborprocess_v1_000/get_fgtsper_worker_in_labor_process_worker_registration_and_category | Carrega 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_amounts | Carrega 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ão | No parameters |
| logix/gpeesocialmotives_v1_000/get_esocial_motives | Retorna lista completa com os motivos de afastamento | companyId (string) required order (array) page (integer) pageSize (integer) |
| logix/inventorycounts_v1_000/get_inventory_counts | Retorna uma ou mais de fichas de inventário conforme parâmetros recebidos | companyCode (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_counts | Geraçã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 PUT | data: { . 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_id | Retorna uma ficha de inventário correspondente ao número informado | internalId (string) fields (string) |
| logix/inventorycounts_v1_000/put_inventory_counts_by_internal_id | Mé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 POST | internalId (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_id | Elimina a ficha de inventário pelo número e data de saldo | internalId (string) |
| logix/inventorycounts_v1_000/post_inventory_counts_by_internal_id_reset_counts | Método responsável pela eliminação das contagens. Contagens voltam ao estado inicial | internalId (string) |
| logix/itemsku_v2_000/post_item_sku | Inclui um Item e seus respectivos SKUs | 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_code | Altera o Item/SKU | Code (string) code (string) 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_forms | Retorna lista completa formulários do Apontamento de Produção Mobile | order (array) page (integer) pageSize (integer) fields (string) CompanyId (string) code (string) appointmentType (string) user (string) userGroup (string) |
| logix/mobileforms_v2_000/post_mobile_forms | Inclui um formulário de Apontamento de Produção Mobile | 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_code | Exclui formulário do Apontamento de Produção Mobile cadastrado conforme dados enviados na requisição | companyId (string) code (string) |
| logix/mobileforms_v2_000/put_mobile_forms_by_company_id_by_code | Atualiza cadastro de formulário do Apontamento de Produção Mobile conforme dados enviados na requisição | companyId (string) code (string) data: { . CompanyId (string) . code (string) . description (string) . appointmentType (string) . iconName (string) . ListOfFormFields (array) . ListOfFormUsers (array) } (object) required |
| logix/paymentcondition_v1_00/get_paymentcondition | Retorna lista completa das condições de pagamento | order (array) page (integer) pageSize (integer) fields (string) |
| logix/paymentcondition_v1_00/post_paymentcondition | Inclui uma condição de pagamento conforme dados enviados na requisição. | 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_id | Retorna a condição de pagamento pelo InternalId | InternalId (string) fields (string) |
| logix/paymentcondition_v1_00/put_paymentcondition_by_internal_id | Atualiza a condição de pagamento conforme dados enviados na requisição | InternalId (string) 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_id | Exclui a condição de pagamento conforme dados enviados na requisição. | InternalId (string) |
| logix/productsupplierrelationship_v1_000/get_product_supplier_relationship | Retorna lista completa de relacionamentos entre Produtos e Fornecedores | order (array) page (integer) pageSize (integer) fields (string) |
| logix/productsupplierrelationship_v1_000/post_product_supplier_relationship | Inclui um relacionamento entre Produto e Fornecedor | 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_id | Retorna um registro de relacionamento de Produto e Fornecedor | InternalId (string) |
| logix/productsupplierrelationship_v1_000/put_product_supplier_relationship_by_internal_id | Atualiza um registro de relacionamento de Produto e Fornecedor | InternalId (string) 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_id | Exclui um registro de relacionamento de produto e Fornecedor conforme dados enviados na requisição | InternalId (string) |
| logix/productionappointment_v2_000/get_productionappointment | Retorna o Apontamento de Produção | order (array) page (integer) pageSize (integer) fields (string) company (string) required productionordernumber (string) required appointmenttype (string) required |
| logix/productionappointment_v2_000/post_productionappointment | Inclui um formulário de Apontamento de Produção Mobile | 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_order | Inclui ou atualiza uma ordem de produção | data (undefined) required |
| logix/quotation_v1_000/get_quotation | Buscas as cotações | page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/quotation_v1_000/post_quotation | Inclui uma cotação para uma ordem de compra | 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/get_quotation_by_internal_id | Pesquisa as cotações de uma determinada ordem de compra | InternalId (string) order (array) page (integer) pageSize (integer) fields (string) expand (string) |
| logix/quotation_v1_000/put_quotation_by_internal_id | Modifica a cotação de uma determinada ordem de compra | InternalId (string) 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_id | Exclui a cotação de uma determinada ordem de compra | InternalId (string) |
| logix/quotation_v1_000/get_quotation_by_internal_id_quotation_item_type_by_item_code | Pesquisa a cotação de um determinado item. | InternalId (string) ItemCode (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/quotation_v1_000/put_quotation_by_internal_id_quotation_item_type_by_item_code | Modifica os dados de um item da cotação de Compra | InternalId (string) ItemCode (string) 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_code | Exclui os dados do item de uma cotação de Compra | InternalId (string) ItemCode (string) |
| logix/quotation_v1_000/put_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id | Modifica uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) 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_id | Exclui uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) |
| logix/quotation_v1_000/get_quotation_by_internal_id_quotation_proposal_type_by_proposal_internal_id_list_of_taxes_document | Pesquisa as taxas de desconto/acrescimos de uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) 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_document | Inclui taxas desconto/acrescimos de uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) 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_id | Modifica uma taxa desconto ou acrescimo de uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) taxesInternalId (string) 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_id | Exclui uma taxa desconto ou acrescimo de uma cotação de uma ordem de compra | InternalId (string) ProposalInternalId (string) taxesInternalId (string) |
| logix/quotation_v1_000/get_quotation_by_internal_id_deliverys_schedule | Pesquisa as programações de entrega de uma ordem de compra | InternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/quotation_v1_000/post_quotation_by_internal_id_deliverys_schedule | Inclui a programação de entrega de uma ordem de compra | InternalId (string) Accept-Language (string) data (array) required |
| logix/quotation_v1_000/get_quotation_by_internal_id_deliverys_schedule_by_delivery_id | Pesquisa uma programação de entrega de uma ordem de compra | InternalId (string) DeliveryID (number) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/quotation_v1_000/put_quotation_by_internal_id_deliverys_schedule_by_delivery_id | Modifica uma programação de entrega de uma ordem de compra | InternalId (string) DeliveryID (number) 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_id | Exclui uma programação de entrega de uma ordem de compra | InternalId (string) DeliveryID (number) |
| logix/quotation_v1_000/get_quotation_by_item_by_item_code_quotation_proposal_type | Pesquisa as cotações de um determinado item | ItemCode (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/quotation_v1_000/post_quotation_by_item_by_item_code_quotation_proposal_type | Inclui uma cotação para um determinado item | ItemCode (string) 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_id | Pesquisa uma cotação de um determinado item | ItemCode (string) ProposalInternalId (string) 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_id | Modifica a cotação de uma determinada ordem de compra | ItemCode (string) ProposalInternalId (string) 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_id | Exclui a cotação de uma determinada ordem de compra | ItemCode (string) ProposalInternalId (string) |
| 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_id | Modifica uma taxa desconto ou acrescimo de uma cotação de um item | ItemCode (string) ProposalInternalId (string) taxesInternalId (string) 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_id | Exclui uma taxa desconto ou acrescimo de uma cotação de um item | ItemCode (string) ProposalInternalId (string) taxesInternalId (string) |
| logix/request_v1_000/get_request | Pesquisa as Solicitações de Compra | RequestInternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) CompanyId (string) |
| logix/request_v1_000/post_request | Inclui uma Solicitação de Compra | Accept-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_id | Pesquisa uma Solicitação de Compra | RequestInternalId (string) fields (string) expand (string) |
| logix/request_v1_000/put_request_by_request_internal_id | Modifica uma Solicitação de Compra | RequestInternalId (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_id | Exclui uma Solicitação de Compra | RequestInternalId (string) |
| logix/request_v1_000/get_request_by_request_internal_id_request_item | Pesquisa os dados de vários itens de uma Solicitação de Compra | RequestInternalId (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_id | Pesquisa os dados de um item de uma Solicitação de Compra | RequestInternalId (string) ItemInternalId (string) fields (string) expand (string) |
| logix/request_v1_000/put_request_by_request_internal_id_request_item_by_item_internal_id | Modifica os dados de um Item da Solicitação de Compra | RequestInternalId (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_id | Exclui os dados do item de uma Solicitação de Compra | ItemInternalId (string) RequestInternalId (string) |
| logix/request_v1_000/get_request_by_request_internal_id_delivery_schedule | Pesquisa as Programações de Entrega da Solicitação de Compra | RequestInternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/request_v1_000/post_request_by_request_internal_id_delivery_schedule | Inclui as Programações de Entrega da Solicitação de Compra | RequestInternalId (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_id | Busca os dados de uma programação de entrega de uma Solicitação de Compra | RequestInternalId (string) DeliveryID (integer) fields (string) expand (string) |
| logix/request_v1_000/put_request_by_request_internal_id_delivery_schedule_by_delivery_id | Modifica uma programação de entrega de uma Solicitação de Compra | RequestInternalId (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_id | Exclui os dados de uma programação de entrega da Solicitação de Compra | RequestInternalId (string) DeliveryID (integer) |
| logix/request_v1_000/get_request_by_request_internal_id_apportion_request_item | Pesquisa os dados do rateio contábil da Solicitação de Compra | RequestInternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/request_v1_000/post_request_by_request_internal_id_apportion_request_item | Inclui o Rateio contábil da Solicitação de Compra | RequestInternalId (string) Accept-Language (string) data (array) required |
| logix/request_v1_000/get_request_by_request_internal_id_apportion_request_item_by_internal_id | Busca os dados de um rateio contábil de uma Solicitação de Compra | RequestInternalId (string) InternalId (string) fields (string) expand (string) |
| logix/request_v1_000/put_request_by_request_internal_id_apportion_request_item_by_internal_id | Modifica um rateio contábil de uma Solicitação de Compra | RequestInternalId (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_id | Exclui os dados de um rateio contábil da Solicitação de Compra | RequestInternalId (string) InternalId (string) |
| logix/request_v1_000/get_request_by_request_internal_id_list_by_item_grids | Pesquisa os dados da grade do item da Solicitação de Compra | RequestInternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/request_v1_000/get_request_by_request_internal_id_list_by_material_order | Pesquisa os dados dos componentes do item da Solicitação de Compra | RequestInternalId (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) |
| logix/state_v1_000/get_states | Retorna lista completa de estados | fields (string) order (array) page (integer) pageSize (integer) |
| logix/state_v1_000/post_states | Inclui um novo Estado conforme dados enviados na requisição. | data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) . Country (string) } (object) required |
| logix/state_v1_000/get_states_by_internal_id | Retorna os dados do Estado conforme o código informado na requisição | InternalId (string) fields (string) |
| logix/state_v1_000/put_states_by_internal_id | Atualiza cadastro do Estado conforme dados enviados na requisição | InternalId (string) data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) . Country (string) } (object) required |
| logix/state_v1_000/delete_states_by_internal_id | Exclui cadastro do Estado conforme dados enviados na requisição. | InternalId (string) |
| logix/unitmeasurementconversion_v2_000/get_unit_measurement_conversions | Recovers a list of entities | page (integer) pageSize (integer) fields (string) order (array) |
| logix/unitmeasurementconversion_v2_000/post_unit_measurement_conversions | Inserts a list of entities | Accept-Language (string) data (array) required |
| logix/unitmeasurementconversion_v2_000/post_unit_measurement_conversions_convert | Performs conversion of value between units of measurement | Accept-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_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| logix/unitmeasurementconversion_v2_000/put_measurement_v1_unit_measurement_conversions_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| logix/unitmeasurementconversion_v2_000/get_unit_measurement_conversions_by_internal_id | Retorna uma lista de fatores de conversão do item | internalId (string) fields (string) order (array) |
| logix/unitmeasurementconversion_v2_000/put_unit_measurement_conversions_by_internal_id | Atualiza fatores de conversão do item. | internalId (string) 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_id | Exclui fatores de conversão do item. | internalId (string) |
| logix/unitofmeasure_v2_000/get_unit_of_measures | Retorna lista completa de Unidade de Medida | order (array) page (integer) pageSize (integer) fields (string) |
| logix/unitofmeasure_v2_000/post_unit_of_measures | Inclui uma Unidade de Medida | data: { . Code (string) . InternalId (string) . Description (string) . ShortName (string) } (object) required |
| logix/unitofmeasure_v2_000/get_unit_of_measures_by_code | Retorna Unidade de Medida pelo seu Código | Code (string) |
| logix/unitofmeasure_v2_000/put_unit_of_measures_by_code | Atualiza cadastro de Unidade de Medida conforme dados enviados na requisição | Code (string) data: { . Code (string) . InternalId (string) . Description (string) . ShortName (string) } (object) required |
| logix/unitofmeasure_v2_000/delete_unit_of_measures_by_code | Exclui Unidade de Medida cadastrada conforme dados enviados na requisição | Code (string) |
| logix/urbanocoletor_v1_000/post_coletor_urbano | Inclui informações do coletor na prestação de contas | data (object) required |
| sara/armazenagemcarganaodesunitizada_v1_000/get_carga_nao_desunitizada | Conforme 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_xls | Geraçã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_rfb | Retorna informações do caixa de mensagens trocadas entre o estabelecimento e a RFB | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/consolidacaodesconsolidacaolotecarga_v1_000/get_consolidacao_desconsolidacao_lote_carga | Conforme ADE parágrafo 2.2.3 - 1.8 Consolidação e Desconsolidação de lote carga | order (array) page (integer) pageSize (integer) NumeroConhecimento (string) idLote (string) |
| sara/consolidacaodesconsolidacaolotecarga_v1_000/get_consolidacao_desconsolidacao_lote_carga_xls | Geração de arquivo .xls - Consolidação e Desconsolidação de Lote de Carga. | order (array) page (integer) pageSize (integer) idLote (string) NumeroConhecimento (string) |
| sara/conteudonotafiscal_v1_000/get_conteudo_nota_fiscal | ADE 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 Fiscal | order (array) page (integer) pageSize (integer) numeroNotaFiscal (string) idTipoNotaFiscal (integer) |
| sara/conteudonotafiscal_v1_000/get_conteudo_nota_fiscal_xls | Conforme 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=3193 | order (array) page (integer) pageSize (integer) numeroNotaFiscal (string) idTipoNotaFiscal (integer) |
| sara/desunitizacaocarga_v2_000/get_desunitizacao_carga | Conforme ADE parágrafo 2.2.3 - 1.6 Desunitização de carga | order (array) page (integer) pageSize (integer) idLoteConhecimento (string) idLote (string) |
| sara/desunitizacaocarga_v2_000/get_desunitizacao_carga_xls | Geração de arquivo .xls - Desunitização de carga | order (array) page (integer) pageSize (integer) idLoteConhecimento (string) idLote (string) |
| sara/desunitizacaoobjetodesunitizacao_v2_000/get_historico_desunitizacao_lote | ADE 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 Lotes | order (array) page (integer) pageSize (integer) dataInicio (string) dataFinal (string) tipoHistorico (integer) |
| sara/desunitizacaoobjetodesunitizacao_v2_000/get_historico_desunitizacao_lote_xls | Geração de arquivo .xls - Histórico Desunitização Lotes | order (array) page (integer) pageSize (integer) dataInicio (string) dataFinal (string) tipoHistorico (integer) |
| sara/entradasaidalotecarga_v2_000/get_entrada_saida_lote_carga | Conforme ADE parágrafo 2.2.3 - Anexo 1.3 - Entrada e saída de lote de carga | 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_xls | Geração de arquivo .xls - Entrada e saída de Lote de Carga. | 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_pessoas | Conforme 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_xls | Geraçã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_veiculos | Conforme ADE parágrafo 2.2.3 - Anexo 1.2 - Entrada e 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/entradasaidaveiculos_v2_000/get_entrada_saida_veiculos_xls | Geraçã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_a | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta A | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idVeiculo (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_b | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta B | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idTransportadora (integer) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_c | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idPessoa (integer) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_d | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idPais (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_e | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_f | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_g | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_h | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idConteiner (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_i | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_j | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/histmovveicnt_v2_000/get_hist_mov_vei_cnt_l | Consulta RFB - Estruturada - Histórico de Movimentação de Veículos e Contêineres - Consulta L | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idAgrupador (integer) |
| sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_a | Consulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / a Lotes que entraram por período. | order (array) page (integer) pageSize (integer) dataInicio (string) required dataFim (string) required |
| sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_b | Consulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / b Lotes que sairam por período. | order (array) page (integer) pageSize (integer) dataInicio (string) required dataFim (string) required |
| sara/historicomovimentacaocargas_v2_000/get_rfb_consultas_estruturadas_v2_historico_movimentacao_cargas_c | Consulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / c Lotes que entraram por período e consignatário. | 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_d | Consulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas - d Lotes que sairam por período e remetente. | 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_e | Consulta RFB - Estruturada - 2.2.7 - Histórico de movimentação de cargas / e Lotes que entraram por período, regime e consignatário. | order (array) page (integer) pageSize (integer) dataInicio (string) required dataFim (string) required idRegime (integer) benId (string) |
| sara/historicomovimentacaopessoas_v2_000/get_historico_movimentacao_pessoas | ADE 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.get | 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_xls | Geração de arquivo .xls - Histórico de movimentação de pessoas. | 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_a | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta A | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idLote (integer) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_b | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta B | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idDocSai (integer) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_c | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) numeroConhec (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_d | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta D | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idLote (integer) tipoDocConhec (string) numeroConhec (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_e | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta E | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idBen (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_f | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta F | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idVeiculo (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_g | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta G | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_h | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta H | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) idConteiner (integer) idVeiculo (string) |
| sara/movimentacaoarmcarga_v2_000/get_movimentacao_arm_carga_i | Consulta RFB - Estruturada - Movimentação e Armazenagem de Carga - Consulta I | order (array) page (integer) pageSize (integer) dataInicial (string) dataFinal (string) numeroConhec (string) |
| sara/mudancasituacaoaduaneiralotecarga_v2_000/get_mudanca_situacao_aduaneira_lote | ADE 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 Carga | order (array) page (integer) pageSize (integer) idLote (string) numeroConhecimento (string) |
| sara/mudancasituacaoaduaneiralotecarga_v2_000/get_mudanca_situacao_aduaneira_lote_xls | Geraçã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_a | ADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta A | order (array) page (integer) pageSize (integer) dataInicial (string) |
| sara/prazopermanencia_v2_000/get_prazo_permanencia_b | ADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta B | order (array) page (integer) pageSize (integer) dataInicial (string) |
| sara/prazopermanencia_v2_000/get_prazo_permanencia_c | ADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta C | order (array) page (integer) pageSize (integer) dataInicial (string) |
| sara/prazopermanencia_v2_000/get_prazo_permanencia_d | ADE COANA/COTEC N°2 DE 26 de setembro de 2003, seção 2.2 Consulta Estruturada, item 2.2.9 - Prazo Permanência consulta D | order (array) page (integer) pageSize (integer) dataInicial (string) |
| sara/registroavariasperdasfurtosroubosoutrasocorrencias_v2_000/get_registro_avarias_perdas_furtos_roubos_outras_ocorrencias | ADE 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ências | order (array) page (integer) pageSize (integer) numeroConhecimento (string) idLote (string) |
| sara/registroavariasperdasfurtosroubosoutrasocorrencias_v2_000/get_restregistro_avarias_perdas_furtos_roubos_outras_ocorrencias_xls | Geração de arquivo .xls - Registro de avarias, perdas, furtos, roubos e outras ocorrências. | order (array) page (integer) pageSize (integer) numeroConhecimento (string) idLote (string) |
| sara/registromudancaregimeaduaneiro_v2_000/get_registro_mudanca_regime_aduaneiro | ADE 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 aduaneiro | order (array) page (integer) pageSize (integer) idLote (string) dataInicial (string) dataFinal (string) |
| sara/registromudancaregimeaduaneiro_v2_000/get_registro_mudanca_regime_aduaneiro_xls | Geraçã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_fiscal | Conforme ADE parágrafo 2.2.3 - Anexo 1.4 - Relação Nota Fiscal. | order (array) page (integer) pageSize (integer) ConhecimentoLote (string) RelacaoNotaFiscal (string) notaFiscal (string) |
| sara/relacaonotasfiscais_v2_000/get_relacao_nota_fisca_l_xls | Geração de arquivo .xls - Relação de Nota Fiscal. | order (array) page (integer) pageSize (integer) ConhecimentoLote (string) RelacaoNotaFiscal (string) notaFiscal (string) |
| sara/relacaotransferenciamercadorias_v2_000/get_relacao_transferencia_mercadorias | ADE 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. | order (array) page (integer) pageSize (integer) idConhecimentoLote (string) required idLote (string) required |
| sara/relacaotransferenciamercadorias_v2_000/get_relacao_transferencia_mercadorias_xls | Geração de arquivo .xls - Relação de Transferência de Mercadorias RTM. | order (array) page (integer) pageSize (integer) idConhecimentoLote (string) required idLote (string) required |
| sara/situacaolotecargaverificacao_v2_000/get_situacao_lote_carga_verificacao | ADE 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_xls | Geraçã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_armazenagem | Conforme 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_xls | Geraçã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_carga | Conforme ADE parágrafo 2.2.3 - Anexo 1.7 - Unitização de lote de carga | order (array) page (integer) pageSize (integer) idLote (string) NumeroConhecimento (string) |
| sara/unitizacaolotecarga_v1_000/get_unitizacao_lote_carga_xls | Geração de arquivo .xls - Unitização de Lote de Carga. | order (array) page (integer) pageSize (integer) idLote (string) NumeroConhecimento (string) |
| hat/attendancelocation_v1_100/post_attendance_locations | Permite a inclusão e alteração de locais de atendimento de prestadores da operadora. | Expires_at (string) required healthInsurerId (string) required data: { . healthInsurerId (string) . ansRegistry (string) . locations (array) } (object) required |
| hat/auditing_v1_100/post_auditing | Recebe a resposta do processo de auditoria e atualiza as guias de atendimento. Pode ser enviado um lote de guias. | Expires_at (string) required data (undefined) required |
| hat/authorization_v1_100/get_authorizations | Retorna 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/b | page (integer) pageSize (integer) order (array) expand (string) fields (string) Expires_at (string) required authStatus (string) authType (number) required dateFrom (string) dateTo (string) healthProviderId (string) attendanceLocation (string) authNumber (string) |
| hat/authorization_v1_100/post_authorizations | Insere 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ído | 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_insurer | Retorna uma mensagem com a guia de atendimento informada no parametro idOnHealthInsurer | idOnHealthInsurer (integer) Expires_at (string) required expand (string) fields (string) |
| hat/authorization_v1_100/post_authorizations_by_id_on_health_insurer_cancel | Efetua o cancelamento de uma guia incluída pelo prestador. | idOnHealthInsurer (integer) data: { . authorizationsToCancel (array) } (object) required |
| hat/healthcareuser_v1_000/get_health_care_users | Retorna 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 CBOS | page (integer) pageSize (integer) order (array) fields (string) Expires_at (string) required |
| hat/healthcareuser_v1_000/post_health_care_users | Realiza a inclusão de um usuário conforme body da requisição. | 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_id | Retorna um usuário de acordo com o código informado | id (string) expand (string) Expires_at (string) required |
| hat/healthcareuser_v1_000/put_health_care_users_by_id | Altera informações do usuário de acordo com o ID informado | id (string) 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_fields | Retorna os campos obrigatorios de um formulario de acordo com o tipo de atendimento | healthInsurerId (integer) page (integer) pageSize (integer) order (array) Expires_at (string) required formType (string) |
| hat/healthinsurer_v1_100/post_health_insurers_by_health_insurer_id_generate_protocol | Gera um numero de protocolo de atendimento | healthInsurerId (integer) Expires_at (string) required |
| hat/healthproviderspecialty_v1_100/post_health_provider_specialties | Permite 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. | Expires_at (string) required data: { . healthInsurerId (string) . ansRegistry (string) . specialties (array) } (object) required |
| hat/healthproviderstatus_v1_100/post_health_provider_status | Permite o bloqueio e desbloqueio de prestadores da operadora. | 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_specialties | Retorna as especialidades que o prestador informado pode atender | healthProviderId (integer) page (integer) pageSize (integer) order (array) Expires_at (string) required |
| hat/healthprovider_v1_100/post_health_providers | Permite a inclusão e alteração de prestadores da operadora. | Expires_at (string) required data: { . healthInsurerId (string) . ansRegistry (string) . providers (array) } (object) required |
| hat/preexistingdisease_v2_000/post_pre_existing_diseases | Permite a inclusao de doencas pre-existentes para o beneficiario informado no cabecalho da integração. | Expires_at (string) required data: { . healthInsurerId (string) . ansRegistry (string) . diseases (array) } (object) required |
| hat/procedure_v1_100/get_procedures | Retorna uma mensagem do tipo cole com os procedimentos. Os resultados podem ser filtrados atraves dos parametros procedureId e tableCode | page (integer) pageSize (integer) order (array) expand (string) fields (string) Expires_at (string) required procedureId (string) tableCode (string) procedureCode (string) |
| hat/procedure_v1_100/get_procedures_by_procedure_id | Retorna uma mensagem com os dados de um procedimentos | procedureId (string) |
| hat/procedure_v1_100/post_procedures_by_procedure_id_check_coverage | O 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 concluido | procedureId (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_professionals | Retorna um lote de profissional de acordo com os parametros enviados. É possivel filtrar o resultado através de todas as propriedades com excessão do CBOS | order (array) page (integer) pageSize (integer) expand (string) expires_at (string) |
| hat/professional_v1_000/post_professionals | Realiza a inclusão de um profissional conforme body da requisição. | expand (string) fields (string) expires_at (string) data (undefined) required |
| hat/professional_v1_000/get_professionals_by_id_on_health_insurer | Retorna um profissional de acordo com o ID informado | idOnHealthInsurer (string) fields (string) expand (string) expires_at (string) |
| hat/professional_v1_000/put_professionals_by_id_on_health_insurer | Altera informações do profissional de acordo com o ID informado | idOnHealthInsurer (string) 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_insurer | Deleta um profissional conforme ID enviado. | idOnHealthInsurer (string) expires_at (string) healthInsurerCode (integer) |
| agriapi/basequantity_v1_000/get_base_quantities | Recovers a list of enumeration values | order (array) page (integer) pageSize (integer) Accept-Language (string) |
| agriapi/baseunitmeasurement_v1_000/get_base_unit_measurements | Recovers a list of entities | order (array) page (integer) pageSize (integer) Accept-Language (string) code (string) description (string) |
| agriapi/baseunitmeasurement_v1_000/post_base_unit_measurements | Inserts a list of entities | Accept-Language (string) data (undefined) required |
| agriapi/baseunitmeasurement_v1_000/get_base_unit_measurements_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/baseunitmeasurement_v1_000/put_base_unit_measurements_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/biome_v1_000/get_biomes | Recovers a list of entities | order (array) page (integer) pageSize (integer) Accept-Language (string) fields (string) expand (string) code (string) description (string) |
| agriapi/biome_v1_000/post_biomes | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/biome_v1_000/get_biomes_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/biome_v1_000/put_biomes_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/climateelement_v1_000/get_climate_elements | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/climateelement_v1_000/post_climate_elements | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/climateelement_v1_000/get_climate_elements_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/climateelement_v1_000/put_climate_elements_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/climatefactor_v1_000/get_climate_factors | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/climatefactor_v1_000/post_climate_factors | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/climatefactor_v1_000/get_climate_factors_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/climatefactor_v1_000/put_climate_factors_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/climatezone_v1_000/get_climate_zones | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/climatezone_v1_000/post_climate_zones | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/climatezone_v1_000/get_climate_zones_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/climatezone_v1_000/put_climate_zones_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/climate_v1_000/get_climates | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/climate_v1_000/post_climates | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/climate_v1_000/get_climates_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/climate_v1_000/put_climates_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/costcentertype_v1_000/get_cost_center_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/costcentertype_v1_000/post_cost_center_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/costcentertype_v1_000/get_cost_center_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/costcentertype_v1_000/put_cost_center_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentavailabilitytype_v1_000/get_equipment_availability_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmentavailabilitytype_v1_000/post_equipment_availability_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmentavailabilitytype_v1_000/get_equipment_availability_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentavailabilitytype_v1_000/put_equipment_availability_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentbrand_v1_000/get_equipment_brands | Retorna dados de situação do beneficiário | Accept-Language (string) page (integer) pageSize (integer) fields (string) order (array) expand (string) code (string) description (string) |
| agriapi/equipmentbrand_v1_000/post_equipment_brands | Entities to be inserted | Accept-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_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentbrand_v1_000/put_equipment_brands_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentidentificationtype_v1_000/get_equipment_identification_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmentidentificationtype_v1_000/post_equipment_identification_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmentidentificationtype_v1_000/get_equipment_identification_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentidentificationtype_v1_000/put_equipment_identification_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentmodality_v1_000/get_equipment_modalities | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmentmodality_v1_000/post_equipment_modalities | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmentmodality_v1_000/get_equipment_modalities_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentmodality_v1_000/put_equipment_modalities_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentmodel_v1_000/get_equipment_models | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmentmodel_v1_000/post_equipment_models | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmentmodel_v1_000/get_equipment_models_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentmodel_v1_000/put_equipment_models_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmentresourcetype_v1_000/get_equipment_resource_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmentresourcetype_v1_000/post_equipment_resource_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmentresourcetype_v1_000/get_equipment_resource_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmentresourcetype_v1_000/put_equipment_resource_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/equipmenttype_v1_000/get_equipment_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/equipmenttype_v1_000/post_equipment_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/equipmenttype_v1_000/get_equipment_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/equipmenttype_v1_000/put_equipment_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/fueltype_v2_000/get_fuel_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/fueltype_v2_000/post_fuel_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/fueltype_v2_000/get_fuel_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/fueltype_v2_000/put_fuel_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/geoservice_v1_000/post_geo_services | Performs a geodata service | Accept-Language (string) service (string) required data (string) required |
| agriapi/humidityclassification_v1_000/get_humidity_classifications | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/humidityclassification_v1_000/post_humidity_classifications | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/humidityclassification_v1_000/get_humidity_classifications_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/humidityclassification_v1_000/put_humidity_classifications_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/humiditydistributionclassification_v1_000/get_humidity_distribution_classifications | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/humiditydistributionclassification_v1_000/post_humidity_distribution_classifications | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/humiditydistributionclassification_v1_000/get_humidity_distribution_classifications_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/humiditydistributionclassification_v1_000/put_humidity_distribution_classifications_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/machineryclassification_v1_000/get_machinery_classifications | Recupera um conjunto de registros de classificação de máquinas | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/machineryclassification_v1_000/post_machinery_classifications | Adicionar lista de classificação de máquinas | Accept-Language (string) data (array) required |
| agriapi/machineryclassification_v1_000/get_machinery_classifications_by_id | Retorna 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_id | Atualiza 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_id | Exclui 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_classes | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operationclass_v1_000/post_operation_classes | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operationclass_v1_000/get_operation_classes_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operationclass_v1_000/put_operation_classes_by_id | Updates a entity with identifier | id (string) Accept-Language (string) data (object) required |
| agriapi/operationclass_v1_000/delete_operation_classes_by_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operationgroup_v1_000/get_operation_groups | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operationgroup_v1_000/post_operation_groups | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operationgroup_v1_000/get_operation_groups_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operationgroup_v1_000/put_operation_groups_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operationtype_v1_000/get_operation_types | Recovers a list of entities | Accept-Language (string) order (array) page (integer) pageSize (integer) fields (string) expand (string) code (string) description (string) |
| agriapi/operationtype_v1_000/post_operation_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operationtype_v1_000/get_operation_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operationtype_v1_000/put_operation_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operation_v1_000/get_operations | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operation_v1_000/post_operations | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operation_v1_000/get_operation_v1_operations_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operation_v1_000/put_operation_v1_operations_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operationalcategory_v2_000/get_operational_categories | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operationalcategory_v2_000/post_operational_categories | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operationalcategory_v2_000/get_operational_categories_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operationalcategory_v2_000/put_operational_categories_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operativegroup_v1_000/get_operative_groups | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) Code (string) description (string) |
| agriapi/operativegroup_v1_000/post_operative_groups | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operativegroup_v1_000/get_operative_groups_by_code | Recovers a specific entity with identifier | Code (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operativegroup_v1_000/put_operative_groups_by_code | Updates a entity with identifier | Code (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_code | Removes a entity with identifier | Code (string) Accept-Language (string) |
| agriapi/operativegroup_v2_000/get_operative_groups | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operativegroup_v2_000/post_operative_groups | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/operativegroup_v2_000/get_operative_groups_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operativegroup_v2_000/put_operative_groups_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/operatortype_v1_000/get_prioritization_classes | Recupera um conjunto de registros | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/operatortype_v1_000/post_prioritization_classes | Adicionar lista de registros. | Accept-Language (string) data (array) required |
| agriapi/operatortype_v1_000/get_prioritization_classes_by_id | Retorna registro de acordo com o Id informado. | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/operatortype_v1_000/put_prioritization_classes_by_id | Atualiza 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_id | Exclui o registro existente, identificado a partir do Id informado. | id (string) Accept-Language (string) |
| agriapi/plantevent_v1_000/get_plant_events | Recupera um conjunto de registros | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/plantevent_v1_000/post_plant_events | Adicionar lista de registros. | Accept-Language (string) data (array) required |
| agriapi/plantevent_v1_000/get_plant_events_by_id | Retorna registro de acordo com o Id informado. | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/plantevent_v1_000/put_plant_events_by_id | Atualiza 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_id | Exclui o registro existente, identificado a partir do Id informado. | id (string) Accept-Language (string) |
| agriapi/plantsituation_v1_000/get_plant_situations | Recupera um conjunto de registros | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/plantsituation_v1_000/post_plant_situations | Adicionar lista de registros. | Accept-Language (string) data (array) required |
| agriapi/plantsituation_v1_000/get_plant_situations_by_id | Retorna registro de acordo com o Id informado. | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/plantsituation_v1_000/put_plant_situations_by_id | Atualiza 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_id | Exclui o registro existente, identificado a partir do Id informado. | id (string) Accept-Language (string) |
| agriapi/powerclass_v1_000/get_power_classes | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/powerclass_v1_000/post_power_classes | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/powerclass_v1_000/get_power_classes_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/powerclass_v1_000/put_power_classes_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/prioritizationclass_v1_000/get_prioritization_classes | Recupera um conjunto de registros | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/prioritizationclass_v1_000/post_prioritization_classes | Adicionar lista de registros. | Accept-Language (string) data (array) required |
| agriapi/prioritizationclass_v1_000/get_prioritization_classes_by_id | Retorna registro de acordo com o Id informado. | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/prioritizationclass_v1_000/put_prioritization_classes_by_id | Atualiza 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_id | Exclui o registro existente, identificado a partir do Id informado. | id (string) Accept-Language (string) |
| agriapi/relieftype_v1_000/get_relief_types | Recovers a list of entities | order (array) page (integer) pageSize (integer) Accept-Language (string) fields (string) expand (string) code (string) description (string) |
| agriapi/relieftype_v1_000/post_relief_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/relieftype_v1_000/get_relief_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/relieftype_v1_000/put_relief_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/soiltexture_v1_000/get_soil_textures | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/soiltexture_v1_000/post_soil_textures | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/soiltexture_v1_000/get_soil_textures_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/soiltexture_v1_000/put_soil_textures_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/soiltype_v1_000/get_soil_types | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/soiltype_v1_000/post_soil_types | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/soiltype_v1_000/get_soil_types_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/soiltype_v1_000/put_soil_types_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/unitmeasurementconversion_v1_000/get_unit_measurement_conversions | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/unitmeasurementconversion_v1_000/post_unit_measurement_conversions | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/unitmeasurementconversion_v1_000/post_unit_measurement_conversions_convert | Performs conversion of value between units of measurement | Accept-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_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/unitmeasurementconversion_v1_000/put_measurement_v1_unit_measurement_conversions_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/unitmeasurementconversion_v2_000/get_unit_measurement_conversions | Recovers a list of entities | page (integer) pageSize (integer) fields (string) order (array) |
| agriapi/unitmeasurementconversion_v2_000/post_unit_measurement_conversions | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/unitmeasurementconversion_v2_000/post_unit_measurement_conversions_convert | Performs conversion of value between units of measurement | Accept-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_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/unitmeasurementconversion_v2_000/put_measurement_v1_unit_measurement_conversions_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/unitmeasurementconversion_v2_000/get_unit_measurement_conversions_by_internal_id | Retorna uma lista de fatores de conversão do item | internalId (string) fields (string) order (array) |
| agriapi/unitmeasurementconversion_v2_000/put_unit_measurement_conversions_by_internal_id | Atualiza fatores de conversão do item. | internalId (string) 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_id | Exclui fatores de conversão do item. | internalId (string) |
| agriapi/unitmeasurement_v1_000/get_unit_measurements | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/unitmeasurement_v1_000/post_unit_measurements | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/unitmeasurement_v1_000/get_unit_measurements_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/unitmeasurement_v1_000/put_unit_measurements_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/wheatherclassification_v1_000/get_weather_classifications | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/wheatherclassification_v1_000/post_weather_classifications | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/wheatherclassification_v1_000/get_weather_classifications_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/wheatherclassification_v1_000/put_weather_classifications_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| agriapi/wheathercondition_v1_000/get_weather_conditions | Recovers a list of entities | Accept-Language (string) page (integer) pageSize (integer) fields (string) expand (string) order (array) code (string) description (string) |
| agriapi/wheathercondition_v1_000/post_weather_conditions | Inserts a list of entities | Accept-Language (string) data (array) required |
| agriapi/wheathercondition_v1_000/get_weather_conditions_by_id | Recovers a specific entity with identifier | id (string) Accept-Language (string) fields (string) expand (string) |
| agriapi/wheathercondition_v1_000/put_weather_conditions_by_id | Updates a entity with identifier | id (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_id | Removes a entity with identifier | id (string) Accept-Language (string) |
| central_de_obrigacoes___sib/beneficiary_v1_000/get_beneficiaries | Retorna um lote de beneficiario de acordo com os parametros enviados | order (array) page (integer) pageSize (integer) fields (string) healthInsurerCode (integer) |
| central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries | Insere e/ou gera uma movimentação de inclusão para o SIB, através de um body. | 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_batch | Insere 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. | 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_id | Retorna um beneficiario de acordo com o ID informado | subscriberId (string) fields (string) healthInsurerCode (integer) required codeCco (integer) |
| central_de_obrigacoes___sib/beneficiary_v1_000/put_beneficiaries_by_subscriber_id | Altera e/ou gera uma movimentação de retificação para o SIB, de acordo com o ID informado. | subscriberId (string) 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_id | Deleta um beneficiario. | subscriberId (string) healthInsurerCode (integer) required codeCco (integer) |
| central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_by_subscriber_id_block | Gera uma movimanetação da action de bloqueio de um beneficiario. | subscriberId (string) 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_unblock | Gera uma movimanetação da action de desbloqueio de um beneficiario. | subscriberId (string) data: { . healthInsurerCode (string) . subscriberId (string) . codeCco (string) . reactivationDate (string) } (object) required |
| central_de_obrigacoes___sib/beneficiary_v1_000/post_beneficiaries_by_subscriber_id_changer_contract | Gera uma movimanetação da action de mudança contratual de um beneficiario. | subscriberId (string) 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_refer | Retorna os arquivos de uma competência | yearMonthRefer (string) order (array) page (integer) pageSize (integer) fields (string) healthInsurerCode (string) |
| central_de_obrigacoes___sib/files_v1_000/get_files_ccos_by_file_name | Retorna os CCOs de um arquivo | fileName (string) order (array) page (integer) pageSize (integer) fields (string) healthInsurerCode (string) |
| central_de_obrigacoes___sib/product_v1_000/get_products | Retorna um lote de produtos. | order (array) page (integer) pageSize (integer) fields (string) healthInsurerCode (string) |
| central_de_obrigacoes___sib/product_v1_000/post_products | Realiza a inclusão de um produto. | 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_code | Retorna um produto. | code (string) |
| central_de_obrigacoes___sib/product_v1_000/put_products_by_code | Altera informações do produto. | code (string) 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_code | Deleta um produto. | healthInsurerCode (string) code (string) |
| rms/branch_v1_000/get_branches | Retorna todas as Filiais da base | order (array) page (integer) pageSize (integer) EnterpriseGroup (string) |
| rms/branch_v1_000/post_branches | Inclui a Filial passada na requisição | 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_id | Retorna todas as Filiais da base | BranchInternalId (string) |
| rms/branch_v1_000/put_branches_by_branch_internal_id | Inclui a Filial passada na requisição | BranchInternalId (string) 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_id | Não é permitida a deleção da Filial por API, por motivos de segurança | BranchInternalId (string) |
| rms/city_v1_000/get_city | Retorna lista completa de cidades | fields (string) order (array) page (integer) pageSize (integer) |
| rms/city_v1_000/post_city | Inclui uma cidade conforme dados enviados na requisição. | 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_id | Retorna os dados da cidade conforme o código informado na requisição | InternalId (string) fields (string) |
| rms/city_v1_000/put_city_by_internal_id | Atualiza cadastro da cidade conforme dados enviados na requisição | InternalId (string) 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_id | Exclui cadastro de cidade conforme dados enviados na requisição. | InternalId (string) |
| rms/company_v1_000/get_companies | Retorna todas as empresas da base | order (array) page (integer) pageSize (integer) fields (string) |
| rms/company_v1_000/post_companies | Inclui a Empresa passada na requisição | 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_code | Retorna todas as Empresas da base | Code (string) |
| rms/company_v1_000/put_companies_by_code | Inclui a Empresa passada na requisição | Code (string) 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_code | Não é permitida a deleção da Empresa por API, por motivos de segurança | Code (string) |
| rms/country_v1_000/get_countries | Retorna lista completa de países | fields (string) order (array) page (integer) pageSize (integer) |
| rms/country_v1_000/post_countries | Inclui um novo País conforme dados enviados na requisição. | data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) } (object) required |
| rms/country_v1_000/get_countries_by_internal_id | Retorna os dados do País conforme o código informado na requisição | InternalId (string) fields (string) |
| rms/country_v1_000/put_countries_by_internal_id | Atualiza cadastro do País conforme dados enviados na requisição | InternalId (string) data: { . InternalId (string) . Code (string) . Description (string) . OfficialCode (number) } (object) required |
| rms/country_v1_000/delete_countries_by_internal_id | Exclui cadastro do País conforme dados enviados na requisição. | InternalId (string) |
| rms/sellers_v1_000/get_sellers | Retorna todos os vendedores | fields (string) order (array) page (integer) pageSize (integer) |
| rms/sellers_v1_000/post_sellers | Inclui o vendedor passado na requisição | 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_id | Retorna um vendedor com base no código informado | InternalId (string) fields (string) |
| rms/sellers_v1_000/put_sellers_by_internal_id | Atualiza um vendedor com base no código informado | InternalId (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 |
| rms/sellers_v1_000/delete_sellers_by_internal_id | Exclui um vendedor com base no código informado | InternalId (string) |
| rms/withdrawals_v1_000/get_withdrawals | Retorna todas as sangrias cadastradas | page (integer) pageSize (integer) order (array) fields (string) |
| rms/withdrawals_v1_000/post_withdrawals | Inclui a entidade sangria passada na requisição | 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_id | Retorna a sangria com base no identificador passado | internalId (string) fields (string) |
| rms/withdrawals_v1_000/put_withdrawals_by_internal_id | Atualiza a sangria com base no identificador passado | internalId (string) 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_id | Exclui a sangria com base no identificador passado | internalId (string) |
| winthor/distribution_v1_000/get_distributions | Retorna todas as praças disponíveis | order (array) page (integer) pageSize (integer) fields (string) |
| winthor/distribution_v1_000/post_distributions | Insere a praça passada na requisição | 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/get_distributions_by_id | Retorna uma praça a partir do código informado | id (integer) |
| winthor/distribution_v1_000/put_distributions_by_id | Altera a praça passada na requisição | id (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_id | Remove uma praça a partir do código informado | id (integer) |
| winthor/paymentticket_v1_000/post_incoming_bills_digitableline | Gera a linha digitável para a transação | data: { . barCode (string) . bankCode (integer) . sellTransactionNumber (integer) . installmentsNumber (string) } (object) required |
| winthor/paymentticket_v1_000/get_layouts | Pesquisar layouts de códigos de barra, baseado nos dados informados que servirão como filtros e de maneira paginada. | name (string) status (string) required page (integer) pageSize (integer) order (array) fields (string) |
| winthor/paymentticket_v1_000/post_layouts | Salva um Layout de boleto | data: { . id (integer) . name (string) . size (integer) . correspondingOurNumber . layoutVariables (array) . digitableLineVariable . status (string) } (object) required |
| winthor/paymentticket_v1_000/post_layouts_build | Gera e persiste o código de barras, nosso número e linha digitavel | data: { . sellTransactionNumber (integer) . bankCode (integer) . installment (string) . branchCode (string) . usesGrossValue (boolean) } (object) required |
| winthor/paymentticket_v1_000/post_layouts_parameters_validate | Validar parâmetro de uma variável | data: { . id (integer) . name (string) . formula (string) } (object) required |
| winthor/paymentticket_v1_000/get_layouts_parameters_variables_by_id | Listar parâmetros de uma variável | id (integer) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/paymentticket_v1_000/get_layouts_by_id | Consultar layouts de códigos de barra | id (integer) |
| winthor/paymentticket_v1_000/delete_layouts_by_id | Exclui o registro de um layout | id (integer) |
| winthor/paymentticket_v1_000/get_variables | Listar todas as variáveis cadastradas | status (string) dataType (string) variableType (string) contentType (string) ourNumber (string) name (string) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/paymentticket_v1_000/post_variables | Salvar uma variável que pode vim a compor um código de barras | data: { . 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_compatibles | Pesquisar 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) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/paymentticket_v1_000/post_variables_validate | Validar conteúdo de uma variável | data: { . 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_id | Consultar variável por código | id (integer) |
| winthor/paymentticket_v1_000/delete_variables_by_id | Excluir variável por código | id (integer) |
| winthor/paymentticket_v1_000/get_variables_by_id_links | Consulta os layouts vinculados à variável | id (integer) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/productdepartment_v1_000/get_product_departments | Returns an list of all departments | order (array) page (integer) pageSize (integer) fields (string) description (string) typeMerchandise (string) |
| winthor/productdepartment_v1_000/post_product_departments | Returns a department inserted | data: { . id (integer) . description (string) . updateStockGeneral (boolean) . typeMerchandise (string) } (object) required |
| winthor/productdepartment_v1_000/delete_product_departments_by_id | Removes a department informed | id (integer) |
| winthor/productdepartment_v1_000/get_product_departments_by_id | Returns an informed department | id (integer) |
| winthor/productdepartment_v1_000/put_product_departments_by_id | Returns a department updated | id (integer) data: { . id (integer) . description (string) . updateStockGeneral (boolean) . typeMerchandise (string) } (object) required |
| winthor/route_v1_000/get_routes | Retorna todas as rotas disponíveis | order (array) page (integer) pageSize (integer) fields (string) |
| winthor/route_v1_000/post_routes | Inclui rota passada na requisição | 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/put_routes_by_id | Altera a rota passada na requisição | id (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_id | Retorna uma rota a partir de um código | id (integer) |
| winthor/route_v1_000/delete_routes_by_id | Remove uma rota a partir de um código informado | id (integer) |
| winthor/stock_v1_000/post_curves_consolidate | Consolidação dos dados de Curva ABC para giro customizado | No parameters |
| winthor/stock_v1_000/get_curves_tables | Apresenta a tabela de Curva ABC disponivel para o giro dia customizado | subsidiary (string) type (string) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/stock_v1_000/get_curves_by_curve_key_subcurves_by_sub_curve_key_frequencies_by_key | Lista de frequencia de compras para o conjunto de curva, sub-curva e frequencia | curveKey (string) subCurveKey (string) key (string) subsidiary (string) type (string) page (integer) pageSize (integer) order (array) fields (string) |
| winthor/stock_v1_000/get_curves_by_curve_key_subsidiaries_by_subsidiary | Obtem uma Curva ABC do giro customizado por identificador unico e filial | curveKey (string) subsidiary (string) |
| winthor/stock_v1_000/get_figures | Listagem de figuras disponiveis para giro dia customizado | page (integer) pageSize (integer) order (array) fields (string) |
| winthor/stock_v1_000/get_figures_by_id | Obtem os dados de uma figura de acordo com o identificador unico | id (integer) fields (string) |
| winthor/stock_v1_000/get_scenarios | Lista os cenários para giro dia customizado | page (integer) pageSize (integer) order (array) fields (string) |
| winthor/stock_v1_000/get_scenarios_products_by_product_id_subsidiaries_by_subsidiary | Obtem um cenários através do codigo do produto e filial | productId (integer) subsidiary (string) fields (string) |
| winthor/stock_v1_000/get_scenarios_by_id | Obtem um cenários por identificador unico | id (integer) fields (string) |
| winthor/stock_v1_000/post_turnover_day_consolidate | Realiza o processo de calculo de giro dia customizado, consolidando os valores de giro para cada produto. | No parameters |
| winthor/stock_v1_000/get_turnover_day_memories_products_by_product_id_subsidiaries_by_subsidiary | Obtem a memoria de calculo do giro dia customizado, por produto e filial | productId (integer) subsidiary (string) fields (string) |
| winthor/stock_v1_000/post_turnover_day_sales_consolidate | Realiza a consolidação de dados de vendas falta, transferencia, kits para o giro dia customizado de acordo com o intervalo de dadas informado. | data: { . dateStart (string) . dateFinal (string) } (object) required |
| winthor/wholesalebilling_v1_000/get_orders | Retorna todos os Pedidos de Venda disponíveis | order (array) page (integer) pageSize (integer) fields (string) saleType (string) status (string) |
| winthor/wholesalebilling_v1_000/post_orders | Inicia o processo de faturamento da venda passada na requisição | 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/put_orders_by_id | Inicia o processo de faturamento da venda passada na requisição | id (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_id | Retorna um Pedido de Venda a partir de um código | id (integer) |
| winthor/wholesalebilling_v1_000/get_shipments | Retorna todos os Carregamentos disponíveis | order (array) page (integer) pageSize (integer) fields (string) status (string) |
| winthor/wholesalebilling_v1_000/post_shipments | Inicia o processo de faturamento da venda passada na requisição | 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/put_shipments_by_id | Inicia o processo de faturamento da venda passada na requisição | id (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_id | Retorna um Carregamento a partir de um código | id (integer) |
| winthor/wholesaleordercancel_v1_000/delete_orders | Cancela um pedido de venda não faturado | id (integer) required productCode (integer) sequence (integer) sendMessageRca (boolean) required reasonCancellation (string) required |
| prosaude/extract_v1_000/get_extracts | Retorna 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 Expires_at (string) required holderholderSubscriberId (string) yearMonth (string) year (string) |
| prosaude/healthcareuser_v1_000/get_health_care_users | Retorna 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 CBOS | page (integer) pageSize (integer) order (array) fields (string) Expires_at (string) required |
| prosaude/healthcareuser_v1_000/post_health_care_users | Realiza a inclusão de um usuário conforme body da requisição. | 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_id | Retorna um usuário de acordo com o código informado | id (string) expand (string) Expires_at (string) required |
| prosaude/healthcareuser_v1_000/put_health_care_users_by_id | Altera informações do usuário de acordo com o ID informado | id (string) 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_classes | Retorna 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 Expires_at (string) required classType (string) typeDrug (string) |
| prosaude/procedureclass_v1_000/get_procedures_classes_by_procedure_class_code | Retorna a classe de procedimento de saúde do código especificado | procedureClassCode (string) Content-Type (string) required Expires_at (string) required |
| prosaude/procedureclass_v1_000/get_procedures_classes_by_procedure_class_code_procedures | Retorna 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 Expires_at (string) required tableCode (string) eventType (string) active (string) allowedGender (string) allowRefund (string) |
| prosaude/refund_v1_000/get_refunds | Retorna 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 Expires_at (string) required holderSubscriberId (string) unrelatedHealthProvider (string) cpfCnpj (string) status (string) |
| prosaude/refund_v1_000/post_refunds | Realiza solicitação de reembolso de um serviço médico prestado por uma rede não referenciada | Content-Type (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_number | Retorna a solicitação de reembolso do protocolo especificado | protocolNumber (string) Content-Type (string) required Expires_at (string) required fields (string) expand (string) |
| prosaude/unrelatedhealthprovider_v1_000/get_unrelated_health_providers | Retorna 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 Expires_at (string) required cpfCnpj (string) state (string) city (string) |
| prosaude/unrelatedhealthprovider_v1_000/post_unrelated_health_providers | Cadastra um prestador de serviço de saúde não referenciado. | Content-Type (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_code | Retorna um prestador de serviço de saúde não referenciado. | unrelatedHealthProviderCode (string) Content-Type (string) required Expires_at (string) required |
| totvschecklist/inspectionobject_v2_000/get_inspection_objects | Método responsável por retornar todos os objetos de inspeção respeitando os filtros de requisição | InspectionObjectCustomId (string) Description (string) order (array) page (integer) pageSize (integer) |
| totvschecklist/inspectionobject_v2_000/post_inspection_objects | Método responsável por criar um objeto de inspeção | data: { . id (integer) . InspectionObjectCustomId (string) . inspectionObjectType . description (string) . _expandables (array) . internalId (string) } (object) required |
| totvschecklist/inspectionobject_v2_000/put_inspection_objects_by_id | Método responsável por alterar a descrição de um objeto de inspeção | id (integer) data: { . id (integer) . InspectionObjectCustomId (string) . inspectionObjectType . description (string) . _expandables (array) . internalId (string) } (object) required |
| totvschecklist/inspectionobject_v2_000/delete_inspection_objects_by_id | Método responsável por remover um objeto de inspeção | id (integer) |
| totvschecklist/inspectionobject_v2_000/get_inspection_objects_by_id | Método responsável por retornar o objeto de inspeção que possui o id passado como parâmetro | id (integer) fields (string) expand (string) |
| totvschecklist/inspectionscript_v1_000/get_inspection_scripts_by_inspection_script_id_draft_version | Método responsável por retornar as informações detalhadas da versão de rascunho | inspectionScriptId (integer) fields (string) order (array) page (integer) pageSize (integer) |
| totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_draft_version | Método responsável por alterar as informações do roteiro de inspeção | inspectionScriptId (integer) data: { . title (string) . description (string) . executionStyleId (integer) } (object) required |
| totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_version | Método responsável por adicionar uma categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) 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_id | Método responsável por alterar a categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) customCategoryId (integer) 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_id | Método responsável por remover uma categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) customCategoryId (integer) |
| totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_version_vehicular_category | Método responsável por adicionar uma categoria veicular na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_draft_version_vehicular_category | Método responsável por remover a categoria veicular na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_draft_version_category_by_custom_category_id_item | Método responsável por adicionar um item em uma categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) customCategoryId (integer) 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_id | Método responsável por alterar um item da categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) customCategoryId (integer) itemId (integer) 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_id | Método responsável por remover um item de uma categoria na versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) customCategoryId (integer) itemId (integer) |
| 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_id | Mé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ção | inspectionScriptId (integer) customCategoryId (integer) itemId (integer) nonComplianceSuggestionId (integer) 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_id | Método responsável por remover uma sugestão de não conformidade de um item de uma categoria | inspectionScriptId (integer) customCategoryId (integer) itemId (integer) nonComplianceSuggestionId (integer) |
| totvschecklist/inspectionscript_v1_000/get_inspection_scripts | Método responsável por retornar todos os roteiros de inspeção com a ùltima versão | Title (string) fields (string) order (array) page (integer) pageSize (integer) expand (string) |
| totvschecklist/inspectionscript_v1_000/post_inspection_scripts | Método responsável por criar um roteiro de inspeção com uma versão de rascunho | data: { . versionTitle (string) . versionDescription (string) . versionInspectionObjectTypeId (integer) . versionExecutionStyleId (integer) } (object) required |
| totvschecklist/inspectionscript_v1_000/put_inspection_scripts_by_inspection_script_id_publish_draft_version | Método responsável por publicar uma versão de rascunho de um roteiro de inspeção | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id_discard_draft_version | Método responsável por descartar uma versão de rascunho do roteiro de inspeção | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/delete_inspection_scripts_by_inspection_script_id | Método responsável por remover um roteiro de inspeção junto com sua versão de rascunho | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/post_inspection_scripts_by_inspection_script_id_new_draft_version_from_current_version | Método responsável por criar uma versão de rascunho a partir da versão corrente do roteiro de inspeção | inspectionScriptId (integer) |
| totvschecklist/inspectionscript_v1_000/get_inspection_scripts_by_inspection_script_id_version | Método responsável por retornar ums lista das versões do roteiro de inspeção informado | inspectionScriptId (integer) fields (string) order (array) page (integer) pageSize (integer) expand (string) |
| totvschecklist/inspectionscript_v1_000/get_inspection_scripts_version_by_version_id | Método responsável por retornar a versão completa, com todos os registros filhos | versionId (integer) fields (string) expand (string) |
| totvschecklist/locality_v1_000/get_localities | Método responsável por retornar todas as localidades respeitando os filtros da requisição | fields (string) order (array) page (integer) pageSize (integer) expand (string) |
| totvschecklist/locality_v1_000/post_localities | Método responsável por criar uma localidade com suas localizações e limitada ao usuário | data: { . name (string) . description (string) . locations (array) . limitedToUsers (array) } (object) required |
| totvschecklist/locality_v1_000/put_localities_by_locality_id | Método responsável por atualizar uma localidade com suas localizações | localityId (integer) data: { . name (string) . description (string) . localityId (integer) . locations (array) } (object) required |
| totvschecklist/locality_v1_000/delete_localities_by_locality_id | Método responsável por eliminar uma localidade | localityId (integer) |
| totvschecklist/locality_v1_000/get_localities_by_locality_id | Método responsável por retornar a localidade que possui o id passado como parâmetro | localityId (integer) fields (string) expand (string) |
| totvschecklist/locality_v1_000/post_localities_by_locality_id_limit_to_users | Método responsável por atualizar os usuários limitados à localidade | localityId (integer) data: { . localityId (integer) . limitedToUsers (array) } (object) required |
| proxima_pims/marks_v1_000/get_marks | Retorna um conjunto de marcas | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| proxima_pims/marks_v1_000/post_marks | Adiciona uma nova marca | data (object) required |
| proxima_pims/marks_v1_000/get_marks_by_code | Retorna uma única marca | Code (string) |
| proxima_pims/marks_v1_000/put_marks_by_code | Atualiza uma marca existente | Code (string) data (object) required |
| proxima_pims/marks_v1_000/delete_marks_by_code | Deleta uma marca | Code (string) |
| proxima_pims/models_v1_000/get_models | Retorna um conjunto de modelos | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| proxima_pims/models_v1_000/post_models | Adiciona um novo modelo | 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/get_models_by_code | Retorna um único modelo | Code (string) |
| proxima_pims/models_v1_000/put_models_by_code | Atualiza um modelo existente | Code (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_code | Deleta um modelo | id (string) Code (string) |
| proxima_pims/operationalcategory_v1_000/get_operational_categorys | Retorna um conjunto de Categorias Operacionais | search (string) order (array) pageSize (integer) page (integer) fields (string) |
| proxima_pims/operationalcategory_v1_000/post_operational_categorys | Adiciona uma nova categoria operacional | data: { . Code (string) . Description (string) . ShortName (string) . UnitOfMeasureCode (string) } (object) required |
| proxima_pims/operationalcategory_v1_000/get_operational_categorys_by_code | Retorna uma única categoria operacional | Code (string) |
| proxima_pims/operationalcategory_v1_000/put_operational_categorys_by_code | Atualiza uma categoria operacional existente | Code (string) data: { . Code (string) . Description (string) . ShortName (string) . UnitOfMeasureCode (string) } (object) required |
| proxima_pims/operationalcategory_v1_000/delete_operational_categorys_by_code | Deleta uma categoria operacional | Code (string) |
| proxima_pims/reasonoccurrence_v1_000/get_reason_occurrences | Returns 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_occurrences | Adds 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_occurrence | Returns 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_occurrence | Updates 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_occurrence | Deletes an occurrence reason. | cdReasonOccurrence (integer) cdControlTypeOccurrence (integer) |
| central_de_obrigacoes___monitoramento/monitoring_v1_000/post_monit_form | Insere e/ou gera movimentações referentes a guia de monitoramento | 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_value | Insere e/ou gera movimentações prestabelecidas referentes a guia de monitoramento | 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_remuneration | Insere e/ou gera movimentações referentes à outras remunerações | 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_supply | Insere e/ou gera movimentações de Fornecimento Direto. | data: { . exclusionId (string) . formProcDt (string) . operatorRecord (string) . providerFormNumber (string) . registration (string) . roboId (string) . monitDirectSupplyEvents (array) } (object) required |
| pims/weighingtype_v1_000/get_weighing_types | Returns 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_types | Adds 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_type | Returns a weighing type by primary key. | instance (string) weighingType (integer) |
| pims/weighingtype_v1_000/put_weighing_types_by_instance_by_weighing_type | Updates a weighing type. | instance (string) weighingType (integer) data (undefined) required |
| pims/weighingtype_v1_000/delete_weighing_types_by_instance_by_weighing_type | Deletes a weighing type. | instance (string) weighingType (integer) data (undefined) required |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |