Método responsável por exportar visualização da lista de cobranças

Lista e filtra registros de api.

Visão geral

Método responsável por exportar visualização da lista de cobranças.

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`Registered`	query	`boolean`	opcional	—	`true`
`Amount`	query	`integer (int64)`	opcional	—	`10`
`DocumentNumber`	query	`string`	opcional	—	`valor`
`BarCode`	query	`string`	opcional	—	`valor`
`SearchString`	query	`string`	opcional	—	`valor`
`Tags`	query	`array de string`	opcional	—	`valor`
`StatusesValue`	query	`array de string`	opcional	—	`valor`
`ExcludeStatusesValue`	query	`array de string`	opcional	—	`valor`
`WalletsCode`	query	`array de integer (int64)`	opcional	—	`valor`
`BankSlipId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`InitialDueDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalDueDate`	query	`string (date-time)`	opcional	—	`valor`
`InitialSettlementDate`	query	`string (date-time)`	opcional	—	`valor`
`FinalSettlementDate`	query	`string (date-time)`	opcional	—	`valor`
`PayerName`	query	`string`	opcional	—	`valor`
`Tenant`	query	`string`	opcional	—	`uy3`
`PayerRegistrationNumber`	query	`string`	opcional	—	`valor`
`FirstInstructionDebtCollection`	query	`string`	opcional	—	`valor`
`BillingIds`	query	`array de string`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Sem resposta de sucesso documentada no contrato.

Códigos de retorno

Código	Significado	Detalhe do contrato
`401`	Não autenticado — token ausente, inválido ou expirado.	—

Exemplos

curl -X GET "{{baseUrl}}/api/v1/Billing/Export" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/api/v1/Billing/Export";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/api/v1/Billing/Export`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads