2.0info: 3.3.1 tcp_titulopagar description: Serviço destinado a operações do contas a pagar x-senior-domain: ERP FINANÇAS x-senior-domain-path: erp_fin x-senior-service-path: tcp_titulopagar contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tcp_titulopagar/queries/pesquisarEmpresa: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: texto: type: string description: Texto pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Empresas default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: texto in: query type: string – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Empresas default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/buscarIdsTodasEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/buscarFiliaisMultiplasEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: Texto todas: type: boolean description: Todas ou não somente: type: array items: type: integer format: int64 description: Somente filiais ids exceto: type: array items: type: integer format: int64 description: Exceto filiais ids pagina: type: object allOf: – #/definitions/recPagina description: Pagina responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Empresas com filiais default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: texto in: query type: string – name: todas in: query required: true type: boolean – name: somente in: query type: array items: type: integer format: int64 – name: exceto in: query type: array items: type: integer format: int64 – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Empresas com filiais default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/buscarIdsFiliaisPorEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas para filiais responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das filiais default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaIds in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: Ids das filiais default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/pesquisarFilial: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – pagina properties: texto: type: string description: Texto empresaId: type: integer format: int64 description: ID da empresa pagina: type: object allOf: – #/definitions/recPagina description: Pagina responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: texto in: query type: string – name: empresaId in: query required: true type: integer format: int64 – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterTipoTitulos: post: description: Retornar os tipos de títulos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – tipoTitulo – totalRegistros properties: tipoTitulo: type: array items: type: object allOf: – #/definitions/recTipoTitulo minimum: 1 description: Tipo titulo totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retornar os tipos de títulos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pagina in: query type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – tipoTitulo – totalRegistros properties: tipoTitulo: type: array items: type: object allOf: – #/definitions/recTipoTitulo minimum: 1 description: Tipo titulo totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterTamanhoMaximoPrefixoTitulo: post: description: Retorna o tamanho máximo do prefixo de títulos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – quantidadeTitulos properties: quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos responses: 200: description: Ok schema: type: object required: – tamanhoMaximo properties: tamanhoMaximo: type: integer format: int64 description: Tamanho máximo default: description: Error response schema: #/definitions/genericError get: description: Retorna o tamanho máximo do prefixo de títulos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: quantidadeTitulos in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tamanhoMaximo properties: tamanhoMaximo: type: integer format: int64 description: Tamanho máximo default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterHistoricoFornecedor: post: description: Retornar os históricos de fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fornecedorId – filialId properties: fornecedorId: type: integer format: int64 description: Fornecedor filialId: type: integer format: int64 description: Filial responses: 200: description: Ok schema: type: object required: – historicoFornecedor properties: historicoFornecedor: type: object allOf: – #/definitions/recHistoricoFornecedor description: Histórico default: description: Error response schema: #/definitions/genericError get: description: Retornar os históricos de fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fornecedorId in: query required: true type: integer format: int64 – name: filialId in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – historicoFornecedor properties: historicoFornecedor: type: object allOf: – #/definitions/recHistoricoFornecedor description: Histórico default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterMoedas: post: description: Retorna as moedas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids das moedas textoLivre: type: string description: Texto livre para pesquisar descrição ou id das moedas sigla: type: array items: type: string description: Lista de siglas de moeda tipo: type: array items: type: string description: Lista de tipos de moeda pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – moedas – totalRegistros properties: moedas: type: array items: type: object allOf: – #/definitions/recMoeda minimum: 1 description: Lista de moedas encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError get: description: Retorna as moedas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id in: query type: array items: type: string – name: textoLivre in: query type: string – name: sigla in: query type: array items: type: string – name: tipo in: query type: array items: type: string – name: pagina in: query type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – moedas – totalRegistros properties: moedas: type: array items: type: object allOf: – #/definitions/recMoeda minimum: 1 description: Lista de moedas encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterCotacaoEmissao: post: description: Retorna a cotação de emissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – dataEmissao – moedaId properties: empresaId: type: integer format: int64 description: Empresa dataEmissao: type: string format: date description: Data de emissão moedaId: type: string description: Moeda ID responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: Cotação default: description: Error response schema: #/definitions/genericError get: description: Retorna a cotação de emissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId in: query required: true type: integer format: int64 – name: dataEmissao in: query required: true type: string format: date – name: moedaId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: Cotação default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterSituacaoTitulosAbertosFornecedor: post: description: Retorna a situação dos títulos abertos por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataBase – pagina properties: empresaId: type: array items: type: integer format: int64 description: Empresa ID filialId: type: array items: type: integer format: int64 description: Filial ID fornecedorId: type: array items: type: integer format: int64 description: Fornecedor ID tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: Modalidade dataBase: type: string format: date description: Data base numeroTitulo: type: array items: type: string description: Número do título tipoTituloId: type: array items: type: string description: Tipo título ID pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – situacaoTitulosFornecedor – totalRegistros properties: situacaoTitulosFornecedor: type: array items: type: object allOf: – #/definitions/recSituacaoTitulosFornecedor minimum: 1 description: Situação dos títulos abertos totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retorna a situação dos títulos abertos por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId in: query type: array items: type: integer format: int64 – name: filialId in: query type: array items: type: integer format: int64 – name: fornecedorId in: query type: array items: type: integer format: int64 – name: tipoVencimento in: query type: string allOf: – #/definitions/enumTipoVencimento – name: vencimentoInicial in: query type: string format: date – name: vencimentoFinal in: query type: string format: date – name: modalidade in: query type: string allOf: – #/definitions/enumModalidadeTitulos – name: dataBase in: query required: true type: string format: date – name: numeroTitulo in: query type: array items: type: string – name: tipoTituloId in: query type: array items: type: string – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – situacaoTitulosFornecedor – totalRegistros properties: situacaoTitulosFornecedor: type: array items: type: object allOf: – #/definitions/recSituacaoTitulosFornecedor minimum: 1 description: Situação dos títulos abertos totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterSituacaoTitulosAbertosVencimento: post: description: Retorna a situação dos títulos abertos por data de vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataBase – pagina properties: empresaId: type: array items: type: integer format: int64 description: Empresa ID filialId: type: array items: type: integer format: int64 description: Filial ID fornecedorId: type: array items: type: integer format: int64 description: Fornecedor ID tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: Modalidade dataBase: type: string format: date description: Data base numeroTitulo: type: array items: type: string description: Número do título tipoTituloId: type: array items: type: string description: Tipo título ID pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – situacaoTitulosFornecedor – totalRegistros properties: situacaoTitulosFornecedor: type: array items: type: object allOf: – #/definitions/recSituacaoTitulosVencimento minimum: 1 description: Situação dos títulos abertos totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retorna a situação dos títulos abertos por data de vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId in: query type: array items: type: integer format: int64 – name: filialId in: query type: array items: type: integer format: int64 – name: fornecedorId in: query type: array items: type: integer format: int64 – name: tipoVencimento in: query type: string allOf: – #/definitions/enumTipoVencimento – name: vencimentoInicial in: query type: string format: date – name: vencimentoFinal in: query type: string format: date – name: modalidade in: query type: string allOf: – #/definitions/enumModalidadeTitulos – name: dataBase in: query required: true type: string format: date – name: numeroTitulo in: query type: array items: type: string – name: tipoTituloId in: query type: array items: type: string – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – situacaoTitulosFornecedor – totalRegistros properties: situacaoTitulosFornecedor: type: array items: type: object allOf: – #/definitions/recSituacaoTitulosVencimento minimum: 1 description: Situação dos títulos abertos totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterFornecedores: post: description: Retorna os fornecedores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: termoBusca: type: string description: Termo de busca fornecedorId: type: integer format: int64 description: ID do fornecedor nome: type: string description: Nome do fornecedor numeroDocumento: type: integer format: int64 description: Número do documento pagina: type: object allOf: – #/definitions/recPagina description: Página situacao: type: string allOf: – #/definitions/enumSituacao description: Situação responses: 200: description: Ok schema: type: object required: – totalRegistros properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor description: Fornecedores totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retorna os fornecedores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca in: query type: string – name: fornecedorId in: query type: integer format: int64 – name: nome in: query type: string – name: numeroDocumento in: query type: integer format: int64 – name: pagina in: query type: object allOf: – #/definitions/recPagina – name: situacao in: query type: string allOf: – #/definitions/enumSituacao responses: 200: description: Ok schema: type: object required: – totalRegistros properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor description: Fornecedores totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterTitulosAbertosPorFornecedor: post: description: Retorna os titulos abertos por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fornecedorId – dataBase – pagina properties: fornecedorId: type: integer format: int64 description: ID do fornecedor empresaId: type: array items: type: integer format: int64 description: ID da empresa filialId: type: array items: type: integer format: int64 description: ID da filial tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: Modalidade dataBase: type: string format: date description: Data base numeroTitulo: type: array items: type: string description: Número do título pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recInformacoesResumidasTitulo description: Títulos a pagar totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retorna os titulos abertos por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fornecedorId in: query required: true type: integer format: int64 – name: empresaId in: query type: array items: type: integer format: int64 – name: filialId in: query type: array items: type: integer format: int64 – name: tipoVencimento in: query type: string allOf: – #/definitions/enumTipoVencimento – name: vencimentoInicial in: query type: string format: date – name: vencimentoFinal in: query type: string format: date – name: modalidade in: query type: string allOf: – #/definitions/enumModalidadeTitulos – name: dataBase in: query required: true type: string format: date – name: numeroTitulo in: query type: array items: type: string – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recInformacoesResumidasTitulo description: Títulos a pagar totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/obterTitulosAbertosPorVencimento: post: description: Retorna os titulos abertos por vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vencimento – dataBase – pagina properties: vencimento: type: string format: date description: Data do vencimento empresaId: type: array items: type: integer format: int64 description: ID da empresa filialId: type: array items: type: integer format: int64 description: ID da filial tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: Modalidade dataBase: type: string format: date description: Data base numeroTitulo: type: array items: type: string description: Número do título pagina: type: object allOf: – #/definitions/recPagina description: Página responses: 200: description: Ok schema: type: object required: – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recInformacoesResumidasTitulo description: Títulos a pagar totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError get: description: Retorna os titulos abertos por vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: vencimento in: query required: true type: string format: date – name: empresaId in: query type: array items: type: integer format: int64 – name: filialId in: query type: array items: type: integer format: int64 – name: tipoVencimento in: query type: string allOf: – #/definitions/enumTipoVencimento – name: vencimentoInicial in: query type: string format: date – name: vencimentoFinal in: query type: string format: date – name: modalidade in: query type: string allOf: – #/definitions/enumModalidadeTitulos – name: dataBase in: query required: true type: string format: date – name: numeroTitulo in: query type: array items: type: string – name: pagina in: query required: true type: object allOf: – #/definitions/recPagina responses: 200: description: Ok schema: type: object required: – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recInformacoesResumidasTitulo description: Títulos a pagar totalRegistros: type: integer format: int64 description: Total de registros default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/actions/alterarTituloPagar: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recTituloPagar properties: fieldsChanges: type: array items: type: string description: recTituloPagar: type: object allOf: – #/definitions/recTituloPagar description: responses: 200: description: Ok schema: type: object required: – recTituloPagar properties: recTituloPagar: type: object allOf: – #/definitions/recTituloPagar description: default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/actions/deletarTituloPagar: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/actions/alterarMovimentoBaixaPagar: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recMovimentoTituloPagar properties: fieldsChanges: type: array items: type: string description: recMovimentoTituloPagar: type: object allOf: – #/definitions/recMovimentoTituloPagar description: responses: 200: description: Ok schema: type: object required: – recMovimentoTituloPagar properties: recMovimentoTituloPagar: type: object allOf: – #/definitions/recMovimentoTituloPagar description: default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/empresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/empresa default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/empresa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/empresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/filial default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/filial/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/filial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagar: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagar responses: 200: description: The created resource schema: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagar responses: 200: description: The created resource schema: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagar/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTituloPagar responses: 200: description: Ok schema: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTituloPagar responses: 200: description: Ok schema: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entTituloPagar default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagar/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/entTituloPagar responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagarMovimento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagarMovimento responses: 200: description: The created resource schema: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagarMovimento responses: 200: description: The created resource schema: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagarMovimento/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTituloPagarMovimento responses: 200: description: Ok schema: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTituloPagarMovimento responses: 200: description: Ok schema: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entTituloPagarMovimento default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTituloPagarMovimento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/entTituloPagarMovimento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTransacaoContasPagar: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTransacaoContasPagar responses: 200: description: The created resource schema: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTransacaoContasPagar responses: 200: description: The created resource schema: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTransacaoContasPagar/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTransacaoContasPagar responses: 200: description: Ok schema: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTransacaoContasPagar responses: 200: description: Ok schema: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entTransacaoContasPagar default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tcp_titulopagar/entities/entTransacaoContasPagar/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/entTransacaoContasPagar responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumSituacaoTitulo: description: type: string enum: – ABERTO_ORGAO_PROTECAO_CREDITO – ABERTO_NEGOCIACAO – ABERTO_ADVOGADO – ABERTO_NORMAL – ABERTO_CARTORIO – ABERTO_ENCONTRO_CONTAS – ABERTO_IMPOSTOS – ABERTO_RETORNO_JURIDICO – ABERTO_PROTESTADO – ABERTO_REPRESENTANTE – ABERTO_SUSPENSO – ABERTO_GESTAO_PESSOAS – ABERTO_EXTERNO – ABERTO_CE – ABERTO_COBRANCA – ABERTO_PE – CANCELADO – LIQUIDADO_NORMAL – LIQUIDADO_CARTORIO – LIQUIDADO_IMPOSTOS – LIQUIDADO_COMPENSADO – LIQUIDADO_COBRANCA – LIQUIDADO_PROTESTADO – LIQUIDADO_SUBSTITUIDO – LIQUIDADO_GESTAO_PESSOAS – LIQUIDADO_EXTERNO enumSituacaoFornecedor: description: Situação do fornecedor type: string enum: – Ativo – Inativo enumTipoFornecedor: description: Tipo fornecedor type: string enum: – PessoaFisica – PessoaJuridica enumTipoOrdenacao: description: Enumeração para o tipo de ordenação type: string enum: – Asc – Desc enumOrigemTitulo: description: Enumeração para definição da origem do título type: string enum: – ContasAPagar – NotaFiscalCompra – EntradaFatura – DebitoDiretoAutorizado enumTipoJuros: description: Enumeração para identificar o tipo de juros a ser cobrado no cálculo financeiro do título type: string enum: – Simples – Composto enumTipoVencimento: description: Enumeração para provável pagamento type: string enum: – ProvavelPagamento – VencimentoProrrogado enumModalidadeTitulos: description: Enumeração para filtros type: string enum: – Previstos – Efetivos – Ambos enumSituacao: description: Situação de regtistro type: string enum: – Ativo – Inativo enumModalidadeTitulo: description: Enumeração para retorno de dados type: string enum: – Previsto – Efetivo enumTipoValorTitulo: description: type: string enum: – Igualitario – Dividido userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recPagina: description: Página para a paginação type: object required: – offset – limit properties: offset: type: integer format: int64 description: Offset da lista limit: type: integer format: int64 description: Limite da lista listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao description: Campos da ordenação dos registros a serem pesquisados recEmpresaComFiliais: description: Empresa com filiais type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: Id codigo: type: string description: Código G5 nome: type: string description: Nome filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais recFilial: description: Filial type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: Id nome: type: string description: Nome codigo: type: string description: Código G5 recListaOrdenacao: description: Define o registro com os dados dos campos à serem ordenados type: object required: – campo – ordenacao properties: campo: type: string description: Nome do campo a ser ordenado ordenacao: type: string allOf: – #/definitions/enumTipoOrdenacao description: Tipo de ordenação do campo (ASC / DESC) recTipoTitulo: description: Tipo título type: object required: – id – descricao properties: id: type: string description: ID descricao: type: string description: Descrição recSituacaoTitulosFornecedor: description: Situacao dos titulos do fornecedor type: object required: – fornecedor – quantidadeTitulos – totalValorAberto – totalValorOriginal properties: fornecedor: type: object allOf: – #/definitions/recFornecedor description: Fornecedor quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos totalValorAberto: type: string description: Total de valor aberto totalValorOriginal: type: string description: Total de valor original totalValorLiquido: type: string description: Total de valor líquido recSituacaoTitulosVencimento: description: Situacao dos titulos por vencimento type: object required: – vencimento – quantidadeTitulos – totalValorAberto – totalValorOriginal properties: vencimento: type: string format: date description: Data de vencimento quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos totalValorAberto: type: string description: Total de valor aberto totalValorOriginal: type: string description: Total de valor original totalValorLiquido: type: string description: Total de valor líquido recFornecedor: description: Fornecedor type: object required: – id – nome properties: id: type: integer format: int64 description: ID nome: type: string description: Nome tipo: type: string allOf: – #/definitions/enumTipoFornecedor description: Tipo numeroDocumento: type: integer format: int64 description: CNPJ ou CPF numeroDocumentoFormatado: type: string description: CNPJ ou CPF formatado situacao: type: string allOf: – #/definitions/enumSituacaoFornecedor description: Situacao telefone: type: string description: Telefone grupoEmpresas: type: string description: Grupo de empresas UUID recInformacoesResumidasTitulo: description: Informações resumidas do título type: object required: – id – numeroTitulo – tipoTitulo – fornecedor – dataEntrada – dataEmissao – vencimentoOriginal – vencimentoProrrogado – vencimentoProvavelPagamento – vencido – diasEmAtraso – valores – situacaoTitulo properties: id: type: integer format: int64 description: ID numeroTitulo: type: string description: Número do título tipoTitulo: type: object allOf: – #/definitions/recTipoTitulo description: Tipo do título fornecedor: type: object allOf: – #/definitions/recFornecedor description: Fornecedor dataEntrada: type: string format: date description: Data de entrada dataEmissao: type: string format: date description: Data de emissão vencimentoOriginal: type: string format: date description: Vencimento original vencimentoProrrogado: type: string format: date description: Vencimento prorrogado vencimentoProvavelPagamento: type: string format: date description: Vencimento do provável pagamento vencido: type: boolean description: Vencido diasEmAtraso: type: integer format: int64 description: Dias em atraso notaFiscal: type: object allOf: – #/definitions/recNotaFiscal description: Nota fiscal fatura: type: object allOf: – #/definitions/recFatura description: Fatura valores: type: object allOf: – #/definitions/recValoresTitulo description: Valores calculados valoresMemoria: type: object allOf: – #/definitions/recValoresMemoria description: Memória de cálculo dos valores dataAlteracao: type: string format: date-time description: Data de alteração modalidadeTitulo: type: string allOf: – #/definitions/enumModalidadeTitulo description: Modalidade do título situacaoTitulo: type: object allOf: – #/definitions/recSituacaoTitulo description: Situação do título recSituacaoTitulo: description: type: object required: – situacaoTitulo – sigla – descricao properties: situacaoTitulo: type: string allOf: – #/definitions/enumSituacaoTitulo description: sigla: type: string description: descricao: type: string description: recNotaFiscal: description: type: object properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: serie: type: string description: filialId: type: integer format: int64 description: recFatura: description: type: object properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: filialId: type: integer format: int64 description: recChaveNota: description: Define o registro da estrura de um título de nota fiscal de compra type: object properties: id: type: integer format: int64 description: Código da identificação da estrutura da nota fiscal de compra numero: type: integer format: int64 description: Código da nota fiscal de entrada serie: type: string description: Séria da nota fiscal de entrada fornecedorId: type: integer format: int64 description: Código do fornecedor da nota fiscal de entrada filialId: type: integer format: int64 description: Código da filial da nota fiscal de entrada recChaveFatura: description: Define o registro da estrura de um título de nota fiscal de compra type: object properties: id: type: integer format: int64 description: Código da identificação da estrutura da fatura de compra numero: type: integer format: int64 description: Código da fatura de compra fornecedorId: type: integer format: int64 description: Código do fornecedor da fatura de compra filialId: type: integer format: int64 description: Código da filial da fatura de compra recTituloPagar: description: Record que define um título a pagar type: object required: – id – valores properties: id: type: integer format: int64 description: Identificação do título a pagar empresaId: type: integer format: int64 description: Código da empresa do título a pagar filialId: type: integer format: int64 description: Código da filial do título a pagar fornecedorId: type: integer format: int64 description: Código do fornecedor do título a pagar tipoTituloId: type: string description: Código do tipo de título do título a pagar origemTitulo: type: string allOf: – #/definitions/enumOrigemTitulo description: Origem do título a pagar numeroTitulo: type: string description: Número do título a pagar dataEntrada: type: string format: date description: Data de entrada do título a pagar dataEmissao: type: string format: date description: Data de emissão do título a pagar valorOriginal: type: string description: Valor original do título a pagar valorAberto: type: string description: Valor aberto do título a pagar codigoBarras: type: string description: Código de barras do título a pagar transacaoContasPagar: type: string description: Transação de entrada do título a pagar vencimentoOriginal: type: string format: date description: Vencimento original do título a pagar vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a pagar provavelPagamento: type: string format: date description: Provável pagamento do título a pagar previsto: type: string description: Indicativo se o título a pagar é previsto codigoFilial: type: integer format: int64 description: Código da filial do título a pagar situacaoTitulo: type: string description: Situação do título a pagar usuarioGeracao: type: string description: Usuário de cadastro do tipo de título dataGeracao: type: string format: date-time description: Data de cadastro do tipo de título usuarioAlteracao: type: string description: Usuário que alterou o tipo de título dataAlteracao: type: string format: date-time description: Data de alteração do tipo de título chaveNota: type: object allOf: – #/definitions/recChaveNota description: Estrutura da nota fiscal de compra do título a pagar chaveFatura: type: object allOf: – #/definitions/recChaveFatura description: Estrutura da fatura de compra do título a pagar portadorId: type: integer format: int64 description: Código do portador do título à pagar carteiraId: type: string description: Código da carteira do título à pagar moedaId: type: string description: jurosNegociados: type: string description: multasNegociados: type: string description: descontosNegociados: type: string description: outrosNegociados: type: string description: dataNegociados: type: string format: date description: jurosDia: type: string description: dataDesconto: type: string format: date description: valorDesconto: type: string description: percentualDesconto: type: string description: percentualMulta: type: string description: percentualJuros: type: string description: cotacaoEmissao: type: string description: cotacaoNegociada: type: string description: dataUltimoPagamento: type: string format: date description: dataCalculoJuros: type: string format: date description: isCalcularDesconto: type: boolean description: toleranciaDiasDesconto: type: integer format: int64 description: toleranciaDiasJuros: type: integer format: int64 description: toleranciaDiasMulta: type: integer format: int64 description: tipoJuros: type: string allOf: – #/definitions/enumTipoJuros description: valores: type: object allOf: – #/definitions/recValoresTitulo description: valoresMemoria: type: object allOf: – #/definitions/recValoresMemoria description: Memória de cálculo dos valores observacao: type: string description: Observação do título recValoresMemoria: description: type: object required: – memoriaJuros – memoriaMulta – memoriaOutrosAcrescimos – memoriaDescontos – memoriaCorrecao – memoriaOutrosDescontos – memoriaReajusteAcrescimos – memoriaReajusteOutrosDescontos – memoriaValorLiquido properties: memoriaJuros: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de juros memoriaMulta: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de multa memoriaOutrosAcrescimos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de outros acrescimos memoriaDescontos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de descontos memoriaCorrecao: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de correção monetária memoriaOutrosDescontos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de outros descontos memoriaReajusteAcrescimos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de reajuste de acréscimos memoriaReajusteOutrosDescontos: type: object allOf: – #/definitions/recMemoria description: memória do cálculo de reajuste de outros descontos memoriaValorLiquido: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de valor líquido recValoresTitulo: description: type: object required: – valorOriginal – valorAberto – valorJuros – valorMulta – valorEncargos – valorCorrecao – valorOutrosAcrescimos – valorDescontos – valorOutrosDescontos – valorLiquido properties: valorOriginal: type: string description: valorAberto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorDescontos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: recMemoria: description: Memória de cálculo type: object required: – memoriaCalculoFormula – memoriaCalculoFormulaTraduzida properties: memoriaCalculoFormula: type: array items: type: string minimum: 1 description: Formula do cáluco com as variávies memoriaCalculoFormulaTraduzida: type: array items: type: string minimum: 1 description: Formula do cálculo com os valores recMovimentoTituloPagar: description: type: object properties: id: type: integer format: int64 description: tituloPagarId: type: integer format: int64 description: transacaoContasPagarId: type: integer format: int64 description: sequenciaMovimento: type: integer format: int64 description: dataMovimento: type: string format: date description: valorAberto: type: string description: numeroDocumento: type: string description: observacao: type: string description: vencimentoProrrogado: type: string format: date description: dataPagamento: type: string format: date description: cotacao: type: string description: valorMovimento: type: string description: valorDesconto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: dataUltimoPagamento: type: string format: date description: dataUltimoJuros: type: string format: date description: prorrogacaoJuros: type: string description: percentualJuros: type: string description: diasJuros: type: integer format: int64 description: valorCotacao: type: string description: numeroLoteContabil: type: integer format: int64 description: movimentoContaInternaId: type: integer format: int64 description: usuarioGeracao: type: string description: Usuário de cadastro dataGeracao: type: string format: date-time description: Data de cadastro usuarioAlteracao: type: string description: Usuário de alteração dataAlteracao: type: string format: date-time description: Data de alteração recHistoricoFornecedor: description: Historico de fornecedor type: object required: – fornecedorId – filialId properties: fornecedorId: type: integer format: int64 description: Fornecedor filialId: type: integer format: int64 description: Filial quantidadeDiasVencimento: type: integer format: int64 description: Quantidade de dias de vencimento grupoContasId: type: string description: Grupo de contas UUID percendutalMulta: type: number format: double description: Percentual de multa toleranciaDiasMulta: type: integer format: int64 description: Tolerância dias de multa percentualJuros: type: number format: double description: Percentual de juros tipoJuros: type: string allOf: – #/definitions/enumTipoJuros description: Tipo de juros toleranciaDiasJuros: type: integer format: int64 description: Tolerancia dias de juros percentualDesconto: type: number format: double description: Percentual de desconto calcularDesconto: type: string maxLength: 1 description: Calcular desconto toleranciaDiasDesconto: type: integer format: int64 description: Tolerancia dias de desconto portadorId: type: integer format: int64 description: Portador carteiraId: type: string maxLength: 2 description: Cateira UUID banco: type: string maxLength: 3 description: Banco Id agencia: type: integer format: int64 description: Agencia Id contaCorrente: type: string maxLength: 14 description: Conta corrente tipoConta: type: integer format: int64 description: Tipo conta formaPagamentoId: type: string description: Forma pagamento UUID favorecidoId: type: string description: Favorecido UUID recMoeda: description: Dados da moeda type: object required: – id – descricao – sigla properties: id: type: string description: Id da moeda descricao: type: string description: Descrição da moeda sigla: type: string description: Sigla da moeda tipo: type: string description: Tipo da moeda empresa: description: type: object required: – codigo – nome properties: id: type: integer format: int64 description: codigo: type: string maxLength: 4 description: nome: type: string maxLength: 100 description: filial: description: type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: nome: type: string description: codigo: type: string description: entTituloPagar: description: Titulo a pagar type: object required: – empresaId – filialId – fornecedorId – tipoTituloId – origemTitulo – dataEntrada – dataEmissao – valorOriginal – vencimentoOriginal – previsto – situacaoTitulo – portadorId – carteiraId properties: id: type: integer format: int64 description: Identificação do título a pagar empresaId: type: integer format: int64 description: Código da empresa do título a pagar filialId: type: integer format: int64 description: Código da filial do título a pagar fornecedorId: type: integer format: int64 description: Código do fornecedor do título a pagar tipoTituloId: type: string description: Código do tipo de título do título a pagar origemTitulo: type: string allOf: – #/definitions/enumOrigemTitulo description: Origem do título a pagar numeroTitulo: type: string description: Número do título a pagar dataEntrada: type: string format: date description: Data de entrada do título a pagar dataEmissao: type: string format: date description: Data de emissão do título a pagar valorOriginal: type: string description: Valor original do título a pagar valorAberto: type: string description: Valor aberto do título a pagar codigoBarras: type: string description: Código de barras do título a pagar transacaoContasPagar: type: string description: Transação de entrada do título a pagar vencimentoOriginal: type: string format: date description: Vencimento original do título a pagar vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a pagar provavelPagamento: type: string format: date description: Provável pagamento do título a pagar previsto: type: string description: Indicativo se o título a pagar é previsto codigoFilial: type: integer format: int64 description: Código da filial do título a pagar situacaoTitulo: type: string description: Situação do título a pagar usuarioGeracao: type: string description: Usuário de cadastro do tipo de título dataGeracao: type: string format: date-time description: Data de cadastro do tipo de título usuarioAlteracao: type: string description: Usuário que alterou o tipo de título dataAlteracao: type: string format: date-time description: Data de alteração do tipo de título chaveNota: type: object allOf: – #/definitions/recChaveNota description: Estrutura da nota fiscal de compra do título a pagar chaveFatura: type: object allOf: – #/definitions/recChaveFatura description: Estrutura da fatura do título a pagar portadorId: type: integer format: int64 description: Código do portador do título à pagar carteiraId: type: string description: Código da carteira do título à pagar moedaId: type: string description: jurosNegociados: type: string description: multasNegociados: type: string description: descontosNegociados: type: string description: outrosNegociados: type: string description: dataNegociados: type: string format: date description: jurosDia: type: string description: dataDesconto: type: string format: date description: valorDesconto: type: string description: percentualDesconto: type: string description: percentualMulta: type: string description: percentualJuros: type: string description: cotacaoEmissao: type: string description: cotacaoNegociada: type: string description: dataUltimoPagamento: type: string format: date description: dataCalculoJuros: type: string format: date description: isCalcularDesconto: type: boolean description: toleranciaDiasDesconto: type: integer format: int64 description: toleranciaDiasJuros: type: integer format: int64 description: toleranciaDiasMulta: type: integer format: int64 description: tipoJuros: type: string allOf: – #/definitions/enumTipoJuros description: observacao: type: string description: Observação do título entTituloPagarMovimento: description: type: object required: – tituloPagarId – valorAberto – valorMovimento – valorLiquido – portadorId – carteiraId properties: id: type: integer format: int64 description: tituloPagarId: type: integer format: int64 description: transacaoContasPagarId: type: integer format: int64 description: sequenciaMovimento: type: integer format: int64 description: dataMovimento: type: string format: date description: valorAberto: type: string description: numeroDocumento: type: string description: observacao: type: string description: vencimentoProrrogado: type: string format: date description: dataPagamento: type: string format: date description: cotacao: type: string description: valorMovimento: type: string description: valorDesconto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: dataUltimoPagamento: type: string format: date description: dataUltimoJuros: type: string format: date description: prorrogacaoJuros: type: string description: percentualJuros: type: string description: diasJuros: type: integer format: int64 description: valorCotacao: type: string description: numeroLoteContabil: type: integer format: int64 description: movimentoContaInternaId: type: integer format: int64 description: portadorId: type: integer format: int64 description: Código do portador do título à pagar carteiraId: type: string description: Código da carteira do título à pagar usuarioGeracao: type: string description: Usuário de cadastro dataGeracao: type: string format: date-time description: Data de cadastro usuarioAlteracao: type: string description: Usuário de alteração dataAlteracao: type: string format: date-time description: Data de alteração entTransacaoContasPagar: description: type: object required: – id – empresaId – transacao – descricao – tipoMovimento – tipoBaixa – aceitaManual properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: transacao: type: string maxLength: 5 description: descricao: type: string maxLength: 60 description: modulo: type: string maxLength: 3 description: tipoMovimento: type: integer format: int64 description: tipoBaixa: type: string description: aceitaManual: type: boolean description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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