{
	"openapi": "3.0.1",
	"servers": [
		{
			"description": "API para a entidade filial (Branch) para produtos TOTVS",
			"url": "{{host}}/api/framework/v1",
			"variables": {
				"serverUrl": {
					"default": "localhost"
				},
				"serverHttpPort": {
					"default": "8051"
				}
			}
		}
	],
	"info": {
		"description": "API para a entidade filial (Branch) para produtos TOTVS",
		"version": "1.000",
		"title": "Filial",
		"contact": {
			"name": "T-Talk",
			"url": "API.Totvs.com.br",
			"email": "comiteintegracao@totvs.com.br"
		},
		"x-totvs": {
			"messageDocumentation": {
				"name": "Filial",
				"description": "Filial",
				"segment": "Foundation"
			},
			"productInformation": [
				{
					"product": "RMS",
					"contact": "lsousa@totvs.com.br",
					"description": "Cadastro de Filial"
				},
				{
					"product": "RM",
					"contact": "TribeBO.Squad.Fis@totvs.com.br",
					"description": "Cadastro de Filial",
					"helpUrl": "https://tdn.totvs.com/x/oP8pIQ"
				}
			]
		}
	},
	"paths": {
		"/Branches": {
			"get": {
				"tags": [
					"Branch"
				],
				"summary": "Retorna todas as Filiais da base",
				"x-totvs": {
					"productInformation": [
						{
							"product": "RMS",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros"
						},
						{
							"product": "RM",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros",
							"minimalVersion": "12.1.29"
						}
					]
				},
				"description": "Retorna todas as Filiais da base",
				"operationId": "getBranch",
				"parameters": [
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
					},
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
					},
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
					},
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
					},
					{
						"$ref": "#/components/parameters/EnterpriseGroup"
					}
				],
				"responses": {
					"200": {
						"description": "Operação realizada com sucesso",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/PagedBranches"
								}
							}
						}
					}
				}
			},
			"post": {
				"tags": [
					"Branch"
				],
				"summary": "Inclui a Filial passada na requisição",
				"description": "Inclui a Filial passada na requisição",
				"operationId": "postBranch",
				"x-totvs": {
					"productInformation": [
						{
							"product": "RMS",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros"
						},
						{
							"product": "RM",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros",
							"minimalVersion": "12.1.29"
						}
					]
				},
				"parameters": [
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
					}
				],
				"requestBody": {
					"content": {
						"application/json": {
							"schema": {
								"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/BranchType"
							}
						}
					},
					"description": "Filial para ser incluida"
				},
				"responses": {
					"200": {
						"description": "Operação realizada com sucesso",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/PagedBranches"
								}
							}
						}
					},
					"400": {
						"description": "erro no momento da Inclusão",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
								}
							}
						}
					}
				}
			}
		},
		"/Branches/{BranchInternalId}": {
			"get": {
				"tags": [
					"Branch"
				],
				"summary": "Retorna todas as Filiais da base",
				"description": "Retorna todas as Filiais da base",
				"operationId": "getBranchID",
				"x-totvs": {
					"productInformation": [
						{
							"product": "RMS",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros"
						},
						{
							"product": "RM",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros",
							"minimalVersion": "12.1.29"
						}
					]
				},
				"parameters": [
					{
						"$ref": "#/components/parameters/BranchInternalId"
					},
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
					}
				],
				"responses": {
					"200": {
						"description": "Operação realizada com sucesso",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/BranchType"
								}
							}
						}
					},
					"404": {
						"description": "Filial não localizada na base",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
								}
							}
						}
					}
				}
			},
			"put": {
				"tags": [
					"Branch"
				],
				"summary": "Inclui a Filial passada na requisição",
				"description": "Inclui a Filial passada na requisição",
				"operationId": "postBranchID",
				"x-totvs": {
					"productInformation": [
						{
							"product": "RMS",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros"
						},
						{
							"product": "RM",
							"available": true,
							"note": "Este verbo está disponivel com todos os parametros",
							"minimalVersion": "12.1.29"
						}
					]
				},
				"parameters": [
					{
						"$ref": "#/components/parameters/BranchInternalId"
					},
					{
						"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
					}
				],
				"requestBody": {
					"content": {
						"application/json": {
							"schema": {
								"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/BranchType"
							}
						}
					},
					"description": "Filial para ser incluida"
				},
				"responses": {
					"200": {
						"description": "Operação realizada com sucesso",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/PagedBranches"
								}
							}
						}
					},
					"400": {
						"description": "erro no momento da Inclusão",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
								}
							}
						}
					},
					"404": {
						"description": "Filial não localizada na base",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
								}
							}
						}
					}
				}
			},
			"delete": {
				"tags": [
					"Branch"
				],
				"deprecated": true,
				"summary": "Funcionalidade retirada por questão de regras",
				"description": "Não é permitida a deleção da Filial por API, por motivos de segurança",
				"operationId": "DeleteBranchID",
				"x-totvs": {
					"productInformation": [
						{
							"product": "RM",
							"available": false,
							"note": "Este verbo não está disponivel, pois não é permitida a exclusão de Filial por endpoit"
						}
					]
				},
				"parameters": [
					{
						"$ref": "#/components/parameters/BranchInternalId"
					}
				],
				"responses": {
					"200": {
						"description": "Operação realizada com sucesso",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_003.json#/definitions/BranchType"
								}
							}
						}
					},
					"405": {
						"description": "Não disponivel",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
								}
							}
						}
					}
				}
			}
		}
	},
	"components": {
		"parameters": {
			"BranchInternalId": {
				"name": "BranchInternalId",
				"in": "path",
				"required": true,
				"description": "Identificador Único representando a Filial",
				"schema": {
					"type": "string"
				}
			},
			"EnterpriseGroup": {
				"name": "EnterpriseGroup",
				"in": "header",
				"required": false,
				"description": "Grupo de empresa das filiais requisitadas",
				"schema": {
					"type": "string"
				},
				"x-totvs": {
					"productInformation": []
				}
			}
		},
		"schemas": {}
	}
}