Contratos (foundation_agreement)

Contratos (foundation_agreement)

105 views 11/05/2021 20/09/2021 integrador 0

2.0info: 1.6.1 Contratos description: Serviço de contratos x-senior-domain: Gestão de Contratos x-senior-domain-path: erpx_ctr x-senior-service-path: foundation_agreement contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_ctr/foundation_agreement/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /queries/getAgreementOrderItem: post: description: Devolver informações do contrato para o item da nota fiscal ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementOrderItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentItemId properties: installmentItemId: type: string description: Identificador do item da competência responses: 200: description: Ok schema: type: object required: – code – tradeName – number – description properties: code: type: integer description: Código da filial tradeName: type: string description: Nome fantasia da filial number: type: string description: Número do contrato description: type: string description: Descrição da competência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/deleteAgreementHeader: post: description: Excluir o cabeçalho dos contratos ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteAgreementHeader – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string description: Lista com os identificadores dos contratos responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: #/definitions/agreementHeaderDeletion 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/upDown checks: #/definitions/checkData default: description: Error response schema: #/definitions/genericError /actions/createTermInstallment: post: description: Gerar as competências de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/createTermInstallment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId properties: termId: type: string description: Identificador da vigência installmentDate: type: string description: Regerar as competências a partir desta data retroactiveTermInstallment: type: boolean description: Gerar competências de forma retroativa responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /actions/createTermItem: post: description: Incluir itens em uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/createTermItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId – items properties: termId: type: string description: Identificador da vigência items: type: array items: #/definitions/itemDataInput description: Lista com os dados dos itens responses: 200: description: Ok schema: type: object required: – items properties: items: #/definitions/itemDataCreateOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getInstallmentSummary: post: description: Retornar a quantidade de competências que serão geradas ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentSummary – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: termId: type: string description: Id da vigência responses: 200: description: Ok schema: type: object properties: quantity: type: integer description: Quantidade de competências initialDate: type: string description: Data da primeira competência finalDate: type: string description: Data da última competência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/createAgreementHeader: post: description: Inserir o cabeçalho de um novo contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/createAgreementHeader – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – branch – person – issueDate – recurrence – module – type properties: branch: #/definitions/branchDataInput person: #/definitions/personDataInput number: type: string description: Número (nos contratos de venda o número é gerado pelo sistema) description: type: string description: Descrição do contrato issueDate: type: string description: Data de emissão recurrence: #/definitions/enumAgreementRecurrence module: #/definitions/enumAgreementModule type: #/definitions/enumAgreementType responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do contrato 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getInstallmentInvoice: post: description: Listar informações das notas fiscais da competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentInvoice – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/installmentInvoiceOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/deleteAgreementTerm: post: description: Excluir as vigências do contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteAgreementTerm – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – agreementId – terms properties: agreementId: type: string description: Identificador do contrato terms: type: array items: type: string description: Lista com os identificadores das vigências responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: #/definitions/agreementTermDeletion 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getTermStatus: post: description: Retornar a situação da vigência e o log de erro (se existir) ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermStatus – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId properties: termId: type: string description: Id da vigência responses: 200: description: Ok schema: type: object properties: termId: type: string description: Id da vigência status: #/definitions/enumAgreementTermStatus installmentError: type: string description: Mensagem de erro da geração das competências 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getTermItem: post: description: Obter os dados de um item de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do item responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador itemProduct: #/definitions/defaultDataOutput itemService: #/definitions/defaultDataOutput transaction: #/definitions/defaultDataOutput quantity: type: number description: Quantidade do item measureUnit: #/definitions/measureUnitDataOutput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto priceList: #/definitions/defaultDataOutput grossValue: type: string description: Valor bruto discountValue: type: string description: Valor de desconto netValue: type: string description: Valor líquido financialAccount: #/definitions/defaultDataOutput costCenter: #/definitions/defaultDataOutput representative: #/definitions/defaultDataOutput readjustmentIndex: #/definitions/defaultDataOutput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateInstallmentItem: post: description: Alterar um item de uma competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateInstallmentItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – transaction – quantity – measureUnit – price properties: id: type: string description: Identificador do item itemProduct: #/definitions/productDataInput itemService: #/definitions/serviceDataInput transaction: #/definitions/transactionDataInput quantity: type: number description: Quantidade do item measureUnit: #/definitions/measureUnitDataInput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto priceList: #/definitions/priceListDataInput discountValue: type: string description: Valor de desconto financialAccount: #/definitions/financialAccountDataInput costCenter: #/definitions/costCenterDataInput representative: #/definitions/personDataInput responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do item 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getAgreementTerm: post: description: Obter os dados de uma vigência específica ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementTerm – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da vigência responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da vigência sequence: type: integer description: Sequência da vigência agreementId: type: string description: Identificador do contrato startDate: type: string description: Data inicial finalDate: type: string description: Data final finishingDate: type: string description: Data e encerramento dueDay: type: integer description: Dia para vencimento billingAdvanceDays: type: integer description: Quantidade de dias para antecipação da cobrança status: #/definitions/enumAgreementTermStatus installmentError: type: string description: Erro de geração hasCompetence: type: boolean description: Possui competências geradas dueDateType: #/definitions/enumDueDateType 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listTermInstallmentCustom: post: description: Listar as competências de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/listTermInstallmentCustom – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId – page properties: termId: type: string description: Identificador da vigência dueDateFrom: type: string description: Permite filtrar as competências a partir de uma data de vencimento dueDateTo: type: string description: Permite filtrar as competências até uma data de vencimento installmentDateFrom: type: string description: Permite filtrar as competências a partir de uma data de competência installmentDateTo: type: string description: Permite filtrar as competências até uma data de competência paymentMethod: type: array items: #/definitions/paymentMethodDataInput description: Permite filtrar por formas de pagamento, através do identificador ou código page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/termInstallmentDataOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listTermItemCustom: post: description: Listar os itens de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/listTermItemCustom – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId – page properties: termId: type: string description: Identificador da vigência itemProduct: type: array items: #/definitions/productDataInput description: Permite filtrar os itens por produto, através do identificador ou código itemService: type: array items: #/definitions/serviceDataInput description: Permite filtrar os itens por serviço, através do identificador ou código transaction: type: array items: #/definitions/transactionDataInput description: Permite filtrar os itens por transação, através do identificador ou código measureUnit: type: array items: #/definitions/measureUnitDataInput description: Permite filtrar os itens pela unidade de medida, através do identificador ou código page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/itemDataOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateAgreementClosure: post: description: Realiza o fechamento do contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementClosure – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do contrato responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do contrato 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateTermItem: post: description: Alterar um item de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateTermItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – transaction – quantity – measureUnit – price properties: id: type: string description: Identificador do item itemProduct: #/definitions/productDataInput itemService: #/definitions/serviceDataInput transaction: #/definitions/transactionDataInput quantity: type: number description: Quantidade do item measureUnit: #/definitions/measureUnitDataInput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto priceList: #/definitions/priceListDataInput discountValue: type: string description: Valor de desconto financialAccount: #/definitions/financialAccountDataInput costCenter: #/definitions/costCenterDataInput representative: #/definitions/personDataInput readjustmentIndex: #/definitions/indexDataInput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do item errors: type: string description: Mensagens de erro que impedem a inclusão do item 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/cancelAgreement: post: description: Cancelar um contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/cancelAgreement – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – reasonId properties: id: type: string description: Id do contrato a ser cancelado reasonId: type: string description: Id do motivo de cancelamento responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id do contrato cancelado 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listAgreementTermCustom: post: description: Listar as vigências de um contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/listAgreementTermCustom – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – agreementId – page properties: agreementId: type: string description: Identificador do cabeçalho do contrato startDateFrom: type: string description: Permite filtrar as vigências a partir de uma data de início finalDateTo: type: string description: Permite filtrar as vigências até uma data de fim finishingDateFrom: type: string description: Permite filtrar as vigências a partir de uma data de encerramento finishingDateTo: type: string description: Permite filtrar as vigências até uma data de encerramento status: #/definitions/enumAgreementTermStatus page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/agreementTermDataOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listAgreementHeaderCustom: post: description: Listar o cabeçalho dos contratos cadastrados ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/listAgreementHeaderCustom – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – page properties: company: type: array items: #/definitions/companyDataInput description: Permite filtrar os contratos por empresas, através do identificador ou código branch: type: array items: #/definitions/branchDataInput description: Permite filtrar os contratos por filiais, através do identificador, código ou CNPJ/CPF person: type: array items: #/definitions/personDataInput description: Permite filtrar os contratos por pessoas, através do identificador, código ou CNPJ/CPF module: #/definitions/enumAgreementModule type: #/definitions/enumAgreementType number: type: string description: Permite selecionar um contrato pelo seu número issueDateFrom: type: string description: Permite filtrar os contratos a partir de uma data de emissão issueDateTo: type: string description: Permite filtrar os contratos até uma data de emissão recurrence: #/definitions/enumAgreementRecurrence status: #/definitions/enumAgreementStatus installmentDateFrom: type: string description: Permite filtrar os contratos a partir de uma data de vencimento da competência installmentDateTo: type: string description: Permite filtrar os contratos até uma data de vencimento da competência installmentStatus: type: array items: #/definitions/enumInstallmentStatus description: Permite filtrar os contratos pela situação da competência readjustmentIndex: #/definitions/indexDataInput readjustmentDate: type: string description: Permite filtrar os contratos através da data do próximo reajuste(MM/AAAA) page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/agreementHeaderOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/deleteInstallmentItem: post: description: Excluir os itens de uma competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteInstallmentItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentId – items properties: installmentId: type: string description: Identificador da competência items: type: array items: type: string description: Lista com os identificadores dos itens responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: #/definitions/itemDeletion 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/finishTerm: post: description: Encerrar uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/finishTerm – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da vigência responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id da vigência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/deleteTermItem: post: description: Excluir os itens de uma vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/deleteTermItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – termId – items properties: termId: type: string description: Identificador da vigência items: type: array items: type: string description: Lista com os identificadores dos itens responses: 200: description: Ok schema: type: object required: – deletions properties: deletions: #/definitions/itemDeletion 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getAgreementHeader: post: description: Obter os dados do cabeçalho de um contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getAgreementHeader – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador company: #/definitions/companyDataOutput branch: #/definitions/personDataOutput person: #/definitions/personDataOutput module: #/definitions/enumAgreementModule type: #/definitions/enumAgreementType number: type: string description: Número do contrato description: type: string description: Descrição do contrato issueDate: type: string description: Data de emissão recurrence: #/definitions/enumAgreementRecurrence status: #/definitions/enumAgreementStatus cancellingReason: #/definitions/defaultDataOutput finishingDate: type: string description: Data de encerramento do contrato cancellingDate: type: string description: Data de cancelamento do contrato currentTerm: type: string description: Vigência atual do contrato 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getInstallmentChargePayment: post: description: Obter informações de cobrança da competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentChargePayment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/installmentChargePaymentOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/createAgreementTerm: post: description: Incluir uma vigência no contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/createAgreementTerm – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – agreementId – startDate – finalDate – dueDay – dueDateType properties: agreementId: type: string description: Identificador do contrato startDate: type: string description: Data inicial finalDate: type: string description: Data final finishingDate: type: string description: Data de encerramento da vigência dueDay: type: integer description: Dia para vencimento billingAdvanceDays: type: integer description: Quantidade de dias para antecipação da cobrança/pagamento dueDateType: #/definitions/enumDueDateType responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da vigência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/createInstallmentItem: post: description: Incluir um item em uma competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/createInstallmentItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentId – item properties: installmentId: type: string description: Identificador da competência item: #/definitions/itemDataInput responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador itemProduct: #/definitions/defaultDataOutput itemService: #/definitions/defaultDataOutput transaction: #/definitions/defaultDataOutput quantity: type: number description: Quantidade do item measureUnit: #/definitions/measureUnitDataOutput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto priceList: #/definitions/defaultDataOutput grossValue: type: string description: Valor bruto discountValue: type: string description: Valor de desconto netValue: type: string description: Valor líquido financialAccount: #/definitions/defaultDataOutput costCenter: #/definitions/defaultDataOutput representative: #/definitions/defaultDataOutput readjustmentIndex: #/definitions/defaultDataOutput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getInstallmentItem: post: description: Obter os dados de um item de uma competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getInstallmentItem – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do item responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador itemProduct: #/definitions/defaultDataOutput itemService: #/definitions/defaultDataOutput transaction: #/definitions/defaultDataOutput quantity: type: number description: Quantidade do item measureUnit: #/definitions/measureUnitDataOutput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto priceList: #/definitions/defaultDataOutput grossValue: type: string description: Valor bruto discountValue: type: string description: Valor de desconto netValue: type: string description: Valor líquido financialAccount: #/definitions/defaultDataOutput costCenter: #/definitions/defaultDataOutput representative: #/definitions/defaultDataOutput readjustmentIndex: #/definitions/defaultDataOutput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateAgreementTerm: post: description: Alterar uma vigência do contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementTerm – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – dueDay properties: id: type: string description: Identificador da vigência dueDay: type: integer description: Dia para vencimento billingAdvanceDays: type: integer description: Quantidade de dias para antecipação da cobrança/pagamento responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da vigência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateTermInstallment: post: description: Alterar uma competência da vigência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateTermInstallment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – dueDate properties: id: type: string description: Identificador da competência dueDate: type: string description: Data de vencimento da competência paymentMethod: #/definitions/paymentMethodDataInput responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da competência 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/updateAgreementHeader: post: description: Atualizar o cabeçalho de um contrato ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/actions/updateAgreementHeader – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – branch – person – issueDate – recurrence properties: id: type: string description: Identificador do cabeçalho do contrato branch: #/definitions/branchDataInput person: #/definitions/personDataInput number: type: string description: Número (nos contratos de venda o número é gerado pelo sistema) description: type: string description: Descrição issueDate: type: string description: Data de emissão recurrence: #/definitions/enumAgreementRecurrence responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do contrato 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/listInstallmentItemCustom: post: description: Listar os itens de uma competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/listInstallmentItemCustom – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – installmentId – page properties: installmentId: type: string description: Identificador da competência itemProduct: type: array items: #/definitions/productDataInput description: Permite filtrar os itens por produto, através do identificador ou código itemService: type: array items: #/definitions/serviceDataInput description: Permite filtrar os itens por serviço, através do identificador ou código transaction: type: array items: #/definitions/transactionDataInput description: Permite filtrar os itens por transação, através do identificador ou código measureUnit: type: array items: #/definitions/measureUnitDataInput description: Permite filtrar os itens pela unidade de medida, através do identificador ou código page: #/definitions/page responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de elementos contents: #/definitions/itemDataOutput 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getTermInstallment: post: description: Obter os dados de um competência ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getTermInstallment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da competência responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador da competência installmentSequence: type: integer description: Sequência description: type: string description: Descrição dueDate: type: string description: Data de vencimento installmentDate: type: string description: Data da competência paymentMethod: #/definitions/defaultDataOutput value: type: string description: Valor da competência invoiceStatus: #/definitions/enumInvoiceStatus chargePaymentStatus: #/definitions/enumChargePaymentStatus status: #/definitions/enumInstallmentStatus validationMessage: type: string description: Mensagem de validação 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getChargePaymentOpened: post: description: Retornar se o contrato possui cobranças/pagamentos em aberto ### Resources: - res://senior.com.br/erpx_ctr/foundation_agreement/queries/getChargePaymentOpened – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do contrato responses: 200: description: Ok schema: type: object required: – hasChargePaymentOpened properties: hasChargePaymentOpened: type: boolean description: Indicativo se possui cobranças/pagamentos em aberto 404: description: Entidade ou Registro não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN enumAgreementModule: type: string enum: – SALE – PURCHASE – FINANCIAL enumAgreementType: type: string enum: – PURCHASE_PRODUCT – PURCHASE_SERVICE – PURCHASE_LEASING – SALE_PRODUCT – SALE_SERVICE – SALE_LEASING – FINANCIAL_APPLICATION – FINANCIAL_LOAN – FINANCIAL_INVESTMENT_FUND – FINANCIAL_FORWARD_MARKET – FINANCIAL_FUTURE_MARKET – FINANCIAL_OPTIONS_MARKET – FINANCIAL_NDF_MARKET – FINANCIAL_SWAP_MARKET enumAgreementRecurrence: type: string enum: – MONTHLY – BIMONTHLY – QUARTERLY – FOUR_MONTHLY – BIANNUAL – ANNUAL enumDueDateType: type: string enum: – CURRENT_MONTH – NEXT_MONTH enumAgreementStatus: type: string enum: – TYPING – CLOSED – CANCELED – FINISHED – SUSPENDED enumAgreementTermStatus: type: string enum: – ACTIVE – FINISHED – CANCELED – FORESEEN – GENERATING_INSTALLMENTS – GENERATING_READJUSTMENT – ERROR_GENERATING_INSTALLMENTS enumChargePaymentStatus: type: string enum: – WAITING – PAID – NOT_CREATED – NO_CHARGE – CANCELED enumInvoiceStatus: type: string enum: – ERROR – NOT_CREATED – TYPING – DISABLED – CANCELED – ISSUED enumInstallmentStatus: type: string enum: – OPENED – PROCESSING – NOT_BILLED – CANCELED – BILLED enumChargePaymentType: type: string enum: – CHARGE – PAYMENT enumTypeOrder: type: string enum: – Asc – Desc checkData: type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: #/definitions/upDown branchDataInput: type: object properties: id: type: string description: Identificador documentNumber: type: string description: Número do CNPJ ou CPF personDataInput: type: object properties: id: type: string description: Identificador code: type: integer description: Código documentNumber: type: string description: Número do CNPJ ou CPF companyDataInput: type: object properties: id: type: string description: Identificador code: type: integer description: Código installmentChargePaymentOutput: type: object properties: id: type: string description: Id da cobrança/pagamento da competência chargePaymentType: #/definitions/enumChargePaymentType status: #/definitions/enumChargePaymentStatus dueDate: type: string description: Data de vencimento format: date chargePayment: #/definitions/chargePaymentOutput branch: #/definitions/personDataOutput chargePaymentOutput: type: object properties: id: type: string description: Id do titulo de cobrança/pagamento number: type: string description: Número do título de cobrança/pagamento code: type: string description: Código do tipo do título value: type: string description: Valor da cobrança personDataOutput: type: object required: – id properties: id: type: string description: Identificador code: type: integer description: Código tradeName: type: string description: Nome fantasia documentNumber: type: string description: Número do CNPJ/CPF agreementHeaderOutput: type: object required: – id properties: id: type: string description: Identificador company: #/definitions/companyDataOutput branch: #/definitions/personDataOutput person: #/definitions/personDataOutput module: #/definitions/enumAgreementModule type: #/definitions/enumAgreementType number: type: string description: Número do contrato description: type: string description: Descrição do contrato issueDate: type: string description: Data de emissão format: date-time recurrence: #/definitions/enumAgreementRecurrence status: #/definitions/enumAgreementStatus cancellingReason: #/definitions/defaultDataOutput finishingDate: type: string description: Data de encerramento do contrato format: date cancellingDate: type: string description: Data de cancelamento do contrato format: date currentTerm: type: string description: Vigência atual do contrato companyDataOutput: type: object required: – id properties: id: type: string description: Identificador code: type: integer description: Código tradeName: type: string description: Nome fantasia defaultDataOutput: type: object required: – id – description properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição installmentInvoiceOutput: type: object properties: id: type: string description: Identificador único da nota fiscal da competência type: type: string description: Tipo da nota fiscal (Entrada ou Saída) invoiceId: type: string description: Identificador único da nota fiscal invoiceNumber: type: string description: Número da nota fiscal serieCode: type: string description: Códito da série netValue: type: string description: Valor líquido da nota fiscal status: type: string description: Situação da nota fiscal da competência agreementId: type: string description: Id do contrato dueDate: type: string description: Data de vencimento da competência format: date branch: #/definitions/companyDataOutput validationMessage: type: string description: Mensagem de validação da nota da competência page: type: object required: – offset – size properties: offset: type: integer description: Offset da página size: type: integer description: Size da página orderBy: type: array items: #/definitions/orderBy description: Campos da ordenação dos registros a serem pesquisados orderBy: type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: #/definitions/enumTypeOrder agreementHeaderDeletion: type: object required: – agreement – isDeleted properties: agreement: #/definitions/agreementHeaderDataDeletionOutput isDeleted: type: boolean description: Indicativo se o registro foi excluído errors: type: array items: type: string description: Lista com as mensagens de erro que impedem a exclusão do contrato agreementHeaderDataDeletionOutput: type: object required: – id properties: id: type: string description: Identificador do contrato number: type: string description: Número do contrato company: #/definitions/companyDataOutput branch: #/definitions/personDataOutput person: #/definitions/personDataOutput agreementTermDeletion: type: object required: – term – isDeleted properties: term: #/definitions/agreementTermDataDeletionOutput isDeleted: type: boolean description: Indicativo se o registro foi excluido errors: type: array items: type: string description: Lista com as mensagens de erro que impedem a exclusão da vigência agreementTermDataDeletionOutput: type: object required: – id – startDate – finalDate properties: id: type: string description: Identificador da vigência sequence: type: integer description: Sequência da vigência startDate: type: string description: Data de início format: date finalDate: type: string description: Data de término format: date agreementTermDataOutput: type: object required: – id properties: id: type: string description: Identificador da vigência sequence: type: integer description: Sequência da vigência agreementId: type: string description: Identificador do contrato startDate: type: string description: Data inicial format: date finalDate: type: string description: Data final format: date finishingDate: type: string description: Data e encerramento format: date dueDay: type: integer description: Dia para vencimento billingAdvanceDays: type: integer description: Quantidade de dias para antecipação da cobrança status: #/definitions/enumAgreementTermStatus installmentError: type: string description: Erro de geração hasCompetence: type: boolean description: Possui competências geradas dueDateType: #/definitions/enumDueDateType itemDataInput: type: object required: – transaction – quantity – measureUnit – price properties: itemProduct: #/definitions/productDataInput itemService: #/definitions/serviceDataInput transaction: #/definitions/transactionDataInput quantity: type: number description: Quantidade do item format: double measureUnit: #/definitions/measureUnitDataInput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto format: double priceList: #/definitions/priceListDataInput discountValue: type: string description: Valor de desconto financialAccount: #/definitions/financialAccountDataInput costCenter: #/definitions/costCenterDataInput representative: #/definitions/personDataInput readjustmentIndex: #/definitions/indexDataInput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste format: date productDataInput: type: object properties: id: type: string description: Identificador code: type: string description: Código serviceDataInput: type: object properties: id: type: string description: Identificador code: type: string description: Código transactionDataInput: type: object properties: id: type: string description: Identificador code: type: string description: Código measureUnitDataInput: type: object properties: id: type: string description: Identificador code: type: string description: Código priceListDataInput: type: object properties: id: type: string description: Identificação code: type: string description: Código financialAccountDataInput: type: object properties: id: type: string description: Identificação code: type: integer description: Código costCenterDataInput: type: object properties: id: type: string description: Identificação code: type: string description: Código indexDataInput: type: object properties: id: type: string description: Identificador itemDataCreateOutput: type: object properties: itemDataOutput: #/definitions/itemDataOutput errors: type: array items: type: string description: Mensagens de erro que impedem a inclusão do item itemDataOutput: type: object required: – id properties: id: type: string description: Identificador itemProduct: #/definitions/defaultDataOutput itemService: #/definitions/defaultDataOutput transaction: #/definitions/defaultDataOutput quantity: type: number description: Quantidade do item format: double measureUnit: #/definitions/measureUnitDataOutput price: type: string description: Preço do item discountPercentage: type: number description: Percentual de desconto format: double priceList: #/definitions/defaultDataOutput grossValue: type: string description: Valor bruto discountValue: type: string description: Valor de desconto netValue: type: string description: Valor líquido financialAccount: #/definitions/defaultDataOutput costCenter: #/definitions/defaultDataOutput representative: #/definitions/defaultDataOutput readjustmentIndex: #/definitions/defaultDataOutput readjustmentFrequency: type: integer description: Periodicidade do reajuste readjustmentDate: type: string description: Data do próximo reajuste format: date measureUnitDataOutput: type: object required: – id – description properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição decimals: type: integer description: Quantidade de casas decimais itemDeletion: type: object required: – item – isDeleted – errors properties: item: #/definitions/termItemDataDeletionOutput isDeleted: type: boolean description: Indicativo se o registro foi excluído errors: type: array items: type: string description: Mensagens de erro que impedem a exclusão do item termItemDataDeletionOutput: type: object required: – id properties: id: type: string description: Identificador do item itemProduct: #/definitions/defaultDataOutput itemService: #/definitions/defaultDataOutput transaction: #/definitions/defaultDataOutput measureUnit: #/definitions/defaultDataOutput paymentMethodDataInput: type: object properties: id: type: string description: Identificador code: type: integer description: Código termInstallmentDataOutput: type: object required: – id properties: id: type: string description: Identificador da competência installmentSequence: type: integer description: Sequência description: type: string description: Descrição dueDate: type: string description: Data de vencimento format: date installmentDate: type: string description: Data da competência format: date paymentMethod: #/definitions/defaultDataOutput value: type: string description: Valor da competência invoiceStatus: #/definitions/enumInvoiceStatus chargePaymentStatus: #/definitions/enumChargePaymentStatus status: #/definitions/enumInstallmentStatus validationMessage: type: string description: Mensagem de validação genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment