
{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "ClientInfoResource"
    },
    "host": "api.onvio.com.br",
    "basePath": "/dominio/integration/v2",
    "tags": [
        {
            "name": "ClientIntegrationResource"
        }
    ],
    "paths": {
        "/client/info": {
            "get": {
                "tags": [
                    "ClientIntegrationResource"
                ],
                "summary": "Return list of clients that the user has access to integrate",
                "description": "",
                "operationId": "findClients",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "pageIndex",
                        "in": "query",
                        "required": false,
                        "type": "integer",
                        "format": "int32"
                    },
                    {
                        "name": "Authorization",
                        "in": "header",
                        "description": "Auth0 access token",
                        "required": true,
                        "type": "string",
                        "default": "Bearer <access token>"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "$ref": "#/definitions/PagedClientv2Dto"
                        }
                    },
					"400": {
                        "description": "Bad request"
                    },
                    "500": {
                        "description": "Internal server error"
                    }
                }
            }
        }
    },
    "definitions": {
        "ClientIntegrationv2Dto": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string",
                    "description": "Client's identifier"
                },
                "nationalIdentity": {
                    "type": "string",
                    "description": "Client's national identity"
                },
				"nationalIdentityKind": {
                    "type": "string",
                    "description": "Client's national identity type options: CNPJ, CPF, CEI and CAEPF"
                },
                "stateInscription": {
                    "type": "string",
                    "description": "Client's state inscription"
                },
                "municipalInscription": {
                    "type": "string",
                    "description": "Client's municipal inscription"
                },
                "name": {
                    "type": "string",
                    "description": "Client's name"
                }
            }
        },
        "PagedClientv2Dto": {
            "type": "object",
            "properties": {
                "totalItems": {
                    "type": "integer",
                    "format": "int32",
                    "description": "The total number of items available in the entire data set"
                },
                "pageIndex": {
                    "type": "integer",
                    "format": "int32",
                    "description": "The index of the current page of items (should be 1-based)"
                },
                "totalPages": {
                    "type": "integer",
                    "format": "int32",
                    "description": "The total number of pages in the entire data set"
                },
                "clients": {
                    "type": "array",
                    "description": "List of clients",
                    "items": {
                        "$ref": "#/definitions/ClientIntegrationv2Dto"
                    }
                }
            }
        }
    }
}
