sale_agreement – Senior X PLATFORM

2.0info: 1.41.0 sale_agreement description: Sale service for Contract module x-senior-domain: Contrato x-senior-domain-path: erpx_ctr x-senior-service-path: sale_agreement contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_ctr/sale_agreementsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getItemSalePrice: post: description: Retorna valores do item ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/getItemSalePrice – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – baseDate – priceListId – saleMeasureUnitId properties: productId: type: string description: Id do Produto serviceId: type: string description: Id do Servico baseDate: type: string description: Data base priceListId: type: string description: ID da tabela de preço saleQuantity: type: number description: Quantidade de venda saleMeasureUnitId: type: string description: Unidade de medida de venda responses: 200: description: Ok schema: type: object properties: salePrice: type: string description: Preço unitário itemDiscountPercentage: type: number description: Porcentagem de desconto salePriceListItem: #/definitions/recE081itp salePriceListValidity: #/definitions/recE081tpr 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna valores do item ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/getItemSalePrice – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – baseDate – priceListId – saleMeasureUnitId properties: productId: type: string description: Id do Produto serviceId: type: string description: Id do Servico baseDate: type: string description: Data base priceListId: type: string description: ID da tabela de preço saleQuantity: type: number description: Quantidade de venda saleMeasureUnitId: type: string description: Unidade de medida de venda responses: 200: description: Ok schema: type: object properties: salePrice: type: string description: Preço unitário itemDiscountPercentage: type: number description: Porcentagem de desconto salePriceListItem: #/definitions/recE081itp salePriceListValidity: #/definitions/recE081tpr 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /reprocessInstallmentInvoice: post: description: Reprocessar documento fiscal gerado com falha ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/actions/reprocessInstallmentInvoice – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – installmentInvoiceId properties: installmentInvoiceId: type: string description: Id do documentos fiscal na competência automaticallyIssue: type: boolean description: Indicativo se os contratos devem ser emitidos automaticamente responses: 200: description: Ok 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 /cancelInvoiceAgreementInstallment: post: description: Cancelar competência proveniente de um cancelamento de nota fiscal ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/actions/cancelInvoiceAgreementInstallment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – invoiceId – installmentChargeback properties: invoiceId: type: string description: Id da nota fiscal installmentChargeback: #/definitions/enumTipEstCon responses: 200: description: Ok 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 /listPrepareInvoiceAgreement: post: description: Listar os resumos do faturamento de contratos ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listPrepareInvoiceAgreement – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – agreementId – page properties: startDate: type: string description: Data de início do faturamento finalDate: type: string description: Data de fim do faturamento agreementId: type: array items: type: string description: Ids dos contratos que serão faturados billNextInstallment: type: boolean description: Faturar a próxima competência do contrato billingType: #/definitions/enumBillingType 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 vigências cadastradas contents: #/definitions/prepareInvoiceDataOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Listar os resumos do faturamento de contratos ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listPrepareInvoiceAgreement – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – agreementId – page properties: startDate: type: string description: Data de início do faturamento finalDate: type: string description: Data de fim do faturamento agreementId: type: array items: type: string description: Ids dos contratos que serão faturados billNextInstallment: type: boolean description: Faturar a próxima competência do contrato billingType: #/definitions/enumBillingType 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 vigências cadastradas contents: #/definitions/prepareInvoiceDataOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listServices: post: description: Listar os serviços disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listServices – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial customerId: type: string description: Id do contratante autoComplete: type: string description: Pesquisa por autocomplete origin: #/definitions/defaultDataLookupInput family: #/definitions/defaultDataLookupInput itemService: #/definitions/defaultDataLookupInput 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/serviceDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Listar os serviços disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listServices – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial customerId: type: string description: Id do contratante autoComplete: type: string description: Pesquisa por autocomplete origin: #/definitions/defaultDataLookupInput family: #/definitions/defaultDataLookupInput itemService: #/definitions/defaultDataLookupInput 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/serviceDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /disableInvoiceAgreementInstallment: post: description: Inutilizar competência proveniente de uma inutilização de nota fiscal ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/actions/disableInvoiceAgreementInstallment – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – invoiceId – installmentChargeback properties: invoiceId: type: string description: Id da nota fiscal installmentChargeback: #/definitions/enumTipEstCon responses: 200: description: Ok 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 /listTransactions: post: description: Listar as transações disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listTransactions – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId – branchId – customerId – itemType – page properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial customerId: type: string description: Id do cliente itemType: #/definitions/enumProSer cfop: type: string description: Natureza da operação application: #/definitions/enumAplNop transaction: #/definitions/defaultDataLookupInput autoComplete: type: string description: Pesquisa por autocomplete 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/transactionDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Listar as transações disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listTransactions – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId – branchId – customerId – itemType – page properties: companyId: type: string description: Id da empresa branchId: type: string description: Id da filial customerId: type: string description: Id do cliente itemType: #/definitions/enumProSer cfop: type: string description: Natureza da operação application: #/definitions/enumAplNop transaction: #/definitions/defaultDataLookupInput autoComplete: type: string description: Pesquisa por autocomplete 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/transactionDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 get: description: Query para o SRE verificar a disponibilidade do serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /listPriceLists: post: description: Listar as tabelas de preço disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listPriceLists – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: companyId: type: string description: Id da empresa serviceId: type: string description: Id do serviço productId: type: string description: Id do produto autoComplete: type: string description: Pesquisa por autocomplete code: type: string description: Código da tabela de preço description: type: string description: Descrição da tabela de preço initials: type: string description: Sigla da tabela de preço 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/priceListDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Listar as tabelas de preço disponíveis para venda ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listPriceLists – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: companyId: type: string description: Id da empresa serviceId: type: string description: Id do serviço productId: type: string description: Id do produto autoComplete: type: string description: Pesquisa por autocomplete code: type: string description: Código da tabela de preço description: type: string description: Descrição da tabela de preço initials: type: string description: Sigla da tabela de preço 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/priceListDataLookupOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listCustomers: post: description: Retorna o nome de todas as Entidades existentes na base cliente ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listCustomers – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: branchId: type: string description: Identificador da filial code: type: integer description: Código da pessoa name: type: string description: Nome da pessoa tradeName: type: string description: Nome fantasia da pessoa type: #/definitions/enumJurFis stateInitials: type: string description: Sigla da UF da pessoa documentNumber: type: string description: CNPJ ou CPF da pessoa cityName: type: string description: Nome da cidade autoComplete: type: string description: Filtro para o autocomplete 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: Totals de elementos contents: #/definitions/customerDataOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome de todas as Entidades existentes na base cliente ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/queries/listCustomers – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – page properties: branchId: type: string description: Identificador da filial code: type: integer description: Código da pessoa name: type: string description: Nome da pessoa tradeName: type: string description: Nome fantasia da pessoa type: #/definitions/enumJurFis stateInitials: type: string description: Sigla da UF da pessoa documentNumber: type: string description: CNPJ ou CPF da pessoa cityName: type: string description: Nome da cidade autoComplete: type: string description: Filtro para o autocomplete 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: Totals de elementos contents: #/definitions/customerDataOutput 403: description: Permissão negada 401: description: Usuário ou senha inválido 404: description: Entidade não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /generateInvoiceAgreement: post: description: Faturamento de contratos ### Resources: - res://senior.com.br/erpx_ctr/sale_agreement/signals/generateInvoiceAgreement – Processar x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – agreementId properties: startDate: type: string description: Data de início do faturamento finalDate: type: string description: Data de fim do faturamento agreementId: type: array items: type: string description: Ids dos contratos que serão faturados billNextInstallment: type: boolean description: Faturar a próxima competência do contrato billingType: #/definitions/enumBillingType automaticallyIssue: type: boolean description: Indicativo se os contratos devem ser emitidos automaticamente responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: enumTipEstCon: type: string enum: – V1 – V2 upDown: type: string enum: – UP – DOWN enumJurFis: type: string enum: – VJ – VF enumAplNop: type: string enum: – VN – VS – VI – VR – VO – VT – VD – VA – VB – VE – VC – VF – VG – VV – VX enumProSer: type: string enum: – VP – VS enumBillingType: type: string enum: – DUE_DATE – BILLING_DATE – NEXT_INSTALLMENT enumSitReg: type: string enum: – VA – VI enumTypeOrder: type: string enum: – Asc – Desc enumInstallmentStatus: type: string enum: – OPENED – PROCESSING – NOT_BILLED – CANCELED – BILLED enumAgreementStatus: type: string enum: – TYPING – CLOSED – CANCELED – FINISHED – SUSPENDED checkData: type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: #/definitions/upDown customerDataOutput: type: object required: – id properties: id: type: string description: Identificador da pessoa code: type: integer description: Código da pessoa tradeName: type: string description: Nome fantasia da pessoa name: type: string description: Nome da pessoa type: #/definitions/enumJurFis documentNumber: type: string description: CNPJ ou CPF da pessoa address: type: string description: Endereço da pessoa addressNumber: type: string description: Número do endereço neighborhood: type: string description: Bairro city: type: string description: Cidade stateInitials: type: string description: Sigla do estado country: type: string description: País status: #/definitions/enumSitReg 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 priceListDataLookupOutput: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição initials: type: string description: Sigla da tabela de preço defaultDataLookupInput: type: object properties: code: type: string description: Código description: type: string description: Descrição recE081tpr: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição recE081itp: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição serviceDataLookupOutput: type: object required: – id – measureUnit properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição origin: #/definitions/defaultDataOutput family: #/definitions/defaultDataOutput measureUnit: #/definitions/measureUnitDataOutput defaultDataOutput: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição measureUnitDataOutput: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição decimals: type: integer description: Quantidade de decimais transactionDataLookupOutput: type: object required: – id properties: id: type: string description: Identificador code: type: string description: Código description: type: string description: Descrição cfop: type: string description: Natureza de operação application: #/definitions/enumAplNop prepareInvoiceDataOutput: type: object required: – id – agreementStatus properties: id: type: string description: Identificador único do contrato person: #/definitions/personAgreementDataOutput number: type: integer description: Número do contrato description: type: string description: Descrição do contrato installment: #/definitions/installmentAgreementDataOutput canBill: type: boolean description: Indicativo se o registro pode ser faturado note: type: string description: Observação agreementStatus: #/definitions/enumAgreementStatus company: type: string description: Empresa do contrato personAgreementDataOutput: type: object properties: id: type: string description: Identificador único da pessoa code: type: integer description: Código da pessoa tradeName: type: string description: Nome fantasia da pessoa installmentAgreementDataOutput: type: object properties: id: type: string description: Identificador da competência description: type: string description: Descrição da competência installmentDate: type: string description: Data da competência format: date dueDate: type: string description: Data de vencimento da competência format: date netValue: type: string description: Valor líquido da competência installmentStatus: #/definitions/enumInstallmentStatus billingDate: type: string description: Data base para faturamento da competência format: date 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