ReadMe_PriorityMetricsResponse

Prioridades de oneração por adquirente e financiador

acquirers object[]

Lista de adquirentes com prioridades por financiador

Lista [

taxIdstring

CNPJ do adquirente

Exemplo 01027058000191

namestring

Nome do adquirente

Exemplo Adquirente Exemplo

totalAmountnumber

Valor total considerado para o adquirente

Exemplo 10000

priorities object[]

Prioridades por financiador

Lista [

financierTaxIdstring

CNPJ do financiador

Exemplo 12345678000190

financierNamestring

Nome do financiador

Exemplo Financiador Exemplo

prioritystring

Prioridade calculada

Exemplo 1

amountnumber

Valor solicitado pelo financiador

Exemplo 1500

encumbranceTypestring

Tipo de oneração

Valores possíveis: [FIXED, PERCENTAGE]

Exemplo FIXED

]

]

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_PriorityMetricsResponse

{
  "acquirers": [
    {
      "taxId": "01027058000191",
      "name": "Adquirente Exemplo",
      "totalAmount": 10000,
      "priorities": [
        {
          "financierTaxId": "12345678000190",
          "financierName": "Financiador Exemplo",
          "priority": "1",
          "amount": 1500,
          "encumbranceType": "FIXED"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}