Atribuição de fatura a um ou mais itens de cobrança

Para incluir os itens de cobrança durante a criação da conta, cada item deve ser atribuído a um número de fatura. Este endpoint permite a atribuição de múltiplos itens a uma única fatura, de forma eficiente e escalável. O processo é assíncrono, permitindo o acompanhamento do status da atribuição por meio de um endpoint dedicado.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Ao atribuir itens de cobrança a uma fatura, a solicitação retorna, como parte da resposta, um header Location. Esse cabeçalho contém a URL do endpoint que permite consultar o status do processo de atribuição.

Além disso, o endpoint retornará as validações 422 ou 404 se nenhuma configuração interna do tipo convenção, etc., tiver sido criada.

Body Params
string
required
Defaults to 56

Este campo representa o código do convênio que identifica a relação entre o cliente (hospital ou instituição de saúde) e a fonte pagadora (operadora de saúde). Trata-se de um código referenciado que vincula o hospital à fonte pagadora responsável pelo pagamento.

string
required
Defaults to 0001

Este campo armazena o número da nota fiscal associada à cobrança. Ele é utilizado para fins de registro, auditoria e conformidade fiscal.

charge_codes
array of strings
required
Defaults to C01

Este campo contém uma lista com os identificadores únicos dos itens de cobrança que serão atribuídos a uma fatura específica. Ele é utilizado para consolidar múltiplos itens em uma única fatura no processo de faturamento.

charge_codes*
string

Esse campo é utilizado para já agregar o protocolo para as contas direto no momento de criação do Invoice/Fatura. Durante o processamento interno, o sistema verifica se o campo settlement_number não é null ou vazio. Caso não seja nulo ou vazio ele será mapeado para o invoice/fatura que está sendo criado.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json