API BillingEntries - v1.000 (Invoicing)

CONTEÚDO

Visão Geral
Exemplo de utilização
1. BillingEntry - Retorna os lançamentos de faturamento
Tela api billingEntry
1. Outras Ações / Ações relacionadas
Tela api billingEntry
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade billingEntries (Lançamentos de Faturamento) do produto TOTVS Saúde Planos Linha Protheus.

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

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.

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

BillingEntries - Retorna os lançamentos de faturamento

Retorna os lançamentos de faturamento da operadora de saúde

/totvsHealthPlans/invoicing/v1/billingEntries

GET

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	*required
health-insurer-code (query)	string	Código da operadora de saúde no sistema	*required
is-finance-statetment (query)	string	Filtro por lançamentos que são visíveis no extrato financeiro (BFQ_EXTFIN), sendo: 1 = Sim
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

Request

Body

Não possui body!

(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de lançamentos de faturamento
items.owner	string	Proprietário, sendo: 1 = Sistema 9 = Cliente	BFQ_PROPRI	*required
items.invoice-entry-code	string	Código de lançamento de faturamento	BFQ_CODLAN	*required
items.description	string	Descrição do lançamento de faturamento	BFQ_DESCRI	*required
items.sequential	string	Sequência	BFQ_SEQUEN	*required
items.type	string	Tipo do lançamento de faturamento, sendo: 1 = Debito 2 = Credito	BFQ_DEBCRE	*required
items.active	string	Define se o lançamento está ativo, sendo: 1 = Sim 0 = Não	BFQ_ATIVO
items.finance-statetment	string	Define se irá visualizar no extrato financeiro, sendo: 1 = Sim 0 = Não	BFQ_EXTFIN

Exemplo

{
    "items": [
        {
            "owner": "1",
            "invoice-entry-code": "01",
            "description": "Produto/Plano (Mensalidade)",
            "sequential": "001",
            "type": "1",
            "active": "1",
            "finance-statetment": "1"
        },
        {
            "owner": "1",
            "invoice-entry-code": "02",
            "description": "Opcionais/Termos Aditivos",
            "sequential": "002",
            "type": "1",
            "active": "1",
            "finance-statetment": ""
        },
        {
            "owner": "1",
            "invoice-entry-code": "03",
            "description": "Taxa Inscricao/Adesao",
            "sequential": "003",
            "type": "1",
            "active": "1",
            "finance-statetment": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 79
}

(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.	*required

Exemplo

{
    "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 BILLINGENTRIES

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA BILLINGENTRIES

Principais Campos e Parâmetros

Campo	Descrição
BFQ_PROPRI	Proprietário
BFQ_CODLAN	Código de lançamento de faturamento

05. TABELAS UTILIZADAS

Lançamentos do Faturamento (BFQ)

Árvore de páginas