Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela api titles
1. Outras Ações / Ações relacionadas
Tela api titles
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade titles (títulos) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

02. EXEMPLO DE UTILIZAÇÃO

Retorna os títulos da empresa ou do beneficiário no Financeiro (Contas a receber).

/totvsHealthPlans/invoicing/v1/titles

GET

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
health-insurer-code (query)	string	Código da operadora (E1_CODINT)	*required
company-code (query)	string	Código da empresa (E1_CODEMP)	*required
family-code (query)	string	Matricula da família (E1_MATRIC) Obs: Filtro para títulos referente a família do beneficiário.
contract-code (query)	string	Contrato da empresa (E1_CONEMP) Obs: Filtro para títulos referente a empresa
contract-version-code (query)	string	Versão do contrato (E1_VERCON) Obs: Filtro para títulos referente a empresa
subcontract-code (query)	string	Subcontrato do contrato da empresa (E1_SUBCON) Obs: Filtro para títulos referente a empresa
subcontract-version-code (query)	string	Versão do subcontrato (E1_VERSUB) Obs: Filtro para títulos referente a empresa
type (query)	string	Tipo do título (E1_TIPO), pode ser enviado mais de um tipo. Ex: NCC,DP
status (query)	string	Status do título (E1_STATUS)
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Body

Não possui body!

hasNext	boolean	Indica se ainda existem registros a serem retornados
remainingRecords	integer	Quantidade de registros ainda existem para retorno
items	array	Lista de títulos retornados
items.customer-id	string	Código	E1_CLIENTE	*required
items.customer-store	string	Descrição	E1_LOJA	*required
items.customer-name	string	Tipo de grupo (Pessoa física ou jurídica)	E1_NOMCLI
items.issue-date	string (date)	Data de Emissão do Titulo	E1_EMISSAO	*required
items.prefix	string	Prefixo do titulo	E1_PREFIXO
items.number	string	Numero do Titulo	E1_NUM	*required
items.parcel	string	Parcela do Titulo	E1_PARCELA
items.type	string	Tipo do titulo	E1_TIPO	*required
items.base-month	string	Mês Base	E1_MESBASE
items.base-year	string	Ano Base	E1_ANOBASE
items.real-due-date	string (date)	Vencimento real do Titulo	E1_VENCREA	*required
items.amount	number (double)	Valor do Titulo	E1_VALOR
items.balance	number (double)	Saldo a Receber	E1_SALDO
items.net-value	number (double)	Valor Liquido da Baixa	E1_VALLIQ
items.low-date	string (date)	Data de Baixa do Titulo	E1_BAIXA
items.status	string	Status do Titulo	E1_STATUS
items.title-id	string	Chave de busca do Titulo	E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO	*required
items.links	array	links relacionados ao recurso títles (Padrão HATEOAS): rel: bankSlip rel: bankSlip/base64		*required

{
    "items": [
        {
            "customer-id": "PLS103",
            "customer-store": "01",
            "customer-name": "ARTHUR E BETINA PAES",
            "issue-date": "2021-04-05",
            "prefix": "PLS",
            "number": "000007027",
            "parcel": "",
            "type": "DP",
            "base-month": "04",
            "base-year": "2021",
            "real-due-date": "2021-04-26",
            "amount": 30351.4,
            "balance": 0,
            "net-value": 28541.08,
            "low-date": "2022-12-20",
            "status": "B",
            "title-id": "PLS000007027+DP",
            "links": [
                {
                    "rel": "bankSlip",
                    "href": "/totvsHealthPlans/invoicing/v1/titles/PLS000007027+DP/bankSlip"
                },
                {
                    "rel": "bankSlip/base64",
                    "href": "/totvsHealthPlans/invoicing/v1/titles/PLS000007027+DP/bankSlip/base64"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 11
}

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

03. TELA XXXXX

Outras Ações / Ações relacionadas

Ação	Descrição
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada
Inclua a ação	Inclua a descrição relacionada

04. TELA XXXXX

Principais Campos e Parâmetros

Campo	Descrição
Inclua o campo	Inclua a descrição relacionada
Inclua o campo	Inclua a descrição relacionada
Inclua o campo	Inclua a descrição relacionada

05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas