v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Listar clientes vinculados a uma obrigação

get/v1/accountingfirms/{accountingFirmId}/obligations/{obligationId}/customers

Path parameters

accountingFirmIdstring required

Id do escritório.

obligationIdstring required

Id da obrigação.

Query parameters

$filterstring

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

$skipstring

Define o número de resultados a serem ignorados. Exemplo: skip=10.

$topstring

Limita o número de resultados retornados. Exemplo: top=5.

$orderbystring

Ordena os resultados. Exemplo: orderby=Name asc.

Headers

X-API-Keystring

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

X-User-Idstring

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Response

200

Example response

{
  "items": [
    {
      "customerId": "id",
      "customerCode": "string",
      "customerName": "string",
      "customerDocumentNumber": "string",
      "customerDocumentType": "int",
      "customerCity": "string",
      "customerState": "string",
      "customerTaxRegime": "int",
      "inChargeUser": {
        "id": "id",
        "name": "string"
      },
      "startControlDate": "datetime"
    }
  ],
  "metadata": {
    "totalAllItems": "int",
    "total": "int"
  }
}