Histórico da Página

...

Dica

title	Autenticação das 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.

Informações

title	Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items

02. EXEMPLO DE UTILIZAÇÃO

...

Painel

titleColor	Orange
borderStyle	solid
title	Titles - Retorna os títulos dos beneficiários/empresas

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

/totvsHealthPlans/invoicing/v1/titles

GET

Nota

Matricula

Expandir

title	Parameters

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	*

requiredhealth-insurer-code

required
healthInsurerCode (query)	string	Código da operadora (E1_CODINT)	*required

company-code

(Quando o subcriberId não for informado)
companyCode (query)	string	Código da empresa (E1_CODEMP)	*required

family-code (query)

string

(Quando o subcriberId não for informado)

subscriberId (query)

string

Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)

familyCode (query)

string

Matricula da família (E1_MATRIC)

Obs: Filtro para títulos referente a família do beneficiário.

contract-code

contractCode (query)

string

Contrato da empresa (E1_CONEMP)

Obs: Filtro para títulos referente a empresa

contract-version-code

contractVersionCode (query)

string

Versão do contrato (E1_VERCON)

Obs: Filtro para títulos referente a empresa

subcontract-code

subcontractCode (query)

string

Subcontrato do contrato da empresa (E1_SUBCON)

Obs: Filtro para títulos referente a empresa

subcontract-version-code

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)

subcontractVersionCode (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)

situation (query)

string

FIltro dos títulos pela situação, sendo:

0 = Carteira
1 = Cob.Simples
2 = Descontada
3 = Caucionada
4 = Vinculada
5 = Advogado;6=Judicial

Pode ser informado mais de uma situação, ex: 2,3,4

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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	integer	Quantidade de registros ainda existem para retorno		*required
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	*required
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 TituloE1_STATUS	Sendo: A = Aberto P = Baixado Parcial B = Baixado
items.title-_id	string	Chave de busca do Titulo	E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO	*required
items.situation	string	Situação do titulo	E1_SITUACA
items.links	array	links relacionados ao recurso títles (Padrão HATEOAS): rel: bankSlip rel: bankSlip/base64		*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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",
			"situation": "1",
            "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
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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.

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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."
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 15

Nova versão Atual

Chave

02. EXEMPLO DE UTILIZAÇÃO